Loading...
Searching...
No Matches
TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > Class Template Reference

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

#include <TurbulenceModel.H>

Inheritance diagram for TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >:
Inheritance graph
[legend]
Collaboration diagram for TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >:
Collaboration graph
[legend]

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.
virtual ~TurbulenceModel ()=default
 Destructor.
const alphaField & alpha () const
 Access function to phase fraction.
const transportModel & transport () const
 Access function to incompressible transport model.
virtual tmp< volScalarField > nu () const
 Return the laminar viscosity.
virtual tmp< scalarField > nu (const label patchi) const
 Return the laminar viscosity on patchi.

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.

Protected Member Functions

 TurbulenceModel (const TurbulenceModel &)=delete
 No copy construct.
void operator= (const TurbulenceModel &)=delete
 No copy assignment.

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

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
typedef Alpha alphaField

Definition at line 62 of file TurbulenceModel.H.

◆ rhoField

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
typedef Rho rhoField

Definition at line 63 of file TurbulenceModel.H.

◆ transportModel

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
typedef TransportModel transportModel

Definition at line 64 of file TurbulenceModel.H.

Constructor & Destructor Documentation

◆ TurbulenceModel() [1/2]

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

No copy construct.

◆ TurbulenceModel() [2/2]

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
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 35 of file TurbulenceModel.C.

References alpha(), alpha_, phi, rho, transport(), transport_, and U.

Here is the call graph for this function:

◆ ~TurbulenceModel()

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
virtual ~TurbulenceModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

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

No copy assignment.

◆ declareRunTimeNewSelectionTable()

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
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()

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
Foam::autoPtr< Foam::TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > > 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.

Definition at line 73 of file TurbulenceModel.C.

References alpha(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, IOobject::group(), IOobject::groupName(), Foam::Info, IOobjectOption::MUST_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, phi, rho, transport(), and U.

Here is the call graph for this function:

◆ alpha()

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
const alphaField & alpha ( ) const
inline

Access function to phase fraction.

Definition at line 155 of file TurbulenceModel.H.

Referenced by IncompressibleTurbulenceModel< transportModel >::IncompressibleTurbulenceModel(), New(), PhaseIncompressibleTurbulenceModel< transportModel >::PhaseIncompressibleTurbulenceModel(), and TurbulenceModel().

Here is the caller graph for this function:

◆ transport()

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
const transportModel & transport ( ) const
inline

Access function to incompressible transport model.

Definition at line 163 of file TurbulenceModel.H.

Referenced by IncompressibleTurbulenceModel< transportModel >::IncompressibleTurbulenceModel(), New(), TurbulenceModel(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), and thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs().

Here is the caller graph for this function:

◆ nu() [1/2]

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
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::yPlus().

Here is the caller graph for this function:

◆ nu() [2/2]

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
virtual tmp< scalarField > nu ( const label patchi) const
inlinevirtual

Return the laminar viscosity on patchi.

Definition at line 179 of file TurbulenceModel.H.

Member Data Documentation

◆ alpha_

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
const alphaField& alpha_
protected

Definition at line 71 of file TurbulenceModel.H.

Referenced by TurbulenceModel().

◆ transport_

template<class Alpha, class Rho, class BasicTurbulenceModel, class TransportModel>
const transportModel& transport_
protected

Definition at line 72 of file TurbulenceModel.H.

Referenced by TurbulenceModel().

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