This boundary condition provides a total temperature condition. More...

Inheritance diagram for totalTemperatureFvPatchScalarField:

Collaboration diagram for totalTemperatureFvPatchScalarField:

Public Member Functions
	TypeName ("totalTemperature")
	Runtime type information. More...

	totalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	totalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given totalTemperatureFvPatchScalarField. More...

	totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &)
	Copy constructor. More...

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const scalarField &	T0 () const
	Return the reference temperature. More...

scalarField &	T0 ()
	Return reference to the temperature to allow adjustment. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Detailed Description

This boundary condition provides a total temperature condition.

Usage

Property	Description	Required	Default value
`U`	Velocity field name	no	U
`phi`	Flux field name	no	phi
`psi`	Compressibility field name	no	thermo:psi
`gamma`	ratio of specific heats (Cp/Cv)	yes
`T0`	reference temperature	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            totalTemperature;
        T0              uniform 300;
    }

Source files

See also: Foam::fixedValueFvPatchField

Definition at line 100 of file totalTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ totalTemperatureFvPatchScalarField() [1/5]

totalTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file totalTemperatureFvPatchScalarField.C.

Referenced by totalTemperatureFvPatchScalarField::clone(), and totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the caller graph for this function:

◆ totalTemperatureFvPatchScalarField() [2/5]

totalTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 67 of file totalTemperatureFvPatchScalarField.C.

References dictionary::found(), scalarField(), fvPatch::size(), and totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ totalTemperatureFvPatchScalarField() [3/5]

totalTemperatureFvPatchScalarField	(	const totalTemperatureFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given totalTemperatureFvPatchScalarField.

onto a new patch

Definition at line 50 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ totalTemperatureFvPatchScalarField() [4/5]

totalTemperatureFvPatchScalarField ( const totalTemperatureFvPatchScalarField & tppsf )

Copy constructor.

Definition at line 95 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ totalTemperatureFvPatchScalarField() [5/5]

totalTemperatureFvPatchScalarField	(	const totalTemperatureFvPatchScalarField &	tppsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 109 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "totalTemperature" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 162 of file totalTemperatureFvPatchScalarField.H.

References totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 179 of file totalTemperatureFvPatchScalarField.H.

References totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ T0() [1/2]

const scalarField& T0 ( ) const

inline

Return the reference temperature.

Definition at line 195 of file totalTemperatureFvPatchScalarField.H.

◆ T0() [2/2]

scalarField& T0 ( )

inline

Return reference to the temperature to allow adjustment.

Definition at line 201 of file totalTemperatureFvPatchScalarField.H.

References totalTemperatureFvPatchScalarField::autoMap(), totalTemperatureFvPatchScalarField::rmap(), totalTemperatureFvPatchScalarField::updateCoeffs(), and totalTemperatureFvPatchScalarField::write().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Used to update fields following mesh topology change

Definition at line 126 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::rmap().

Referenced by totalTemperatureFvPatchScalarField::T0(), and totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rmap()

void rmap	(	const fvPatchScalarField &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Used to reconstruct fields

Definition at line 136 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::rmap().

Referenced by totalTemperatureFvPatchScalarField::autoMap(), totalTemperatureFvPatchScalarField::rmap(), and totalTemperatureFvPatchScalarField::T0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 150 of file totalTemperatureFvPatchScalarField.C.

References Foam::magSqr(), and Foam::pos0().

Referenced by totalTemperatureFvPatchScalarField::T0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 177 of file totalTemperatureFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

Referenced by totalTemperatureFvPatchScalarField::T0().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ totalTemperatureFvPatchScalarField() [1/5]

◆ totalTemperatureFvPatchScalarField() [2/5]

◆ totalTemperatureFvPatchScalarField() [3/5]

◆ totalTemperatureFvPatchScalarField() [4/5]

◆ totalTemperatureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ T0() [1/2]

◆ T0() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()