Package com.comsol.model

Interface Frame

All Superinterfaces:

EquationViewParent, ModelEntity, PrimitiveModelEntity

public interface Frame
extends ModelEntity, EquationViewParent

Frame.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	coord()	Returns coordinate names.
Frame	coord(int pos, java.lang.String coord)	Set the coordinate name in position pos.
Frame	coord(java.lang.String[] coordlist)	Sets the coordinate names.
java.lang.String	geom()	Returns the geometry.
Frame	geom(java.lang.String gtag)	Sets the geometry.
Frame	geometryFrame()	Sets this frame to be the geometry frame.
java.lang.String	identifier()	Returns the frame's identifier.
java.lang.String[]	inPlaneCoord()	Get the in-plane components of the coordinate vector, that is, the coordinate names for the geometry's dimension.
boolean	isGeometryFrame()	Checks if the frame is the geometry frame.
boolean	ismaterialframe()	Deprecated. Use isMaterialFrame() instead.
boolean	isMaterialFrame()	Checks if the frame is the material frame.
boolean	ismeshframe()	Deprecated. Use isGeometryFrame() instead.
boolean	isMeshFrame()	Checks if the frame is the mesh frame.
boolean	isspatialframe()	Deprecated. Use isSpatialFrame() instead.
boolean	isSpatialFrame()	Checks if the frame is the spatial frame.
Frame	materialframe()	Deprecated. Use materialFrame() instead.
Frame	materialFrame()	Sets the frame to be the material frame.
Frame	meshframe()	Deprecated. Use meshFrame() instead.
Frame	meshFrame()	Sets the frame to be the mesh frame.
int	sorder()	Returns the geometry shape order.
Frame	sorder(int arg0)	Deprecated. Deprecated: use ModelNode.sorder(String) instead.
Frame	spatialframe()	Deprecated. Use spatialFrame() instead.
Frame	spatialFrame()	Sets the frame to be the spatial frame.
FrameFeatureList	sshape()	Returns all frame features.
FrameFeature	sshape(java.lang.String tag)	Returns a frame feature.
java.lang.String	varNameSuffix()	Returns the variable name suffix of the frame.

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

featureInfo, featureInfo

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, resolveModelPath

Method Detail

coord

java.lang.String[] coord()

Returns coordinate names. The length of the coordinate vector is always 3.

Returns:

List of coordinate names.

coord

Frame coord(java.lang.String[] coordlist)

Sets the coordinate names. The length of the coordinate vector is always 3.

Parameters:

coordlist - List of coordinate names.

Returns:

Frame.

coord

Frame coord(int pos,
            java.lang.String coord)

Set the coordinate name in position pos. The length of the coordinate vector is always 3.

Parameters:

pos - Position index.

coord - Coordinate name.

Returns:

Frame.

geom

java.lang.String geom()

Returns the geometry.

Returns:

Geometry sequence tag.

geom

Frame geom(java.lang.String gtag)

Sets the geometry.

Parameters:

gtag - Geometry sequence tag.

Returns:

Frame.

geometryFrame

Frame geometryFrame()

Sets this frame to be the geometry frame.

Returns:

Frame.

identifier

java.lang.String identifier()

Returns the frame's identifier.

Returns:

Frame identifier.

inPlaneCoord

java.lang.String[] inPlaneCoord()

Get the in-plane components of the coordinate vector, that is, the coordinate names for the geometry's dimension.

Returns:

Coordinate vector.

isGeometryFrame

boolean isGeometryFrame()

Checks if the frame is the geometry frame.

Returns:

true if geometry frame.

isMaterialFrame

boolean isMaterialFrame()

Checks if the frame is the material frame.

Returns:

true if material frame.

isMeshFrame

boolean isMeshFrame()

Checks if the frame is the mesh frame.

Returns:

true if mesh frame.

isSpatialFrame

boolean isSpatialFrame()

Checks if the frame is the spatial frame.

Returns:

true if spatial frame.

ismaterialframe

@Deprecated
boolean ismaterialframe()

Deprecated.

Use isMaterialFrame() instead.

ismeshframe

@Deprecated
boolean ismeshframe()

Deprecated.

Use isGeometryFrame() instead.

isspatialframe

@Deprecated
boolean isspatialframe()

Deprecated.

Use isSpatialFrame() instead.

materialFrame

Frame materialFrame()

Sets the frame to be the material frame.

Returns:

Frame.

materialframe

@Deprecated
Frame materialframe()

Deprecated.

Use materialFrame() instead.

meshFrame

Frame meshFrame()

Sets the frame to be the mesh frame.

Returns:

Frame.

meshframe

@Deprecated
Frame meshframe()

Deprecated.

Use meshFrame() instead.

sorder

int sorder()

Returns the geometry shape order.

Returns:

Geometry shape order.

sorder

@Deprecated
Frame sorder(int arg0)

Deprecated.

Deprecated: use ModelNode.sorder(String) instead.

spatialFrame

Frame spatialFrame()

Sets the frame to be the spatial frame.

Returns:

Frame.

spatialframe

@Deprecated
Frame spatialframe()

Deprecated.

Use spatialFrame() instead.

sshape

FrameFeatureList sshape()

Returns all frame features.

Returns:

List of frame features.

sshape

FrameFeature sshape(java.lang.String tag)

Returns a frame feature.

Parameters:

tag - Frame feature tag.

Returns:

Frame feature.

varNameSuffix

java.lang.String varNameSuffix()

Returns the variable name suffix of the frame.

Returns:

Variable name suffix.