fixedTemperatureConstraint Class Reference

Fixed temperature equation constraint. More...

Inheritance diagram for fixedTemperatureConstraint:
Collaboration diagram for fixedTemperatureConstraint:

Public Types

enum  temperatureMode { uniform, lookup }
 Temperature mode. More...
 

Public Member Functions

 TypeName ("fixedTemperatureConstraint")
 Runtime type information. More...
 
 fixedTemperatureConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 fixedTemperatureConstraint (const fixedTemperatureConstraint &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fixedTemperatureConstraint ()
 Destructor. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
virtual bool constrain (fvMatrix< scalar > &eqn, const word &fieldName) const
 Constrain energy equation to fix the temperature. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for mesh changes. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const fixedTemperatureConstraint &)=delete
 Disallow default bitwise assignment. 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...
 

Static Public Attributes

static const NamedEnum< temperatureMode, 2 > modeNames_
 String representation of mode enums. 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

Fixed temperature equation constraint.

Usage
fixedTemperature
{
    type            fixedTemperatureConstraint;

    selectionMode   all;

    phase           gas; // Optional phase name

    // Uniform temperature constraint
    mode            uniform;
    temperature     constant 500; // Uniform temperature

    // // Looked-up field temperature constraint
    // T            T; // Temperature field name
}
Note
The 'uniform' option allows the use of a time-varying uniform temperature by means of the Function1 type.
Source files

Definition at line 76 of file fixedTemperatureConstraint.H.

Member Enumeration Documentation

◆ temperatureMode

enum temperatureMode
strong

Temperature mode.

Enumerator
uniform 
lookup 

Definition at line 83 of file fixedTemperatureConstraint.H.

Constructor & Destructor Documentation

◆ fixedTemperatureConstraint() [1/2]

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

Construct from components.

Definition at line 90 of file fixedTemperatureConstraint.C.

◆ fixedTemperatureConstraint() [2/2]

Disallow default bitwise copy construction.

◆ ~fixedTemperatureConstraint()

Member Function Documentation

◆ TypeName()

TypeName ( "fixedTemperatureConstraint"  )

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 fixedTemperatureConstraint.C.

References fixedTemperatureConstraint::constrain(), basicThermo::dictName, IOobject::groupName(), basicThermo::he(), mesh, IOobject::name(), and thermo.

Referenced by fixedTemperatureConstraint::~fixedTemperatureConstraint().

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

◆ constrain()

bool constrain ( fvMatrix< scalar > &  eqn,
const word fieldName 
) const
virtual

Constrain energy equation to fix the temperature.

Definition at line 123 of file fixedTemperatureConstraint.C.

References cells, basicThermo::dictName, IOobject::groupName(), basicThermo::he(), lookup(), mesh, fvMatrix< Type >::setValues(), List< T >::size(), Foam::T(), and thermo.

Referenced by fixedTemperatureConstraint::constrainedFields(), and fixedTemperatureConstraint::~fixedTemperatureConstraint().

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

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for mesh changes.

Reimplemented from fvConstraint.

Definition at line 159 of file fixedTemperatureConstraint.C.

Referenced by fixedTemperatureConstraint::~fixedTemperatureConstraint().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 165 of file fixedTemperatureConstraint.C.

References fvConstraint::read().

Referenced by fixedTemperatureConstraint::~fixedTemperatureConstraint().

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

◆ operator=()

void operator= ( const fixedTemperatureConstraint )
delete

Disallow default bitwise assignment.

Referenced by fixedTemperatureConstraint::~fixedTemperatureConstraint().

Here is the caller graph for this function:

Member Data Documentation

◆ modeNames_

String representation of mode enums.

Definition at line 90 of file fixedTemperatureConstraint.H.


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