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 > &)
 Construct from patch and internal field. 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 fvPatchFieldMapper &)
 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

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 123 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 42 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

Referenced by turbulentMixingLengthDissipationRateInletFvPatchScalarField::clone(), and turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField().

Here is the caller graph for this function:

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 59 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References dictionary::lookupOrDefault(), fvPatchField< Type >::operator=(), fvPatch::size(), and turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField().

Here is the call graph for this function:

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [3/5]

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

Construct by mapping given.

turbulentMixingLengthDissipationRateInletFvPatchScalarField onto a new patch

Definition at line 81 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField().

Here is the call graph for this function:

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [4/5]

turbulentMixingLengthDissipationRateInletFvPatchScalarField ( const turbulentMixingLengthDissipationRateInletFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ turbulentMixingLengthDissipationRateInletFvPatchScalarField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 96 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 185 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.H.

References turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), and turbulentMixingLengthDissipationRateInletFvPatchScalarField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 109 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References momentumTransportModel::coeffDict(), Foam::constant::atomic::group, IOobject::groupName(), dictionary::lookupOrDefault(), Foam::pos0(), Foam::pow(), Foam::sqrt(), and turbulentMixingLengthDissipationRateInletFvPatchScalarField::write().

Referenced by turbulentMixingLengthDissipationRateInletFvPatchScalarField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 146 of file turbulentMixingLengthDissipationRateInletFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

Referenced by turbulentMixingLengthDissipationRateInletFvPatchScalarField::clone(), and turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: