All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
WALE< BasicMomentumTransportModel > Class Template Reference

The Wall-adapting local eddy-viscosity (WALE) SGS model. More...

Inheritance diagram for WALE< BasicMomentumTransportModel >:
Collaboration diagram for WALE< BasicMomentumTransportModel >:

Public Types

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

Public Member Functions

 TypeName ("WALE")
 Runtime type information. More...
 
 WALE (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &type=typeName)
 Construct from components. More...
 
 WALE (const WALE &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~WALE ()
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
virtual tmp< volScalarFieldk () const
 Return SGS kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return sub-grid disipation rate. More...
 
virtual void correct ()
 Correct Eddy-Viscosity and related properties. More...
 
void operator= (const WALE &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from LESeddyViscosity< BasicMomentumTransportModel >
 LESeddyViscosity (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
 LESeddyViscosity (const LESeddyViscosity &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~LESeddyViscosity ()
 Destructor. More...
 
void operator= (const LESeddyViscosity &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
 eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
virtual ~eddyViscosity ()
 Destructor. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volSymmTensorFieldsigma () const
 Return the Reynolds stress tensor [m^2/s^2]. More...
 
virtual void validate ()
 Validate the turbulence fields after construction. More...
 
- Public Member Functions inherited from linearViscousStress< LESModel< BasicMomentumTransportModel > >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
virtual ~linearViscousStress ()
 Destructor. More...
 
virtual tmp< volSymmTensorFielddevTau () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrixdivDevTau (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
- Public Member Functions inherited from LESModel< BasicMomentumTransportModel >
 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),(alpha, rho, U, alphaRhoPhi, phi, transport))
 
 LESModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
 LESModel (const LESModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~LESModel ()
 Destructor. 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...
 
void operator= (const LESModel &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

tmp< volSymmTensorFieldSd (const volTensorField &gradU) const
 Return the deviatoric symmetric part of the square of the given. More...
 
tmp< volScalarFieldk (const volTensorField &gradU) const
 Return SGS kinetic energy. More...
 
virtual void correctNut ()
 Update the SGS eddy-viscosity. More...
 
- Protected Member Functions inherited from LESModel< BasicMomentumTransportModel >
virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 

Protected Attributes

dimensionedScalar Ck_
 
dimensionedScalar Cw_
 
- Protected Attributes inherited from LESeddyViscosity< BasicMomentumTransportModel >
dimensionedScalar Ce_
 
- Protected Attributes inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
volScalarField nut_
 
- Protected Attributes inherited from LESModel< BasicMomentumTransportModel >
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...
 
dimensionedScalar epsilonMin_
 Lower limit of epsilon. More...
 
dimensionedScalar omegaMin_
 Lower limit for omega. More...
 
autoPtr< Foam::LESdeltadelta_
 Run-time selectable delta model. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LESModel< BasicMomentumTransportModel >
static autoPtr< LESModelNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Return a reference to the selected LES model. More...
 

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::LESModels::WALE< BasicMomentumTransportModel >

The Wall-adapting local eddy-viscosity (WALE) SGS model.

Reference:

    Nicoud, F., & Ducros, F. (1999).
    Subgrid-scale stress modelling based on the square of the velocity
    gradient tensor.
    Flow, Turbulence and Combustion, 62(3), 183-200.

The default model coefficients are

    WALECoeffs
    {
        Ck                  0.094;
        Ce                  1.048;e
        Cw                  0.325;
    }
See also
Foam::LESModels::Smagorinsky
Source files

Definition at line 73 of file WALE.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 101 of file WALE.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 102 of file WALE.H.

◆ transportModel

typedef BasicMomentumTransportModel::transportModel transportModel

Definition at line 103 of file WALE.H.

Constructor & Destructor Documentation

◆ WALE() [1/2]

WALE ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const transportModel transport,
const word type = typeName 
)

Construct from components.

Definition at line 94 of file WALE.C.

Referenced by WALE< BasicMomentumTransportModel >::correctNut().

Here is the caller graph for this function:

◆ WALE() [2/2]

WALE ( const WALE< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise copy construction.

◆ ~WALE()

virtual ~WALE ( )
inlinevirtual

Destructor.

Definition at line 129 of file WALE.H.

References WALE< BasicMomentumTransportModel >::read().

Here is the call graph for this function:

Member Function Documentation

◆ Sd()

tmp< volSymmTensorField > Sd ( const volTensorField gradU) const
protected

Return the deviatoric symmetric part of the square of the given.

velocity gradient field

Definition at line 41 of file WALE.C.

References Foam::dev(), WALE< BasicMomentumTransportModel >::k(), and Foam::symm().

Here is the call graph for this function:

◆ k() [1/2]

tmp< volScalarField > k ( const volTensorField gradU) const
protected

Return SGS kinetic energy.

calculated from the given velocity gradient

Definition at line 51 of file WALE.C.

References delta, IOobject::groupName(), Foam::magSqr(), GeometricField< scalar, fvPatchField, volMesh >::New(), Foam::pow(), Foam::pow3(), Foam::sqr(), and Foam::symm().

Here is the call graph for this function:

◆ correctNut()

void correctNut ( )
protectedvirtual

Update the SGS eddy-viscosity.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 82 of file WALE.C.

References delta, Foam::fvc::grad(), k, dictionary::New(), Foam::sqrt(), and WALE< BasicMomentumTransportModel >::WALE().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "WALE< BasicMomentumTransportModel >"  )

Runtime type information.

◆ read()

bool read ( )
virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicMomentumTransportModel >.

Definition at line 145 of file WALE.C.

Referenced by WALE< BasicMomentumTransportModel >::~WALE().

Here is the caller graph for this function:

◆ k() [2/2]

virtual tmp<volScalarField> k ( ) const
inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 139 of file WALE.H.

References WALE< BasicMomentumTransportModel >::correct(), WALE< BasicMomentumTransportModel >::epsilon(), Foam::fvc::grad(), and WALE< BasicMomentumTransportModel >::operator=().

Referenced by WALE< BasicMomentumTransportModel >::Sd().

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

◆ epsilon()

tmp< volScalarField > epsilon ( ) const
virtual

Return sub-grid disipation rate.

Reimplemented from LESeddyViscosity< BasicMomentumTransportModel >.

Definition at line 162 of file WALE.C.

References delta, Foam::fvc::grad(), IOobject::groupName(), k, GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::sqrt().

Referenced by WALE< BasicMomentumTransportModel >::k().

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

◆ correct()

void correct ( )
virtual

Correct Eddy-Viscosity and related properties.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 175 of file WALE.C.

References eddyViscosity< LESModel< BasicMomentumTransportModel > >::correct().

Referenced by WALE< BasicMomentumTransportModel >::k().

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

◆ operator=()

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

Disallow default bitwise assignment.

Referenced by WALE< BasicMomentumTransportModel >::k().

Here is the caller graph for this function:

Member Data Documentation

◆ Ck_

dimensionedScalar Ck_
protected

Definition at line 81 of file WALE.H.

◆ Cw_

dimensionedScalar Cw_
protected

Definition at line 82 of file WALE.H.


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