Public Member Functions | List of all members
turbulentMixingLengthDissipationRateInletFvPatchScalarField Class Reference

This boundary condition provides a turbulence dissipation, $\epsilon$ (epsilon) inlet condition based on a specified mixing length. The patch values are calculated using: More...

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

Public Member Functions

 TypeName ("turbulentMixingLengthDissipationRateInlet")
 Runtime type information. More...
 
 turbulentMixingLengthDissipationRateInletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 turbulentMixingLengthDissipationRateInletFvPatchScalarField (const turbulentMixingLengthDissipationRateInletFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 turbulentMixingLengthDissipationRateInletFvPatchScalarField (const turbulentMixingLengthDissipationRateInletFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 turbulentMixingLengthDissipationRateInletFvPatchScalarField (const turbulentMixingLengthDissipationRateInletFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (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 turbulence dissipation, $\epsilon$ (epsilon) inlet condition based on a specified mixing length. The patch values are calculated using:

\[ \epsilon_p = \frac{C_{\mu}^{0.75} k^{1.5}}{L} \]

where

$ \epsilon_p $ = patch epsilon values
$ C_{\mu} $ = Model coefficient, set to 0.09
$ k $ = turbulence kinetic energy
$ L $ = length scale
Usage
Property Description Required Default value
mixingLength Length scale [m] yes
phi flux field name no phi
k turbulence kinetic energy field name no k
Cmu Turbulence model coefficient no 0.09

Example of the boundary condition specification: 

    <patchName>
    {
        type            turbulentMixingLengthDissipationRateInlet;
        mixingLength    0.005;
        value           uniform 200;   // placeholder
    }

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

See also
Foam::inletOutletFvPatchField
Source files

Definition at line 129 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 40 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), fvPatchField< Type >::operator, and p.

Here is the call graph for this function:

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [2/4]

turbulentMixingLengthDissipationRateInletFvPatchScalarField ( const turbulentMixingLengthDissipationRateInletFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

turbulentMixingLengthDissipationRateInletFvPatchScalarField onto a new patch

Definition at line 66 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [3/4]

turbulentMixingLengthDissipationRateInletFvPatchScalarField ( const turbulentMixingLengthDissipationRateInletFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 82 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentMixingLengthDissipationRateInlet"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 186 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 98 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References Foam::neg(), Foam::pow(), and Foam::sqrt().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 120 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.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: