Loading...
Searching...
No Matches
sigma< BasicTurbulenceModel > Class Template Reference
Turbulence models » LES turbulence

The sigma SGS model. More...

#include <sigma.H>

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

Public Types

typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel
Public Types inherited from LESeddyViscosity< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel
Public Types inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel
Public Types inherited from linearViscousStress< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
typedef BasicTurbulenceModel::rhoField rhoField
typedef BasicTurbulenceModel::transportModel transportModel

Public Member Functions

 TypeName ("sigma")
 Runtime type information.
 sigma (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
 Construct from components.
virtual ~sigma ()
 Destructor.
virtual bool read ()
 Read model coefficients if they have changed.
virtual tmp< volScalarField > k () const
 Return SGS kinetic energy.
virtual tmp< volScalarField > epsilon () const
 Return SGS disipation rate.
virtual void correct ()
 Correct Eddy-Viscosity and related properties.
Public Member Functions inherited from LESeddyViscosity< BasicTurbulenceModel >
 LESeddyViscosity (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Construct from components.
virtual ~LESeddyViscosity ()=default
 Destructor.
Public Member Functions inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
 eddyViscosity (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.
virtual ~eddyViscosity ()=default
 Destructor.
virtual tmp< volScalarField > nut () const
 Return the turbulence viscosity.
virtual tmp< volSymmTensorField > R () const
 Return the Reynolds stress tensor.
virtual void validate ()
 Validate the turbulence fields after construction.
Public Member Functions inherited from linearViscousStress< BasicTurbulenceModel >
 linearViscousStress (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.
virtual ~linearViscousStress ()=default
 Destructor.
virtual tmp< volSymmTensorField > devRhoReff () const
 Return the effective stress tensor.
virtual tmp< volSymmTensorField > devRhoReff (const volVectorField &U) const
 Return the effective stress tensor based on a given velocity field.
virtual tmp< fvVectorMatrix > divDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation.
virtual tmp< fvVectorMatrix > divDevRhoReff (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation.

Protected Member Functions

virtual void correctNut ()
 Update the SGS eddy-viscosity.

Protected Attributes

dimensionedScalar Ck_
dimensionedScalar Cw_
dimensionedScalar Csigma_
Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField nut_

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModels::sigma< BasicTurbulenceModel >

The sigma SGS model.

Reference: 

    Nicoud, F., Toda, H. B., Cabrit, O., Bose, S., & Lee, J. (2011).
    Using singular values to build a subgrid-scale
    model for large eddy simulations.
    Physics of fluids, 23(8), 085106.
    DOI:10.1063/1.3623274

The default model coefficients correspond to the following: 

    sigmaCoeffs
    {
        ck          0.094;
        Csigma      1.68;
    }
Note
The default value of the Csigma constant implemented was calibrated for OpenFOAM using decaying isotropic turbulence and is slightly higher than the value suggested in the reference publication.
Source files

Definition at line 77 of file sigma.H.

Member Typedef Documentation

◆ alphaField

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 113 of file sigma.H.

◆ rhoField

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 114 of file sigma.H.

◆ transportModel

template<class BasicTurbulenceModel>
typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 115 of file sigma.H.

Constructor & Destructor Documentation

◆ sigma()

template<class BasicTurbulenceModel>
sigma ( const alphaField & alpha,
const rhoField & rho,
const volVectorField & U,
const surfaceScalarField & alphaRhoPhi,
const surfaceScalarField & phi,
const transportModel & transport,
const word & propertiesName = turbulenceModel::propertiesName,
const word & type = typeName )

Construct from components.

Definition at line 50 of file sigma.C.

References alpha, Ck_, Csigma_, Cw_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, phi, rho, and U.

◆ ~sigma()

template<class BasicTurbulenceModel>
virtual ~sigma ( )
inlinevirtual

Destructor.

Definition at line 145 of file sigma.H.

Member Function Documentation

◆ correctNut()

template<class BasicTurbulenceModel>
void correctNut ( )
protectedvirtual

Update the SGS eddy-viscosity.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 36 of file sigma.C.

References optionList::correct(), Csigma_, delta, Foam::fvc::grad(), options::New(), eddyViscosity< LESModel< BasicTurbulenceModel > >::nut_, Foam::sqr(), and DESModel< BasicTurbulenceModel >::Ssigma().

Referenced by correct().

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

◆ TypeName()

template<class BasicTurbulenceModel>
TypeName ( "sigma< BasicTurbulenceModel >" )

Runtime type information.

◆ read()

template<class BasicTurbulenceModel>
bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Definition at line 114 of file sigma.C.

References Ck_, Csigma_, Cw_, and LESeddyViscosity< BasicTurbulenceModel >::read().

Here is the call graph for this function:

◆ k()

template<class BasicTurbulenceModel>
tmp< volScalarField > k ( ) const
virtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 130 of file sigma.C.

References Ck_, delta, Foam::devSymm(), Foam::fvc::grad(), IOobject::groupName(), Foam::magSqr(), tmp< T >::New(), and Foam::sqr().

Referenced by epsilon().

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

◆ epsilon()

template<class BasicTurbulenceModel>
tmp< volScalarField > epsilon ( ) const
virtual

Return SGS disipation rate.

Definition at line 143 of file sigma.C.

References delta, IOobject::groupName(), k(), k, tmp< T >::New(), and Foam::sqrt().

Here is the call graph for this function:

◆ correct()

template<class BasicTurbulenceModel>
void correct ( )
virtual

Correct Eddy-Viscosity and related properties.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 154 of file sigma.C.

References linearViscousStress< BasicTurbulenceModel >::correct(), and correctNut().

Here is the call graph for this function:

Member Data Documentation

◆ Ck_

template<class BasicTurbulenceModel>
dimensionedScalar Ck_
protected

Definition at line 98 of file sigma.H.

Referenced by k(), read(), and sigma().

◆ Cw_

template<class BasicTurbulenceModel>
dimensionedScalar Cw_
protected

Definition at line 99 of file sigma.H.

Referenced by read(), and sigma().

◆ Csigma_

template<class BasicTurbulenceModel>
dimensionedScalar Csigma_
protected

Definition at line 100 of file sigma.H.

Referenced by correctNut(), read(), and sigma().

The documentation for this class was generated from the following files:
  • src/TurbulenceModels/turbulenceModels/LES/sigma/sigma.H
  • src/TurbulenceModels/turbulenceModels/LES/sigma/sigma.C