All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fixedValueConstraint Class Reference

Constrain the field values within a specified region. More...

Inheritance diagram for fixedValueConstraint:
Collaboration diagram for fixedValueConstraint:

Public Member Functions

 TypeName ("fixedValueConstraint")
 Runtime type information. More...
 
 fixedValueConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN)
 Add a constraint to an equation. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for mesh changes. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from fvConstraint
 TypeName ("fvConstraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvConstraint, dictionary,(const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh),(name, constraintType, dict, mesh))
 
 fvConstraint (const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< fvConstraintclone () const
 Return clone. More...
 
virtual ~fvConstraint ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () const
 Return dictionary. More...
 
virtual bool constrainsField (const word &fieldName) const
 Return true if the given field is constrained. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN)
 Apply a constraint to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD)
 Apply contraint to a field. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraintNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Constrain the field values within a specified region.

Usage
For example to set the turbulence properties within a porous region:
porosityTurbulence
{
    type            fixedValueConstraint;

    selectionMode   cellZone;
    cellZone        porosity;

    fieldValues
    {
        k           1;
        epsilon     150;
    }
}
Source files

Definition at line 71 of file fixedValueConstraint.H.

Constructor & Destructor Documentation

◆ fixedValueConstraint()

fixedValueConstraint ( const word name,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 94 of file fixedValueConstraint.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValueConstraint"  )

Runtime type information.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 110 of file fixedValueConstraint.C.

References FOR_ALL_FIELD_TYPES(), and IMPLEMENT_FV_CONSTRAINT_CONSTRAIN.

Here is the call graph for this function:

◆ FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES ( DEFINE_FV_CONSTRAINT_CONSTRAIN  )

Add a constraint to an equation.

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for mesh changes.

Reimplemented from fvConstraint.

Definition at line 123 of file fixedValueConstraint.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read source dictionary.

Reimplemented from fvConstraint.

Definition at line 129 of file fixedValueConstraint.C.

References fvConstraint::read().

Here is the call graph for this function:

The documentation for this class was generated from the following files: