AuxiliaryField

class AuxiliaryField : public godzilla::Object, public godzilla::PrintInterface

Base class for auxiliary fields.

Subclassed by godzilla::ConstantAuxiliaryField, godzilla::FunctionAuxiliaryField

Public Functions

virtual void create() override

Called to construct the object.

Int get_dimension() const

Get the spatial dimension of the problem this field is part of.

Returns:

Spatial dimension of the problem

Int get_block_id() const

Get block ID this field is defined on.

Returns:

Block ID

const Label &get_label() const

Get the Label this field is defined on.

Returns:

Reference to a Label

const std::string &get_region() const

Get the region name this field is defined on.

Returns:

The region name

Int get_field_id() const

Get the ID of the field this boundary condition operates on.

Returns:

ID of the field

const std::string &get_field() const

Get field name.

Returns:

The field name

virtual Int get_num_components() const = 0

Get the number of constrained components.

Returns:

The number of constrained components