fixedTemperatureConstraint Class Reference

Fixed temperature equation constraint. More...

Inheritance diagram for fixedTemperatureConstraint:
Collaboration diagram for fixedTemperatureConstraint:

Public Types

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

Public Member Functions

 TypeName ("fixedTemperatureConstraint")
 Runtime type information. More...
 
 fixedTemperatureConstraint (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 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 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 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 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
 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 constraint to a field. 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< fvConstraint > New (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Fixed temperature equation constraint.

Usage
fixedTemperature
{
    type            fixedTemperatureConstraint;

    select          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 fvMesh &  mesh,
const dictionary &  dict 
)

Construct from components.

Definition at line 94 of file fixedTemperatureConstraint.C.

◆ fixedTemperatureConstraint() [2/2]

Disallow default bitwise copy construction.

◆ ~fixedTemperatureConstraint()

virtual ~fixedTemperatureConstraint ( )
inlinevirtual

Destructor.

Definition at line 146 of file fixedTemperatureConstraint.H.

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 115 of file fixedTemperatureConstraint.C.

References IOobject::groupName(), and thermo.

Here is the call 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 127 of file fixedTemperatureConstraint.C.

References cells, IOobject::groupName(), fvMatrix< Type >::setValues(), Foam::T(), and thermo.

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 195 of file fixedTemperatureConstraint.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)
virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 202 of file fixedTemperatureConstraint.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)
virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 211 of file fixedTemperatureConstraint.C.

◆ distribute()

void distribute ( const polyDistributionMap &  map)
virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 217 of file fixedTemperatureConstraint.C.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 226 of file fixedTemperatureConstraint.C.

References dict, and fvConstraint::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const fixedTemperatureConstraint &  )
delete

Disallow default bitwise assignment.

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: