totalTemperatureFvPatchScalarField Class Reference

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 > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
	Construct by mapping given totalTemperatureFvPatchScalarField. More...
	totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. 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	map (const fvPatchScalarField &, const fieldMapper &)
	Map the given fvPatchField onto this fvPatchField. More...
virtual void	reset (const fvPatchScalarField &)
	Reset the fvPatchField to the given 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	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

• totalTemperatureFvPatchScalarField.H
• totalTemperatureFvPatchScalarField.C

See also

Foam::fixedValueFvPatchField

Definition at line 100 of file totalTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

totalTemperatureFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 34 of file totalTemperatureFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh >::dimensions(), fvPatchField< Type >::operator=(), and p.

Referenced by totalTemperatureFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

totalTemperatureFvPatchScalarField() [2/4]

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

Construct by mapping given totalTemperatureFvPatchScalarField.

onto a new patch

Definition at line 62 of file totalTemperatureFvPatchScalarField.C.

totalTemperatureFvPatchScalarField() [3/4]

totalTemperatureFvPatchScalarField ( const totalTemperatureFvPatchScalarField &  )

delete

Disallow copy without setting internal field reference.

totalTemperatureFvPatchScalarField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 79 of file totalTemperatureFvPatchScalarField.C.

Member Function Documentation

TypeName()

TypeName

(

"totalTemperature"

)

Runtime type information.

clone()

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 162 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 179 of file totalTemperatureFvPatchScalarField.H.

T0() [2/2]

scalarField& T0 ( )

inline

Return reference to the temperature to allow adjustment.

Definition at line 185 of file totalTemperatureFvPatchScalarField.H.

map()

void map ( const fvPatchScalarField &  ptf, const fieldMapper &  mapper  )

virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 96 of file totalTemperatureFvPatchScalarField.C.

reset()

void reset ( const fvPatchScalarField &  ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 111 of file totalTemperatureFvPatchScalarField.C.

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 125 of file totalTemperatureFvPatchScalarField.C.

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

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Definition at line 152 of file totalTemperatureFvPatchScalarField.C.

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

Here is the call 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