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

Templated abstract base class for LES SGS models. More...

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

Public Types

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

Public Member Functions

 TypeName ("LES")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LESModel, 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))
 
 LESModel (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 ~LESModel ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
const dimensionedScalarkMin () const
 Return the lower allowable limit for k (default: SMALL) More...
 
dimensionedScalarkMin ()
 Allow kMin to be changed. More...
 
const volScalarFielddelta () const
 Access function to filter width. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual void correct ()
 Solve the turbulence equations and correct the turbulence viscosity. More...
 

Static Public Member Functions

static autoPtr< LESModelNew (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 LES model. More...
 

Protected Member Functions

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

Protected Attributes

dictionary LESDict_
 LES coefficients dictionary. More...
 
Switch turbulence_
 Turbulence on/off flag. More...
 
Switch printCoeffs_
 Flag to print the model coeffs at run-time. More...
 
dictionary coeffDict_
 Model coefficients dictionary. More...
 
dimensionedScalar kMin_
 Lower limit of k. More...
 
autoPtr< Foam::LESdeltadelta_
 Run-time selectable delta model. More...
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModel< BasicTurbulenceModel >

Templated abstract base class for LES SGS models.

Source files

Definition at line 56 of file LESModel.H.

Member Typedef Documentation

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 103 of file LESModel.H.

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 104 of file LESModel.H.

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 105 of file LESModel.H.

Constructor & Destructor Documentation

LESModel ( 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 44 of file LESModel.C.

References LESModel< BasicTurbulenceModel >::New().

Here is the call graph for this function:

virtual ~LESModel ( )
inlinevirtual

Destructor.

Definition at line 164 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Function Documentation

void printCoeffs ( const word type)
protectedvirtual

Print model coefficients.

Definition at line 31 of file LESModel.C.

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

Here is the call graph for this function:

TypeName ( "LES"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
LESModel< 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)   
)
Foam::autoPtr< Foam::LESModel< 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 LES model.

Definition at line 104 of file LESModel.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool read ( )
virtual
virtual const dictionary& coeffDict ( ) const
inlinevirtual

Const access to the coefficients dictionary.

Definition at line 177 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::coeffDict_.

const dimensionedScalar& kMin ( ) const
inline

Return the lower allowable limit for k (default: SMALL)

Definition at line 183 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::kMin_.

dimensionedScalar& kMin ( )
inline

Allow kMin to be changed.

Definition at line 189 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::kMin_.

const volScalarField& delta ( ) const
inline

Access function to filter width.

Definition at line 195 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::delta_.

Referenced by dynamicLagrangian< BasicTurbulenceModel >::k().

Here is the caller graph for this function:

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Definition at line 202 of file LESModel.H.

References IOobject::groupName(), nu, and nut.

Here is the call graph for this function:

virtual tmp<scalarField> nuEff ( const label  patchi) const
inlinevirtual

Return the effective viscosity on patch.

Definition at line 215 of file LESModel.H.

References LESModel< BasicTurbulenceModel >::correct(), nu, and nut.

Here is the call graph for this function:

void correct ( )
virtual

Member Data Documentation

dictionary LESDict_
protected

LES coefficients dictionary.

Definition at line 66 of file LESModel.H.

Switch turbulence_
protected

Turbulence on/off flag.

Definition at line 69 of file LESModel.H.

Switch printCoeffs_
protected

Flag to print the model coeffs at run-time.

Definition at line 72 of file LESModel.H.

dictionary coeffDict_
protected

Model coefficients dictionary.

Definition at line 75 of file LESModel.H.

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

dimensionedScalar kMin_
protected

Lower limit of k.

Definition at line 78 of file LESModel.H.

Referenced by LESModel< BasicTurbulenceModel >::kMin().

autoPtr<Foam::LESdelta> delta_
protected

Run-time selectable delta model.

Definition at line 81 of file LESModel.H.

Referenced by LESModel< BasicTurbulenceModel >::delta().


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