eddyViscosity< BasicTurbulenceModel > Class Template Referenceabstract

Eddy viscosity turbulence model base class. More...

Inheritance diagram for eddyViscosity< BasicTurbulenceModel >:
[legend]
Collaboration diagram for eddyViscosity< BasicTurbulenceModel >:
[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< volScalarFieldnut () const
 Return the turbulence viscosity. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const =0
 Return the turbulence kinetic energy. More...
 
virtual tmp< volSymmTensorFieldR () 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< 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...
 

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 55 of file eddyViscosity.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 76 of file eddyViscosity.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 77 of file eddyViscosity.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 78 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 36 of file eddyViscosity.C.

◆ ~eddyViscosity()

virtual ~eddyViscosity ( )
virtualdefault

Destructor.

Member Function Documentation

◆ correctNut()

◆ read()

bool read ( )
pure virtual

Re-read model coefficients if they have changed.

Implements linearViscousStress< BasicTurbulenceModel >.

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

Definition at line 77 of file eddyViscosity.C.

◆ nut() [1/2]

virtual tmp<volScalarField> nut ( ) const
inlinevirtual

Return the turbulence viscosity.

Definition at line 107 of file eddyViscosity.H.

◆ nut() [2/2]

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

Return the turbulence viscosity on patch.

Definition at line 113 of file eddyViscosity.H.

◆ k()

◆ R()

◆ 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 127 of file eddyViscosity.C.

◆ correct()

void correct ( )
pure virtual

Member Data Documentation

◆ nut_

volScalarField nut_
protected

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