Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
kEqn< BasicTurbulenceModel > Class Template Reference

One equation eddy-viscosity model. More...

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 LESModel< BasicTurbulenceModel >::alphaField alphaField
 
typedef LESModel< BasicTurbulenceModel >::rhoField rhoField
 
typedef LESModel< BasicTurbulenceModel >::transportModel transportModel
 
- Public Types inherited from linearViscousStress< LESModel< BasicTurbulenceModel > >
typedef LESModel< BasicTurbulenceModel >::alphaField alphaField
 
typedef LESModel< BasicTurbulenceModel >::rhoField rhoField
 
typedef LESModel< BasicTurbulenceModel >::transportModel transportModel
 
- Public Types inherited from LESModel< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 

Public Member Functions

 TypeName ("kEqn")
 Runtime type information. More...
 
 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. More...
 
virtual ~kEqn ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
virtual tmp< volScalarFieldk () const
 Return SGS kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return sub-grid disipation rate. More...
 
tmp< volScalarFieldDkEff () const
 Return the effective diffusivity for k. More...
 
virtual void correct ()
 Correct eddy-Viscosity and related properties. More...
 
- 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. More...
 
virtual ~LESeddyViscosity ()
 Destructor. More...
 
- 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. More...
 
virtual ~eddyViscosity ()
 Destructor. More...
 
volScalarFieldevNut ()
 Return non-const access to the turbulence viscosity. 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< volSymmTensorFieldR () const
 Return the Reynolds stress tensor. More...
 
- Public Member Functions inherited from linearViscousStress< LESModel< 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 ()
 Destructor. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. 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...
 
- Public Member Functions inherited from LESModel< BasicTurbulenceModel >
 TypeName ("LES")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LESModel, dictionary,( const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName ),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))
 
 LESModel (const word &type, 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 ~LESModel ()
 Destructor. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
const dimensionedScalarkMin () const
 Return the lower allowable limit for k (default: SMALL) More...
 
dimensionedScalarkMin ()
 Allow kMin to be changed. More...
 
const volScalarFielddelta () const
 Access function to filter width. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 

Protected Member Functions

virtual void correctNut ()
 
virtual tmp< fvScalarMatrixkSource () const
 
- Protected Member Functions inherited from LESModel< BasicTurbulenceModel >
virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 

Protected Attributes

volScalarField k_
 
dimensionedScalar Ck_
 
- Protected Attributes inherited from LESeddyViscosity< BasicTurbulenceModel >
dimensionedScalar Ce_
 
- Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField nut_
 
- Protected Attributes inherited from LESModel< BasicTurbulenceModel >
dictionary LESDict_
 LES coefficients dictionary. More...
 
Switch turbulence_
 Turbulence on/off flag. More...
 
Switch printCoeffs_
 Flag to print the model coeffs at run-time. More...
 
dictionary coeffDict_
 Model coefficients dictionary. More...
 
dimensionedScalar kMin_
 Lower limit of k. More...
 
autoPtr< Foam::LESdeltadelta_
 Run-time selectable delta model. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LESModel< BasicTurbulenceModel >
static autoPtr< LESModelNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Return a reference to the selected LES model. More...
 

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 74 of file kEqn.H.

Member Typedef Documentation

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 107 of file kEqn.H.

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 108 of file kEqn.H.

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 109 of file kEqn.H.

Constructor & Destructor Documentation

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 66 of file kEqn.C.

References Foam::bound().

Here is the call graph for this function:

virtual ~kEqn ( )
inlinevirtual

Destructor.

Definition at line 133 of file kEqn.H.

References kEqn< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Function Documentation

void correctNut ( )
protectedvirtual

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Reimplemented in NicenoKEqn< BasicTurbulenceModel >.

Definition at line 38 of file kEqn.C.

References delta, and Foam::sqrt().

Referenced by continuousGasKEqn< BasicTurbulenceModel >::continuousGasKEqn().

Here is the call graph for this function:

Here is the caller graph for this function:

tmp< fvScalarMatrix > kSource ( ) const
protectedvirtual

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

Definition at line 48 of file kEqn.C.

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

TypeName ( "kEqn< BasicTurbulenceModel >"  )

Runtime type information.

bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

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

Definition at line 125 of file kEqn.C.

Referenced by kEqn< BasicTurbulenceModel >::~kEqn().

Here is the caller graph for this function:

virtual tmp<volScalarField> k ( ) const
inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 143 of file kEqn.H.

References kEqn< BasicTurbulenceModel >::epsilon(), and kEqn< BasicTurbulenceModel >::k_.

Here is the call graph for this function:

tmp< volScalarField > epsilon ( ) const
virtual

Return sub-grid disipation rate.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Definition at line 141 of file kEqn.C.

References delta, IOobject::groupName(), k, IOobject::NO_READ, IOobject::NO_WRITE, and Foam::sqrt().

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

Here is the call graph for this function:

Here is the caller graph for this function:

tmp<volScalarField> DkEff ( ) const
inline

Return the effective diffusivity for k.

Definition at line 152 of file kEqn.H.

References kEqn< BasicTurbulenceModel >::correct(), nu, and eddyViscosity< LESModel< BasicTurbulenceModel > >::nut_.

Here is the call graph for this function:

void correct ( )
virtual

Member Data Documentation

volScalarField k_
protected

Definition at line 91 of file kEqn.H.

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

dimensionedScalar Ck_
protected

Definition at line 96 of file kEqn.H.


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