Package com.comsol.model

Interface Field

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

public interface Field
extends ModelEntity

Field.

Method Summary

Modifier and Type	Method	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.

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

field

java.lang.String field()

Returns the field name as a string.

Returns:

Field name.

field

Field field(java.lang.String fname)

Sets the field name.

Parameters:

fname - Field name.

Returns:

Field.

fieldname

@Deprecated
java.lang.String fieldname()

Deprecated.

Use field() instead.

fieldname

@Deprecated
Field fieldname(java.lang.String arg0)

Deprecated.

Use field(String) instead.

geom

java.lang.String geom()

Returns the geometry associated with the field.

Returns:

Geometry tag.

shape

java.lang.String[] shape()

Returns the shape functions as a string vector.

Returns:

Shape function tags.

shape

Field shape(java.lang.String[] shlist)

Sets the shape functions defining the field variables.

Parameters:

shlist - List of shape function tags.

Returns:

Field.

type

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. 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.
The discrete and quadrature types are not yet used by fields.
.

Returns:

Field type.

type

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. 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.
The discrete and quadrature types are not yet used by fields.
.

Parameters:

shlist - List of shape function tags.

Returns:

Field.