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

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

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

Public Types

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

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 viscosity &viscosity, 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< volScalarField > k () const
 Return SGS kinetic energy. More...
 
virtual tmp< volScalarField > epsilon () 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 viscosity &viscosity)
 Construct from components. More...
 
 LESeddyViscosity (const LESeddyViscosity &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~LESeddyViscosity ()
 Destructor. More...
 
virtual tmp< volScalarField > omega () const
 Return the turbulence specific dissipation rate. 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 viscosity &viscosity)
 Construct from components. More...
 
virtual ~eddyViscosity ()
 Destructor. 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< volSymmTensorField > R () 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< BasicMomentumTransportModel >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
virtual ~linearViscousStress ()
 Destructor. More...
 
virtual tmp< surfaceVectorField > devTau () const
 Return the effective surface stress. More...
 
virtual tmp< fvVectorMatrix > divDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrix > divDevTau (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
template<class RhoFieldType >
Foam::tmp< Foam::fvVectorMatrix > DivDevTau (const RhoFieldType &rho, volVectorField &U) const
 

Protected Member Functions

tmp< volSymmTensorField > Sd (const volTensorField &gradU) const
 Return the deviatoric symmetric part of the square of the given. More...
 
tmp< volScalarField > k (const volTensorField &gradU) const
 Return SGS kinetic energy. More...
 
virtual void correctNut ()
 Update the SGS eddy-viscosity. More...
 
- Protected Member Functions inherited from linearViscousStress< BasicMomentumTransportModel >
template<class RhoFieldType >
tmp< fvVectorMatrix > DivDevTau (const RhoFieldType &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 

Protected Attributes

dimensionedScalar Ck_
 
dimensionedScalar Cw_
 
- Protected Attributes inherited from LESeddyViscosity< BasicMomentumTransportModel >
dimensionedScalar Ck_
 
dimensionedScalar Ce_
 
- Protected Attributes inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
volScalarField nut_
 

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.

Constructor & Destructor Documentation

◆ WALE() [1/2]

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

Construct from components.

Definition at line 93 of file WALE.C.

◆ WALE() [2/2]

WALE ( const WALE< BasicMomentumTransportModel > &  )
delete

Disallow default bitwise copy construction.

◆ ~WALE()

virtual ~WALE ( )
inlinevirtual

Destructor.

Definition at line 128 of file WALE.H.

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 40 of file WALE.C.

References Foam::dev(), 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 50 of file WALE.C.

References delta, Foam::magSqr(), GeometricField< Type, GeoMesh, PrimitiveField >::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(), and Foam::sqrt().

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 123 of file WALE.C.

◆ k() [2/2]

virtual tmp<volScalarField> k ( ) const
inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 138 of file WALE.H.

References Foam::fvc::grad().

Here is the call graph for this function:

◆ epsilon()

tmp< volScalarField > epsilon
virtual

Return sub-grid disipation rate.

Reimplemented from LESeddyViscosity< BasicMomentumTransportModel >.

Definition at line 140 of file WALE.C.

References delta, Foam::fvc::grad(), k, GeometricField< Type, GeoMesh, PrimitiveField >::New(), and Foam::sqrt().

Here is the call graph for this function:

◆ correct()

void correct
virtual

Correct Eddy-Viscosity and related properties.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Definition at line 153 of file WALE.C.

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

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.

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: