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

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

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

Public Types

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

Public Member Functions

 TypeName ("RAS")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, RASModel, 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))
 
 RASModel (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 ~RASModel ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
const dimensionedScalarkMin () const
 Return the lower allowable limit for k (default: SMALL) More...
 
const dimensionedScalarepsilonMin () const
 Return the lower allowable limit for epsilon (default: SMALL) More...
 
const dimensionedScalaromegaMin () const
 Return the lower allowable limit for omega (default: SMALL) More...
 
dimensionedScalarkMin ()
 Allow kMin to be changed. More...
 
dimensionedScalarepsilonMin ()
 Allow epsilonMin to be changed. More...
 
dimensionedScalaromegaMin ()
 Allow omegaMin to be changed. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. 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< RASModelNew (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 RAS model. More...
 

Protected Member Functions

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

Protected Attributes

dictionary RASDict_
 RAS 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...
 
dimensionedScalar epsilonMin_
 Lower limit of epsilon. More...
 
dimensionedScalar omegaMin_
 Lower limit for omega. More...
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::RASModel< BasicTurbulenceModel >

Templated abstract base class for RAS turbulence models.

Source files

Definition at line 49 of file RASModel.H.

Member Typedef Documentation

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 99 of file RASModel.H.

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 100 of file RASModel.H.

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 101 of file RASModel.H.

Constructor & Destructor Documentation

RASModel ( 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 RASModel.C.

References RASModel< BasicTurbulenceModel >::New().

Here is the call graph for this function:

virtual ~RASModel ( )
inlinevirtual

Destructor.

Definition at line 160 of file RASModel.H.

References RASModel< 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 RASModel.C.

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

Here is the call graph for this function:

TypeName ( "RAS"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
RASModel< 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::RASModel< 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 RAS model.

Definition at line 116 of file RASModel.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 RASModel< BasicTurbulenceModel >::RASModel().

Here is the call graph for this function:

Here is the caller graph for this function:

bool read ( )
virtual
const dimensionedScalar& kMin ( ) const
inline

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

Definition at line 173 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::kMin_.

const dimensionedScalar& epsilonMin ( ) const
inline

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

Definition at line 179 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::epsilonMin_.

const dimensionedScalar& omegaMin ( ) const
inline

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

Definition at line 185 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::omegaMin_.

dimensionedScalar& kMin ( )
inline

Allow kMin to be changed.

Definition at line 191 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::kMin_.

dimensionedScalar& epsilonMin ( )
inline

Allow epsilonMin to be changed.

Definition at line 197 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::epsilonMin_.

dimensionedScalar& omegaMin ( )
inline

Allow omegaMin to be changed.

Definition at line 203 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::omegaMin_.

virtual const dictionary& coeffDict ( ) const
inlinevirtual

Const access to the coefficients dictionary.

Definition at line 209 of file RASModel.H.

References RASModel< BasicTurbulenceModel >::coeffDict_.

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Reimplemented in continuousGasKEpsilon< BasicTurbulenceModel >.

Definition at line 216 of file RASModel.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 229 of file RASModel.H.

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

Here is the call graph for this function:

void correct ( )
virtual

Member Data Documentation

dictionary RASDict_
protected

RAS coefficients dictionary.

Definition at line 59 of file RASModel.H.

Switch turbulence_
protected

Turbulence on/off flag.

Definition at line 62 of file RASModel.H.

Switch printCoeffs_
protected

Flag to print the model coeffs at run-time.

Definition at line 65 of file RASModel.H.

dictionary coeffDict_
protected

Model coefficients dictionary.

Definition at line 68 of file RASModel.H.

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

dimensionedScalar kMin_
protected

Lower limit of k.

Definition at line 71 of file RASModel.H.

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

dimensionedScalar epsilonMin_
protected

Lower limit of epsilon.

Definition at line 74 of file RASModel.H.

Referenced by RASModel< BasicTurbulenceModel >::epsilonMin().

dimensionedScalar omegaMin_
protected

Lower limit for omega.

Definition at line 77 of file RASModel.H.

Referenced by RASModel< BasicTurbulenceModel >::omegaMin().


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