src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::compressible::LESModels::GenEddyVisc
  26
  27 Description
  28     General base class for all compressible models that can be implemented as
  29     an eddy viscosity, i.e. algebraic and one-equation models.
  30
  31     Contains fields for k (SGS turbulent kinetic energy), gamma
  32     (modelled viscosity) and epsilon (SGS dissipation).
  33
  34 SourceFiles
  35     GenEddyVisc.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef compressibleGenEddyVisc_H
  40 #define compressibleGenEddyVisc_H
  41
  42 #include "LESModel.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48 namespace compressible
  49 {
  50 namespace LESModels
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class GenEddyVisc Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class GenEddyVisc
  58 :
  59     virtual public LESModel
  60 {
  61     // Private Member Functions
  62
  63         // Disallow default bitwise copy construct and assignment
  64         GenEddyVisc(const GenEddyVisc&);
  65         GenEddyVisc& operator=(const GenEddyVisc&);
  66
  67
  68 protected:
  69
  70     // Model coefficients
  71
  72         dimensionedScalar ce_;
  73         dimensionedScalar Prt_;
  74
  75
  76     // Fields
  77
  78         volScalarField muSgs_;
  79         volScalarField alphaSgs_;
  80
  81
  82 public:
  83
  84     //- Partial Runtime type information
  85     static const word typeName;
  86
  87     // Constructors
  88
  89         //- Construct from components
  90         GenEddyVisc
  91         (
  92             const volScalarField& rho,
  93             const volVectorField& U,
  94             const surfaceScalarField& phi,
  95             const basicThermo& thermoPhysicalModel,
  96             const word& turbulenceModelName = turbulenceModel::typeName,
  97             const word& modelName = typeName
  98         );
  99
 100
 101     //- Destructor
 102     virtual ~GenEddyVisc()
 103     {}
 104
 105
 106     // Member Functions
 107
 108         //- Return sub-grid disipation rate
 109         virtual tmp<volScalarField> epsilon() const
 110         {
 111             return ce_*k()*sqrt(k())/delta();
 112         }
 113
 114         //- Return viscosity
 115         virtual tmp<volScalarField> muSgs() const
 116         {
 117             return muSgs_;
 118         }
 119
 120         //- Return thermal diffusivity
 121         virtual tmp<volScalarField> alphaSgs() const
 122         {
 123             return alphaSgs_;
 124         }
 125
 126         //- Return the sub-grid stress tensor.
 127         virtual tmp<volSymmTensorField> B() const;
 128
 129         //- Return the deviatoric part of the effective sub-grid
 130         //  turbulence stress tensor including the laminar stress
 131         virtual tmp<volSymmTensorField> devRhoBeff() const;
 132
 133         //- Returns div(rho*dev(B)).
 134         // This is the additional term due to the filtering of the NSE.
 135         virtual tmp<fvVectorMatrix> divDevRhoBeff(volVectorField& U) const;
 136
 137         //- Correct Eddy-Viscosity and related properties
 138         virtual void correct(const tmp<volTensorField>& gradU);
 139
 140         //- Read LESProperties dictionary
 141         virtual bool read();
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace LESModels
 148 } // End namespace compressible
 149 } // End namespace Foam
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #endif
 154
 155 // ************************************************************************* //