Public Member Functions | List of all members
turbulentKineticEnergyFvPatchScalarField Class Reference

This boundary condition provides a turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the mean velocity: More...

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

Public Member Functions

 TypeName ("turbulentKineticEnergy")
 Runtime type information. More...
 
 turbulentKineticEnergyFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 turbulentKineticEnergyFvPatchScalarField (const turbulentKineticEnergyFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 turbulentKineticEnergyFvPatchScalarField (const turbulentKineticEnergyFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 turbulentKineticEnergyFvPatchScalarField (const turbulentKineticEnergyFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. 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 turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the mean velocity:

\[ k_p = 1.5 (I |U|)^2 \]

where

$ k_p $ = kinetic energy at the patch
$ I $ = turbulence intensity
$ U $ = velocity field

In the event of reverse flow, a zero-gradient condition is applied.

Usage
Property Description Required Default value
intensity fraction of mean field [0-1] yes
U velocity field name no U
phi flux field name no phi

Example of the boundary condition specification: 

    <patchName>
    {
        type        turbulentKineticEnergy;
        intensity   0.05;           // 5% turbulence
        value       uniform 1;      // placeholder
    }
See also
Foam::inletOutletFvPatchField
Source files

Definition at line 117 of file turbulentKineticEnergyFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentKineticEnergyFvPatchScalarField() [1/4]

turbulentKineticEnergyFvPatchScalarField ( const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 34 of file turbulentKineticEnergyFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, fvPatchField< Type >::operator, and p.

Here is the call graph for this function:

◆ turbulentKineticEnergyFvPatchScalarField() [2/4]

turbulentKineticEnergyFvPatchScalarField ( const turbulentKineticEnergyFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

turbulentKineticEnergyFvPatchScalarField onto a new patch

Definition at line 71 of file turbulentKineticEnergyFvPatchScalarField.C.

◆ turbulentKineticEnergyFvPatchScalarField() [3/4]

turbulentKineticEnergyFvPatchScalarField ( const turbulentKineticEnergyFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ turbulentKineticEnergyFvPatchScalarField() [4/4]

turbulentKineticEnergyFvPatchScalarField ( const turbulentKineticEnergyFvPatchScalarField &  ptf,
const DimensionedField< scalar, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 86 of file turbulentKineticEnergyFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentKineticEnergy"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 171 of file turbulentKineticEnergyFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 101 of file turbulentKineticEnergyFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 122 of file turbulentKineticEnergyFvPatchScalarField.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: