Public Member Functions | List of all members
turbulentEpsilonFvScalarFieldSource Class Reference

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

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

Public Member Functions

 TypeName ("turbulentEpsilon")
 Runtime type information. More...
 
 turbulentEpsilonFvScalarFieldSource (const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 turbulentEpsilonFvScalarFieldSource (const turbulentEpsilonFvScalarFieldSource &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual autoPtr< fvScalarFieldSource > clone (const DimensionedField< scalar, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~turbulentEpsilonFvScalarFieldSource ()
 Destructor. More...
 
virtual tmp< DimensionedField< scalar, fvMesh > > sourceValue (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
 Return the source value. More...
 
virtual tmp< scalarField > sourceValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
 Return the source value. More...
 
virtual tmp< DimensionedField< scalar, fvMesh > > internalCoeff (const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
 Return the internal coefficient. More...
 
virtual tmp< scalarField > internalCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
 Return the internal coefficient. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

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

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

where

$ \epsilon $ = epsilon values
$ C_{\mu} $ = Model coefficient, set to 0.09
$ k $ = turbulence kinetic energy
$ L $ = length scale

In the case of a sink, the current cell values are used instead.

Usage
Property Description Required Default value
mixingLength Length scale [m] yes
k turbulence kinetic energy field name no k
Cmu Turbulence model coefficient no 0.09

Example of the source condition specification: 

    <sourceName>
    {
        type            turbulentEpsilon;
        mixingLength    0.005;
    }
Source files

Definition at line 118 of file turbulentEpsilonFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ turbulentEpsilonFvScalarFieldSource() [1/2]

turbulentEpsilonFvScalarFieldSource ( const DimensionedField< scalar, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 34 of file turbulentEpsilonFvScalarFieldSource.C.

◆ turbulentEpsilonFvScalarFieldSource() [2/2]

turbulentEpsilonFvScalarFieldSource ( const turbulentEpsilonFvScalarFieldSource &  field,
const DimensionedField< scalar, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 48 of file turbulentEpsilonFvScalarFieldSource.C.

◆ ~turbulentEpsilonFvScalarFieldSource()

~turbulentEpsilonFvScalarFieldSource ( )
virtual

Destructor.

Definition at line 64 of file turbulentEpsilonFvScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentEpsilon"  )

Runtime type information.

◆ clone()

virtual autoPtr<fvScalarFieldSource> clone ( const DimensionedField< scalar, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 159 of file turbulentEpsilonFvScalarFieldSource.H.

◆ sourceValue() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > sourceValue ( const fvSource &  model,
const DimensionedField< scalar, fvMesh > &  source 
) const
virtual

Return the source value.

Definition at line 72 of file turbulentEpsilonFvScalarFieldSource.C.

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

Here is the call graph for this function:

◆ sourceValue() [2/2]

Foam::tmp< Foam::scalarField > sourceValue ( const fvSource &  model,
const scalarField &  source,
const labelUList &  cells 
) const
virtual

Return the source value.

Definition at line 88 of file turbulentEpsilonFvScalarFieldSource.C.

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

Here is the call graph for this function:

◆ internalCoeff() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::fvMesh > > internalCoeff ( const fvSource &  model,
const DimensionedField< scalar, fvMesh > &  source 
) const
virtual

Return the internal coefficient.

Definition at line 102 of file turbulentEpsilonFvScalarFieldSource.C.

References Foam::neg0().

Here is the call graph for this function:

◆ internalCoeff() [2/2]

Foam::tmp< Foam::scalarField > internalCoeff ( const fvSource &  model,
const scalarField &  source,
const labelUList &  cells 
) const
virtual

Return the internal coefficient.

Definition at line 113 of file turbulentEpsilonFvScalarFieldSource.C.

References Foam::neg0().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 124 of file turbulentEpsilonFvScalarFieldSource.C.

References Foam::vtkWriteOps::write(), and Foam::writeEntry().

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