fvConstraint Class Referenceabstract

Finite volume options abstract base class. More...

Inheritance diagram for fvConstraint:

Classes

class  iNew
 Return pointer to new fvConstraint object created. More...
 

Public Member Functions

 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< 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 wordList constrainedFields () const
 Return the list of constrained fields. 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...
 
virtual bool movePoints ()=0
 Update for mesh motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)=0
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)=0
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)=0
 Redistribute or update using the given distribution map. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 

Static Public Member Functions

static autoPtr< fvConstraintNew (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Finite volume options abstract base class.

Source files

Definition at line 56 of file fvConstraint.H.

Constructor & Destructor Documentation

◆ fvConstraint()

fvConstraint ( const word name,
const word constraintType,
const fvMesh mesh,
const dictionary dict 
)

Construct from components.

Definition at line 60 of file fvConstraint.C.

References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Foam::Info.

Here is the call graph for this function:

◆ ~fvConstraint()

~fvConstraint ( )
virtual

Destructor.

Definition at line 142 of file fvConstraint.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fvConstraint"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
fvConstraint  ,
dictionary  ,
(const word &name, const word &constraintType, const fvMesh &mesh, const dictionary &dict ,
(name, constraintType, mesh, dict  
)

◆ clone()

autoPtr<fvConstraint> clone ( ) const
inline

Return clone.

Definition at line 126 of file fvConstraint.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::fvConstraint > New ( const word name,
const fvMesh mesh,
const dictionary dict 
)
static

Return a reference to the selected fvConstraint.

Definition at line 81 of file fvConstraint.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::indent(), Foam::Info, Foam::libs, dictionary::lookup(), Foam::name(), Foam::nl, dlLibraryTable::open(), and string::remove().

Referenced by fvConstraints::fvConstraints(), and fvConstraint::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const
inline

Return const access to the source name.

Definition at line 28 of file fvConstraintI.H.

Referenced by fvConstraints::constrain(), and fvConstraints::read().

Here is the caller graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Return const access to the mesh database.

Definition at line 34 of file fvConstraintI.H.

Referenced by meanVelocityForce::meanVelocityForce(), and zeroDimensionalFixedPressureConstraint::zeroDimensionalFixedPressureConstraint().

Here is the caller graph for this function:

◆ coeffs()

const Foam::dictionary & coeffs ( ) const
inline

Return dictionary.

Definition at line 40 of file fvConstraintI.H.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of constrained fields.

Reimplemented in zeroDimensionalFixedPressureConstraint, meanVelocityForce, limitTemperature, limitPressure, limitMag, fixedValueConstraint, fixedTemperature, and bound.

Definition at line 148 of file fvConstraint.C.

References List< word >::null().

Here is the call graph for this function:

◆ constrainsField()

bool constrainsField ( const word fieldName) const
virtual

Return true if the given field is constrained.

Definition at line 154 of file fvConstraint.C.

References Foam::findIndex().

Referenced by fvConstraints::constrain().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FOR_ALL_FIELD_TYPES() [1/2]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_CONSTRAINT_CONSTRAIN  )

Apply a constraint to an equation.

◆ FOR_ALL_FIELD_TYPES() [2/2]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD  )

Apply constraint to a field.

◆ movePoints()

virtual bool movePoints ( )
pure virtual

◆ topoChange()

virtual void topoChange ( const polyTopoChangeMap )
pure virtual

◆ mapMesh()

virtual void mapMesh ( const polyMeshMap )
pure virtual

◆ distribute()

virtual void distribute ( const polyDistributionMap )
pure virtual

Redistribute or update using the given distribution map.

Implemented in zeroDimensionalFixedPressureConstraint, meanVelocityForce, limitTemperature, limitPressure, limitMag, fixedValueConstraint, fixedTemperature, and bound.

◆ read()


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