Package com.comsol.model

Interface StudyFeature

    • Method Detail

      • activate

        @Deprecated
boolean activate​(java.lang.String arg0)
        Deprecated.
        Use solveFor(String) instead.

      • createNewOPTStudy

        StudyFeature createNewOPTStudy()
        Create new study, copy all current study steps, change optimization solver to default solver and set initial conditions with the current best parameters in copied optimization study step.
        Returns:
        Newly created optimization study step.

      • createNewUQStudy

        StudyFeature createNewUQStudy​(java.lang.String uqtype)
        Create new study, copy all current study steps, and change uncertainty quantification study settings in the newly created uncertainty quantification study step.
        Parameters:
        uqtype - Uncertainty quantification study type of the newly created uncertainty quantification study step.
        Returns:
        Newly created uncertainty quantification study step.

      • discardData

        void discardData()
        Discard any imported data.

      • discretization

        java.lang.String discretization​(java.lang.String physics)
        Returns discretization for a multigrid level.
        Parameters:
        physics - Physics interface or physics feature.
        Returns:
        Discretization feature under a physics mode.

      • discretization

        StudyFeature discretization​(java.lang.String physics,
                            java.lang.String disc)
        Assigns discretization for a multigrid level.
        Parameters:
        physics - Physics interface or physics feature.
        disc - Discretization feature under a physics mode.
        Returns:
        Study feature.

      • exportData

        void exportData​(java.lang.String filename)
        Export data.
        Parameters:
        filename - Filename.

      • feature

        StudyFeatureList feature()
        Returns the study steps.
        Returns:
        List of study steps.

      • feature

        StudyFeature feature​(java.lang.String studyFeature)
        Returns a study step with the given tag.
        Parameters:
        studyFeature - StudyFeature tag.
        Returns:
        Requested study tag.

      • importData

        void importData()
        Import data.

      • importData

        void importData​(java.lang.String filename)
        Import data from specified file.
        Parameters:
        filename - Filename.

      • loadFile

        boolean loadFile​(java.lang.String filePath)
        Tries to load a file content into the study feature. Returns the success of the operation.
        Parameters:
        filePath - Path of the file.
        Returns:
        true if success.

      • mesh

        java.lang.String mesh​(java.lang.String geom)
        Returns the mesh selected for the given geometry.
        Parameters:
        geom - Geometry sequence tag.
        Returns:
        Mesh sequence tag.

      • mesh

        StudyFeature mesh​(java.lang.String geom,
                  java.lang.String mesh)
        Specifies which mesh to use for the geometry.
        Parameters:
        geom - Geometry sequence tag.
        mesh - Mesh sequence tag.
        Returns:
        Study feature.

      • mglevel

        MultigridLevelList mglevel()
        Returns multigrid level list for this study step.
        Returns:
        List of multigrid levels.

      • mglevel

        MultigridLevel mglevel​(java.lang.String level)
        Sets a multigrid level for this study step.
        Parameters:
        level - Multigrid level tag.
        Returns:
        Multigrid level.

      • problem

        ProblemList problem()
        Returns all problems for this feature.
        Returns:
        Problem feature list.

      • problem

        ProblemFeature problem​(java.lang.String tag)
        Returns a problem feature.
        Parameters:
        tag - Problem tag.
        Returns:
        Problem feature.

      • refresh

        void refresh()
        Reread the files that this feature depends on, if any.

      • saveFile

        boolean saveFile​(java.lang.String filePath)
        Tries to save the content of the study feature to a file. Returns the success of the operation.
        Parameters:
        filePath - Path of the file.
        Returns:
        true if active.

      • selection

        LocalSelection selection​(java.lang.String name)
        Returns the selection stored in a selection property with the given name.
        Specified by:
        selection in interface PropFeature
        Parameters:
        name - Selection property name.
        Returns:
        Selection.

      • setSolveFor

        boolean setSolveFor​(java.lang.String entityURI,
                    boolean state)
        Specifies whether degrees of freedom contributed by a model entity should be actively solved for when computing this study step.
        Parameters:
        entityURI - Model URI of entity contributing degrees of freedom.
        state - Activation state.
        Returns:
        true if the model entity respects the setting in a meaningful way.

      • solveFor

        boolean solveFor​(java.lang.String entityURI)
        Returns true if degrees of freedom contributed by a model entity should be actively solved for when computing this study step.
        Parameters:
        entityURI - Model URI of entity contributing degrees of freedom.
        Returns:
        true if solved for.

      • type

        java.lang.String type()
        Returns the study type.
        Returns:
        Study type.