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

#include <kEpsilon.H>

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.
	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.
virtual	~kEpsilon ()=default
	Destructor.
virtual bool	read ()
	Re-read model coefficients if they have changed.
tmp< volScalarField >	DkEff () const
	Return the effective diffusivity for k.
tmp< volScalarField >	DepsilonEff () const
	Return the effective diffusivity for epsilon.
virtual tmp< volScalarField >	k () const
	Return the turbulence kinetic energy.
virtual tmp< volScalarField >	epsilon () const
	Return the turbulence kinetic energy dissipation rate.
virtual void	correct ()
	Solve the turbulence equations and correct the turbulence viscosity.
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.
virtual	~eddyViscosity ()=default
	Destructor.
virtual tmp< volScalarField >	nut () const
	Return the turbulence viscosity.
virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor.
virtual void	validate ()
	Validate the turbulence fields after construction.
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.
virtual	~linearViscousStress ()=default
	Destructor.
virtual tmp< volSymmTensorField >	devRhoReff () const
	Return the effective stress tensor.
virtual tmp< volSymmTensorField >	devRhoReff (const volVectorField &U) const
	Return the effective stress tensor based on a given velocity field.
virtual tmp< fvVectorMatrix >	divDevRhoReff (volVectorField &U) const
	Return the source term for the momentum equation.
virtual tmp< fvVectorMatrix >	divDevRhoReff (const volScalarField &rho, volVectorField &U) const
	Return the source term for the momentum equation.

Protected Member Functions
virtual void	correctNut ()
virtual tmp< fvScalarMatrix >	kSource () const
virtual tmp< fvScalarMatrix >	epsilonSource () const

Protected Attributes
dimensionedScalar	Cmu_
dimensionedScalar	C1_
dimensionedScalar	C2_
dimensionedScalar	C3_
dimensionedScalar	sigmak_
dimensionedScalar	sigmaEps_
volScalarField	k_
volScalarField	epsilon_
bool	twoLayerTreatment_
dimensionedScalar	ReyStar_
dimensionedScalar	ReyFactor_
std::unique_ptr< volScalarField::Internal >	lEpsPtr_
std::unique_ptr< volScalarField >	lambdaEpsPtr_
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.

    Two-layer wall treatment to allow operation on low-Re grids:
        Jongen, T. and Marx, Y.P. (1997) “Design of an Unconditionally
        Stable, Positive Scheme for the k−epsilon and Two-Layer Turbulence
        Models”, Computers & Fluids, 26(5), 469-487.

The default model coefficients are

    kEpsilonCoeffs
    {
        Cmu                 0.09;
        C1                  1.44;
        C2                  1.92;
        C3                  -0.33;
        sigmak              1.0;
        sigmaEps            1.3;
        twoLayerTreatment   false;

        // If two twoLayerTreatment = true,

        // Critical turbulence Reynolds number marking the separation
        // of inner-layer and outer-layer. Can be adjusted from 50.0
        // (low-speed flows) to 200.0 (default value).
        ReyStar          200.0;

        // Smoothness of transition from inner-layer to outer-layer.
        // Typically from 0.05 (sharp transition) to 0.2 (smooth transition).
        // For unstable cases, prefer larger values.
        ReyFactor        0.05;
    }

Source files

Definition at line 103 of file kEpsilon.H.

Member Typedef Documentation

◆ alphaField

template<class BasicTurbulenceModel>

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 158 of file kEpsilon.H.

◆ rhoField

template<class BasicTurbulenceModel>

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 159 of file kEpsilon.H.

◆ transportModel

template<class BasicTurbulenceModel>

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 160 of file kEpsilon.H.

Constructor & Destructor Documentation

◆ kEpsilon()

template<class BasicTurbulenceModel>

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 118 of file kEpsilon.C.

References alpha, Cmu_, eddyViscosity< RASModel< BasicTurbulenceModel > >::eddyViscosity(), phi, rho, and U.

Here is the call graph for this function:

◆ ~kEpsilon()

template<class BasicTurbulenceModel>

virtual ~kEpsilon ( )

virtualdefault

Destructor.

Member Function Documentation

◆ correctNut()

template<class BasicTurbulenceModel>

void correctNut ( )

protectedvirtual

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

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

Definition at line 37 of file kEpsilon.C.

References A, Foam::atanh(), Cmu_, optionList::correct(), epsilon_, Foam::exp(), k_, lambdaEpsPtr_, lEpsPtr_, Foam::mag(), options::New(), MeshObject< fvMesh, UpdateableMeshObject, wallDist >::New(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut_, Foam::pow(), Rey, ReyFactor_, ReyStar_, Foam::sqr(), Foam::sqrt(), Foam::tanh(), twoLayerTreatment_, wallDist::y(), and y.

Referenced by correct(), and continuousGasKEpsilon< BasicTurbulenceModel >::correctNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kSource()

template<class BasicTurbulenceModel>

tmp< fvScalarMatrix > kSource ( ) const

protectedvirtual

Reimplemented in buoyantKEpsilon< BasicTurbulenceModel >, buoyantKEpsilon< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >, buoyantKEpsilon< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >, continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 75 of file kEpsilon.C.

References alpha, Foam::dimTime, Foam::dimVolume, epsilon_, k_, lambdaEpsPtr_, lEpsPtr_, tmp< T >::New(), rho, Foam::fvm::Sp(), Foam::sqrt(), and twoLayerTreatment_.

Referenced by correct(), and buoyantKEpsilon< BasicTurbulenceModel >::kSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ epsilonSource()

template<class BasicTurbulenceModel>

tmp< fvScalarMatrix > epsilonSource ( ) const

protectedvirtual

Reimplemented in buoyantKEpsilon< BasicTurbulenceModel >, buoyantKEpsilon< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >, buoyantKEpsilon< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >, continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 105 of file kEpsilon.C.

References Foam::dimTime, Foam::dimVolume, epsilon_, and tmp< T >::New().

Referenced by correct(), and buoyantKEpsilon< BasicTurbulenceModel >::epsilonSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

template<class BasicTurbulenceModel>

TypeName ( "kEpsilon< BasicTurbulenceModel >" )

Runtime type information.

◆ read()

template<class BasicTurbulenceModel>

bool read ( )

virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

Reimplemented in PDRkEpsilon, buoyantKEpsilon< BasicTurbulenceModel >, buoyantKEpsilon< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >, buoyantKEpsilon< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >, continuousGasKEpsilon< BasicTurbulenceModel >, and LaheyKEpsilon< BasicTurbulenceModel >.

Definition at line 294 of file kEpsilon.C.

References C1_, C2_, C3_, Cmu_, eddyViscosity< RASModel< BasicTurbulenceModel > >::eddyViscosity(), read(), ReyFactor_, ReyStar_, sigmaEps_, and sigmak_.

Referenced by buoyantKEpsilon< BasicTurbulenceModel >::read(), continuousGasKEpsilon< BasicTurbulenceModel >::read(), read(), and LaheyKEpsilon< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DkEff()

template<class BasicTurbulenceModel>

tmp< volScalarField > DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 203 of file kEpsilon.H.

Referenced by correct().

Here is the caller graph for this function:

◆ DepsilonEff()

template<class BasicTurbulenceModel>

tmp< volScalarField > DepsilonEff ( ) const

inline

Return the effective diffusivity for epsilon.

Definition at line 215 of file kEpsilon.H.

Referenced by correct().

Here is the caller graph for this function:

◆ k()

template<class BasicTurbulenceModel>

virtual tmp< volScalarField > k ( ) const

inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< RASModel< BasicTurbulenceModel > >.

Definition at line 227 of file kEpsilon.H.

◆ epsilon()

template<class BasicTurbulenceModel>

virtual tmp< volScalarField > epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 235 of file kEpsilon.H.

◆ correct()

template<class BasicTurbulenceModel>

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 318 of file kEpsilon.C.

References Foam::fvc::absolute(), alpha, Foam::bound(), C1_, C2_, C3_, tmp< T >::clear(), Cmu_, correct(), correctNut(), Foam::fvm::ddt(), DepsilonEff(), Foam::devTwoSymm(), Foam::fvc::div(), Foam::fvm::div(), divU, DkEff(), eddyViscosity< RASModel< BasicTurbulenceModel > >::eddyViscosity(), epsilon_, epsilonSource(), fvOptions, Foam::fvc::grad(), k_, kSource(), Foam::fvm::laplacian(), options::New(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut(), nut, eddyViscosity< RASModel< BasicTurbulenceModel > >::nut_, phi, tmp< T >::ref(), rho, IOobject::scopedName(), solve(), Foam::fvm::Sp(), Foam::fvm::SuSp(), Foam::type(), 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_

template<class BasicTurbulenceModel>

dimensionedScalar Cmu_

protected

Definition at line 126 of file kEpsilon.H.

Referenced by correct(), correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), buoyantKEpsilon< BasicTurbulenceModel >::Gcoef(), kEpsilon(), and read().

◆ C1_

template<class BasicTurbulenceModel>

dimensionedScalar C1_

protected

Definition at line 127 of file kEpsilon.H.

Referenced by correct(), buoyantKEpsilon< BasicTurbulenceModel >::epsilonSource(), and read().

◆ C2_

template<class BasicTurbulenceModel>

dimensionedScalar C2_

protected

Definition at line 128 of file kEpsilon.H.

Referenced by correct(), LaheyKEpsilon< BasicTurbulenceModel >::LaheyKEpsilon(), and read().

◆ C3_

template<class BasicTurbulenceModel>

dimensionedScalar C3_

protected

Definition at line 129 of file kEpsilon.H.

Referenced by correct(), and read().

◆ sigmak_

template<class BasicTurbulenceModel>

dimensionedScalar sigmak_

protected

Definition at line 130 of file kEpsilon.H.

Referenced by read().

◆ sigmaEps_

template<class BasicTurbulenceModel>

dimensionedScalar sigmaEps_

protected

Definition at line 131 of file kEpsilon.H.

Referenced by read().

◆ k_

template<class BasicTurbulenceModel>

volScalarField k_

protected

Definition at line 136 of file kEpsilon.H.

Referenced by correct(), correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::epsilonSource(), buoyantKEpsilon< BasicTurbulenceModel >::Gcoef(), buoyantKEpsilon< BasicTurbulenceModel >::kSource(), continuousGasKEpsilon< BasicTurbulenceModel >::kSource(), kSource(), and LaheyKEpsilon< BasicTurbulenceModel >::kSource().

◆ epsilon_

template<class BasicTurbulenceModel>

volScalarField epsilon_

protected

Definition at line 137 of file kEpsilon.H.

Referenced by correct(), correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), buoyantKEpsilon< BasicTurbulenceModel >::epsilonSource(), continuousGasKEpsilon< BasicTurbulenceModel >::epsilonSource(), epsilonSource(), LaheyKEpsilon< BasicTurbulenceModel >::epsilonSource(), buoyantKEpsilon< BasicTurbulenceModel >::Gcoef(), and kSource().

◆ twoLayerTreatment_

template<class BasicTurbulenceModel>

bool twoLayerTreatment_

protected

Definition at line 142 of file kEpsilon.H.

Referenced by correctNut(), and kSource().

◆ ReyStar_

template<class BasicTurbulenceModel>

dimensionedScalar ReyStar_

protected

Definition at line 143 of file kEpsilon.H.

Referenced by correctNut(), and read().

◆ ReyFactor_

template<class BasicTurbulenceModel>

dimensionedScalar ReyFactor_

protected

Definition at line 144 of file kEpsilon.H.

Referenced by correctNut(), and read().

◆ lEpsPtr_

template<class BasicTurbulenceModel>

std::unique_ptr<volScalarField::Internal> lEpsPtr_

protected

Definition at line 145 of file kEpsilon.H.

Referenced by correctNut(), and kSource().

◆ lambdaEpsPtr_

template<class BasicTurbulenceModel>

std::unique_ptr<volScalarField> lambdaEpsPtr_

protected

Definition at line 146 of file kEpsilon.H.

Referenced by correctNut(), and kSource().

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

src/TurbulenceModels/turbulenceModels/RAS/kEpsilon/kEpsilon.H
src/TurbulenceModels/turbulenceModels/RAS/kEpsilon/kEpsilon.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ kEpsilon()

◆ ~kEpsilon()

Member Function Documentation

◆ correctNut()

◆ kSource()

◆ epsilonSource()

◆ TypeName()

◆ read()

◆ DkEff()

◆ DepsilonEff()

◆ k()

◆ epsilon()

◆ correct()

Member Data Documentation

◆ Cmu_

◆ C1_

◆ C2_

◆ C3_

◆ sigmak_

◆ sigmaEps_

◆ k_

◆ epsilon_

◆ twoLayerTreatment_

◆ ReyStar_

◆ ReyFactor_

◆ lEpsPtr_

◆ lambdaEpsPtr_