FreeFOAM The Cross-Platform CFD Toolkit
incompressible::turbulenceModel Class Reference

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

#include <incompressibleTurbulenceModel/turbulenceModel.H>


Detailed Description

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

Source files

Definition at line 68 of file turbulenceModel.H.

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

List of all members.

Public Member Functions

 TypeName ("turbulenceModel")
 Runtime type information.
 declareRunTimeNewSelectionTable (autoPtr, turbulenceModel, turbulenceModel,(const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel),(U, phi, lamTransportModel))
 turbulenceModel (const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)
 Construct from components.
virtual ~turbulenceModel ()
 Destructor.
const volVectorFieldU () const
 Access function to velocity field.
const surfaceScalarFieldphi () const
 Access function to flux field.
transportModeltransport () const
 Access function to incompressible transport model.
const volScalarFieldnu () const
 Return the laminar viscosity.
virtual tmp< volScalarFieldnut () const =0
 Return the turbulence viscosity.
virtual tmp< volScalarFieldnuEff () const =0
 Return the effective viscosity.
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< volSymmTensorFielddevReff () const =0
 Return the effective stress tensor including the laminar stress.
virtual tmp< fvVectorMatrixdivDevReff (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 volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)
 Return a reference to the selected turbulence model.

Protected Attributes

const TimerunTime_
const fvMeshmesh_
const volVectorFieldU_
const surfaceScalarFieldphi_
transportModeltransportModel_

Constructor & Destructor Documentation

turbulenceModel ( const volVectorField U,
const surfaceScalarField phi,
transportModel lamTransportModel 
)

Construct from components.

virtual ~turbulenceModel ( )
inlinevirtual

Destructor.

Definition at line 140 of file turbulenceModel.H.


Member Function Documentation

TypeName ( "turbulenceModel"  )

Runtime type information.

declareRunTimeNewSelectionTable ( autoPtr  ,
turbulenceModel  ,
turbulenceModel  ,
(const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)  ,
(U, phi, lamTransportModel)   
)
autoPtr< turbulenceModel > New ( const volVectorField U,
const surfaceScalarField phi,
transportModel lamTransportModel 
)
static
transportModel& transport ( ) const
inline

Access function to incompressible transport model.

Definition at line 159 of file turbulenceModel.H.

References incompressible::turbulenceModel::transportModel_.

const volScalarField& nu ( ) const
inline

Return the laminar viscosity.

Definition at line 165 of file turbulenceModel.H.

References transportModel::nu(), and incompressible::turbulenceModel::transportModel_.

Referenced by LamBremhorstKE::correct(), LienLeschzinerLowRe::correct(), LaunderSharmaKE::correct(), qZeta::correct(), realizableKE::correct(), SpalartAllmaras::correct(), LienCubicKELowRe::correct(), LRRDiffStress::DBEff(), DeardorffDiffStress::DBEff(), LamBremhorstKE::DepsilonEff(), kEpsilon::DepsilonEff(), LienLeschzinerLowRe::DepsilonEff(), LienCubicKE::DepsilonEff(), RNGkEpsilon::DepsilonEff(), LaunderSharmaKE::DepsilonEff(), NonlinearKEShih::DepsilonEff(), LRR::DepsilonEff(), realizableKE::DepsilonEff(), LaunderGibsonRSTM::DepsilonEff(), LienCubicKELowRe::DepsilonEff(), laminar::devBeff(), GenSGSStress::devBeff(), laminar::devReff(), LRR::devReff(), LaunderGibsonRSTM::devReff(), laminar::divDevBeff(), LamBremhorstKE::DkEff(), kEpsilon::DkEff(), LienLeschzinerLowRe::DkEff(), LienCubicKE::DkEff(), RNGkEpsilon::DkEff(), oneEqEddy::DkEff(), NonlinearKEShih::DkEff(), LaunderSharmaKE::DkEff(), kOmega::DkEff(), dynOneEqEddy::DkEff(), realizableKE::DkEff(), LienCubicKELowRe::DkEff(), locDynOneEqEddy::DkEff(), kOmegaSST::DkEff(), kOmegaSSTSAS::DkEff(), SpalartAllmaras::DnuTildaEff(), kOmega::DomegaEff(), kOmegaSST::DomegaEff(), kOmegaSSTSAS::DomegaEff(), qZeta::DqEff(), LRR::DREff(), LaunderGibsonRSTM::DREff(), qZeta::DzetaEff(), laminar::epsilon(), kOmegaSSTSAS::F1(), kOmegaSSTSAS::F2(), SpalartAllmaras::fv1(), SpalartAllmaras::fv2(), SpalartAllmaras::fv3(), spectEddyVisc::k(), laminar::nuEff(), laminar::nuSgs(), and laminar::nut().

virtual tmp<volScalarField> nuEff ( ) const
pure virtual

Return the effective viscosity.

Implemented in incompressible::RASModel, incompressible::LESModel, laminar, incompressible::laminar, and laminar.

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

Return the source term for the momentum equation.

void correct ( )
pure virtual

Member Data Documentation

transportModel& transportModel_
protected

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