inletOutletTotalTemperatureFvPatchScalarField Class Reference

This boundary condition provides an outflow condition for total temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. More...

Inheritance diagram for inletOutletTotalTemperatureFvPatchScalarField:
Collaboration diagram for inletOutletTotalTemperatureFvPatchScalarField:

Public Member Functions

 TypeName ("inletOutletTotalTemperature")
 Runtime type information. More...
 
 inletOutletTotalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 inletOutletTotalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor 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 an outflow condition for total temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow.

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 heat capacity ration (Cp/Cv) yes
inletValue reverse flow (inlet) value yes
T0 static temperature [K] yes

Example of the boundary condition specification:

    <patchName>
    {
        type            inletOutletTotalTemperature;
        U               U;
        phi             phi;
        psi             psi;
        gamma           gamma;
        inletValue      uniform 0;
        T0              uniform 0;
        value           uniform 0;
    }
See also
Foam::inletOutletFvPatchField
Source files

Definition at line 114 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ inletOutletTotalTemperatureFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 36 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References Foam::Zero.

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

Here is the caller graph for this function:

◆ inletOutletTotalTemperatureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 55 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References dictionary::found(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), dictionary::lookupOrDefault(), scalarField(), fvPatch::size(), and Foam::Zero.

Here is the call graph for this function:

◆ inletOutletTotalTemperatureFvPatchScalarField() [3/5]

◆ inletOutletTotalTemperatureFvPatchScalarField() [4/5]

Disallow copy without setting internal field reference.

◆ inletOutletTotalTemperatureFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 106 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References inletOutletTotalTemperatureFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "inletOutletTotalTemperature"  )

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 181 of file inletOutletTotalTemperatureFvPatchScalarField.H.

References inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ T0() [1/2]

const scalarField& T0 ( ) const
inline

Return the total pressure.

Definition at line 197 of file inletOutletTotalTemperatureFvPatchScalarField.H.

◆ T0() [2/2]

◆ 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 122 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References inletOutletTotalTemperatureFvPatchScalarField::rmap().

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

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 132 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References inletOutletTotalTemperatureFvPatchScalarField::rmap().

Referenced by inletOutletTotalTemperatureFvPatchScalarField::autoMap(), inletOutletTotalTemperatureFvPatchScalarField::rmap(), and inletOutletTotalTemperatureFvPatchScalarField::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 146 of file inletOutletTotalTemperatureFvPatchScalarField.C.

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

Referenced by inletOutletTotalTemperatureFvPatchScalarField::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 172 of file inletOutletTotalTemperatureFvPatchScalarField.C.

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

Referenced by inletOutletTotalTemperatureFvPatchScalarField::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: