com.comsol.model.physics

Interface Physics

All Superinterfaces:

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

public interface Physics
extends SelectionEntity, StudyContainer, IPlotAndImageExport, EquationViewParent

Physics interface.

Method Summary

Modifier and Type	Method and 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.
PhysicsFeatureList	feature() Returns the physics features.
PhysicsFeature	feature(java.lang.String tag) Returns a physics feature.
PhysicsFieldList	field() Returns list of physics fields.
PhysicsField	field(java.lang.String field) Returns a physics field.
java.lang.String	geom() Returns the tag of the geometry which the physics interface lives on.
java.lang.String	getType() Get the type identification.
boolean	groupBySpaceDimension() Whether to group nodes by space dimension.
java.lang.String	identifier() Deprecated. Use ModelEntity.tag() instead.
Physics	identifier(java.lang.String arg0) Deprecated. Use ModelEntity.tag(String) instead.
PhysicsPropList	prop() Returns the physics properties.
PhysicsProp	prop(java.lang.String propname) Returns a physics property.
void	setGroupBySpaceDimension(boolean groupBySpaceDimension) Sets whether to group nodes by space dimension.

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

Methods inherited from interface com.comsol.model.IPlotAndImageExport

image

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

featureInfo, featureInfo

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 interfaces doesn't want or doesn't support diagram visualization.

feature

PhysicsFeatureList feature()

Returns the physics features.

Returns:

Physics features.

feature

PhysicsFeature feature(java.lang.String tag)

Returns a physics feature.

Parameters:

tag - The feature tag.

Returns:

Physics feature.

field

PhysicsFieldList field()

Returns list of physics fields.

Returns:

List of physics fields.

field

PhysicsField field(java.lang.String field)

Returns a physics field.

Parameters:

field - Field name.

Returns:

Physics field.

geom

java.lang.String geom()

Returns the tag of the geometry which the physics interface lives on. Returns null for 0D physics interfaces.

Returns:

Geometry tag or null.

getType

java.lang.String getType()

Get the type identification.

Returns:

Type identifier.

groupBySpaceDimension

boolean groupBySpaceDimension()

Whether to group nodes by space dimension.

Returns:

Whether to group nodes by space dimension.

identifier

@Deprecated
java.lang.String identifier()

Deprecated. Use ModelEntity.tag() instead.

identifier

@Deprecated
Physics identifier(java.lang.String arg0)

Deprecated. Use ModelEntity.tag(String) instead.

prop

PhysicsPropList prop()

Returns the physics properties.

Returns:

List of physics properties.

prop

PhysicsProp prop(java.lang.String propname)

Returns a physics property.

Parameters:

propname - Property name.

Returns:

Physics property.

setGroupBySpaceDimension

void setGroupBySpaceDimension(boolean groupBySpaceDimension)

Sets whether to group nodes by space dimension.

Parameters:

groupBySpaceDimension - Whether to group nodes by space dimension.