LienCubicKE Class Reference

Lien cubic non-linear low-Reynolds k-epsilon turbulence models for incompressible flows. More...

Inheritance diagram for LienCubicKE:
Collaboration diagram for LienCubicKE:

Public Member Functions

 TypeName ("LienCubicKE")
 Runtime type information. More...
 
 LienCubicKE (const geometricOneField &alpha, const geometricOneField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity, const word &type=typeName)
 Construct from components. More...
 
virtual ~LienCubicKE ()
 Destructor. More...
 
virtual bool read ()
 Read RASProperties dictionary. 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 tmp< volScalarFieldomega () const
 Return the turbulence specific dissipation rate. More...
 
virtual void correct ()
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
- Public Member Functions inherited from nonlinearEddyViscosity< incompressible::RASModel >
 nonlinearEddyViscosity (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 ~nonlinearEddyViscosity ()
 Destructor. More...
 
virtual tmp< volSymmTensorFieldsigma () const
 Return the Reynolds stress tensor [m^2/s^2]. 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...
 
- Public Member Functions inherited from eddyViscosity< incompressible::RASModel >
 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 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...
 

Protected Member Functions

tmp< volScalarFieldfMu () const
 
tmp< volScalarFieldf2 () const
 
tmp< volScalarFieldE (const volScalarField &f2) const
 
tmp< volScalarFieldboundEpsilon ()
 Bound epsilon and return Cmu*sqr(k) for nut. More...
 
virtual void correctNut ()
 Correct the eddy-viscosity nut. More...
 
virtual void correctNonlinearStress (const volTensorField &gradU)
 

Protected Attributes

dimensionedScalar Ceps1_
 
dimensionedScalar Ceps2_
 
dimensionedScalar sigmak_
 
dimensionedScalar sigmaEps_
 
dimensionedScalar Cmu1_
 
dimensionedScalar Cmu2_
 
dimensionedScalar Cbeta_
 
dimensionedScalar Cbeta1_
 
dimensionedScalar Cbeta2_
 
dimensionedScalar Cbeta3_
 
dimensionedScalar Cgamma1_
 
dimensionedScalar Cgamma2_
 
dimensionedScalar Cgamma4_
 
dimensionedScalar Cmu_
 
dimensionedScalar kappa_
 
dimensionedScalar Anu_
 
dimensionedScalar AE_
 
volScalarField k_
 
volScalarField epsilon_
 
- Protected Attributes inherited from nonlinearEddyViscosity< incompressible::RASModel >
volSymmTensorField nonlinearStress_
 
- Protected Attributes inherited from eddyViscosity< incompressible::RASModel >
volScalarField nut_
 

Additional Inherited Members

- Public Types inherited from nonlinearEddyViscosity< incompressible::RASModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
- Public Types inherited from eddyViscosity< incompressible::RASModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
- Public Types inherited from linearViscousStress< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 

Detailed Description

Lien cubic non-linear low-Reynolds k-epsilon turbulence models for incompressible flows.

This turbulence model is described in:

    Lien, F.S., Chen, W.L. & Leschziner, M.A. (1996).
    Low-Reynolds-number eddy-viscosity modeling based on non-linear
    stress-strain/vorticity relations.
    Engineering Turbulence Modelling and Experiments 3, 91-100.

Implemented according to the specification in: Apsley: Turbulence Models 2002

In addition to the low-Reynolds number damping functions support for wall-functions is also included to allow for low- and high-Reynolds number operation.

See also
Foam::incompressible::RASModels::ShihQuadraticKE
Source files

Definition at line 74 of file LienCubicKE.H.

Constructor & Destructor Documentation

◆ LienCubicKE()

LienCubicKE ( const geometricOneField alpha,
const geometricOneField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const viscosity viscosity,
const word type = typeName 
)

Construct from components.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ ~LienCubicKE()

virtual ~LienCubicKE ( )
inlinevirtual

Destructor.

Definition at line 148 of file LienCubicKE.H.

Member Function Documentation

◆ fMu()

tmp<volScalarField> fMu ( ) const
protected

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ f2()

tmp<volScalarField> f2 ( ) const
protected

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ E()

tmp<volScalarField> E ( const volScalarField f2) const
protected

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ boundEpsilon()

tmp<volScalarField> boundEpsilon ( )
protected

Bound epsilon and return Cmu*sqr(k) for nut.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ correctNut()

virtual void correctNut ( )
protectedvirtual

Correct the eddy-viscosity nut.

Implements eddyViscosity< incompressible::RASModel >.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ correctNonlinearStress()

virtual void correctNonlinearStress ( const volTensorField gradU)
protectedvirtual

Implements nonlinearEddyViscosity< incompressible::RASModel >.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "LienCubicKE"  )

Runtime type information.

◆ read()

virtual bool read ( )
virtual

Read RASProperties dictionary.

Implements eddyViscosity< incompressible::RASModel >.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

◆ DkEff()

tmp<volScalarField> DkEff ( ) const
inline

Return the effective diffusivity for k.

Definition at line 158 of file LienCubicKE.H.

References GeometricField< Type, PatchField, GeoMesh >::New(), eddyViscosity< incompressible::RASModel >::nut_, and LienCubicKE::sigmak_.

Referenced by makeMomentumTransportModelTypes().

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

◆ DepsilonEff()

tmp<volScalarField> DepsilonEff ( ) const
inline

Return the effective diffusivity for epsilon.

Definition at line 168 of file LienCubicKE.H.

References GeometricField< Type, PatchField, GeoMesh >::New(), eddyViscosity< incompressible::RASModel >::nut_, and LienCubicKE::sigmaEps_.

Referenced by makeMomentumTransportModelTypes().

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

◆ k()

virtual tmp<volScalarField> k ( ) const
inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< incompressible::RASModel >.

Definition at line 178 of file LienCubicKE.H.

References LienCubicKE::k_.

◆ epsilon()

virtual tmp<volScalarField> epsilon ( ) const
inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 184 of file LienCubicKE.H.

References LienCubicKE::epsilon_.

◆ omega()

virtual tmp<volScalarField> omega ( ) const
inlinevirtual

Return the turbulence specific dissipation rate.

Definition at line 190 of file LienCubicKE.H.

References LienCubicKE::Cmu_, LienCubicKE::epsilon_, LienCubicKE::k_, and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ correct()

virtual void correct ( )
virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements eddyViscosity< incompressible::RASModel >.

Referenced by makeMomentumTransportModelTypes().

Here is the caller graph for this function:

Member Data Documentation

◆ Ceps1_

dimensionedScalar Ceps1_
protected

Definition at line 85 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Ceps2_

dimensionedScalar Ceps2_
protected

Definition at line 86 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ sigmak_

dimensionedScalar sigmak_
protected

Definition at line 87 of file LienCubicKE.H.

Referenced by LienCubicKE::DkEff(), and makeMomentumTransportModelTypes().

◆ sigmaEps_

dimensionedScalar sigmaEps_
protected

Definition at line 88 of file LienCubicKE.H.

Referenced by LienCubicKE::DepsilonEff(), and makeMomentumTransportModelTypes().

◆ Cmu1_

dimensionedScalar Cmu1_
protected

Definition at line 89 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cmu2_

dimensionedScalar Cmu2_
protected

Definition at line 90 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cbeta_

dimensionedScalar Cbeta_
protected

Definition at line 91 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cbeta1_

dimensionedScalar Cbeta1_
protected

Definition at line 92 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cbeta2_

dimensionedScalar Cbeta2_
protected

Definition at line 93 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cbeta3_

dimensionedScalar Cbeta3_
protected

Definition at line 94 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cgamma1_

dimensionedScalar Cgamma1_
protected

Definition at line 95 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cgamma2_

dimensionedScalar Cgamma2_
protected

Definition at line 96 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cgamma4_

dimensionedScalar Cgamma4_
protected

Definition at line 97 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Cmu_

dimensionedScalar Cmu_
protected

Definition at line 99 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes(), and LienCubicKE::omega().

◆ kappa_

dimensionedScalar kappa_
protected

Definition at line 100 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ Anu_

dimensionedScalar Anu_
protected

Definition at line 102 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ AE_

dimensionedScalar AE_
protected

Definition at line 103 of file LienCubicKE.H.

Referenced by makeMomentumTransportModelTypes().

◆ k_

volScalarField k_
protected

◆ epsilon_

volScalarField epsilon_
protected

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