TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > Class Template Reference

Templated abstract base class for turbulence models. More...

Inheritance diagram for TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >:

Collaboration diagram for TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >:

Public Types
typedef Alpha	alphaField
typedef Rho	rhoField
typedef TransportModel	transportModel

Public Member Functions
	declareRunTimeNewSelectionTable (autoPtr, TurbulenceModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))
	TurbulenceModel (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct. More...
virtual	~TurbulenceModel ()
	Destructor. More...
const alphaField &	alpha () const
	Access function to phase fraction. More...
const transportModel &	transport () const
	Access function to incompressible transport model. More...
virtual tmp< volScalarField >	nu () const
	Return the laminar viscosity. More...
virtual tmp< scalarField >	nu (const label patchi) const
	Return the laminar viscosity on patchi. More...

Static Public Member Functions
static autoPtr< TurbulenceModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
	Return a reference to the selected turbulence model. More...

Protected Attributes
const alphaField &	alpha_
const transportModel &	transport_

Detailed Description

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
class Foam::TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >

Templated abstract base class for turbulence models.

Source files

• TurbulenceModel.H
• TurbulenceModel.C

Definition at line 57 of file TurbulenceModel.H.

Member Typedef Documentation

alphaField

typedef Alpha alphaField

Definition at line 64 of file TurbulenceModel.H.

rhoField

typedef Rho rhoField

Definition at line 65 of file TurbulenceModel.H.

transportModel

typedef TransportModel transportModel

Definition at line 66 of file TurbulenceModel.H.

Constructor & Destructor Documentation

TurbulenceModel()

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

Construct.

Definition at line 41 of file TurbulenceModel.C.

~TurbulenceModel()

virtual ~TurbulenceModel ( )

inlinevirtual

Destructor.

Definition at line 141 of file TurbulenceModel.H.

Member Function Documentation

declareRunTimeNewSelectionTable()

declareRunTimeNewSelectionTable	(	autoPtr	,
		TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >	,
		dictionary	,
		(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)	,
		(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName)
	)

New()

static autoPtr<TurbulenceModel> New ( const alphaField &  alpha, const rhoField &  rho, const volVectorField &  U, const surfaceScalarField &  alphaRhoPhi, const surfaceScalarField &  phi, const transportModel &  transport, const word &  propertiesName = turbulenceModel::propertiesName  )

static

Return a reference to the selected turbulence model.

Referenced by TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::TurbulenceModel().

Here is the caller graph for this function:

alpha()

const alphaField& alpha ( ) const

inline

Access function to phase fraction.

Definition at line 148 of file TurbulenceModel.H.

transport()

const transportModel& transport ( ) const

inline

Access function to incompressible transport model.

Definition at line 154 of file TurbulenceModel.H.

nu() [1/2]

virtual tmp<volScalarField> nu ( ) const

inlinevirtual

Return the laminar viscosity.

Reimplemented in CompressibleTurbulenceModel< TransportModel >.

Definition at line 160 of file TurbulenceModel.H.

Referenced by kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::DkEff(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::DomegaEff(), and alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

nu() [2/2]

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

inlinevirtual

Return the laminar viscosity on patchi.

Reimplemented in CompressibleTurbulenceModel< TransportModel >.

Definition at line 166 of file TurbulenceModel.H.

Member Data Documentation

alpha_

const alphaField& alpha_

protected

Definition at line 73 of file TurbulenceModel.H.

Referenced by TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::alpha().

transport_

const transportModel& transport_

protected

Definition at line 74 of file TurbulenceModel.H.

Referenced by TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::transport().

---

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

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