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

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 &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &, 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...
 
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.


Patch 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:

    myPatch
    {
        type        turbulentIntensityKineticEnergyInlet;
        intensity   0.05;           // 5% turbulence
        value       uniform 1;      // placeholder
    }
See also
Foam::inletOutletFvPatchField
Source files

Definition at line 121 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

Constructor & Destructor Documentation

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

Construct as copy setting internal field reference.

Definition at line 119 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References turbulentIntensityKineticEnergyInletFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "turbulentIntensityKineticEnergyInlet"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 175 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

References turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField().

Here is the call graph for this function:

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual
void updateCoeffs ( )
virtual
void write ( Ostream os) const
virtual

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