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

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

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

Public Types

typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 

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 viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))
 
 RASModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
 RASModel (const RASModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~RASModel ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
const dimensionedScalar & kMin () const
 Return the lower allowable limit for k (default: small) More...
 
const dimensionedScalar & epsilonMin () const
 Return the lower allowable limit for epsilon (default: small) More...
 
const dimensionedScalar & omegaMin () const
 Return the lower allowable limit for omega (default: small) More...
 
dimensionedScalar & kMin ()
 Allow kMin to be changed. More...
 
dimensionedScalar & epsilonMin ()
 Allow epsilonMin to be changed. More...
 
dimensionedScalar & omegaMin ()
 Allow omegaMin to be changed. More...
 
virtual const dictionary & coeffDict () const
 Const access to the coefficients dictionary. 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...
 
virtual tmp< volScalarField > nuEff () const
 Return the effective viscosity. More...
 
virtual tmp< scalarField > nuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual void correct ()
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
void operator= (const RASModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< RASModel > New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 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...
 
autoPtr< laminarModels::generalisedNewtonianViscosityModel > viscosityModel_
 Run-time selectable generalised Newtonian viscosity model. More...
 

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::RASModel< BasicMomentumTransportModel >

Templated abstract base class for RAS turbulence models.

with support for generalised Newtonian viscosity models including strain-rate dependency.

Source files

Definition at line 53 of file RASModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 96 of file RASModel.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 97 of file RASModel.H.

Constructor & Destructor Documentation

◆ RASModel() [1/2]

RASModel ( const word &  type,
const alphaField &  alpha,
const rhoField &  rho,
const volVectorField &  U,
const surfaceScalarField &  alphaRhoPhi,
const surfaceScalarField &  phi,
const viscosity &  viscosity 
)

Construct from components.

Definition at line 45 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::printCoeffs().

Here is the caller graph for this function:

◆ RASModel() [2/2]

RASModel ( const RASModel< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise copy construction.

◆ ~RASModel()

virtual ~RASModel ( )
inlinevirtual

Destructor.

Definition at line 156 of file RASModel.H.

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( const word &  type)
protectedvirtual

Print model coefficients.

Definition at line 32 of file RASModel.C.

◆ TypeName()

TypeName ( "RAS"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
RASModel< BasicMomentumTransportModel >  ,
dictionary  ,
(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)  ,
(alpha, rho, U, alphaRhoPhi, phi, viscosity)   
)

◆ New()

Foam::autoPtr< Foam::RASModel< BasicMomentumTransportModel > > New ( const alphaField &  alpha,
const rhoField &  rho,
const volVectorField &  U,
const surfaceScalarField &  alphaRhoPhi,
const surfaceScalarField &  phi,
const viscosity &  viscosity 
)
static

Return a reference to the selected RAS model.

Definition at line 135 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::RASModel().

Here is the caller graph for this function:

◆ read()

bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented in kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >, kOmegaSSTLM< BasicMomentumTransportModel >, mixtureKEpsilon< BasicMomentumTransportModel >, v2f< BasicMomentumTransportModel >, kOmegaSSTSato< BasicMomentumTransportModel >, SpalartAllmaras< BasicMomentumTransportModel >, kineticTheoryModel, LRR< BasicMomentumTransportModel >, kEpsilonLopesdaCosta< BasicMomentumTransportModel >, SSG< BasicMomentumTransportModel >, kOmegaSSTSAS< BasicMomentumTransportModel >, realizableKE< BasicMomentumTransportModel >, RNGkEpsilon< BasicMomentumTransportModel >, kOmega2006< BasicMomentumTransportModel >, LaunderSharmaKE< BasicMomentumTransportModel >, kEpsilon< BasicMomentumTransportModel >, kEpsilon< compressible::momentumTransportModel >, LaheyKEpsilon< BasicMomentumTransportModel >, continuousGasKEpsilon< BasicMomentumTransportModel >, kOmega< BasicMomentumTransportModel >, buoyantKEpsilon< BasicMomentumTransportModel >, phasePressureModel, PDRkEpsilon, ReynoldsStress< RASModel< BasicMomentumTransportModel > >, eddyViscosity< RASModel< compressible::momentumTransportModel > >, eddyViscosity< RASModel< BasicMomentumTransportModel > >, eddyViscosity< RASModel< phaseCompressible::momentumTransportModel > >, linearViscousStress< RASModel< compressible::momentumTransportModel > >, linearViscousStress< RASModel< BasicMomentumTransportModel > >, and linearViscousStress< RASModel< phaseCompressible::momentumTransportModel > >.

Definition at line 184 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::~RASModel().

Here is the caller graph for this function:

◆ kMin() [1/2]

const dimensionedScalar& kMin ( ) const
inline

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

Definition at line 166 of file RASModel.H.

◆ epsilonMin() [1/2]

const dimensionedScalar& epsilonMin ( ) const
inline

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

Definition at line 172 of file RASModel.H.

◆ omegaMin() [1/2]

const dimensionedScalar& omegaMin ( ) const
inline

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

Definition at line 178 of file RASModel.H.

◆ kMin() [2/2]

dimensionedScalar& kMin ( )
inline

Allow kMin to be changed.

Definition at line 184 of file RASModel.H.

◆ epsilonMin() [2/2]

dimensionedScalar& epsilonMin ( )
inline

Allow epsilonMin to be changed.

Definition at line 190 of file RASModel.H.

◆ omegaMin() [2/2]

dimensionedScalar& omegaMin ( )
inline

Allow omegaMin to be changed.

Definition at line 196 of file RASModel.H.

◆ coeffDict()

virtual const dictionary& coeffDict ( ) const
inlinevirtual

Const access to the coefficients dictionary.

Definition at line 202 of file RASModel.H.

◆ nu() [1/2]

virtual tmp<volScalarField> nu ( ) const
inlinevirtual

Return the laminar viscosity.

Definition at line 208 of file RASModel.H.

Referenced by mixtureKEpsilon< BasicMomentumTransportModel >::correct(), kEpsilon< compressible::momentumTransportModel >::DepsilonEff(), LaunderSharmaKE< BasicMomentumTransportModel >::DepsilonEff(), RNGkEpsilon< BasicMomentumTransportModel >::DepsilonEff(), realizableKE< BasicMomentumTransportModel >::DepsilonEff(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::DepsilonEff(), v2f< BasicMomentumTransportModel >::DepsilonEff(), kOmegaSSTLM< BasicMomentumTransportModel >::DgammaIntEff(), kOmega< BasicMomentumTransportModel >::DkEff(), kEpsilon< compressible::momentumTransportModel >::DkEff(), LaunderSharmaKE< BasicMomentumTransportModel >::DkEff(), kOmega2006< BasicMomentumTransportModel >::DkEff(), RNGkEpsilon< BasicMomentumTransportModel >::DkEff(), realizableKE< BasicMomentumTransportModel >::DkEff(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::DkEff(), v2f< BasicMomentumTransportModel >::DkEff(), kOmega< BasicMomentumTransportModel >::DomegaEff(), kOmega2006< BasicMomentumTransportModel >::DomegaEff(), kOmegaSSTLM< BasicMomentumTransportModel >::gammaInt(), and RASModel< phaseCompressible::momentumTransportModel >::nuEff().

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.

Definition at line 214 of file RASModel.H.

◆ nuEff() [1/2]

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Reimplemented in kineticTheoryModel, continuousGasKEpsilon< BasicMomentumTransportModel >, and phasePressureModel.

Definition at line 220 of file RASModel.H.

◆ nuEff() [2/2]

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

Return the effective viscosity on patch.

Reimplemented in kineticTheoryModel, and phasePressureModel.

Definition at line 230 of file RASModel.H.

◆ correct()

void correct ( )
virtual

Solve the turbulence equations and correct the turbulence viscosity.

Reimplemented in kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >, kOmegaSSTLM< BasicMomentumTransportModel >, v2f< BasicMomentumTransportModel >, mixtureKEpsilon< BasicMomentumTransportModel >, kEpsilonLopesdaCosta< BasicMomentumTransportModel >, kineticTheoryModel, LRR< BasicMomentumTransportModel >, realizableKE< BasicMomentumTransportModel >, RNGkEpsilon< BasicMomentumTransportModel >, SSG< BasicMomentumTransportModel >, SpalartAllmaras< BasicMomentumTransportModel >, kOmega2006< BasicMomentumTransportModel >, LaunderSharmaKE< BasicMomentumTransportModel >, kEpsilon< BasicMomentumTransportModel >, kEpsilon< compressible::momentumTransportModel >, kOmegaSSTSato< BasicMomentumTransportModel >, kOmega< BasicMomentumTransportModel >, phasePressureModel, ReynoldsStress< RASModel< BasicMomentumTransportModel > >, LaheyKEpsilon< BasicMomentumTransportModel >, eddyViscosity< RASModel< compressible::momentumTransportModel > >, eddyViscosity< RASModel< BasicMomentumTransportModel > >, eddyViscosity< RASModel< phaseCompressible::momentumTransportModel > >, PDRkEpsilon, linearViscousStress< RASModel< compressible::momentumTransportModel > >, linearViscousStress< RASModel< BasicMomentumTransportModel > >, and linearViscousStress< RASModel< phaseCompressible::momentumTransportModel > >.

Definition at line 207 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::nuEff().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const RASModel< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise assignment.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::nuEff().

Here is the caller graph for this function:

Member Data Documentation

◆ RASDict_

dictionary RASDict_
protected

RAS coefficients dictionary.

Definition at line 63 of file RASModel.H.

◆ turbulence_

Switch turbulence_
protected

Turbulence on/off flag.

Definition at line 66 of file RASModel.H.

◆ printCoeffs_

Switch printCoeffs_
protected

Flag to print the model coeffs at run-time.

Definition at line 69 of file RASModel.H.

◆ coeffDict_

dictionary coeffDict_
protected

Model coefficients dictionary.

Definition at line 72 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::coeffDict().

◆ kMin_

dimensionedScalar kMin_
protected

Lower limit of k.

Definition at line 75 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::kMin().

◆ epsilonMin_

dimensionedScalar epsilonMin_
protected

Lower limit of epsilon.

Definition at line 78 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::epsilonMin().

◆ omegaMin_

dimensionedScalar omegaMin_
protected

Lower limit for omega.

Definition at line 81 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::omegaMin().

◆ viscosityModel_

autoPtr<laminarModels::generalisedNewtonianViscosityModel> viscosityModel_
protected

Run-time selectable generalised Newtonian viscosity model.

Definition at line 85 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::nu().

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