Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for inletOutletTotalTemperatureFvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("inletOutletTotalTemperature")
 Runtime type information. 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 fieldMapper &)
 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< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting 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 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 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 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/4]

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

Construct from patch, internal field and dictionary.

Definition at line 34 of file inletOutletTotalTemperatureFvPatchScalarField.C.

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

Referenced by inletOutletTotalTemperatureFvPatchScalarField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ inletOutletTotalTemperatureFvPatchScalarField() [2/4]

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

Construct by mapping given.

inletOutletTotalTemperatureFvPatchScalarField onto a new patch

Definition at line 68 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ inletOutletTotalTemperatureFvPatchScalarField() [3/4]

inletOutletTotalTemperatureFvPatchScalarField ( const inletOutletTotalTemperatureFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ inletOutletTotalTemperatureFvPatchScalarField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 85 of file inletOutletTotalTemperatureFvPatchScalarField.C.

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

◆ T0() [2/2]

scalarField& T0 ( )
inline

Return reference to the total pressure to allow adjustment.

Definition at line 196 of file inletOutletTotalTemperatureFvPatchScalarField.H.

◆ map()

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

Map the given fvPatchField onto this fvPatchField.

Definition at line 102 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ reset()

void reset ( const fvPatchScalarField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 117 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 131 of file inletOutletTotalTemperatureFvPatchScalarField.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 157 of file inletOutletTotalTemperatureFvPatchScalarField.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: