Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
eddyViscosity< BasicTurbulenceModel > Class Template Referenceabstract
Turbulence models

Eddy viscosity turbulence model base class. More...

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

Public Types

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

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

Protected Member Functions

virtual void correctNut ()=0
 

Protected Attributes

volScalarField nut_
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::eddyViscosity< BasicTurbulenceModel >

Eddy viscosity turbulence model base class.

Source files

Definition at line 51 of file eddyViscosity.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 72 of file eddyViscosity.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 73 of file eddyViscosity.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 74 of file eddyViscosity.H.

Constructor & Destructor Documentation

◆ eddyViscosity()

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.

Definition at line 29 of file eddyViscosity.C.

◆ ~eddyViscosity()

virtual ~eddyViscosity ( )
virtualdefault

Destructor.

Member Function Documentation

◆ correctNut()

virtual void correctNut ( )
protectedpure virtual

Implemented in SpalartAllmaras< BasicTurbulenceModel >, RNGkEpsilon< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, kOmegaSST< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, kEpsilonPhitF< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, WALE< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, sigma< BasicTurbulenceModel >, kEqn< BasicTurbulenceModel >, dynamicLagrangian< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, mixtureKEpsilon< BasicTurbulenceModel >, LaheyKEpsilon< BasicTurbulenceModel >, continuousGasKEpsilon< BasicTurbulenceModel >, SmagorinskyZhang< BasicTurbulenceModel >, NicenoKEqn< BasicTurbulenceModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, kL< BasicTurbulenceModel >, and kEpsilonLopesdaCosta< BasicTurbulenceModel >.

◆ read()

bool read
pure virtual

Re-read model coefficients if they have changed.

Implements linearViscousStress< BasicTurbulenceModel >.

Implemented in RNGkEpsilon< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, kOmegaSSTSAS< BasicTurbulenceModel >, kOmegaSSTLM< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, kEpsilonPhitF< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, WALE< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, sigma< BasicTurbulenceModel >, LESeddyViscosity< BasicTurbulenceModel >, kEqn< BasicTurbulenceModel >, dynamicLagrangian< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, DESModel< BasicTurbulenceModel >, SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, mixtureKEpsilon< BasicTurbulenceModel >, LaheyKEpsilon< BasicTurbulenceModel >, kOmegaSSTSato< BasicTurbulenceModel >, continuousGasKEpsilon< BasicTurbulenceModel >, SmagorinskyZhang< BasicTurbulenceModel >, NicenoKEqn< BasicTurbulenceModel >, continuousGasKEqn< BasicTurbulenceModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, buoyantKEpsilon< BasicTurbulenceModel >, phasePressureModel, kineticTheoryModel, phasePressureModel, kineticTheoryModel, kL< BasicTurbulenceModel >, kEpsilonLopesdaCosta< BasicTurbulenceModel >, and PDRkEpsilon.

Definition at line 72 of file eddyViscosity.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ nut() [1/2]

virtual tmp<volScalarField> nut ( ) const
inlinevirtual

Return the turbulence viscosity.

Definition at line 111 of file eddyViscosity.H.

References eddyViscosity< BasicTurbulenceModel >::nut_.

◆ nut() [2/2]

virtual tmp<scalarField> nut ( const label  patchi) const
inlinevirtual

Return the turbulence viscosity on patch.

Definition at line 119 of file eddyViscosity.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and eddyViscosity< BasicTurbulenceModel >::nut_.

Here is the call graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const
pure virtual

Return the turbulence kinetic energy.

Implemented in RNGkEpsilon< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, kEpsilonPhitF< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, WALE< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, sigma< BasicTurbulenceModel >, kEqn< BasicTurbulenceModel >, dynamicLagrangian< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, mixtureKEpsilon< BasicTurbulenceModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, phasePressureModel, kineticTheoryModel, phasePressureModel, kineticTheoryModel, kL< BasicTurbulenceModel >, and kEpsilonLopesdaCosta< BasicTurbulenceModel >.

◆ R()

Foam::tmp< Foam::volSymmTensorField > R
virtual

Return the Reynolds stress tensor.

Reimplemented in nonlinearEddyViscosity< BasicTurbulenceModel >, nonlinearEddyViscosity< incompressible::RASModel >, continuousGasKEpsilon< BasicTurbulenceModel >, phasePressureModel, kineticTheoryModel, phasePressureModel, and kineticTheoryModel.

Definition at line 80 of file eddyViscosity.C.

◆ validate()

void validate
virtual

Validate the turbulence fields after construction.

Update turbulence viscosity and other derived fields as requires

Reimplemented in kkLOmega.

Definition at line 112 of file eddyViscosity.C.

◆ correct()

void correct
pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements linearViscousStress< BasicTurbulenceModel >.

Implemented in RNGkEpsilon< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, kOmegaSSTLM< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, kEpsilonPhitF< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, WALE< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, sigma< BasicTurbulenceModel >, kEqn< BasicTurbulenceModel >, dynamicLagrangian< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, mixtureKEpsilon< BasicTurbulenceModel >, LaheyKEpsilon< BasicTurbulenceModel >, kOmegaSSTSato< BasicTurbulenceModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, phasePressureModel, kineticTheoryModel, phasePressureModel, kineticTheoryModel, kL< BasicTurbulenceModel >, kEpsilonLopesdaCosta< BasicTurbulenceModel >, and PDRkEpsilon.

Definition at line 119 of file eddyViscosity.C.

References correct().

Referenced by kkLOmega::correct(), LamBremhorstKE::correct(), LienCubicKE::correct(), LienLeschziner::correct(), qZeta::correct(), and ShihQuadraticKE::correct().

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

Member Data Documentation

◆ nut_

volScalarField nut_
protected

Definition at line 62 of file eddyViscosity.H.

Referenced by mixtureKEpsilon< BasicTurbulenceModel >::correct(), and eddyViscosity< BasicTurbulenceModel >::nut().

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