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 noexcept
	Return const access to the time start. More...

scalar	duration () const noexcept
	Return const access to the duration. More...

bool	inTimeLimits (const scalar timeValue) const
	True if within time limits. More...

selectionModeType	selectionMode () const noexcept
	Return the cell selection mode. More...

bool	useSubMesh () const noexcept
	True if sub-selection should be used. More...

const word &	cellSetName () const noexcept

scalar	V () const noexcept
	Return const access to the total cell volume. More...

const labelList &	cells () const noexcept
	Return const access to the cell selection. More...

scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value. More...

scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value. 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< option >	clone () const
	Return clone. More...

virtual	~option ()=default
	Destructor. More...

const word &	name () const noexcept
	Return const access to the source name. More...

const fvMesh &	mesh () const noexcept
	Return const access to the mesh database. More...

const dictionary &	coeffs () const noexcept
	Return dictionary. More...

bool	active () const noexcept
	True if source is active. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

bool	active (const bool on) noexcept
	Change source active flag, return previous value. 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< point >	points_
	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 fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

bool	active_
	Source active flag. More...

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smAll, smCellSet, smCellZone, smPoints }
	Enumeration for selection mode types. More...

Static Public Member Functions inherited from option
static autoPtr< option >	New (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< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names. More...

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input. More...

void	setCellSelection ()
	Set the cell selection based on user input selection mode. More...

void	setVol ()
	Recalculate the volume. More...

Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. 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

Foam::fv::fixedTemperatureConstraint

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(), Foam::type(), and cellSetOption::useSubMesh().

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:

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_