src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H

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