public interface Field extends ModelEntity
Modifier and Type | Method and Description |
---|---|
java.lang.String |
field()
Returns the field name as a string.
|
Field |
field(java.lang.String fname)
Sets the field name.
|
java.lang.String |
fieldname()
Deprecated.
Use
field() instead. |
Field |
fieldname(java.lang.String arg0)
Deprecated.
Use
field(String) instead. |
java.lang.String |
geom()
Returns the geometry associated with the field.
|
java.lang.String[] |
shape()
Returns the shape functions as a string vector.
|
Field |
shape(java.lang.String[] shlist)
Sets the shape functions defining the field variables.
|
java.lang.String |
type()
Returns the type of field, which can be
normal ,
control , discrete , or
quadrature .The control type is used to
mark a field as intended only for use by the optimization and
sensitivity solvers. |
Field |
type(java.lang.String shlist)
Sets the type of field, which can be
normal ,
control , discrete , or
quadrature .The control type is used to
mark a field as intended only for use by the optimization and
sensitivity solvers. |
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
getContainer, getDisplayString
java.lang.String field()
Field field(java.lang.String fname)
fname
- Field name.@Deprecated java.lang.String fieldname()
field()
instead.@Deprecated Field fieldname(java.lang.String arg0)
field(String)
instead.java.lang.String geom()
java.lang.String[] shape()
Field shape(java.lang.String[] shlist)
shlist
- List of shape function tags.java.lang.String type()
normal
,
control
, discrete
, or
quadrature
.control
type is used to
mark a field as intended only for use by the optimization and
sensitivity solvers. A control variable field should never actually
be solved for by the basic solvers, while an optimization solver will
modify them in its outer loop.discrete
and
quadrature
types are not yet used by fields.Field type(java.lang.String shlist)
normal
,
control
, discrete
, or
quadrature
.control
type is used to
mark a field as intended only for use by the optimization and
sensitivity solvers. A control variable field should never actually
be solved for by the basic solvers, while an optimization solver will
modify them in its outer loop.discrete
and
quadrature
types are not yet used by fields.shlist
- List of shape function tags.