Public Member Functions | List of all members
fixedValueConstraint Class Reference

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

Inheritance diagram for fixedValueConstraint:
Inheritance graph
[legend]
Collaboration diagram for fixedValueConstraint:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fixedValue")
 Runtime type information. More...
 
 fixedValueConstraint (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 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 bool movePoints ()
 Update for mesh motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. 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 fvMesh &mesh, const dictionary &dict),(name, constraintType, mesh, dict))
 
 fvConstraint (const word &name, const word &constraintType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
autoPtr< fvConstraint > clone () const
 Return clone. More...
 
virtual ~fvConstraint ()
 Destructor. More...
 
const word & name () const
 Return const access to the source name. More...
 
const fvMesh & mesh () const
 Return const access to the mesh database. More...
 
const dictionary & coeffs (const dictionary &) const
 Return the coefficients sub-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 constraint to a field. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraint > New (const word &name, const fvMesh &mesh, const dictionary &dict)
 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;

    cellZone        porosity;

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

Definition at line 70 of file fixedValueConstraint.H.

Constructor & Destructor Documentation

◆ fixedValueConstraint()

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

Construct from components.

Definition at line 133 of file fixedValueConstraint.C.

References fvConstraint::coeffs(), and dict.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue"  )

Runtime type information.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 150 of file fixedValueConstraint.C.

◆ FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES ( DEFINE_FV_CONSTRAINT_CONSTRAIN  )

Add a constraint to an equation.

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 163 of file fixedValueConstraint.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)
virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 170 of file fixedValueConstraint.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)
virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 176 of file fixedValueConstraint.C.

◆ distribute()

void distribute ( const polyDistributionMap &  map)
virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 182 of file fixedValueConstraint.C.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read source dictionary.

Reimplemented from fvConstraint.

Definition at line 191 of file fixedValueConstraint.C.

References dict, and fvConstraint::read().

Here is the call graph for this function:
The documentation for this class was generated from the following files: