kEpsilon< BasicTurbulenceModel > Class Template Reference

Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distortion theory (RDT) based compression term. More...

Inheritance diagram for kEpsilon< BasicTurbulenceModel >:
[legend]
Collaboration diagram for kEpsilon< BasicTurbulenceModel >:
[legend]

Public Types

typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 
- Public Types inherited from eddyViscosity< RASModel< BasicTurbulenceModel > >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 
- Public Types inherited from linearViscousStress< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 

Public Member Functions

 TypeName ("kEpsilon")
 Runtime type information. More...
 
 kEpsilon (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
 Construct from components. More...
 
virtual ~kEpsilon ()=default
 Destructor. More...
 
virtual bool read ()
 Re-read model coefficients if they have changed. More...
 
tmp< volScalarFieldDkEff () const
 Return the effective diffusivity for k. More...
 
tmp< volScalarFieldDepsilonEff () const
 Return the effective diffusivity for epsilon. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulence kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return the turbulence kinetic energy dissipation rate. More...
 
virtual void correct ()
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
- Public Member Functions inherited from eddyViscosity< RASModel< BasicTurbulenceModel > >
 eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct from components. More...
 
virtual ~eddyViscosity ()=default
 Destructor. More...
 
virtual bool read ()=0
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const=0
 Return the turbulence kinetic energy. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor. More...
 
virtual void validate ()
 Validate the turbulence fields after construction. More...
 
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
- Public Member Functions inherited from linearViscousStress< BasicTurbulenceModel >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct from components. More...
 
virtual ~linearViscousStress ()=default
 Destructor. More...
 
virtual bool read ()=0
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< volSymmTensorFielddevRhoReff (const volVectorField &U) const
 Return the effective stress tensor based on a given velocity field. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity. More...
 

Protected Member Functions

virtual void correctNut ()
 
virtual tmp< fvScalarMatrixkSource () const
 
virtual tmp< fvScalarMatrixepsilonSource () const
 
virtual void correctNut ()=0
 

Protected Attributes

dimensionedScalar Cmu_
 
dimensionedScalar C1_
 
dimensionedScalar C2_
 
dimensionedScalar C3_
 
dimensionedScalar sigmak_
 
dimensionedScalar sigmaEps_
 
volScalarField k_
 
volScalarField epsilon_
 
- Protected Attributes inherited from eddyViscosity< RASModel< BasicTurbulenceModel > >
volScalarField nut_
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::RASModels::kEpsilon< BasicTurbulenceModel >

Standard k-epsilon turbulence model for incompressible and compressible flows including rapid distortion theory (RDT) based compression term.

Reference:

    Standard model:
        Launder, B. E., & Spalding, D. B. (1972).
        Lectures in mathematical models of turbulence.

        Launder, B. E., & Spalding, D. B. (1974).
        The numerical computation of turbulent flows.
        Computer methods in applied mechanics and engineering,
        3(2), 269-289.

    For the RDT-based compression term:
        El Tahry, S. H. (1983).
        k-epsilon equation for compressible reciprocating engine flows.
        Journal of Energy, 7(4), 345-353.

The default model coefficients are

    kEpsilonCoeffs
    {
        Cmu         0.09;
        C1          1.44;
        C2          1.92;
        C3          -0.33;
        sigmak      1.0;
        sigmaEps    1.3;
    }
Source files

Definition at line 89 of file kEpsilon.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 130 of file kEpsilon.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 131 of file kEpsilon.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 132 of file kEpsilon.H.

Constructor & Destructor Documentation

◆ kEpsilon()

kEpsilon ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const transportModel transport,
const word propertiesName = turbulenceModel::propertiesName,
const word type = typeName 
)

Construct from components.

Definition at line 86 of file kEpsilon.C.

◆ ~kEpsilon()

virtual ~kEpsilon ( )
virtualdefault

Destructor.

Member Function Documentation

◆ correctNut()

void correctNut
protectedvirtual

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

Reimplemented in continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 43 of file kEpsilon.C.

References Time::New(), and Foam::sqr().

Referenced by continuousGasKEpsilon< BasicTurbulenceModel >::correctNut().

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

◆ kSource()

tmp< fvScalarMatrix > kSource
protectedvirtual

Reimplemented in buoyantKEpsilon< BasicTurbulenceModel >, continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 54 of file kEpsilon.C.

References Foam::dimTime, and Foam::dimVolume.

Referenced by buoyantKEpsilon< BasicTurbulenceModel >::kSource().

Here is the caller graph for this function:

◆ epsilonSource()

tmp< fvScalarMatrix > epsilonSource
protectedvirtual

Reimplemented in buoyantKEpsilon< BasicTurbulenceModel >, continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 69 of file kEpsilon.C.

References Foam::dimTime, and Foam::dimVolume.

Referenced by buoyantKEpsilon< BasicTurbulenceModel >::epsilonSource().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "kEpsilon< BasicTurbulenceModel >"  )

Runtime type information.

◆ read()

bool read
virtual

◆ DkEff()

tmp< volScalarField > DkEff ( ) const
inline

Return the effective diffusivity for k.

Definition at line 165 of file kEpsilon.H.

References nu, and eddyViscosity< RASModel< BasicTurbulenceModel > >::nut_.

◆ DepsilonEff()

tmp< volScalarField > DepsilonEff ( ) const
inline

Return the effective diffusivity for epsilon.

Definition at line 178 of file kEpsilon.H.

References nu, and eddyViscosity< RASModel< BasicTurbulenceModel > >::nut_.

◆ k()

virtual tmp< volScalarField > k ( ) const
inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

Definition at line 191 of file kEpsilon.H.

References kEpsilon< BasicTurbulenceModel >::k_.

◆ epsilon()

virtual tmp< volScalarField > epsilon ( ) const
inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 197 of file kEpsilon.H.

References kEpsilon< BasicTurbulenceModel >::epsilon_.

◆ correct()

void correct
virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

Reimplemented in PDRkEpsilon, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 222 of file kEpsilon.C.

References alpha, Foam::bound(), tmp< T >::clear(), correct(), Foam::dev(), divU, fvOptions, nut, phi, tmp< T >::ref(), rho, solve(), Foam::twoSymm(), and U.

Referenced by LaheyKEpsilon< BasicTurbulenceModel >::correct().

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

Member Data Documentation

◆ Cmu_

dimensionedScalar Cmu_
protected

Definition at line 108 of file kEpsilon.H.

◆ C1_

dimensionedScalar C1_
protected

Definition at line 109 of file kEpsilon.H.

◆ C2_

dimensionedScalar C2_
protected

Definition at line 110 of file kEpsilon.H.

◆ C3_

dimensionedScalar C3_
protected

Definition at line 111 of file kEpsilon.H.

◆ sigmak_

dimensionedScalar sigmak_
protected

Definition at line 112 of file kEpsilon.H.

◆ sigmaEps_

dimensionedScalar sigmaEps_
protected

Definition at line 113 of file kEpsilon.H.

◆ k_

volScalarField k_
protected

Definition at line 117 of file kEpsilon.H.

Referenced by kEpsilon< BasicTurbulenceModel >::k().

◆ epsilon_

volScalarField epsilon_
protected

Definition at line 118 of file kEpsilon.H.

Referenced by kEpsilon< BasicTurbulenceModel >::epsilon().


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