Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel > Class Template Reference

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

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. More...
 
 TurbulenceModel (const TurbulenceModel &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const TurbulenceModel &)=delete
 Disallow default bitwise assignment. 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

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() [1/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 41 of file TurbulenceModel.C.

◆ TurbulenceModel() [2/2]

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

Disallow default bitwise copy construction.

◆ ~TurbulenceModel()

virtual ~TurbulenceModel ( )
inlinevirtual

Destructor.

Definition at line 133 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 140 of file TurbulenceModel.H.

◆ transport()

const transportModel& transport ( ) const
inline

Access function to incompressible transport model.

Definition at line 146 of file TurbulenceModel.H.

◆ nu() [1/2]

virtual tmp<volScalarField> nu ( ) const
inlinevirtual

Return the laminar viscosity.

Reimplemented in CompressibleTurbulenceModel< TransportModel >.

Definition at line 152 of file TurbulenceModel.H.

Referenced by kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::DkEff(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::DomegaEff(), wallHeatTransferCoeff::execute(), 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 158 of file TurbulenceModel.H.

◆ operator=()

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

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

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: