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")

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

	limitTemperature (const limitTemperature &)=delete

void	operator= (const limitTemperature &)=delete

virtual	~limitTemperature ()=default

virtual bool	read (const dictionary &dict)

virtual void	correct (volScalarField &he)

Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")

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

virtual	~cellSetOption ()=default

scalar	timeStart () const noexcept

scalar	duration () const noexcept

bool	inTimeLimits (const scalar timeValue) const

selectionModeType	selectionMode () const noexcept

bool	useSubMesh () const noexcept

const word &	cellSetName () const noexcept

scalar	V () const noexcept

const labelList &	cells () const noexcept

scalar	timeStart (scalar val) noexcept

scalar	duration (scalar val) noexcept

virtual bool	isActive ()

Public Member Functions inherited from option
	TypeName ("option")

	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)

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

bool	active (const bool on) noexcept

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

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

virtual void	writeFooter (Ostream &) const

virtual void	writeData (Ostream &) const

Protected Attributes
scalar	Tmin_

scalar	Tmax_

word	phase_

Protected Attributes inherited from cellSetOption
scalar	timeStart_

scalar	duration_

selectionModeType	selectionMode_

word	cellSetName_

List< point >	points_

labelList	cells_

scalar	V_

Protected Attributes inherited from option
const word	name_

const word	modelType_

const fvMesh &	mesh_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

bool	active_

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smAll, smCellSet, smCellZone, smPoints }

Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)

Public Attributes inherited from option
bool	log

Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)

void	setCellSelection ()

void	setVol ()

Protected Member Functions inherited from option
void	resetApplied ()

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

Foam::fv::fixedTemperatureConstraint

Source files

Definition at line 130 of file limitTemperature.H.

Constructor & Destructor Documentation

◆ limitTemperature() [1/2]

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

Definition at line 42 of file limitTemperature.C.

References dictName().

Here is the call graph for this function:

◆ limitTemperature() [2/2]

limitTemperature ( const limitTemperature & )

delete

◆ ~limitTemperature()

virtual ~limitTemperature ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "limitTemperature" )

◆ operator=()

void operator= ( const limitTemperature & )

delete

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from cellSetOption.

Definition at line 70 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

Reimplemented from option.

Definition at line 101 of file limitTemperature.C.

References basicThermo::dictName, Foam::endl(), fvPatchField::fixesValue(), forAll, IOobject::groupName(), he, Foam::Info, Foam::max(), Foam::min(), Foam::nl, Foam::reduce(), Foam::T(), Foam::type(), and cellSetOption::useSubMesh().

Here is the call graph for this function:

Member Data Documentation

◆ Tmin_

scalar Tmin_

protected

Definition at line 139 of file limitTemperature.H.

Referenced by limitTemperature::read().

◆ Tmax_

scalar Tmax_

protected

Definition at line 142 of file limitTemperature.H.

Referenced by limitTemperature::read().

◆ phase_

word phase_

protected

Definition at line 145 of file limitTemperature.H.

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

src/fvOptions/corrections/limitTemperature/limitTemperature.H
src/fvOptions/corrections/limitTemperature/limitTemperature.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ limitTemperature() [1/2]

◆ limitTemperature() [2/2]

◆ ~limitTemperature()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ correct()

Member Data Documentation

◆ Tmin_

◆ Tmax_

◆ phase_