com.comsol.model

Interface StudyFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, SelectionContainer, SelectionEntity, StudyContainer

public interface StudyFeature
extends PropFeature, StudyContainer

Study step.

Method Summary

Modifier and Type	Method and Description
boolean	activate(java.lang.String physics) Returns activation status of a physics interface or a physics interface feature.
StudyFeature	activate(java.lang.String physics, boolean state) Sets activation status of a physics interface or a physics interface feature.
java.lang.String	discretization(java.lang.String physics) Returns discretization for a multigrid level.
StudyFeature	discretization(java.lang.String physics, java.lang.String disc) Assigns discretization for a multigrid level.
boolean	loadFile(java.lang.String filePath) Tries to load a file content into the study feature.
java.lang.String	mesh(java.lang.String geom) Returns the mesh selected for the given geometry.
StudyFeature	mesh(java.lang.String geom, java.lang.String mesh) Specifies which mesh to use for the geometry.
MultigridLevelList	mglevel() Returns multigrid level list for this study step.
MultigridLevel	mglevel(java.lang.String level) Sets a multigrid level for this study step.
boolean	saveFile(java.lang.String filePath) Tries to save the content of the study feature to a file.
LocalSelection	selection(java.lang.String name) Returns a study feature's selection property.
java.lang.String	type() Returns the study type.

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Methods inherited from interface com.comsol.model.ModelEntity

active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString

Method Detail

activate

boolean activate(java.lang.String physics)

Returns activation status of a physics interface or a physics interface feature.

Parameters:

physics - Physics interface or physics feature.

Returns:

true if active.

activate

StudyFeature activate(java.lang.String physics,
                      boolean state)

Sets activation status of a physics interface or a physics interface feature.

Parameters:

physics - Physics interface or physics feature.

state - Activation state.

Returns:

Study feature.

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.

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.

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 a study feature's selection property.

Specified by:

selection in interface PropFeature

Parameters:

name - The selection property name.

Returns:

Selection.

type

java.lang.String type()

Returns the study type.

Returns:

Study type.