limitTemperature Class Reference

Corrects temperature field (i.e. T) within a specified region by applying limits between a given minimum and maximum. More...

Inheritance diagram for limitTemperature:
[legend]
Collaboration diagram for limitTemperature:
[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
 No copy construct. More...
 
void operator= (const limitTemperature &)=delete
 No copy assignment. More...
 
virtual ~limitTemperature ()=default
 Destructor. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
virtual void correct (volScalarField &he)
 Correct the energy field. More...
 
- Public Member Functions inherited from cellSetOption
 TypeName ("cellSetOption")
 Runtime type information. More...
 
 cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual ~cellSetOption ()=default
 Destructor. More...
 
scalar timeStart () const
 Return const access to the time start. More...
 
scalar duration () const
 Return const access to the duration. More...
 
bool inTimeLimits (const scalar time) const
 Return true if within time limits. More...
 
const selectionModeTypeselectionMode () const
 Return const access to the cell selection mode. More...
 
const wordcellSetName () const
 Return const access to the name of cell set for "cellSet". More...
 
scalar V () const
 Return const access to the total cell volume. More...
 
const labelListcells () const
 Return const access to the cell set. More...
 
scalar & timeStart ()
 Return access to the time start. More...
 
scalar & duration ()
 Return access to the duration. More...
 
virtual bool isActive ()
 Is the source active? More...
 
- Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()=default
 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...
 
bool active () const
 Return const access to the source active flag. More...
 
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi. More...
 
Switchactive ()
 Return access to the source active flag. More...
 
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list. More...
 
virtual void checkApplied () const
 Check that the source has been applied. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (volVectorField &field)
 
virtual void correct (volSphericalTensorField &field)
 
virtual void correct (volSymmTensorField &field)
 
virtual void correct (volTensorField &field)
 
virtual void postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. More...
 

Protected Attributes

scalar Tmin_
 Minimum temperature limit [K]. More...
 
scalar Tmax_
 Maximum temperature limit [K]. More...
 
word phase_
 Optional phase name [K]. More...
 
- Protected Attributes inherited from cellSetOption
scalar timeStart_
 Start time of fvOption. More...
 
scalar duration_
 Duration of fvOption execution starting from timeStart. More...
 
selectionModeType selectionMode_
 Cell selection mode. More...
 
word cellSetName_
 Name of set/zone for "cellSet" and "cellZone" selectionMode. More...
 
List< pointpoints_
 List of points for "points" selectionMode. More...
 
labelList cells_
 Set of cells to apply source to. More...
 
scalar V_
 Sum of cell volumes. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
Switch active_
 Source active flag. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< boolapplied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 

Additional Inherited Members

- Public Types inherited from cellSetOption
enum  selectionModeType { smPoints, smCellSet, smCellZone, smAll }
 Enumeration for selection mode types. More...
 
- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Public Attributes inherited from option
bool log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeTypeselectionModeTypeNames_
 List of selection mode type names. More...
 
- Protected Member Functions inherited from cellSetOption
void setSelection (const dictionary &dict)
 Set the cellSet or points selection. More...
 
void setCellSet ()
 Set the cell set based on the user input selection mode. More...
 
void setVol ()
 Recalculate the volume. More...
 

Detailed Description

Corrects temperature field (i.e. T) within a specified region by applying limits between a given minimum and maximum.

Corrections applied to:

  T    | Temperature                   [K]

Required fields:

  T    | Temperature                   [K]
  e/h  | Internal energy/Enthalphy     [m2/s2]
Usage
Minimal example by using constant/fvOptions:
limitTemperature1
{
    // Mandatory entries (unmodifiable)
    type            limitTemperature;

    // Mandatory entries (runtime modifiable)
    min             <minValue>;
    max             <maxValue>;

    // Optional entries (runtime modifiable)
    phase           <phaseName>;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: limitTemperature word yes -
min Minimum temperature limit [K] scalar yes -
max Maximum temperature limit [K] scalar yes -
phase Name of operand phase field word no ""

The inherited entries are elaborated in:

See also
Source files

Definition at line 134 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 49 of file limitTemperature.C.

References dictName().

Here is the call graph for this function:

◆ limitTemperature() [2/2]

limitTemperature ( const limitTemperature )
delete

No copy construct.

◆ ~limitTemperature()

virtual ~limitTemperature ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "limitTemperature"  )

Runtime type information.

◆ operator=()

void operator= ( const limitTemperature )
delete

No copy assignment.

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 77 of file limitTemperature.C.

References option::coeffs_, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, cellSetOption::read(), dictionary::readEntry(), limitTemperature::Tmax_, and limitTemperature::Tmin_.

Here is the call graph for this function:

◆ correct()

void correct ( volScalarField he)
virtual

Correct the energy field.

Reimplemented from option.

Definition at line 108 of file limitTemperature.C.

References dictionary::dictName(), Foam::endl(), fvPatchField< Type >::fixesValue(), forAll, IOobject::groupName(), he, Foam::Info, Foam::max(), Foam::min(), Foam::nl, Foam::reduce(), Foam::T(), and Foam::type().

Here is the call graph for this function:

Member Data Documentation

◆ Tmin_

scalar Tmin_
protected

Minimum temperature limit [K].

Definition at line 143 of file limitTemperature.H.

Referenced by limitTemperature::read().

◆ Tmax_

scalar Tmax_
protected

Maximum temperature limit [K].

Definition at line 146 of file limitTemperature.H.

Referenced by limitTemperature::read().

◆ phase_

word phase_
protected

Optional phase name [K].

Definition at line 149 of file limitTemperature.H.


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