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

Eddy viscosity turbulence model base class. More...

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

Public Types

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

 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 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< volSymmTensorField > R () const
 Return the Reynolds stress tensor [m^2/s^2]. More...
 
virtual tmp< volScalarField > k () const =0
 Return the turbulence kinetic energy. 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< 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< surfaceVectorField > devTau () const
 Return the effective surface stress. More...
 
virtual tmp< fvVectorMatrix > divDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrix > divDevTau (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
template<class RhoFieldType >
Foam::tmp< Foam::fvVectorMatrix > DivDevTau (const RhoFieldType &rho, volVectorField &U) const
 

Protected Member Functions

virtual void correctNut ()=0
 
- Protected Member Functions inherited from linearViscousStress< BasicMomentumTransportModel >
template<class RhoFieldType >
tmp< fvVectorMatrix > DivDevTau (const RhoFieldType &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 

Protected Attributes

volScalarField nut_
 

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::eddyViscosity< BasicMomentumTransportModel >

Eddy viscosity turbulence model base class.

Source files

Definition at line 49 of file eddyViscosity.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 70 of file eddyViscosity.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 71 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 viscosity &  viscosity 
)

Construct from components.

Definition at line 34 of file eddyViscosity.C.

◆ ~eddyViscosity()

virtual ~eddyViscosity ( )
inlinevirtual

Destructor.

Definition at line 90 of file eddyViscosity.H.

Member Function Documentation

◆ correctNut()

virtual void correctNut ( )
protectedpure virtual

Implemented in mixtureKEpsilon< BasicMomentumTransportModel >, LaheyKEpsilon< BasicMomentumTransportModel >, continuousGasKEpsilon< BasicMomentumTransportModel >, SmagorinskyZhang< BasicMomentumTransportModel >, NicenoKEqn< BasicMomentumTransportModel >, v2f< BasicMomentumTransportModel >, SpalartAllmaras< BasicMomentumTransportModel >, RNGkEpsilon< BasicMomentumTransportModel >, realizableKE< BasicMomentumTransportModel >, LaunderSharmaKE< BasicMomentumTransportModel >, kOmega2006< BasicMomentumTransportModel >, kOmega< BasicMomentumTransportModel >, kEpsilon< BasicMomentumTransportModel >, kEpsilon< compressible::momentumTransportModel >, WALE< BasicMomentumTransportModel >, SpalartAllmarasDES< BasicMomentumTransportModel >, Smagorinsky< BasicMomentumTransportModel >, kEqn< BasicMomentumTransportModel >, dynamicLagrangian< BasicMomentumTransportModel >, dynamicKEqn< BasicMomentumTransportModel >, kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, and kEpsilonLopesdaCosta< BasicMomentumTransportModel >.

◆ read()

bool read
pure virtual

Re-read model coefficients if they have changed.

Implements linearViscousStress< BasicMomentumTransportModel >.

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

Definition at line 74 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 100 of file eddyViscosity.H.

References eddyViscosity< BasicMomentumTransportModel >::nut_.

◆ nut() [2/2]

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

Return the turbulence viscosity on patch.

Definition at line 106 of file eddyViscosity.H.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), eddyViscosity< BasicMomentumTransportModel >::nut_, and patchi.

Here is the call graph for this function:

◆ R()

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

Return the Reynolds stress tensor [m^2/s^2].

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

Definition at line 82 of file eddyViscosity.C.

References Foam::dev(), Foam::fvc::grad(), Foam::I, k, GeometricField< Type, GeoMesh, PrimitiveField >::New(), and Foam::twoSymm().

Here is the call graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const
pure virtual

Return the turbulence kinetic energy.

Implemented in mixtureKEpsilon< BasicMomentumTransportModel >, v2f< BasicMomentumTransportModel >, SpalartAllmaras< BasicMomentumTransportModel >, RNGkEpsilon< BasicMomentumTransportModel >, realizableKE< BasicMomentumTransportModel >, LaunderSharmaKE< BasicMomentumTransportModel >, kOmega2006< BasicMomentumTransportModel >, kOmega< BasicMomentumTransportModel >, kEpsilon< BasicMomentumTransportModel >, kEpsilon< compressible::momentumTransportModel >, WALE< BasicMomentumTransportModel >, SpalartAllmarasDES< BasicMomentumTransportModel >, Smagorinsky< BasicMomentumTransportModel >, kEqn< BasicMomentumTransportModel >, dynamicLagrangian< BasicMomentumTransportModel >, dynamicKEqn< BasicMomentumTransportModel >, kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, kEpsilonLopesdaCosta< BasicMomentumTransportModel >, phasePressureModel, and kineticTheoryModel.

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

◆ correct()

void correct
pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements linearViscousStress< BasicMomentumTransportModel >.

Implemented in mixtureKEpsilon< BasicMomentumTransportModel >, LaheyKEpsilon< BasicMomentumTransportModel >, kOmegaSSTSato< BasicMomentumTransportModel >, v2f< BasicMomentumTransportModel >, SpalartAllmaras< BasicMomentumTransportModel >, RNGkEpsilon< BasicMomentumTransportModel >, realizableKE< BasicMomentumTransportModel >, LaunderSharmaKE< BasicMomentumTransportModel >, kOmegaSSTLM< BasicMomentumTransportModel >, kOmega2006< BasicMomentumTransportModel >, kOmega< BasicMomentumTransportModel >, kEpsilon< BasicMomentumTransportModel >, kEpsilon< compressible::momentumTransportModel >, WALE< BasicMomentumTransportModel >, SpalartAllmarasDES< BasicMomentumTransportModel >, Smagorinsky< BasicMomentumTransportModel >, kEqn< BasicMomentumTransportModel >, dynamicLagrangian< BasicMomentumTransportModel >, dynamicKEqn< BasicMomentumTransportModel >, kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >, ShihQuadraticKE, qZeta, LienLeschziner, LienCubicKE, LamBremhorstKE, kkLOmega, kEpsilonLopesdaCosta< BasicMomentumTransportModel >, phasePressureModel, kineticTheoryModel, and PDRkEpsilon.

Definition at line 100 of file eddyViscosity.C.

References Foam::MULES::correct().

Referenced by makeMomentumTransportModelTypes().

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

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

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