eddyViscosity< BasicTurbulenceModel > Class Template Reference

Eddy viscosity turbulence model base class. More...

Inheritance diagram for eddyViscosity< BasicTurbulenceModel >:

Collaboration diagram for eddyViscosity< BasicTurbulenceModel >:

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField
typedef BasicTurbulenceModel::rhoField	rhoField
typedef BasicTurbulenceModel::transportModel	transportModel
Public Types inherited from linearViscousStress< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField
typedef BasicTurbulenceModel::rhoField	rhoField
typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct from components. More...
virtual	~eddyViscosity ()
	Destructor. More...
virtual bool	read ()=0
	Re-read model coefficients if they have changed. More...
volScalarField &	evNut ()
	Return non-const access to the turbulence viscosity. More...
virtual tmp< volScalarField >	nut () const
	Return the turbulence viscosity. More...
virtual tmp< scalarField >	nut (const label patchi) const
	Return the turbulence viscosity on patch. More...
virtual tmp< volScalarField >	k () const =0
	Return the turbulence kinetic energy. More...
virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor. More...
virtual void	validate ()
	Validate the turbulence fields after construction. More...
virtual void	correct ()=0
	Solve the turbulence equations and correct the turbulence viscosity. More...
Public Member Functions inherited from linearViscousStress< BasicTurbulenceModel >
	linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct from components. More...
virtual	~linearViscousStress ()
	Destructor. More...
virtual tmp< volSymmTensorField >	devRhoReff () const
	Return the effective stress tensor. More...
virtual tmp< fvVectorMatrix >	divDevRhoReff (volVectorField &U) const
	Return the source term for the momentum equation. More...
virtual tmp< fvVectorMatrix >	divDevRhoReff (const volScalarField &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...

Protected Member Functions
virtual void	correctNut ()=0

Protected Attributes
volScalarField	nut_

Detailed Description

template<class BasicTurbulenceModel>
class Foam::eddyViscosity< BasicTurbulenceModel >

Eddy viscosity turbulence model base class.

Source files

• eddyViscosity.H
• eddyViscosity.C

Definition at line 52 of file eddyViscosity.H.

Member Typedef Documentation

alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 73 of file eddyViscosity.H.

rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 74 of file eddyViscosity.H.

transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 75 of file eddyViscosity.H.

Constructor & Destructor Documentation

eddyViscosity()

eddyViscosity	(	const word &	modelName,
		const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport,
		const word &	propertiesName
	)

Construct from components.

Definition at line 34 of file eddyViscosity.C.

~eddyViscosity()

virtual ~eddyViscosity ( )

inlinevirtual

Destructor.

Definition at line 95 of file eddyViscosity.H.

Member Function Documentation

correctNut()

virtual void correctNut ( )

protectedpure virtual

Implemented in kkLOmega, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, SpalartAllmarasDES< BasicTurbulenceModel >, v2f< BasicTurbulenceModel >, kOmegaSSTSato< BasicTurbulenceModel >, SpalartAllmaras< BasicTurbulenceModel >, kineticTheoryModel, mixtureKEpsilon< BasicTurbulenceModel >, kineticTheoryModel, kOmegaSST< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, LienCubicKE, realizableKE< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, RNGkEpsilon< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, LaheyKEpsilon< BasicTurbulenceModel >, LienLeschziner, NicenoKEqn< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, SmagorinskyZhang< BasicTurbulenceModel >, qZeta, continuousGasKEpsilon< BasicTurbulenceModel >, WALE< BasicTurbulenceModel >, phasePressureModel, LamBremhorstKE, kEqn< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, phasePressureModel, ShihQuadraticKE, and dynamicLagrangian< BasicTurbulenceModel >.

read()

bool read

pure virtual

Re-read model coefficients if they have changed.

Implements linearViscousStress< BasicTurbulenceModel >.

Implemented in kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, kkLOmega, mixtureKEpsilon< BasicTurbulenceModel >, SpalartAllmarasDES< BasicTurbulenceModel >, v2f< BasicTurbulenceModel >, kOmegaSSTSato< BasicTurbulenceModel >, SpalartAllmaras< BasicTurbulenceModel >, kineticTheoryModel, kineticTheoryModel, kOmegaSSTSAS< BasicTurbulenceModel >, dynamicKEqn< BasicTurbulenceModel >, LaunderSharmaKE< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, RNGkEpsilon< BasicTurbulenceModel >, LienCubicKE, LaheyKEpsilon< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, NicenoKEqn< BasicTurbulenceModel >, SpalartAllmarasIDDES< BasicTurbulenceModel >, Smagorinsky< BasicTurbulenceModel >, SmagorinskyZhang< BasicTurbulenceModel >, continuousGasKEpsilon< BasicTurbulenceModel >, LienLeschziner, WALE< BasicTurbulenceModel >, phasePressureModel, buoyantKEpsilon< BasicTurbulenceModel >, continuousGasKEqn< BasicTurbulenceModel >, qZeta, kEqn< BasicTurbulenceModel >, phasePressureModel, kOmega< BasicTurbulenceModel >, SpalartAllmarasDDES< BasicTurbulenceModel >, LamBremhorstKE, ShihQuadraticKE, dynamicLagrangian< BasicTurbulenceModel >, PDRkEpsilon, and LESeddyViscosity< BasicTurbulenceModel >.

Definition at line 75 of file eddyViscosity.C.

evNut()

volScalarField& evNut ( )

inline

Return non-const access to the turbulence viscosity.

to allow modification by means other than derivation

Definition at line 106 of file eddyViscosity.H.

nut() [1/2]

virtual tmp<volScalarField> nut ( ) const

inlinevirtual

Return the turbulence viscosity.

Definition at line 112 of file eddyViscosity.H.

nut() [2/2]

virtual tmp<scalarField> nut ( const label  patchi ) const

inlinevirtual

Return the turbulence viscosity on patch.

Definition at line 118 of file eddyViscosity.H.

k()

virtual tmp<volScalarField> k ( ) const

pure virtual

Return the turbulence kinetic energy.

Implemented in kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, and kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >.

R()

Foam::tmp< Foam::volSymmTensorField > R

virtual

Return the Reynolds stress tensor.

Reimplemented in nonlinearEddyViscosity< BasicTurbulenceModel >, and nonlinearEddyViscosity< incompressible::RASModel >.

Definition at line 83 of file eddyViscosity.C.

validate()

void validate

virtual

Validate the turbulence fields after construction.

Update turbulence viscosity and other derived fields as requires

Reimplemented in kkLOmega.

Definition at line 125 of file eddyViscosity.C.

correct()

void correct

pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements linearViscousStress< BasicTurbulenceModel >.

Implemented in kkLOmega, kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >, v2f< BasicTurbulenceModel >, mixtureKEpsilon< BasicTurbulenceModel >, SpalartAllmarasDES< BasicTurbulenceModel >, kineticTheoryModel, kineticTheoryModel, qZeta, LaunderSharmaKE< BasicTurbulenceModel >, realizableKE< BasicTurbulenceModel >, RNGkEpsilon< BasicTurbulenceModel >, kEpsilon< BasicTurbulenceModel >, kOmega< BasicTurbulenceModel >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, SpalartAllmaras< BasicTurbulenceModel >, kOmegaSSTSato< BasicTurbulenceModel >, LienCubicKE, dynamicKEqn< BasicTurbulenceModel >, phasePressureModel, LienLeschziner, phasePressureModel, LamBremhorstKE, ShihQuadraticKE, Smagorinsky< BasicTurbulenceModel >, LaheyKEpsilon< BasicTurbulenceModel >, kEqn< BasicTurbulenceModel >, dynamicLagrangian< BasicTurbulenceModel >, WALE< BasicTurbulenceModel >, and PDRkEpsilon.

Definition at line 132 of file eddyViscosity.C.

Referenced by LamBremhorstKE::correct(), ShihQuadraticKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), qZeta::correct(), and kkLOmega::correct().

Here is the caller graph for this function:

Field Documentation

nut_

volScalarField nut_

protected

Definition at line 63 of file eddyViscosity.H.

Referenced by eddyViscosity< RASModel< BasicTurbulenceModel > >::nut().

---

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

• src/TurbulenceModels/turbulenceModels/eddyViscosity/eddyViscosity.H
• src/TurbulenceModels/turbulenceModels/eddyViscosity/eddyViscosity.C