Constrain temperature equation (i.e. T) with a given set of fixed values within a specified region. More...

Inheritance diagram for fixedTemperatureConstraint:

Collaboration diagram for fixedTemperatureConstraint:

[legend]

Public Types
enum	temperatureMode { tmUniform, tmLookup }

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

Public Member Functions
	TypeName ("fixedTemperatureConstraint")

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

	fixedTemperatureConstraint (const fixedTemperatureConstraint &)=delete

void	operator= (const fixedTemperatureConstraint &)=delete

virtual	~fixedTemperatureConstraint ()=default

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual bool	read (const dictionary &dict)

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< 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 (volScalarField &field)

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

Static Public Attributes
static const Enum< temperatureMode >	temperatureModeNames_

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

Protected Attributes
temperatureMode	mode_

autoPtr< Function1< scalar > >	Tuniform_

word	TName_

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

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

Constrain temperature equation (i.e. T) with a given set of fixed values within a specified region.

Constraints applied to:

  T    | Temperature                   [K]

Required fields:

  T    | Temperature                   [K]
  e/h  | Internal energy/Enthalphy     [m2/s2]

Usage

Minimal example by using constant/fvOptions:

fixedTemperatureConstraint1
{
    // Mandatory entries (unmodifiable)
    type            fixedTemperatureConstraint;
    mode            <mode>;

    // Conditional mandatory/optional entries (runtime modifiable)

        // when mode=uniform (mandatory)
        temperature     constant 500; // fixed temperature with time [K]

        // when mode=lookup (optional)
        T            <Tname>;

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

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: fixedTemperatureConstraint	word	yes	-
`mode`	Temperature mode - see below	word	yes	-
`temperature`	Function1 type temperature field	Function1	cndtnl	-
`T`	Name of operand temperature field	word	cndtnl	T

Options for the mode entry:

      uniform | Use Function1 type temperature field
      lookup  | Use temperature field given field name

The inherited entries are elaborated in:

Note:

The uniform option allows the use of a time-varying uniform temperature by means of the Function1 type.

See also

Source files

Definition at line 145 of file fixedTemperatureConstraint.H.

Member Enumeration Documentation

◆ temperatureMode

enum temperatureMode

Enumerator
tmUniform
tmLookup

Definition at line 152 of file fixedTemperatureConstraint.H.

Constructor & Destructor Documentation

◆ fixedTemperatureConstraint() [1/2]

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

Definition at line 58 of file fixedTemperatureConstraint.C.

References dictName().

Here is the call graph for this function:

◆ fixedTemperatureConstraint() [2/2]

fixedTemperatureConstraint ( const fixedTemperatureConstraint & )

delete

◆ ~fixedTemperatureConstraint()

virtual ~fixedTemperatureConstraint ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "fixedTemperatureConstraint" )

◆ operator=()

void operator= ( const fixedTemperatureConstraint & )

delete

◆ constrain()

void constrain	(	fvMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented from option.

Definition at line 106 of file fixedTemperatureConstraint.C.

References dictName(), mesh, fvMatrix::setValues(), T, IOobject::time(), and dimensioned::value().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from cellSetOption.

Definition at line 140 of file fixedTemperatureConstraint.C.

References option::coeffs_, dict, dictionary::found(), option::mesh_, cellSetOption::read(), dictionary::readIfPresent(), fixedTemperatureConstraint::TName_, and fixedTemperatureConstraint::Tuniform_.

Here is the call graph for this function:

Member Data Documentation

◆ temperatureModeNames_

const Foam::Enum< Foam::fv::fixedTemperatureConstraint::temperatureMode > temperatureModeNames_

static

Definition at line 159 of file fixedTemperatureConstraint.H.

◆ mode_

temperatureMode mode_

protected

Definition at line 167 of file fixedTemperatureConstraint.H.

◆ Tuniform_

autoPtr<Function1<scalar> > Tuniform_

protected

Definition at line 170 of file fixedTemperatureConstraint.H.

Referenced by fixedTemperatureConstraint::read().

◆ TName_

word TName_

protected

Definition at line 173 of file fixedTemperatureConstraint.H.

Referenced by fixedTemperatureConstraint::read().

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

src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H
src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.C

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ temperatureMode

Constructor & Destructor Documentation

◆ fixedTemperatureConstraint() [1/2]

◆ fixedTemperatureConstraint() [2/2]

◆ ~fixedTemperatureConstraint()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ constrain()

◆ read()

Member Data Documentation

◆ temperatureModeNames_

◆ mode_

◆ Tuniform_

◆ TName_