FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

Base class for all incompressible flow LES SGS models. More...

#include <incompressibleLESModels/LESModel.H>


Detailed Description

Base class for all incompressible flow LES SGS models.

This class defines the basic interface for an incompressible flow SGS model, and encapsulates data of value to all possible models. In particular this includes references to all the dependent fields (U, phi), the physical viscosity nu, and the LESProperties dictionary, which contains the model selection and model coefficients.

Source files

Definition at line 71 of file LESModel.H.

Inheritance diagram for incompressible::LESModel:
Collaboration diagram for incompressible::LESModel:

List of all members.

Public Member Functions

 TypeName ("LESModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, LESModel, dictionary,(const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel),(U, phi, lamTransportModel))
 LESModel (const word &type, const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)
 Construct from components.
virtual  ~LESModel ()
 Destructor.
const dictionary &  coeffDict () const
 Const access to the coefficients dictionary,.
virtual const volScalarField &  delta () const
 Access function to filter width.
const dimensionedScalar &  k0 () const
 Return the value of k0 which k is not allowed to be less than.
dimensionedScalar &  k0 ()
 Allow k0 to be changed.
virtual tmp< volScalarField >  k () const =0
 Return the SGS turbulent kinetic energy.
virtual tmp< volScalarField >  epsilon () const =0
 Return the SGS turbulent dissipation.
virtual tmp< volScalarField >  nuSgs () const =0
 Return the SGS viscosity.
virtual tmp< volScalarField >  nuEff () const
 Return the effective viscosity.
virtual tmp< volSymmTensorField >  B () const =0
 Return the sub-grid stress tensor.
virtual tmp< volSymmTensorField >  devBeff () const =0
 Return the deviatoric part of the effective sub-grid.
virtual tmp< fvVectorMatrix >  divDevBeff (volVectorField &U) const =0
 Returns div(dev(Beff)).
virtual tmp< volScalarField >  nut () const
 Return the turbulence viscosity.
virtual tmp< volSymmTensorField >  R () const
 Return the Reynolds stress tensor.
virtual tmp< volSymmTensorField >  devReff () const
 Return the effective stress tensor including the laminar stress.
virtual tmp< fvVectorMatrix >  divDevReff (volVectorField &U) const
 Return the source term for the momentum equation.
void  correct ()
 Correct Eddy-Viscosity and related properties.
virtual void  correct (const tmp< volTensorField > &gradU)
 Correct Eddy-Viscosity and related properties.
virtual bool  read ()=0
 Read LESProperties dictionary.

Static Public Member Functions

static autoPtr< LESModel >  New (const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)
 Return a reference to the selected LES model.

Protected Member Functions

virtual void  printCoeffs ()
 Print model coefficients.

Protected Attributes

Switch  printCoeffs_
dictionary  coeffDict_
dimensionedScalar  k0_
autoPtr< LESdelta >  delta_

Constructor & Destructor Documentation

LESModel ( const word &   type,
const volVectorField &   U,
const surfaceScalarField &   phi,
transportModel &   lamTransportModel  
)

Construct from components.

Definition at line 56 of file LESModel.C.

References readIfPresent().

virtual ~LESModel (  ) [inline, virtual]

Destructor.

Definition at line 152 of file LESModel.H.


Member Function Documentation

void printCoeffs (  ) [protected, virtual]

Print model coefficients.

Definition at line 44 of file LESModel.C.

References Foam::endl(), Foam::Info, and Foam::type().

TypeName ( "LESModel"    )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr   ,
LESModel   ,
dictionary   ,
(const volVectorField &U, const surfaceScalarField &phi, transportModel &lamTransportModel)   ,
(U, phi, lamTransportModel)    
)
autoPtr< LESModel > New ( const volVectorField &   U,
const surfaceScalarField &   phi,
transportModel &   lamTransportModel  
) [static]
const dictionary& coeffDict (  ) const [inline]
const dimensionedScalar& k0 (  ) const [inline]

Return the value of k0 which k is not allowed to be less than.

Definition at line 173 of file LESModel.H.

References incompressible::LESModel::k0_.

Referenced by LRRDiffStress::correct(), locDynOneEqEddy::correct(), kOmegaSSTSAS::correct(), oneEqEddy::correct(), dynOneEqEddy::correct(), and DeardorffDiffStress::correct().

dimensionedScalar& k0 (  ) [inline]

Allow k0 to be changed.

Definition at line 179 of file LESModel.H.

References incompressible::LESModel::k0_.

virtual tmp<volScalarField> epsilon (  ) const [pure virtual]

Return the SGS turbulent dissipation.

Implements incompressible::turbulenceModel.

Implemented in GenEddyVisc, GenSGSStress, kOmegaSSTSAS, laminar, mixedSmagorinsky, scaleSimilarity, and SpalartAllmaras.

virtual tmp<volScalarField> nuSgs (  ) const [pure virtual]
virtual tmp<volSymmTensorField> B (  ) const [pure virtual]

Return the sub-grid stress tensor.

Implemented in GenEddyVisc, GenSGSStress, kOmegaSSTSAS, laminar, mixedSmagorinsky, scaleSimilarity, Smagorinsky2, and SpalartAllmaras.

Referenced by incompressible::LESModel::R().

virtual tmp<volSymmTensorField> devBeff (  ) const [pure virtual]

Return the deviatoric part of the effective sub-grid.

turbulence stress tensor including the laminar stress

Implemented in GenEddyVisc, GenSGSStress, kOmegaSSTSAS, laminar, mixedSmagorinsky, scaleSimilarity, and SpalartAllmaras.

Referenced by incompressible::LESModel::devReff().

virtual tmp<fvVectorMatrix> divDevBeff ( volVectorField &   U  ) const [pure virtual]

Returns div(dev(Beff)).

This is the additional term due to the filtering of the NSE.

Implemented in GenEddyVisc, GenSGSStress, kOmegaSSTSAS, laminar, mixedSmagorinsky, scaleSimilarity, Smagorinsky2, and SpalartAllmaras.

Referenced by incompressible::LESModel::divDevReff().

virtual tmp<volScalarField> nut (  ) const [inline, virtual]

Return the turbulence viscosity.

Implements incompressible::turbulenceModel.

Definition at line 218 of file LESModel.H.

References incompressible::LESModel::nuSgs().

virtual tmp<volSymmTensorField> R (  ) const [inline, virtual]

Return the Reynolds stress tensor.

Implements incompressible::turbulenceModel.

Definition at line 224 of file LESModel.H.

References incompressible::LESModel::B().

virtual tmp<volSymmTensorField> devReff (  ) const [inline, virtual]

Return the effective stress tensor including the laminar stress.

Implements incompressible::turbulenceModel.

Definition at line 230 of file LESModel.H.

References incompressible::LESModel::devBeff().

virtual tmp<fvVectorMatrix> divDevReff ( volVectorField &   U  ) const [inline, virtual]

Return the source term for the momentum equation.

Definition at line 236 of file LESModel.H.

References incompressible::LESModel::divDevBeff().

void correct (  ) [virtual]
void correct ( const tmp< volTensorField > &   gradU  ) [virtual]

Member Data Documentation

Switch printCoeffs_ [protected]

Definition at line 81 of file LESModel.H.

dictionary coeffDict_ [protected]

Definition at line 82 of file LESModel.H.

Referenced by incompressible::LESModel::coeffDict().

dimensionedScalar k0_ [protected]

Definition at line 84 of file LESModel.H.

Referenced by incompressible::LESModel::k0().

autoPtr<LESdelta> delta_ [protected]

Definition at line 86 of file LESModel.H.

Referenced by incompressible::LESModel::delta().


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