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:
[legend]
Collaboration diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:
[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.

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 122 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 37 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 67 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::getOrDefault(), Foam::nl, word::null, fvPatchField< scalar >::operator=(), p, and UList< T >::size().

Here is the call graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [3/5]

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [4/5]

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 113 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentIntensityKineticEnergyInlet"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 176 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 195 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 128 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 149 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References os(), ObukhovLength::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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