Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ReynoldsStress< BasicTurbulenceModel > Class Template Referenceabstract
Turbulence models

Reynolds-stress turbulence model base class. More...

Inheritance diagram for ReynoldsStress< BasicTurbulenceModel >:
[legend]
Collaboration diagram for ReynoldsStress< BasicTurbulenceModel >:
[legend]

Public Types

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

Public Member Functions

 ReynoldsStress (const word &modelName, 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 ~ReynoldsStress ()=default
 Destructor. More...
 
virtual bool read ()=0
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volScalarField > nut () const
 Return the turbulence viscosity. More...
 
virtual tmp< scalarField > nut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarField > k () const
 Return the turbulence kinetic energy. More...
 
virtual tmp< volSymmTensorField > R () const
 Return the Reynolds stress tensor. More...
 
virtual tmp< volSymmTensorField > devRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< volSymmTensorField > devRhoReff (const volVectorField &U) const
 Return the effective stress tensor based on a given velocity field. More...
 
virtual tmp< fvVectorMatrix > divDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrix > divDevRhoReff (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual void validate ()
 Validate the turbulence fields after construction. More...
 
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
template<class RhoFieldType >
Foam::tmp< Foam::fvVectorMatrix > DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const
 

Protected Member Functions

void boundNormalStress (volSymmTensorField &R) const
 
void correctWallShearStress (volSymmTensorField &R) const
 
virtual void correctNut ()=0
 Update the eddy-viscosity. More...
 
template<class RhoFieldType >
tmp< fvVectorMatrix > DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 

Protected Attributes

dimensionedScalar couplingFactor_
 
volSymmTensorField R_
 
volScalarField nut_
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::ReynoldsStress< BasicTurbulenceModel >

Reynolds-stress turbulence model base class.

Source files

Definition at line 53 of file ReynoldsStress.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 91 of file ReynoldsStress.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 92 of file ReynoldsStress.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 93 of file ReynoldsStress.H.

Constructor & Destructor Documentation

◆ ReynoldsStress()

ReynoldsStress ( const word &  modelName,
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 112 of file ReynoldsStress.C.

◆ ~ReynoldsStress()

virtual ~ReynoldsStress ( )
virtualdefault

Destructor.

Member Function Documentation

◆ boundNormalStress()

void boundNormalStress ( volSymmTensorField &  R) const
protected

Definition at line 38 of file ReynoldsStress.C.

◆ correctWallShearStress()

void correctWallShearStress ( volSymmTensorField &  R) const
protected

Definition at line 63 of file ReynoldsStress.C.

◆ correctNut()

virtual void correctNut ( )
protectedpure virtual

Update the eddy-viscosity.

Implemented in LRR< BasicTurbulenceModel >, SSG< BasicTurbulenceModel >, and DeardorffDiffStress< BasicTurbulenceModel >.

◆ DivDevRhoReff() [1/2]

tmp<fvVectorMatrix> DivDevRhoReff ( const RhoFieldType &  rho,
volVectorField &  U 
) const
protected

Return the source term for the momentum equation.

◆ read()

bool read ( )
pure virtual

Re-read model coefficients if they have changed.

Implemented in LRR< BasicTurbulenceModel >, SSG< BasicTurbulenceModel >, and DeardorffDiffStress< BasicTurbulenceModel >.

Definition at line 184 of file ReynoldsStress.C.

◆ nut() [1/2]

virtual tmp<volScalarField> nut ( ) const
inlinevirtual

Return the turbulence viscosity.

Definition at line 122 of file ReynoldsStress.H.

◆ nut() [2/2]

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

Return the turbulence viscosity on patch.

Definition at line 128 of file ReynoldsStress.H.

◆ k()

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

Return the turbulence kinetic energy.

Reimplemented in LRR< BasicTurbulenceModel >, and SSG< BasicTurbulenceModel >.

Definition at line 200 of file ReynoldsStress.C.

◆ R()

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

Return the Reynolds stress tensor.

Definition at line 192 of file ReynoldsStress.C.

◆ devRhoReff() [1/2]

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

Return the effective stress tensor.

Definition at line 210 of file ReynoldsStress.C.

◆ devRhoReff() [2/2]

Foam::tmp< Foam::volSymmTensorField > devRhoReff ( const volVectorField &  U) const
virtual

Return the effective stress tensor based on a given velocity field.

Definition at line 219 of file ReynoldsStress.C.

◆ divDevRhoReff() [1/2]

Foam::tmp< Foam::fvVectorMatrix > divDevRhoReff ( volVectorField &  U) const
virtual

Return the source term for the momentum equation.

Definition at line 294 of file ReynoldsStress.C.

◆ divDevRhoReff() [2/2]

Foam::tmp< Foam::fvVectorMatrix > divDevRhoReff ( const volScalarField &  rho,
volVectorField &  U 
) const
virtual

Return the source term for the momentum equation.

Definition at line 305 of file ReynoldsStress.C.

◆ validate()

void validate ( )
virtual

Validate the turbulence fields after construction.

Update turbulence viscosity and other derived fields as requires

Definition at line 315 of file ReynoldsStress.C.

◆ correct()

void correct ( )
pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implemented in LRR< BasicTurbulenceModel >, SSG< BasicTurbulenceModel >, and DeardorffDiffStress< BasicTurbulenceModel >.

Definition at line 322 of file ReynoldsStress.C.

◆ DivDevRhoReff() [2/2]

Foam::tmp<Foam::fvVectorMatrix> DivDevRhoReff ( const RhoFieldType &  rho,
volVectorField &  U 
) const

Definition at line 247 of file ReynoldsStress.C.

Member Data Documentation

◆ couplingFactor_

dimensionedScalar couplingFactor_
protected

Definition at line 64 of file ReynoldsStress.H.

◆ R_

volSymmTensorField R_
protected

Definition at line 68 of file ReynoldsStress.H.

◆ nut_

volScalarField nut_
protected

Definition at line 69 of file ReynoldsStress.H.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut().

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