Loading...
Searching...
No Matches
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...

#include <turbulentIntensityKineticEnergyInletFvPatchScalarField.H>

Inheritance diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:
Collaboration diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:

Public Member Functions

 TypeName ("turbulentIntensityKineticEnergyInlet")
 Runtime type information.
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &)
 Construct as copy.
 turbulentIntensityKineticEnergyInletFvPatchScalarField (const turbulentIntensityKineticEnergyInletFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > > clone () const
 Return a clone.
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Clone with an internal field reference.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

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

Constructor & Destructor Documentation

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [1/5]

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

◆ 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 60 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobjectOption::MUST_READ, Foam::nl, p, fvPatchFieldBase::readDict(), and Foam::Zero.

Here is the call graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [3/5]

turbulentIntensityKineticEnergyInletFvPatchScalarField ( const turbulentIntensityKineticEnergyInletFvPatchScalarField & ptf,
const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF,
const fvPatchFieldMapper & mapper )

Construct by mapping given.

turbulentIntensityKineticEnergyInletFvPatchScalarField onto a new patch

Definition at line 46 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References p, and turbulentIntensityKineticEnergyInletFvPatchScalarField().

Here is the call graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [4/5]

turbulentIntensityKineticEnergyInletFvPatchScalarField ( const turbulentIntensityKineticEnergyInletFvPatchScalarField & ptf)

Construct as copy.

Definition at line 94 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References turbulentIntensityKineticEnergyInletFvPatchScalarField().

Here is the call graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [5/5]

turbulentIntensityKineticEnergyInletFvPatchScalarField ( const turbulentIntensityKineticEnergyInletFvPatchScalarField & ptf,
const DimensionedField< scalar, volMesh > & iF )

Construct as copy setting internal field reference.

Definition at line 106 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References turbulentIntensityKineticEnergyInletFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentIntensityKineticEnergyInlet" )

Runtime type information.

References turbulentIntensityKineticEnergyInletFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 198 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 206 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 121 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.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 142 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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