FreeFOAM The Cross-Platform CFD Toolkit
turbulenceModel Class Reference

Abstract base class for compressible turbulence models (RAS, LES and laminar). More...

#include <compressibleTurbulenceModel/turbulenceModel.H>


Detailed Description

Abstract base class for compressible turbulence models (RAS, LES and laminar).

Source files

Definition at line 69 of file turbulenceModel.H.

+ Inheritance diagram for turbulenceModel:
+ Collaboration diagram for turbulenceModel:

List of all members.

Public Member Functions

 TypeName ("turbulenceModel")
 Runtime type information.
 declareRunTimeNewSelectionTable (autoPtr, turbulenceModel, turbulenceModel,(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel),(rho, U, phi, thermoPhysicalModel))
 turbulenceModel (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel)
 Construct from components.
virtual ~turbulenceModel ()
 Destructor.
const volScalarFieldrho () const
 Access function to density field.
const volVectorFieldU () const
 Access function to velocity field.
const surfaceScalarFieldphi () const
 Access function to flux field.
const basicThermothermo () const
 Access function to thermophysical model.
const volScalarFieldmu () const
 Return the laminar viscosity.
const volScalarFieldalpha () const
 Return the laminar thermal conductivity.
virtual tmp< volScalarFieldmut () const =0
 Return the turbulence viscosity.
virtual tmp< volScalarFieldmuEff () const =0
 Return the effective viscosity.
virtual tmp< volScalarFieldalphaEff () const =0
 Return the effective turbulent thermal diffusivity.
virtual tmp< volScalarFieldk () const =0
 Return the turbulence kinetic energy.
virtual tmp< volScalarFieldepsilon () const =0
 Return the turbulence kinetic energy dissipation rate.
virtual tmp< volSymmTensorFieldR () const =0
 Return the Reynolds stress tensor.
virtual tmp< volSymmTensorFielddevRhoReff () const =0
 Return the effective stress tensor including the laminar stress.
virtual tmp< fvVectorMatrixdivDevRhoReff (volVectorField &U) const =0
 Return the source term for the momentum equation.
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity.
virtual bool read ()=0
 Read turbulenceProperties dictionary.

Static Public Member Functions

static autoPtr< turbulenceModelNew (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel)
 Return a reference to the selected turbulence model.

Protected Attributes

const TimerunTime_
const fvMeshmesh_
const volScalarFieldrho_
const volVectorFieldU_
const surfaceScalarFieldphi_
const basicThermothermophysicalModel_

Constructor & Destructor Documentation

turbulenceModel ( const volScalarField rho,
const volVectorField U,
const surfaceScalarField phi,
const basicThermo thermoPhysicalModel 
)

Construct from components.

virtual ~turbulenceModel ( )
inlinevirtual

Destructor.

Definition at line 145 of file turbulenceModel.H.


Member Function Documentation

TypeName ( "turbulenceModel"  )

Runtime type information.

declareRunTimeNewSelectionTable ( autoPtr  ,
turbulenceModel  ,
turbulenceModel  ,
(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel)  ,
(rho, U, phi, thermoPhysicalModel)   
)
autoPtr< turbulenceModel > New ( const volScalarField rho,
const volVectorField U,
const surfaceScalarField phi,
const basicThermo thermoPhysicalModel 
)
static
const surfaceScalarField& phi ( ) const
inline

Access function to flux field.

Definition at line 164 of file turbulenceModel.H.

References turbulenceModel::phi_.

const basicThermo& thermo ( ) const
inline

Access function to thermophysical model.

Definition at line 170 of file turbulenceModel.H.

References turbulenceModel::thermophysicalModel_.

Referenced by turbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs().

virtual tmp<volScalarField> mut ( ) const
pure virtual
virtual tmp<volScalarField> muEff ( ) const
pure virtual

Return the effective viscosity.

Implemented in RASModel, LESModel, laminar, and laminar.

virtual tmp<volScalarField> alphaEff ( ) const
pure virtual
virtual tmp<volScalarField> k ( ) const
pure virtual
virtual tmp<volScalarField> epsilon ( ) const
pure virtual
virtual tmp<volSymmTensorField> R ( ) const
pure virtual
virtual tmp<volSymmTensorField> devRhoReff ( ) const
pure virtual

Return the effective stress tensor including the laminar stress.

Implemented in RASModel, kOmegaSST, LESModel, SpalartAllmaras, LaunderGibsonRSTM, realizableKE, LRR, PDRkEpsilon, LaunderSharmaKE, RNGkEpsilon, kEpsilon, laminar, and laminar.

virtual tmp<fvVectorMatrix> divDevRhoReff ( volVectorField U) const
pure virtual

Return the source term for the momentum equation.

void correct ( )
pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implemented in RASModel, kOmegaSST, LESModel, SpalartAllmaras, LaunderGibsonRSTM, realizableKE, LRR, PDRkEpsilon, LaunderSharmaKE, RNGkEpsilon, kEpsilon, laminar, and laminar.

Definition at line 121 of file turbulenceModel.C.


Member Data Documentation

const Time& runTime_
protected

Definition at line 76 of file turbulenceModel.H.

Referenced by SpalartAllmaras::epsilon(), and SpalartAllmaras::k().

const fvMesh& mesh_
protected
const volScalarField& rho_
protected

Definition at line 79 of file turbulenceModel.H.

Referenced by SpalartAllmaras::DnuTildaEff(), and turbulenceModel::rho().

const volVectorField& U_
protected

Definition at line 80 of file turbulenceModel.H.

Referenced by turbulenceModel::U().

const surfaceScalarField& phi_
protected

Definition at line 81 of file turbulenceModel.H.

Referenced by turbulenceModel::phi().

const basicThermo& thermophysicalModel_
protected

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