FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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 volVectorField &  U () const
 Access function to velocity field.
const surfaceScalarField &  phi () const
 Access function to flux field.
transportModel &  transport () const
 Access function to incompressible transport model.
const volScalarField &  nu () const
 Return the laminar viscosity.
virtual tmp< volScalarField >  nut () const =0
 Return the turbulence viscosity.
virtual tmp< volScalarField >  nuEff () const =0
 Return the effective viscosity.
virtual tmp< volScalarField >  k () const =0
 Return the turbulence kinetic energy.
virtual tmp< volScalarField >  epsilon () const =0
 Return the turbulence kinetic energy dissipation rate.
virtual tmp< volSymmTensorField >  R () const =0
 Return the Reynolds stress tensor.
virtual tmp< volSymmTensorField >  devReff () const =0
 Return the effective stress tensor including the laminar stress.
virtual tmp< fvVectorMatrix >  divDevReff (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< turbulenceModel >  New (const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)
 Return a reference to the selected turbulence model.

Protected Attributes

const Time &  runTime_
const fvMesh &  mesh_
const volVectorField &  U_
const surfaceScalarField &  phi_
transportModel &  transportModel_

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 45 of file turbulenceModel.C.

virtual ~turbulenceModel (  ) [inline, virtual]

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 qZeta::correct(), LienLeschzinerLowRe::correct(), LienCubicKELowRe::correct(), LamBremhorstKE::correct(), realizableKE::correct(), LaunderSharmaKE::correct(), SpalartAllmaras::correct(), LRRDiffStress::DBEff(), DeardorffDiffStress::DBEff(), NonlinearKEShih::DepsilonEff(), LienLeschzinerLowRe::DepsilonEff(), LienCubicKELowRe::DepsilonEff(), LienCubicKE::DepsilonEff(), LamBremhorstKE::DepsilonEff(), RNGkEpsilon::DepsilonEff(), realizableKE::DepsilonEff(), LRR::DepsilonEff(), LaunderSharmaKE::DepsilonEff(), LaunderGibsonRSTM::DepsilonEff(), kEpsilon::DepsilonEff(), laminar::devBeff(), GenSGSStress::devBeff(), LRR::devReff(), LaunderGibsonRSTM::devReff(), laminar::devReff(), laminar::divDevBeff(), NonlinearKEShih::DkEff(), LienLeschzinerLowRe::DkEff(), LienCubicKELowRe::DkEff(), LienCubicKE::DkEff(), LamBremhorstKE::DkEff(), kOmega::DkEff(), locDynOneEqEddy::DkEff(), kOmegaSSTSAS::DkEff(), RNGkEpsilon::DkEff(), realizableKE::DkEff(), LaunderSharmaKE::DkEff(), kOmegaSST::DkEff(), kEpsilon::DkEff(), oneEqEddy::DkEff(), dynOneEqEddy::DkEff(), SpalartAllmaras::DnuTildaEff(), kOmega::DomegaEff(), kOmegaSSTSAS::DomegaEff(), kOmegaSST::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 laminar, incompressible::LESModel, laminar, incompressible::RASModel, and incompressible::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: