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

• src/turbulenceModels/incompressible/turbulenceModel/turbulenceModel.H
• src/turbulenceModels/incompressible/turbulenceModel/turbulenceModel.C
• src/turbulenceModels/incompressible/turbulenceModel/newTurbulenceModel.C

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.

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

Return a reference to the selected turbulence model.

Definition at line 63 of file turbulenceModel.C.

References TimePaths::constant(), IOobject::db(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), IOobject::MUST_READ, IOobject::NO_WRITE, phi, IOobject::time(), and U.

const volVectorField& U ( ) const

inline

Access function to velocity field.

Definition at line 147 of file turbulenceModel.H.

References incompressible::turbulenceModel::U_.

Referenced by laminar::B(), scaleSimilarity::B(), Smagorinsky2::B(), GenEddyVisc::B(), SpalartAllmaras::B(), kOmegaSSTSAS::B(), locDynOneEqEddy::correct(), laminar::devBeff(), GenEddyVisc::devBeff(), GenSGSStress::devBeff(), SpalartAllmaras::devBeff(), kOmegaSSTSAS::devBeff(), laminar::epsilon(), scaleSimilarity::epsilon(), SpalartAllmaras::epsilon(), kOmegaSSTSAS::epsilon(), laminar::k(), scaleSimilarity::k(), spectEddyVisc::k(), Smagorinsky::k(), SpalartAllmaras::k(), and incompressible::fixedShearStressFvPatchVectorField::updateCoeffs().

const surfaceScalarField& phi ( ) const

inline

Access function to flux field.

Definition at line 153 of file turbulenceModel.H.

References incompressible::turbulenceModel::phi_.

Referenced by LRRDiffStress::correct(), DeardorffDiffStress::correct(), oneEqEddy::correct(), dynOneEqEddy::correct(), locDynOneEqEddy::correct(), SpalartAllmaras::correct(), and kOmegaSSTSAS::correct().

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> nut ( ) const

pure virtual

Return the turbulence viscosity.

Implemented in incompressible::RASModel, incompressible::LESModel, kOmegaSST, SpalartAllmaras, LienCubicKELowRe, LaunderGibsonRSTM, realizableKE, LRR, kOmega, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, qZeta, kEpsilon, LamBremhorstKE, incompressible::laminar, and laminar.

virtual tmp<volScalarField> nuEff ( ) const

pure virtual

Return the effective viscosity.

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

virtual tmp<volScalarField> k ( ) const

pure virtual

Return the turbulence kinetic energy.

Implemented in incompressible::RASModel, kOmegaSST, kOmegaSSTSAS, incompressible::LESModel, SpalartAllmaras, LienCubicKELowRe, LaunderGibsonRSTM, realizableKE, SpalartAllmaras, LRR, locDynOneEqEddy, kOmega, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, homogeneousDynSmagorinsky, LienCubicKE, LienLeschzinerLowRe, qZeta, kEpsilon, dynOneEqEddy, LamBremhorstKE, Smagorinsky, spectEddyVisc, oneEqEddy, mixedSmagorinsky, GenSGSStress, scaleSimilarity, incompressible::laminar, GenEddyVisc, laminar, and laminar.

virtual tmp<volScalarField> epsilon ( ) const

pure virtual

Return the turbulence kinetic energy dissipation rate.

Implemented in incompressible::RASModel, kOmegaSST, kOmegaSSTSAS, incompressible::LESModel, LienCubicKELowRe, SpalartAllmaras, LaunderGibsonRSTM, realizableKE, kOmega, SpalartAllmaras, LRR, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, qZeta, kEpsilon, LamBremhorstKE, mixedSmagorinsky, GenSGSStress, scaleSimilarity, incompressible::laminar, GenEddyVisc, laminar, and laminar.

virtual tmp<volSymmTensorField> R ( ) const

pure virtual

Return the Reynolds stress tensor.

Implemented in incompressible::RASModel, kOmegaSST, incompressible::LESModel, kOmega, LienCubicKELowRe, SpalartAllmaras, LaunderGibsonRSTM, realizableKE, LRR, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, qZeta, kEpsilon, LamBremhorstKE, incompressible::laminar, and laminar.

virtual tmp<volSymmTensorField> devReff ( ) const

pure virtual

Return the effective stress tensor including the laminar stress.

Implemented in incompressible::RASModel, kOmegaSST, incompressible::LESModel, kOmega, LienCubicKELowRe, LaunderGibsonRSTM, SpalartAllmaras, realizableKE, LRR, qZeta, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, kEpsilon, LamBremhorstKE, 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

Solve the turbulence equations and correct the turbulence viscosity.

Implemented in incompressible::RASModel, kOmegaSST, incompressible::LESModel, kOmega, LienCubicKELowRe, LaunderGibsonRSTM, SpalartAllmaras, realizableKE, LRR, qZeta, LaunderSharmaKE, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, kEpsilon, LamBremhorstKE, incompressible::laminar, and laminar.

Definition at line 114 of file turbulenceModel.C.

virtual bool read ( )

pure virtual

Read turbulenceProperties dictionary.

Implemented in incompressible::RASModel, kOmegaSST, kOmegaSSTSAS, incompressible::LESModel, kOmega, LienCubicKELowRe, LaunderGibsonRSTM, SpalartAllmaras, SpalartAllmaras, realizableKE, LRR, qZeta, LaunderSharmaKE, locDynOneEqEddy, NonlinearKEShih, RNGkEpsilon, LienCubicKE, LienLeschzinerLowRe, kEpsilon, LamBremhorstKE, homogeneousDynSmagorinsky, dynOneEqEddy, mixedSmagorinsky, oneEqEddy, GenSGSStress, Smagorinsky, SpalartAllmarasIDDES, DeardorffDiffStress, LRRDiffStress, GenEddyVisc, spectEddyVisc, scaleSimilarity, incompressible::laminar, Smagorinsky2, laminar, and laminar.

---

Member Data Documentation

const Time& runTime_

protected

Definition at line 75 of file turbulenceModel.H.

Referenced by laminar::B(), GenSGSStress::devBeff(), laminar::devReff(), LamBremhorstKE::devReff(), kEpsilon::devReff(), LienLeschzinerLowRe::devReff(), LienCubicKE::devReff(), RNGkEpsilon::devReff(), NonlinearKEShih::devReff(), LaunderSharmaKE::devReff(), qZeta::devReff(), LRR::devReff(), realizableKE::devReff(), LaunderGibsonRSTM::devReff(), SpalartAllmaras::devReff(), LienCubicKELowRe::devReff(), kOmega::devReff(), kOmegaSST::devReff(), laminar::epsilon(), SpalartAllmaras::epsilon(), laminar::k(), SpalartAllmaras::k(), laminar::nuSgs(), laminar::nut(), laminar::R(), LamBremhorstKE::R(), kEpsilon::R(), LienLeschzinerLowRe::R(), qZeta::R(), LienCubicKE::R(), RNGkEpsilon::R(), NonlinearKEShih::R(), LaunderSharmaKE::R(), realizableKE::R(), SpalartAllmaras::R(), LienCubicKELowRe::R(), kOmega::R(), and kOmegaSST::R().

const fvMesh& mesh_

protected

Definition at line 76 of file turbulenceModel.H.

Referenced by laminar::B(), LamBremhorstKE::correct(), LienLeschzinerLowRe::correct(), LRR::correct(), SpalartAllmaras::correct(), LaunderGibsonRSTM::correct(), LienCubicKELowRe::correct(), kOmegaSSTSAS::correct(), kOmegaSST::correct(), GenSGSStress::devBeff(), laminar::devReff(), LamBremhorstKE::devReff(), kEpsilon::devReff(), LienLeschzinerLowRe::devReff(), LienCubicKE::devReff(), RNGkEpsilon::devReff(), NonlinearKEShih::devReff(), LaunderSharmaKE::devReff(), qZeta::devReff(), LRR::devReff(), realizableKE::devReff(), LaunderGibsonRSTM::devReff(), SpalartAllmaras::devReff(), LienCubicKELowRe::devReff(), kOmega::devReff(), kOmegaSST::devReff(), laminar::epsilon(), kOmega::epsilon(), SpalartAllmaras::epsilon(), kOmegaSST::epsilon(), laminar::k(), SpalartAllmaras::k(), laminar::nuSgs(), laminar::nut(), laminar::R(), LamBremhorstKE::R(), kEpsilon::R(), qZeta::R(), LienLeschzinerLowRe::R(), LienCubicKE::R(), RNGkEpsilon::R(), NonlinearKEShih::R(), LaunderSharmaKE::R(), realizableKE::R(), SpalartAllmaras::R(), LienCubicKELowRe::R(), kOmega::R(), and kOmegaSST::R().

const volVectorField& U_

protected

Definition at line 78 of file turbulenceModel.H.

Referenced by LamBremhorstKE::correct(), kEpsilon::correct(), LienLeschzinerLowRe::correct(), LienCubicKE::correct(), RNGkEpsilon::correct(), NonlinearKEShih::correct(), LaunderSharmaKE::correct(), qZeta::correct(), LRR::correct(), realizableKE::correct(), SpalartAllmaras::correct(), LaunderGibsonRSTM::correct(), LienCubicKELowRe::correct(), kOmega::correct(), kOmegaSST::correct(), laminar::devReff(), LamBremhorstKE::devReff(), kEpsilon::devReff(), LienLeschzinerLowRe::devReff(), LienCubicKE::devReff(), RNGkEpsilon::devReff(), NonlinearKEShih::devReff(), LaunderSharmaKE::devReff(), qZeta::devReff(), LRR::devReff(), realizableKE::devReff(), SpalartAllmaras::devReff(), LaunderGibsonRSTM::devReff(), LienCubicKELowRe::devReff(), kOmega::devReff(), kOmegaSST::devReff(), laminar::epsilon(), laminar::k(), laminar::R(), LamBremhorstKE::R(), kEpsilon::R(), qZeta::R(), LienLeschzinerLowRe::R(), RNGkEpsilon::R(), NonlinearKEShih::R(), LaunderSharmaKE::R(), realizableKE::R(), SpalartAllmaras::R(), kOmega::R(), kOmegaSST::R(), and incompressible::turbulenceModel::U().

const surfaceScalarField& phi_

protected

Definition at line 79 of file turbulenceModel.H.

Referenced by LamBremhorstKE::correct(), kEpsilon::correct(), LienLeschzinerLowRe::correct(), LienCubicKE::correct(), RNGkEpsilon::correct(), NonlinearKEShih::correct(), LaunderSharmaKE::correct(), qZeta::correct(), LRR::correct(), realizableKE::correct(), SpalartAllmaras::correct(), LaunderGibsonRSTM::correct(), LienCubicKELowRe::correct(), kOmega::correct(), kOmegaSST::correct(), and incompressible::turbulenceModel::phi().

transportModel& transportModel_

protected

Definition at line 81 of file turbulenceModel.H.

Referenced by incompressible::turbulenceModel::nu(), and incompressible::turbulenceModel::transport().

---

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

• src/turbulenceModels/incompressible/turbulenceModel/turbulenceModel.H
• src/turbulenceModels/incompressible/turbulenceModel/turbulenceModel.C