Package com.comsol.model

Interface Shape

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, SelectionContainer, SelectionEntity, StudyContainer

public interface Shape
extends SelectionEntity, StudyContainer

Shape function.

Method Summary

Modifier and Type	Method	Description
ShapeFeature	create(java.lang.String tag, java.lang.String sfname)	Creates shape feature and adds it to the list of children.
Shape	domainFlux(java.lang.String[][] domFlux, java.lang.String frameTag)	Sets expressions for the domain flux in a given frame.
java.lang.String	downFlux()	Returns the name of the down flux variable (an empty string if the variable name has not been set.).
Shape	downFlux(java.lang.String fluxName)	Sets the name of the down flux variable.
java.lang.String	elementset()	Deprecated. Use elementSet() instead.
Shape	elementset(java.lang.String arg0)	Deprecated. Use elementSet(String) instead.
java.lang.String	elementSet()	Returns the element set condition associated with the shape function.
Shape	elementSet(java.lang.String expr)	Sets the mesh element set condition to the given string.
ShapeFeatureList	feature()	Return all shape features of the shape function.
ShapeFeature	feature(java.lang.String tag)	Returns a shape feature with given tag.
java.lang.String[]	fieldvariable()	Deprecated. Use fieldVariable() instead.
java.lang.String[]	fieldVariable()	Returns the field variables associate with the shape function.
java.lang.String	frame()	Return the frame associated with the shape function.
Shape	frame(java.lang.String frameTag)	Sets the frame of the shape feature.
XDLocalSelection	selection()	Returns the shape function's selection.
LocalSelection	slits()	Return slit selection.
boolean	smoothBoundaryFlux()	Returns whether smoothing is applied in the computation of boundary flux.
Shape	smoothBoundaryFlux(boolean smooth)	Sets whether smoothing is applied in the computation of boundary flux.
java.lang.String	upFlux()	Returns the name of the up flux variable (an empty string if the variable name has not been set.).
Shape	upFlux(java.lang.String fluxName)	Sets the name of the up flux variables.
java.lang.String	valuetype()	Returns the value type of the shape function.
Shape	valuetype(java.lang.String type)	Sets the value type of the shape function.

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

create

ShapeFeature create(java.lang.String tag,
                    java.lang.String sfname)

Creates shape feature and adds it to the list of children.

Parameters:

tag - Shape function feature tag.

sfname - Shape function type: shape function name or a shape function with arguments.

Returns:

Created shape feature.

domainFlux

Shape domainFlux(java.lang.String[][] domFlux,
                 java.lang.String frameTag)

Sets expressions for the domain flux in a given frame. This is required to make the boundary flux variables produce accurate results. Only Lagrange shape functions support boundary flux variables.

Parameters:

domFlux - Matrix of boundary flux expressions.

frameTag - Frame tag.

Returns:

Shape function.

downFlux

java.lang.String downFlux()

Returns the name of the down flux variable (an empty string if the variable name has not been set.).

Returns:

Name of down flux variable.

downFlux

Shape downFlux(java.lang.String fluxName)

Sets the name of the down flux variable.

Parameters:

fluxName - Name of down flux variable.

Returns:

Shape function.

elementSet

java.lang.String elementSet()

Returns the element set condition associated with the shape function.

Returns:

Element set tag.

elementSet

Shape elementSet(java.lang.String expr)

Sets the mesh element set condition to the given string.

Parameters:

expr - Element set condition.

Returns:

Element set condition.

elementset

@Deprecated
java.lang.String elementset()

Deprecated.

Use elementSet() instead.

elementset

@Deprecated
Shape elementset(java.lang.String arg0)

Deprecated.

Use elementSet(String) instead.

feature

ShapeFeatureList feature()

Return all shape features of the shape function.

Returns:

List of shape features.

feature

ShapeFeature feature(java.lang.String tag)

Returns a shape feature with given tag.

Parameters:

tag - Shape feature tag.

Returns:

Shape feature.

fieldVariable

java.lang.String[] fieldVariable()

Returns the field variables associate with the shape function.

Returns:

Field variable tags.

fieldvariable

@Deprecated
java.lang.String[] fieldvariable()

Deprecated.

Use fieldVariable() instead.

frame

java.lang.String frame()

Return the frame associated with the shape function.

Returns:

Frame tag.

frame

Shape frame(java.lang.String frameTag)

Sets the frame of the shape feature.

Parameters:

frameTag - Frame tag.

Returns:

Shape function.

selection

XDLocalSelection selection()

Returns the shape function's selection.

Specified by:

selection in interface SelectionEntity

Returns:

Selection.

slits

LocalSelection slits()

Return slit selection.

Returns:

Selection.

smoothBoundaryFlux

boolean smoothBoundaryFlux()

Returns whether smoothing is applied in the computation of boundary flux.

Returns:

Whether smoothing is applied in the computation of boundary flux.

smoothBoundaryFlux

Shape smoothBoundaryFlux(boolean smooth)

Sets whether smoothing is applied in the computation of boundary flux.

Parameters:

smooth - Whether smoothing should be applied.

Returns:

Shape function.

upFlux

java.lang.String upFlux()

Returns the name of the up flux variable (an empty string if the variable name has not been set.).

Returns:

Name of up flux variable.

upFlux

Shape upFlux(java.lang.String fluxName)

Sets the name of the up flux variables.

Parameters:

fluxName - Name of up flux variable.

Returns:

Shape function.

valuetype

java.lang.String valuetype()

Returns the value type of the shape function.

Returns:

Value type.

valuetype

Shape valuetype(java.lang.String type)

Sets the value type of the shape function.

Parameters:

type - Value type.

Returns:

Shape function.