Package com.comsol.model

Interface ModelNode

All Superinterfaces:

AbstractModel, ModelEntity, PrimitiveModelEntity

public interface ModelNode
extends AbstractModel

Model node.

Method Summary

Modifier and Type	Method	Description
ModelNode	basesystem(java.lang.String arg0)	Deprecated. Use baseSystem(String) instead.
ModelNode	baseSystem(java.lang.String name)	Sets the base unit system.
ComponentCoordsysList	coordSystem()	Returns all coordinate systems for this component.
ComponentCplList	cpl()	Returns all component couplings for this component.
boolean	curvedInterior()	Returns true if curved interior mesh is activated on the model node.
ModelNode	curvedInterior(boolean curvedInterior)	Sets the curved interior mesh setting on the model node.
boolean	defineAllFrames()	Returns true if all frames are always defined.
ModelNode	defineAllFrames(boolean define)	Set whether all frames should always be defined.
boolean	defineLocalCoord()	Returns true if local coordinate variables (xi1, xi2, xi3) will be defined.
ModelNode	defineLocalCoord(boolean define)	Set a flag that determines whether local coordinate variables (xi1, xi2, xi3, also known as barycentric coordinates) will be defined in each mesh element.
ComponentExtraDimList	extraDim()	Returns all extra dimension features for this component.
ComponentFunctionFeatureList	func()	Returns all functions for this component.
ComponentGeomList	geom()	Returns all geometry sequences for this component.
java.lang.String	geometricModel()	Get the geometric model used in the component.
void	geometricModel(java.lang.String sequenceTag)	Specify the geometric model used in the component.
java.lang.String[]	geometryCoord()	Returns names of geometry frame coordinates.
ModelNode	geometryCoord(java.lang.String[] coord)	Sets names of geometry frame coordinates.
java.lang.String	getType()	Get the type identifier of this component.
java.lang.String	identifier()	Deprecated. Returns the node's identifier.
ModelNode	identifier(java.lang.String arg0)	Deprecated. Sets the node's identifier.
ComponentProbeFeatureList	massProp()	Returns all mass properties for this component.
ComponentMaterialList	material()	Returns all materials for this component.
java.lang.String[]	materialCoord()	Returns names of material frame coordinates.
ModelNode	materialCoord(java.lang.String[] coord)	Sets names of material frame coordinates.
ComponentMeshList	mesh()	Returns all meshing sequences for this component.
java.lang.String[]	meshCoord()	Returns names of mesh frame coordinates.
ModelNode	meshCoord(java.lang.String[] coord)	Sets names of mesh frame coordinates.
ComponentMultiphysicsCouplingList	multiphysics()	Returns all multiphysics couplings for this component.
ComponentPairList	pair()	Returns all pairs for this component.
ComponentPhysicsList	physics()	Returns all physics interfaces for this component.
ComponentProbeFeatureList	probe()	Returns all probes for this component.
ComponentSelectionList	selection()	Returns all named selections for this component.
java.lang.String	sorder()	Returns the geometry shape order used for the model node and its descendants.
ModelNode	sorder(java.lang.String sorder)	Sets the geometry shape order used for the model node and its descendants.
java.lang.String[]	spatialCoord()	Returns names of spatial frame coordinates.
ModelNode	spatialCoord(java.lang.String[] coord)	Sets names of spatial frame coordinates.
ComponentExprList	variable()	Returns all variable collections for this component.
ComponentViewList	view()	Returns all views for this component.

Methods inherited from interface com.comsol.model.AbstractModel

basesystem, baseSystem, common, common, coordSystem, cpl, extraDim, func, geom, groupByType, massProp, material, mesh, multiphysics, pair, physics, probe, selection, setGroupByType, variable, view

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

baseSystem

ModelNode baseSystem(java.lang.String name)

Sets the base unit system.

Specified by:

baseSystem in interface AbstractModel

Parameters:

name - Name of base unit system: : SI, bft, cgs,mpa, emu, esu, fps, ips, or psi.

Returns:

Modified model.

basesystem

@Deprecated
ModelNode basesystem(java.lang.String arg0)

Deprecated.

Use baseSystem(String) instead.

Specified by:

basesystem in interface AbstractModel

coordSystem

ComponentCoordsysList coordSystem()

Returns all coordinate systems for this component.

Specified by:

coordSystem in interface AbstractModel

Returns:

List of coordinate systems.

cpl

ComponentCplList cpl()

Returns all component couplings for this component.

Specified by:

cpl in interface AbstractModel

Returns:

List of component couplings.

curvedInterior

boolean curvedInterior()

Returns true if curved interior mesh is activated on the model node.

Returns:

Curved interior mesh setting.

curvedInterior

ModelNode curvedInterior(boolean curvedInterior)

Sets the curved interior mesh setting on the model node. If true, the interior domain mesh elements can be curved, to avoid inverted elements.

Parameters:

curvedInterior - Curved interior mesh setting.

Returns:

Model node.

defineAllFrames

boolean defineAllFrames()

Returns true if all frames are always defined.

Returns:

True if all frames are always defined.

defineAllFrames

ModelNode defineAllFrames(boolean define)

Set whether all frames should always be defined.

Parameters:

define - Flag.

Returns:

Model node.

defineLocalCoord

boolean defineLocalCoord()

Returns true if local coordinate variables (xi1, xi2, xi3) will be defined.

Returns:

True if local coordinates variables exist.

defineLocalCoord

ModelNode defineLocalCoord(boolean define)

Set a flag that determines whether local coordinate variables (xi1, xi2, xi3, also known as barycentric coordinates) will be defined in each mesh element.

Parameters:

define - Flag.

Returns:

Model node.

extraDim

ComponentExtraDimList extraDim()

Returns all extra dimension features for this component.

Specified by:

extraDim in interface AbstractModel

Returns:

List of extra dimension features.

func

ComponentFunctionFeatureList func()

Returns all functions for this component.

Specified by:

func in interface AbstractModel

Returns:

List of functions.

geom

ComponentGeomList geom()

Returns all geometry sequences for this component.

Specified by:

geom in interface AbstractModel

Returns:

List of geometry sequences.

geometricModel

java.lang.String geometricModel()

Get the geometric model used in the component.

Returns:

The tag of the geometry or meshing sequence that defines the geometric model of the component. The tag is prefixed with geom/ or mesh/ to indicate if it is a geometry or mesh.

geometricModel

void geometricModel(java.lang.String sequenceTag)

Specify the geometric model used in the component.

Parameters:

sequenceTag - Tag of the geometry or meshing sequence that should define the geometric model of the component. Use the prefix geom/ or mesh/ (e.g. "geom/geom1") if the tag only is ambiguous.

geometryCoord

java.lang.String[] geometryCoord()

Returns names of geometry frame coordinates.

Returns:

Names of geometry frame coordinates.

geometryCoord

ModelNode geometryCoord(java.lang.String[] coord)

Sets names of geometry frame coordinates.

Parameters:

coord - Geometry frame coordinate names.

Returns:

Model node.

getType

java.lang.String getType()

Get the type identifier of this component.

Returns:

Type identifier.

identifier

@Deprecated
java.lang.String identifier()

Deprecated.

Returns the node's identifier. @deprecated Use ModelEntity.tag() instead.

identifier

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

Deprecated.

Sets the node's identifier. @deprecated Use ModelEntity.tag(String) instead.

massProp

ComponentProbeFeatureList massProp()

Returns all mass properties for this component.

Specified by:

massProp in interface AbstractModel

Returns:

List of mass properties.

material

ComponentMaterialList material()

Returns all materials for this component.

Specified by:

material in interface AbstractModel

Returns:

List of materials.

materialCoord

java.lang.String[] materialCoord()

Returns names of material frame coordinates.

Returns:

Names of material frame coordinates.

materialCoord

ModelNode materialCoord(java.lang.String[] coord)

Sets names of material frame coordinates.

Parameters:

coord - Material frame coordinate names.

Returns:

Model node.

mesh

ComponentMeshList mesh()

Returns all meshing sequences for this component.

Specified by:

mesh in interface AbstractModel

Returns:

List of meshing sequences.

meshCoord

java.lang.String[] meshCoord()

Returns names of mesh frame coordinates.

Returns:

Names of mesh frame coordinates.

meshCoord

ModelNode meshCoord(java.lang.String[] coord)

Sets names of mesh frame coordinates.

Parameters:

coord - Mesh frame coordinate names.

Returns:

Model node.

multiphysics

ComponentMultiphysicsCouplingList multiphysics()

Returns all multiphysics couplings for this component.

Specified by:

multiphysics in interface AbstractModel

Returns:

List of multiphysics couplings.

pair

ComponentPairList pair()

Returns all pairs for this component.

Specified by:

pair in interface AbstractModel

Returns:

List of pairs.

physics

ComponentPhysicsList physics()

Returns all physics interfaces for this component.

Specified by:

physics in interface AbstractModel

Returns:

List of physics interfaces.

probe

ComponentProbeFeatureList probe()

Returns all probes for this component.

Specified by:

probe in interface AbstractModel

Returns:

List of probes.

selection

ComponentSelectionList selection()

Returns all named selections for this component.

Specified by:

selection in interface AbstractModel

Returns:

List of named selections.

sorder

java.lang.String sorder()

Returns the geometry shape order used for the model node and its descendants.

Returns:

Geometry shape order.

sorder

ModelNode sorder(java.lang.String sorder)

Sets the geometry shape order used for the model node and its descendants.

Parameters:

sorder - Geometry shape order.

Returns:

Model node.

spatialCoord

java.lang.String[] spatialCoord()

Returns names of spatial frame coordinates.

Returns:

Names of spatial frame coordinates.

spatialCoord

ModelNode spatialCoord(java.lang.String[] coord)

Sets names of spatial frame coordinates.

Parameters:

coord - Spatial frame coordinate names.

Returns:

Model node.

variable

ComponentExprList variable()

Returns all variable collections for this component.

Specified by:

variable in interface AbstractModel

Returns:

List of variable collections.

view

ComponentViewList view()

Returns all views for this component.

Specified by:

view in interface AbstractModel

Returns:

List of views.