Public Member Functions | List of all members
limitTemperature Class Reference

Limits the temperature to be between minimum and maximum values. More...

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

Public Member Functions

 TypeName ("limitTemperature")
 Runtime type information. More...
 
 limitTemperature (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 limitTemperature (const limitTemperature &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~limitTemperature ()
 Destructor. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
virtual bool constrain (volScalarField &he) const
 Constrain the energy field. 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 limitTemperature &)=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< 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraint > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Limits the temperature to be between minimum and maximum values.

Usage
Example usage: 
limitT
{
    type            limitTemperature;

    selectionMode   all;

    // field           T;   // Optional energy/temperature field name
                            // Set to T for compressibleInterFoam

    phase           gas; // Optional phase name

    min             200;
    max             500;
}
Source files

Definition at line 70 of file limitTemperature.H.

Constructor & Destructor Documentation

◆ limitTemperature() [1/2]

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

Construct from components.

Definition at line 61 of file limitTemperature.C.

◆ limitTemperature() [2/2]

limitTemperature ( const limitTemperature &  )
delete

Disallow default bitwise copy construction.

◆ ~limitTemperature()

virtual ~limitTemperature ( )
inlinevirtual

Destructor.

Definition at line 120 of file limitTemperature.H.

References limitTemperature::constrain(), limitTemperature::constrainedFields(), limitTemperature::distribute(), he(), limitTemperature::mapMesh(), limitTemperature::movePoints(), limitTemperature::operator=(), limitTemperature::read(), and limitTemperature::topoChange().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "limitTemperature"  )

Runtime type information.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 81 of file limitTemperature.C.

References IOobject::groupName(), basicThermo::he(), mesh, IOobject::name(), word::null, and thermo.

Referenced by limitTemperature::~limitTemperature().

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

◆ constrain()

bool constrain ( volScalarField &  he) const
virtual

Constrain the energy field.

Definition at line 100 of file limitTemperature.C.

References fvCellSet::all, GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), cells, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTemperature, fvPatchField< Type >::fixesValue(), forAll, IOobject::groupName(), basicThermo::he(), Foam::max(), mesh, Foam::min(), patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), List< T >::size(), and thermo.

Referenced by limitTemperature::~limitTemperature().

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

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 186 of file limitTemperature.C.

Referenced by limitTemperature::~limitTemperature().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)
virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 193 of file limitTemperature.C.

Referenced by limitTemperature::~limitTemperature().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)
virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 199 of file limitTemperature.C.

Referenced by limitTemperature::~limitTemperature().

Here is the caller graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap &  map)
virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 205 of file limitTemperature.C.

Referenced by limitTemperature::~limitTemperature().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 211 of file limitTemperature.C.

References fvConstraint::read().

Referenced by limitTemperature::~limitTemperature().

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

◆ operator=()

void operator= ( const limitTemperature &  )
delete

Disallow default bitwise assignment.

Referenced by limitTemperature::~limitTemperature().

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