Package com.comsol.model.physics

Interface PhysicsFeature

All Superinterfaces:

EquationViewParent, IPlotAndImageExport, ModelEntity, ParameterContainer, ParameterEntity, PrimitiveModelEntity, SelectionContainer, SelectionEntity, StudyContainer

public interface PhysicsFeature
extends ParameterEntity, StudyContainer, IPlotAndImageExport, EquationViewParent

Physics feature.

Method Summary

Modifier and Type	Method	Description
PhysicsFeature	create(java.lang.String tag, java.lang.String feature)	Creates a physics feature.
PhysicsFeature	create(java.lang.String tag, java.lang.String feature, int dim)	Creates a physics feature.
com.comsol.model.Diagram	diagram()	Returns the top-level diagram feature container, if any.
void	discardData()	Discard data.
PhysicsFeatureList	feature()	Returns the physics features.
PhysicsFeature	feature(java.lang.String tag)	Returns a physics feature.
java.lang.String	getType()	Gets the type identification.
void	importData()	Import data.
XDLocalSelection	selection()	Returns the selection.

Methods inherited from interface com.comsol.model.physics.EquationViewParent

featureInfo, featureInfo

Methods inherited from interface com.comsol.model.IPlotAndImageExport

image

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.ParameterContainer

commands, hasParam, param, params, runCommand

Methods inherited from interface com.comsol.model.ParameterEntity

getAllowedPropertyValues, getBoolean, getDblStringArray, getDouble, getDoubleArray, getDoubleMatrix, getExtraSelectionNames, getString, getStringArray, getStringMatrix, getValueType, hasProperty, properties, selection, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

create

PhysicsFeature create(java.lang.String tag,
                      java.lang.String feature)

Creates a physics feature.

Parameters:

tag - The feature tag.

feature - The feature type identifier.

Returns:

Created physics feature.

create

PhysicsFeature create(java.lang.String tag,
                      java.lang.String feature,
                      int dim)

Creates a physics feature.

Parameters:

tag - The feature tag.

feature - The feature type identifier.

dim - The geometric entity level to assign the feature to.

Returns:

Created physics feature.

diagram

com.comsol.model.Diagram diagram()

Returns the top-level diagram feature container, if any.

Returns:

An instance of Diagram or null if the physics feature doesn't want or doesn't support diagram visualization.

discardData

void discardData()

Discard data.

feature

PhysicsFeatureList feature()

Returns the physics features.

Returns:

Physics features.

feature

PhysicsFeature feature(java.lang.String tag)

Returns a physics feature.

Parameters:

tag - Physics feature tag.

Returns:

Physics feature.

getType

java.lang.String getType()

Gets the type identification.

Returns:

Type identifier.

importData

void importData()

Import data.

selection

XDLocalSelection selection()

Returns the selection.

Specified by:

selection in interface SelectionEntity

Returns:

Selection.