OpenFOAM logo
Open Source CFD Toolkit

turbulenceModel Class Reference

Inheritance diagram for turbulenceModel:

Inheritance graph
[legend]
Collaboration diagram for turbulenceModel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("turbulenceModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, turbulenceModel, dictionary,(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, basicThermo &thermoPhysicalModel),(rho, U, phi, thermoPhysicalModel))
 turbulenceModel (const word &type, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, basicThermo &thermoPhysicalModel)
 Construct from components.
virtual ~turbulenceModel ()
const dimensionedScalark0 () const
 Return the value of k0 which k is not allowed to be less than.
const dimensionedScalarepsilon0 () const
 Return the value of epsilon0 which epsilon is not allowed to be.
const dimensionedScalarepsilonSmall () const
 Return the value of epsilonSmall which is added to epsilon when.
dimensionedScalark0 ()
 Allow k0 to be changed.
dimensionedScalarepsilon0 ()
 Allow epsilon0 to be changed.
dimensionedScalarepsilonSmall ()
 Allow epsilonSmall to be changed.
scalar kappa () const
 Return kappa for use in wall-functions.
scalar E () const
 Return E for use in wall-functions.
scalar yPlusLam () const
 Return y+ at the edge of the laminar sublayer.
virtual tmp< volScalarFieldmut () const =0
 Return the effective viscosity.
virtual tmp< volScalarFieldmuEff () const
 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< volTensorFieldR () const =0
 Return the Reynolds stress tensor.
virtual tmp< fvVectorMatrixdivRhoR (volVectorField &U) const =0
 Return the source term for the momentum equation.
virtual tmp< scalarFieldyPlus (const label patchI) const
 Return yPlus for the given patch.
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity.
virtual bool read ()=0
 Read turbulenceProperties dictionary.

Static Public Member Functions

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

Protected Member Functions

scalar yPlusLam (const scalar kappa, const scalar E)
const volScalarFieldmu () const
 Return the laminar viscosity.
const volScalarFieldalpha () const
 Return the laminar thermal conductivity.

Protected Attributes

const TimerunTime_
const fvMeshmesh_
const volScalarFieldrho_
const volVectorFieldU_
const surfaceScalarFieldphi_
basicThermothermophysicalModel_
Switch turbulence_
dictionary turbulenceModelCoeffs_
scalar kappa_
scalar E_
scalar yPlusLam_
dimensionedScalar k0_
dimensionedScalar epsilon0_
dimensionedScalar epsilonSmall_
nearWallDist y_

Constructor & Destructor Documentation

turbulenceModel const word type,
const volScalarField rho,
const volVectorField U,
const surfaceScalarField phi,
basicThermo thermoPhysicalModel
 

Construct from components.

virtual ~turbulenceModel  )  [inline, virtual]
 

Definition at line 180 of file turbulenceModel.H.

References Foam::dimensionedScalar.


Member Function Documentation

const volScalarField& alpha  )  const [inline, protected]
 

Return the laminar thermal conductivity.

Definition at line 113 of file turbulenceModel.H.

References declareRunTimeSelectionTable, Foam::surfaceScalarField, Foam::volScalarField, and Foam::volVectorField.

virtual tmp<volScalarField> alphaEff  )  const [pure virtual]
 

Return the effective turbulent thermal diffusivity.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

virtual void correct  )  [pure virtual]
 

Solve the turbulence equations and correct the turbulence viscosity.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

declareRunTimeSelectionTable autoPtr  ,
turbulenceModel  ,
dictionary  ,
(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, basicThermo &thermoPhysicalModel)  ,
(rho, U, phi, thermoPhysicalModel) 
 

virtual tmp<fvVectorMatrix> divRhoR volVectorField U  )  const [pure virtual]
 

Return the source term for the momentum equation.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

scalar E  )  const [inline]
 

Return E for use in wall-functions.

Definition at line 239 of file turbulenceModel.H.

virtual tmp<volScalarField> epsilon  )  const [pure virtual]
 

Return the turbulence kinetic energy dissipation rate.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

dimensionedScalar& epsilon0  )  [inline]
 

Allow epsilon0 to be changed.

Definition at line 220 of file turbulenceModel.H.

const dimensionedScalar& epsilon0  )  const [inline]
 

Return the value of epsilon0 which epsilon is not allowed to be.

less than

Definition at line 198 of file turbulenceModel.H.

dimensionedScalar& epsilonSmall  )  [inline]
 

Allow epsilonSmall to be changed.

Definition at line 226 of file turbulenceModel.H.

const dimensionedScalar& epsilonSmall  )  const [inline]
 

Return the value of epsilonSmall which is added to epsilon when.

calculating nut

Definition at line 207 of file turbulenceModel.H.

References Foam::dimensionedScalar.

virtual tmp<volScalarField> k  )  const [pure virtual]
 

Return the turbulence kinetic energy.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

dimensionedScalar& k0  )  [inline]
 

Allow k0 to be changed.

Definition at line 214 of file turbulenceModel.H.

References Foam::dimensionedScalar.

const dimensionedScalar& k0  )  const [inline]
 

Return the value of k0 which k is not allowed to be less than.

Definition at line 189 of file turbulenceModel.H.

References Foam::dimensionedScalar.

scalar kappa  )  const [inline]
 

Return kappa for use in wall-functions.

Definition at line 233 of file turbulenceModel.H.

const volScalarField& mu  )  const [inline, protected]
 

Return the laminar viscosity.

Definition at line 107 of file turbulenceModel.H.

virtual tmp<volScalarField> muEff  )  const [inline, virtual]
 

Return the effective viscosity.

Reimplemented in laminar.

Definition at line 258 of file turbulenceModel.H.

References Foam::volVectorField.

virtual tmp<volScalarField> mut  )  const [pure virtual]
 

Return the effective viscosity.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

autoPtr<turbulenceModel> New const volScalarField rho,
const volVectorField U,
const surfaceScalarField phi,
basicThermo thermoPhysicalModel
[static]
 

Return a reference to the selected turbulence model.

virtual tmp<volTensorField> R  )  const [pure virtual]
 

Return the Reynolds stress tensor.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

virtual bool read  )  [pure virtual]
 

Read turbulenceProperties dictionary.

Reimplemented from regIOobject.

Implemented in kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, and RNGkEpsilon.

TypeName "turbulenceModel"   ) 
 

Runtime type information.

virtual tmp<scalarField> yPlus const label  patchI  )  const [virtual]
 

Return yPlus for the given patch.

scalar yPlusLam  )  const [inline]
 

Return y+ at the edge of the laminar sublayer.

for use in wall-functions

Definition at line 248 of file turbulenceModel.H.

scalar yPlusLam const scalar  kappa,
const scalar  E
[protected]
 


Member Data Documentation

scalar E_ [protected]
 

Definition at line 94 of file turbulenceModel.H.

dimensionedScalar epsilon0_ [protected]
 

Definition at line 100 of file turbulenceModel.H.

dimensionedScalar epsilonSmall_ [protected]
 

Definition at line 101 of file turbulenceModel.H.

dimensionedScalar k0_ [protected]
 

Definition at line 99 of file turbulenceModel.H.

scalar kappa_ [protected]
 

Definition at line 93 of file turbulenceModel.H.

const fvMesh& mesh_ [protected]
 

Definition at line 82 of file turbulenceModel.H.

const surfaceScalarField& phi_ [protected]
 

Definition at line 86 of file turbulenceModel.H.

const volScalarField& rho_ [protected]
 

Definition at line 84 of file turbulenceModel.H.

const Time& runTime_ [protected]
 

Definition at line 81 of file turbulenceModel.H.

basicThermo& thermophysicalModel_ [protected]
 

Definition at line 88 of file turbulenceModel.H.

Switch turbulence_ [protected]
 

Definition at line 90 of file turbulenceModel.H.

dictionary turbulenceModelCoeffs_ [protected]
 

Definition at line 91 of file turbulenceModel.H.

const volVectorField& U_ [protected]
 

Definition at line 85 of file turbulenceModel.H.

nearWallDist y_ [protected]
 

Definition at line 103 of file turbulenceModel.H.

scalar yPlusLam_ [protected]
 

Definition at line 97 of file turbulenceModel.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org