Classes | Public Member Functions | Static Public Member Functions | List of all members
fvConstraint Class Referenceabstract

Finite volume options abstract base class. More...

Inheritance diagram for fvConstraint:
Inheritance graph
[legend]

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 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< 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
 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< fvConstraint > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 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 dictionary &  dict,
const fvMesh &  mesh 
)

Construct from components.

Definition at line 61 of file fvConstraint.C.

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

Here is the call graph for this function:

◆ ~fvConstraint()

~fvConstraint ( )
virtual

Destructor.

Definition at line 119 of file fvConstraint.C.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "fvConstraint"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone()

autoPtr<fvConstraint> clone ( ) const
inline

Return clone.

Definition at line 126 of file fvConstraint.H.

References fvConstraint::iNew::iNew(), and NotImplemented.

Here is the call graph for this function:

◆ New()

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

Return a reference to the selected fvConstraint.

Definition at line 82 of file fvConstraint.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::indent(), Foam::Info, Foam::libs, dictionary::lookup(), mesh, Foam::name(), Foam::nl, and dlLibraryTable::open().

Referenced by fvConstraint::fvConstraint(), 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(), fvConstraint::iNew::operator()(), 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 fvConstraint::iNew::operator()().

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.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of constrained fields.

Reimplemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, and limitPressure.

Definition at line 125 of file fvConstraint.C.

References List< T >::null().

Referenced by fvConstraint::iNew::operator()().

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

◆ constrainsField()

bool constrainsField ( const word &  fieldName) const
virtual

Return true if the given field is constrained.

Definition at line 131 of file fvConstraint.C.

References Foam::findIndex(), Foam::FOR_ALL_FIELD_TYPES(), IMPLEMENT_FV_CONSTRAINT_CONSTRAIN, and IMPLEMENT_FV_CONSTRAINT_CONSTRAIN_FIELD.

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

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.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ 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

Update for mesh motion.

Implemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, and limitPressure.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ topoChange()

virtual void topoChange ( const polyTopoChangeMap &  )
pure virtual

Update topology using the given map.

Implemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, and limitPressure.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ mapMesh()

virtual void mapMesh ( const polyMeshMap &  )
pure virtual

Update from another mesh using the given map.

Implemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, and limitPressure.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ distribute()

virtual void distribute ( const polyDistributionMap &  )
pure virtual

Redistribute or update using the given distribution map.

Implemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, and limitPressure.

Referenced by fvConstraint::iNew::operator()().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read source dictionary.

Reimplemented in fixedTemperatureConstraint, meanVelocityForce, limitTemperature, fixedValueConstraint, limitMag, limitPressure, and patchMeanVelocityForce.

Definition at line 143 of file fvConstraint.C.

References dictionary::optionalSubDict().

Referenced by fvConstraint::iNew::operator()(), limitPressure::read(), fixedValueConstraint::read(), limitMag::read(), limitTemperature::read(), fvConstraints::read(), meanVelocityForce::read(), and fixedTemperatureConstraint::read().

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