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) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::incompressible::RASModels::LaunderSharmaKE
  27
  28 Description
  29     Launder and Sharma low-Reynolds k-epsilon turbulence model for
  30     incompressible flows.
  31
  32     The default model coefficients correspond to the following:
  33     @verbatim
  34         LaunderSharmaKECoeffs
  35         {
  36             Cmu         0.09;
  37             C1          1.44;
  38             C2          1.92;
  39             C3          -0.33;
  40             sigmaEps    1.3;
  41         }
  42     @endverbatim
  43
  44 SourceFiles
  45     LaunderSharmaKE.C
  46
  47 \*---------------------------------------------------------------------------*/
  48
  49 #ifndef LaunderSharmaKE_H
  50 #define LaunderSharmaKE_H
  51
  52 #include "RASModel.H"
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 namespace Foam
  57 {
  58 namespace incompressible
  59 {
  60 namespace RASModels
  61 {
  62
  63 /*---------------------------------------------------------------------------*\
  64                            Class LaunderSharmaKE Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class LaunderSharmaKE
  68 :
  69     public RASModel
  70 {
  71     // Private 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 epsilonTilda_;
  85             volScalarField nut_;
  86
  87
  88     // Private member functions
  89
  90         tmp<volScalarField> fMu() const;
  91         tmp<volScalarField> f2() const;
  92
  93
  94 public:
  95
  96     //- Runtime type information
  97     TypeName("LaunderSharmaKE");
  98
  99     // Constructors
 100
 101         //- Construct from components
 102         LaunderSharmaKE
 103         (
 104             const volVectorField& U,
 105             const surfaceScalarField& phi,
 106             transportModel& transport
 107         );
 108
 109
 110     //- Destructor
 111     virtual ~LaunderSharmaKE()
 112     {}
 113
 114
 115     // Member Functions
 116
 117         //- Return the turbulence viscosity
 118         virtual tmp<volScalarField> nut() const
 119         {
 120             return nut_;
 121         }
 122
 123         //- Return the effective diffusivity for k
 124         tmp<volScalarField> DkEff() const
 125         {
 126             return tmp<volScalarField>
 127             (
 128                 new volScalarField("DkEff", nut_ + nu())
 129             );
 130         }
 131
 132         //- Return the effective diffusivity for epsilon
 133         tmp<volScalarField> DepsilonEff() const
 134         {
 135             return tmp<volScalarField>
 136             (
 137                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
 138             );
 139         }
 140
 141         //- Return the turbulence kinetic energy
 142         virtual tmp<volScalarField> k() const
 143         {
 144             return k_;
 145         }
 146
 147         //- Note that epsilonTilda is returned as epsilon.
 148         //  This is the appropriate variable for most purposes.
 149         virtual tmp<volScalarField> epsilon() const
 150         {
 151             return epsilonTilda_;
 152         }
 153
 154         //- Return the Reynolds stress tensor
 155         virtual tmp<volSymmTensorField> R() const;
 156
 157         //- Return the effective stress tensor including the laminar stress
 158         virtual tmp<volSymmTensorField> devReff() const;
 159
 160         //- Return the source term for the momentum equation
 161         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 162
 163         //- Solve the turbulence equations and correct the turbulence viscosity
 164         virtual void correct();
 165
 166         //- Read RASProperties dictionary
 167         virtual bool read();
 168 };
 169
 170
 171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 172
 173 } // End namespace RASModels
 174 } // End namespace incompressible
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //