Public Member Functions | List of all members
totalTemperatureFvPatchScalarField Class Reference

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

Inheritance diagram for totalTemperatureFvPatchScalarField:
Inheritance graph
[legend]
Collaboration diagram for totalTemperatureFvPatchScalarField:
Collaboration graph
[legend]

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 &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 totalTemperatureFvPatchScalarField (const totalTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const scalarFieldT0 () const
 Return the total pressure. More...
 
scalarFieldT0 ()
 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 reference temperature yes

Example of the boundary condition specification:

    <patchName>
    {
        type            totalTemperature;
        T0              uniform 300;
    }
Source files
See also
Foam::fixedValueFvPatchField

Definition at line 103 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]

Construct as copy.

Definition at line 95 of file totalTemperatureFvPatchScalarField.C.

References totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ totalTemperatureFvPatchScalarField() [5/5]

Construct as copy 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 165 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 182 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 total pressure.

Definition at line 198 of file totalTemperatureFvPatchScalarField.H.

◆ T0() [2/2]

scalarField& T0 ( )
inline

Return reference to the total pressure to allow adjustment.

Definition at line 204 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.

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.

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 token::END_STATEMENT, Foam::makePatchTypeField(), Foam::nl, fvPatchField< Type >::write(), and Field< Type >::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: