turbulentIntensityKineticEnergyInletFvPatchScalarField 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 turbulentIntensityKineticEnergyInletFvPatchScalarField:
Collaboration diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:

Public Member Functions

 TypeName ("turbulentIntensityKineticEnergyInlet")
 Runtime type information. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &, 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...
 
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        turbulentIntensityKineticEnergyInlet;
        intensity   0.05;           // 5% turbulence
        value       uniform 1;      // placeholder
    }
See also
Foam::inletOutletFvPatchField
Source files

Definition at line 117 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [1/5]

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [2/5]

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [3/5]

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [4/5]

Disallow copy without setting internal field reference.

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 102 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References turbulentIntensityKineticEnergyInletFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentIntensityKineticEnergyInlet"  )

Runtime type information.

◆ clone()

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

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