src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.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::incompressible::RASModels::kEpsilon
  26
  27 Description
  28     Standard k-epsilon turbulence model for incompressible flows.
  29
  30     The default model coefficients correspond to the following:
  31     \verbatim
  32         kEpsilonCoeffs
  33         {
  34             Cmu         0.09;
  35             C1          1.44;
  36             C2          1.92;
  37             sigmaEps    1.3;
  38         }
  39     \endverbatim
  40
  41 SourceFiles
  42     kEpsilon.C
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef kEpsilon_H
  47 #define kEpsilon_H
  48
  49 #include "RASModel.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55 namespace incompressible
  56 {
  57 namespace RASModels
  58 {
  59
  60 /*---------------------------------------------------------------------------*\
  61                            Class kEpsilon Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class kEpsilon
  65 :
  66     public RASModel
  67 {
  68
  69 protected:
  70
  71     // Protected data
  72
  73         // Model coefficients
  74
  75             dimensionedScalar Cmu_;
  76             dimensionedScalar C1_;
  77             dimensionedScalar C2_;
  78             dimensionedScalar sigmaEps_;
  79
  80
  81         // Fields
  82
  83             volScalarField k_;
  84             volScalarField epsilon_;
  85             volScalarField nut_;
  86
  87
  88 public:
  89
  90     //- Runtime type information
  91     TypeName("kEpsilon");
  92
  93     // Constructors
  94
  95         //- Construct from components
  96         kEpsilon
  97         (
  98             const volVectorField& U,
  99             const surfaceScalarField& phi,
 100             transportModel& transport,
 101             const word& turbulenceModelName = turbulenceModel::typeName,
 102             const word& modelName = typeName
 103         );
 104
 105
 106     //- Destructor
 107     virtual ~kEpsilon()
 108     {}
 109
 110
 111     // Member Functions
 112
 113         //- Return the turbulence viscosity
 114         virtual tmp<volScalarField> nut() const
 115         {
 116             return nut_;
 117         }
 118
 119         //- Return the effective diffusivity for k
 120         tmp<volScalarField> DkEff() const
 121         {
 122             return tmp<volScalarField>
 123             (
 124                 new volScalarField("DkEff", nut_ + nu())
 125             );
 126         }
 127
 128         //- Return the effective diffusivity for epsilon
 129         tmp<volScalarField> DepsilonEff() const
 130         {
 131             return tmp<volScalarField>
 132             (
 133                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
 134             );
 135         }
 136
 137         //- Return the turbulence kinetic energy
 138         virtual tmp<volScalarField> k() const
 139         {
 140             return k_;
 141         }
 142
 143         //- Return the turbulence kinetic energy dissipation rate
 144         virtual tmp<volScalarField> epsilon() const
 145         {
 146             return epsilon_;
 147         }
 148
 149         //- Return the Reynolds stress tensor
 150         virtual tmp<volSymmTensorField> R() const;
 151
 152         //- Return the effective stress tensor including the laminar stress
 153         virtual tmp<volSymmTensorField> devReff() const;
 154
 155         //- Return the source term for the momentum equation
 156         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 157
 158         //- Solve the turbulence equations and correct the turbulence viscosity
 159         virtual void correct();
 160
 161         //- Read RASProperties dictionary
 162         virtual bool read();
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace RASModels
 169 } // End namespace incompressible
 170 } // End namespace Foam
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #endif
 175
 176 // ************************************************************************* //