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 > &)
	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 this_bctype &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping onto a new patch. More...
	totalTemperatureFvPatchScalarField (const this_bctype &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...
	totalTemperatureFvPatchScalarField (const this_bctype &)=delete
	No copy without an internal field. More...
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference. More...
const scalarField &	T0 () const
	Return the total pressure. More...
scalarField &	T0 ()
	Return reference to the total pressure 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	total temperature	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            totalTemperature;
        gamma           1.4;
        T0              uniform 800;
    }

Source files

• totalTemperatureFvPatchScalarField.H
• totalTemperatureFvPatchScalarField.C

See also

Foam::fixedValueFvPatchField

Definition at line 102 of file totalTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

totalTemperatureFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

totalTemperatureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

totalTemperatureFvPatchScalarField() [3/5]

totalTemperatureFvPatchScalarField	(	const this_bctype &	,
		const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping onto a new patch.

totalTemperatureFvPatchScalarField() [4/5]

totalTemperatureFvPatchScalarField	(	const this_bctype &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct as copy setting internal field reference.

totalTemperatureFvPatchScalarField() [5/5]

totalTemperatureFvPatchScalarField ( const this_bctype &  )

delete

No copy without an internal field.

Member Function Documentation

TypeName()

TypeName

(

"totalTemperature"

)

Runtime type information.

clone()

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

inlinevirtual

Clone with an internal field reference.

Definition at line 195 of file totalTemperatureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

T0() [1/2]

const scalarField& T0 ( ) const

inline

Return the total pressure.

Definition at line 210 of file totalTemperatureFvPatchScalarField.H.

T0() [2/2]

scalarField& T0 ( )

inline

Return reference to the total pressure to allow adjustment.

Definition at line 218 of file totalTemperatureFvPatchScalarField.H.

autoMap()

virtual void autoMap ( const fvPatchFieldMapper &  )

virtual

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

rmap()

virtual void rmap ( const fvPatchScalarField &  , const labelList &    )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

updateCoeffs()

virtual void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

write()

virtual void write ( Ostream &  ) const

virtual

Write.

---

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

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