Loading...
Searching...
No Matches
kEqn< BasicTurbulenceModel > Class Template Reference
Turbulence models » LES turbulence

One equation eddy-viscosity model. More...

#include <kEqn.H>

Inheritance diagram for kEqn< BasicTurbulenceModel >:
Inheritance graph
[legend]
Collaboration diagram for kEqn< BasicTurbulenceModel >:
Collaboration graph
[legend]

Public Types

typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel
Public Types inherited from LESeddyViscosity< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel
Public Types inherited from eddyViscosity< LESModel< 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 ("kEqn")
 Runtime type information.
 kEqn (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)
 Constructor from components.
virtual ~kEqn ()=default
 Destructor.
virtual bool read ()
 Read model coefficients if they have changed.
virtual tmp< volScalarField > k () const
 Return SGS kinetic energy.
tmp< volScalarField > DkEff () const
 Return the effective diffusivity for k.
virtual void correct ()
 Correct eddy-Viscosity and related properties.
Public Member Functions inherited from LESeddyViscosity< BasicTurbulenceModel >
 LESeddyViscosity (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Construct from components.
virtual ~LESeddyViscosity ()=default
 Destructor.
Public Member Functions inherited from eddyViscosity< LESModel< 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

 kEqn (const kEqn &)=delete
 No copy construct.
void operator= (const kEqn &)=delete
 No copy assignment.
virtual void correctNut ()
virtual tmp< fvScalarMatrix > kSource () const

Protected Attributes

volScalarField k_
dimensionedScalar Ck_
Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField nut_

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModels::kEqn< BasicTurbulenceModel >

One equation eddy-viscosity model.

Eddy viscosity SGS model using a modeled balance equation to simulate the behaviour of k.

Reference: 

    Yoshizawa, A. (1986).
    Statistical theory for compressible turbulent shear flows,
    with the application to subgrid modeling.
    Physics of Fluids (1958-1988), 29(7), 2152-2164.

The default model coefficients are 

    kEqnCoeffs
    {
        Ck                  0.094;
        Ce                  1.048;
    }
Source files

Definition at line 73 of file kEqn.H.

Member Typedef Documentation

◆ alphaField

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 110 of file kEqn.H.

◆ rhoField

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 111 of file kEqn.H.

◆ transportModel

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 112 of file kEqn.H.

Constructor & Destructor Documentation

◆ kEqn() [1/2]

template<class BasicTurbulenceModel>
kEqn ( const kEqn< BasicTurbulenceModel > & )
protecteddelete

No copy construct.

Referenced by continuousGasKEqn< BasicTurbulenceModel >::continuousGasKEqn(), correct(), and NicenoKEqn< BasicTurbulenceModel >::NicenoKEqn().

Here is the caller graph for this function:

◆ kEqn() [2/2]

template<class BasicTurbulenceModel>
kEqn ( 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 )

Constructor from components.

Definition at line 59 of file kEqn.C.

References alpha, Foam::bound(), Ck_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, k_, phi, rho, timeName, and U.

Here is the call graph for this function:

◆ ~kEqn()

template<class BasicTurbulenceModel>
virtual ~kEqn ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

template<class BasicTurbulenceModel>
void operator= ( const kEqn< BasicTurbulenceModel > & )
protecteddelete

No copy assignment.

◆ correctNut()

template<class BasicTurbulenceModel>
void correctNut ( )
protectedvirtual

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Reimplemented in NicenoKEqn< BasicTurbulenceModel >.

Definition at line 35 of file kEqn.C.

References Ck_, optionList::correct(), delta, k_, options::New(), eddyViscosity< LESModel< BasicTurbulenceModel > >::nut_, and Foam::sqrt().

Referenced by correct().

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 continuousGasKEqn< BasicTurbulenceModel >, and NicenoKEqn< BasicTurbulenceModel >.

Definition at line 46 of file kEqn.C.

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

Referenced by correct().

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

◆ TypeName()

template<class BasicTurbulenceModel>
TypeName ( "kEqn< BasicTurbulenceModel >" )

Runtime type information.

◆ read()

template<class BasicTurbulenceModel>
bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Reimplemented in continuousGasKEqn< BasicTurbulenceModel >, and NicenoKEqn< BasicTurbulenceModel >.

Definition at line 118 of file kEqn.C.

References Ck_, and LESeddyViscosity< BasicTurbulenceModel >::read().

Referenced by continuousGasKEqn< BasicTurbulenceModel >::read(), and NicenoKEqn< BasicTurbulenceModel >::read().

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

◆ k()

template<class BasicTurbulenceModel>
virtual tmp< volScalarField > k ( ) const
inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 155 of file kEqn.H.

◆ DkEff()

template<class BasicTurbulenceModel>
tmp< volScalarField > DkEff ( ) const
inline

Return the effective diffusivity for k.

Definition at line 163 of file kEqn.H.

Referenced by correct().

Here is the caller graph for this function:

◆ correct()

template<class BasicTurbulenceModel>
void correct ( )
virtual

Correct eddy-Viscosity and related properties.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 132 of file kEqn.C.

References Foam::fvc::absolute(), alpha, Foam::bound(), tmp< T >::clear(), linearViscousStress< BasicTurbulenceModel >::correct(), correctNut(), Foam::fvm::ddt(), delta, Foam::devTwoSymm(), Foam::fvc::div(), Foam::fvm::div(), divU, DkEff(), fvOptions, Foam::fvc::grad(), k_, kEqn(), kSource(), Foam::fvm::laplacian(), options::New(), eddyViscosity< LESModel< BasicTurbulenceModel > >::nut(), eddyViscosity< LESModel< BasicTurbulenceModel > >::nut_, phi, rho, solve(), Foam::fvm::Sp(), Foam::sqrt(), Foam::fvm::SuSp(), and U.

Here is the call graph for this function:

Member Data Documentation

◆ k_

template<class BasicTurbulenceModel>
volScalarField k_
protected

Definition at line 83 of file kEqn.H.

Referenced by correct(), correctNut(), NicenoKEqn< BasicTurbulenceModel >::correctNut(), kEqn(), continuousGasKEqn< BasicTurbulenceModel >::kSource(), kSource(), and NicenoKEqn< BasicTurbulenceModel >::kSource().

◆ Ck_

template<class BasicTurbulenceModel>
dimensionedScalar Ck_
protected

Definition at line 88 of file kEqn.H.

Referenced by correctNut(), NicenoKEqn< BasicTurbulenceModel >::correctNut(), kEqn(), NicenoKEqn< BasicTurbulenceModel >::NicenoKEqn(), and read().

The documentation for this class was generated from the following files:
  • src/TurbulenceModels/turbulenceModels/LES/kEqn/kEqn.H
  • src/TurbulenceModels/turbulenceModels/LES/kEqn/kEqn.C