src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.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::RASModels::realizableKE
  26
  27 Description
  28     Realizable k-epsilon turbulence model for compressible flows.
  29
  30     Model described in the paper:
  31     \verbatim
  32         "A New k-epsilon Eddy Viscosity Model for High Reynolds Number
  33         Turbulent Flows"
  34
  35         Tsan-Hsing Shih, William W. Liou, Aamir Shabbir, Zhigang Tang and
  36         Jiang Zhu
  37
  38         Computers and Fluids Vol. 24, No. 3, pp. 227-238, 1995
  39     \endverbatim
  40
  41     The default model coefficients correspond to the following:
  42     \verbatim
  43         realizableKECoeffs
  44         {
  45             Cmu         0.09;
  46             A0          4.0;
  47             C2          1.9;
  48             sigmak      1.0;
  49             sigmaEps    1.2;
  50             Prt         1.0;    // only for compressible
  51         }
  52     \endverbatim
  53
  54 SourceFiles
  55     realizableKE.C
  56
  57 \*---------------------------------------------------------------------------*/
  58
  59 #ifndef realizableKE_H
  60 #define realizableKE_H
  61
  62 #include "RASModel.H"
  63
  64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  65
  66 namespace Foam
  67 {
  68 namespace compressible
  69 {
  70 namespace RASModels
  71 {
  72
  73 /*---------------------------------------------------------------------------*\
  74                         Class realizableKE Declaration
  75 \*---------------------------------------------------------------------------*/
  76
  77 class realizableKE
  78 :
  79     public RASModel
  80 {
  81
  82 protected:
  83
  84     // Protected data
  85
  86         // Model coefficients
  87
  88             dimensionedScalar Cmu_;
  89             dimensionedScalar A0_;
  90             dimensionedScalar C2_;
  91             dimensionedScalar sigmak_;
  92             dimensionedScalar sigmaEps_;
  93             dimensionedScalar Prt_;
  94
  95
  96         // Fields
  97
  98             volScalarField k_;
  99             volScalarField epsilon_;
 100             volScalarField mut_;
 101             volScalarField alphat_;
 102
 103
 104    // Protected Member Functions
 105
 106         tmp<volScalarField> rCmu
 107         (
 108             const volTensorField& gradU,
 109             const volScalarField& S2,
 110             const volScalarField& magS
 111         );
 112
 113         tmp<volScalarField> rCmu(const volTensorField& gradU);
 114
 115
 116 public:
 117
 118     //- Runtime type information
 119     TypeName("realizableKE");
 120
 121     // Constructors
 122
 123         //- Construct from components
 124         realizableKE
 125         (
 126             const volScalarField& rho,
 127             const volVectorField& U,
 128             const surfaceScalarField& phi,
 129             const basicThermo& thermophysicalModel,
 130             const word& turbulenceModelName = turbulenceModel::typeName,
 131             const word& modelName = typeName
 132         );
 133
 134
 135     //- Destructor
 136     virtual ~realizableKE()
 137     {}
 138
 139
 140     // Member Functions
 141
 142         //- Return the effective diffusivity for k
 143         tmp<volScalarField> DkEff() const
 144         {
 145             return tmp<volScalarField>
 146             (
 147                 new volScalarField("DkEff", mut_/sigmak_ + mu())
 148             );
 149         }
 150
 151         //- Return the effective diffusivity for epsilon
 152         tmp<volScalarField> DepsilonEff() const
 153         {
 154             return tmp<volScalarField>
 155             (
 156                 new volScalarField("DepsilonEff", mut_/sigmaEps_ + mu())
 157             );
 158         }
 159
 160         //- Return the turbulence viscosity
 161         virtual tmp<volScalarField> mut() const
 162         {
 163             return mut_;
 164         }
 165
 166         //- Return the turbulence thermal diffusivity
 167         virtual tmp<volScalarField> alphat() const
 168         {
 169             return alphat_;
 170         }
 171
 172         //- Return the turbulence kinetic energy
 173         virtual tmp<volScalarField> k() const
 174         {
 175             return k_;
 176         }
 177
 178         //- Return the turbulence kinetic energy dissipation rate
 179         virtual tmp<volScalarField> epsilon() const
 180         {
 181             return epsilon_;
 182         }
 183
 184         //- Return the Reynolds stress tensor
 185         virtual tmp<volSymmTensorField> R() const;
 186
 187         //- Return the effective stress tensor including the laminar stress
 188         virtual tmp<volSymmTensorField> devRhoReff() const;
 189
 190         //- Return the source term for the momentum equation
 191         virtual tmp<fvVectorMatrix> divDevRhoReff(volVectorField& U) const;
 192
 193         //- Solve the turbulence equations and correct the turbulence viscosity
 194         virtual void correct();
 195
 196         //- Read RASProperties dictionary
 197         virtual bool read();
 198 };
 199
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 } // End namespace RASModels
 204 } // End namespace compressible
 205 } // End namespace Foam
 206
 207 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 208
 209 #endif
 210
 211 // ************************************************************************* //