kEqn< BasicMomentumTransportModel > Class Template Reference

One equation eddy-viscosity model. More...

Inheritance diagram for kEqn< BasicMomentumTransportModel >:
Collaboration diagram for kEqn< BasicMomentumTransportModel >:

Public Types

typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
- Public Types inherited from LESeddyViscosity< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
- Public Types inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
- Public Types inherited from linearViscousStress< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 

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 viscosity &viscosity, const word &type=typeName)
 Constructor from components. More...
 
 kEqn (const kEqn &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const kEqn &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from LESeddyViscosity< BasicMomentumTransportModel >
 LESeddyViscosity (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
 LESeddyViscosity (const LESeddyViscosity &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~LESeddyViscosity ()
 Destructor. More...
 
virtual tmp< volScalarFieldomega () const
 Return the turbulence specific dissipation rate. More...
 
void operator= (const LESeddyViscosity &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
 eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
virtual ~eddyViscosity ()
 Destructor. 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< volSymmTensorFieldsigma () const
 Return the Reynolds stress tensor [m^2/s^2]. More...
 
virtual void validate ()
 Validate the turbulence fields after construction. More...
 
- Public Member Functions inherited from linearViscousStress< BasicMomentumTransportModel >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
virtual ~linearViscousStress ()
 Destructor. More...
 
virtual tmp< volSymmTensorFielddevTau () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrixdivDevTau (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 

Protected Member Functions

virtual void correctNut ()
 
virtual tmp< fvScalarMatrixkSource () const
 

Protected Attributes

volScalarField k_
 
dimensionedScalar Ck_
 
- Protected Attributes inherited from LESeddyViscosity< BasicMomentumTransportModel >
dimensionedScalar Ck_
 
dimensionedScalar Ce_
 
- Protected Attributes inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
volScalarField nut_
 

Detailed Description

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

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

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 97 of file kEqn.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 98 of file kEqn.H.

Constructor & Destructor Documentation

◆ kEqn() [1/2]

kEqn ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const viscosity viscosity,
const word type = typeName 
)

Constructor from components.

Definition at line 66 of file kEqn.C.

References Foam::bound(), kEqn< BasicMomentumTransportModel >::k_, and Foam::type().

Here is the call graph for this function:

◆ kEqn() [2/2]

kEqn ( const kEqn< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise copy construction.

◆ ~kEqn()

virtual ~kEqn ( )
inlinevirtual

Destructor.

Definition at line 124 of file kEqn.H.

Member Function Documentation

◆ correctNut()

void correctNut
protectedvirtual

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Reimplemented in NicenoKEqn< BasicMomentumTransportModel >.

Definition at line 40 of file kEqn.C.

References delta, dictionary::New(), and Foam::sqrt().

Here is the call graph for this function:

◆ kSource()

tmp< fvScalarMatrix > kSource
protectedvirtual

◆ TypeName()

TypeName ( "kEqn< BasicMomentumTransportModel >"  )

Runtime type information.

◆ read()

bool read
virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicMomentumTransportModel >.

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

Definition at line 123 of file kEqn.C.

◆ k()

virtual tmp<volScalarField> k ( ) const
inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 134 of file kEqn.H.

References kEqn< BasicMomentumTransportModel >::k_.

◆ epsilon()

tmp< volScalarField > epsilon
virtual

Return sub-grid disipation rate.

Reimplemented from LESeddyViscosity< BasicMomentumTransportModel >.

Definition at line 139 of file kEqn.C.

References delta, k, GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqrt().

Here is the call graph for this function:

◆ DkEff()

tmp<volScalarField> DkEff ( ) const
inline

Return the effective diffusivity for k.

Definition at line 143 of file kEqn.H.

References GeometricField< Type, PatchField, GeoMesh >::New(), and eddyViscosity< LESModel< BasicMomentumTransportModel > >::nut_.

Here is the call graph for this function:

◆ correct()

◆ operator=()

void operator= ( const kEqn< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ k_

◆ Ck_

dimensionedScalar Ck_
protected

Definition at line 86 of file kEqn.H.


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