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

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

[legend]

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 ()=default
	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 Member Functions
	TurbulenceModel (const TurbulenceModel &)=delete
	No copy construct. More...

void	operator= (const TurbulenceModel &)=delete
	No copy assignment. 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

Definition at line 55 of file TurbulenceModel.H.

Member Typedef Documentation

◆ alphaField

typedef Alpha alphaField

Definition at line 62 of file TurbulenceModel.H.

◆ rhoField

typedef Rho rhoField

Definition at line 63 of file TurbulenceModel.H.

◆ transportModel

typedef TransportModel transportModel

Definition at line 64 of file TurbulenceModel.H.

Constructor & Destructor Documentation

◆ TurbulenceModel() [1/2]

TurbulenceModel ( const TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > & )

protecteddelete

No copy construct.

◆ TurbulenceModel() [2/2]

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 37 of file TurbulenceModel.C.

◆ ~TurbulenceModel()

virtual ~TurbulenceModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > & )

protecteddelete

No copy assignment.

◆ 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.

◆ alpha()

const alphaField& alpha ( ) const

inline

Access function to phase fraction.

Definition at line 155 of file TurbulenceModel.H.

◆ transport()

const transportModel& transport ( ) const

inline

Access function to incompressible transport model.

Definition at line 163 of file TurbulenceModel.H.

◆ nu() [1/2]

virtual tmp<volScalarField> nu ( ) const

inlinevirtual

Return the laminar viscosity.

Reimplemented in CompressibleTurbulenceModel< TransportModel >.

Definition at line 171 of file TurbulenceModel.H.

Referenced by alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), and alphatJayatillekeWallFunctionFvPatchScalarField::yPlus().

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 179 of file TurbulenceModel.H.

Member Data Documentation

◆ alpha_

const alphaField& alpha_

protected

Definition at line 71 of file TurbulenceModel.H.

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

◆ transport_

const transportModel& transport_