Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
laminarModel< BasicTurbulenceModel > Class Template Reference

Templated abstract base class for laminar transport models. More...

Inheritance diagram for laminarModel< BasicTurbulenceModel >:
Inheritance graph
[legend]
Collaboration diagram for laminarModel< BasicTurbulenceModel >:
Collaboration graph
[legend]

Public Types

typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 

Public Member Functions

 TypeName ("laminar")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, laminarModel, 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))
 
 laminarModel (const word &type, 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 ~laminarModel ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity, i.e. 0 for laminar flow. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity, i.e. the laminar viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulence kinetic energy, i.e. 0 for laminar flow. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return the turbulence kinetic energy dissipation rate,. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor, i.e. 0 for laminar flow. More...
 
virtual void correct ()
 Correct the laminar transport. More...
 

Static Public Member Functions

static autoPtr< laminarModelNew (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 laminar model. More...
 

Protected Member Functions

virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 

Protected Attributes

dictionary laminarDict_
 laminar coefficients dictionary More...
 
Switch printCoeffs_
 Flag to print the model coeffs at run-time. More...
 
dictionary coeffDict_
 Model coefficients dictionary. More...
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::laminarModel< BasicTurbulenceModel >

Templated abstract base class for laminar transport models.

Source files

Definition at line 49 of file laminarModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 87 of file laminarModel.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 88 of file laminarModel.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 89 of file laminarModel.H.

Constructor & Destructor Documentation

◆ laminarModel()

laminarModel ( const word type,
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 45 of file laminarModel.C.

References laminarModel< BasicTurbulenceModel >::New().

Here is the call graph for this function:

◆ ~laminarModel()

virtual ~laminarModel ( )
inlinevirtual

Destructor.

Definition at line 148 of file laminarModel.H.

References laminarModel< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( const word type)
protectedvirtual

Print model coefficients.

Definition at line 32 of file laminarModel.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "laminar"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
laminarModel< BasicTurbulenceModel >  ,
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()

Foam::autoPtr< Foam::laminarModel< BasicTurbulenceModel > > 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 laminar model.

Definition at line 83 of file laminarModel.C.

References Foam::constant::atomic::alpha, TimePaths::constant(), IOobject::db(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), IOobject::group(), Foam::Info, dictionary::lookup(), Foam::nl, phi, rho, dictionary::subDict(), IOobject::time(), and U.

Referenced by laminarModel< BasicTurbulenceModel >::laminarModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented in Maxwell< BasicTurbulenceModel >, Stokes< BasicTurbulenceModel >, and linearViscousStress< laminarModel< BasicTurbulenceModel > >.

Definition at line 167 of file laminarModel.C.

References Foam::blockMeshTools::read().

Referenced by laminarModel< BasicTurbulenceModel >::~laminarModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ coeffDict()

virtual const dictionary& coeffDict ( ) const
inlinevirtual

◆ nut() [1/2]

Foam::tmp< Foam::volScalarField > nut ( ) const
virtual

Return the turbulence viscosity, i.e. 0 for laminar flow.

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 186 of file laminarModel.C.

References Foam::dimViscosity.

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().

Here is the caller graph for this function:

◆ nut() [2/2]

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

Return the turbulence viscosity on patch.

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 211 of file laminarModel.C.

References patchi, and scalarField().

Here is the call graph for this function:

◆ nuEff() [1/2]

Foam::tmp< Foam::volScalarField > nuEff ( ) const
virtual

Return the effective viscosity, i.e. the laminar viscosity.

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 224 of file laminarModel.C.

References nu.

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().

Here is the caller graph for this function:

◆ nuEff() [2/2]

Foam::tmp< Foam::scalarField > nuEff ( const label  patchi) const
virtual

Return the effective viscosity on patch.

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 239 of file laminarModel.C.

References nu.

◆ k()

Foam::tmp< Foam::volScalarField > k ( ) const
virtual

Return the turbulence kinetic energy, i.e. 0 for laminar flow.

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 249 of file laminarModel.C.

References Foam::sqr().

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ epsilon()

Foam::tmp< Foam::volScalarField > epsilon ( ) const
virtual

Return the turbulence kinetic energy dissipation rate,.

i.e. 0 for laminar flow

Reimplemented in Stokes< BasicTurbulenceModel >.

Definition at line 273 of file laminarModel.C.

References Foam::dimTime, and Foam::sqr().

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ R()

Foam::tmp< Foam::volSymmTensorField > R ( ) const
virtual

Return the Reynolds stress tensor, i.e. 0 for laminar flow.

Reimplemented in Maxwell< BasicTurbulenceModel >, and Stokes< BasicTurbulenceModel >.

Definition at line 300 of file laminarModel.C.

References Foam::sqr(), and Foam::Zero.

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correct()

void correct ( )
virtual

Member Data Documentation

◆ laminarDict_

dictionary laminarDict_
protected

laminar coefficients dictionary

Definition at line 59 of file laminarModel.H.

◆ printCoeffs_

Switch printCoeffs_
protected

Flag to print the model coeffs at run-time.

Definition at line 62 of file laminarModel.H.

◆ coeffDict_

dictionary coeffDict_
protected

Model coefficients dictionary.

Definition at line 65 of file laminarModel.H.

Referenced by laminarModel< BasicTurbulenceModel >::coeffDict().


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