src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.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::LaunderGibsonRSTM
  27
  28 Description
  29     Launder-Gibson Reynolds stress turbulence model for incompressible flows.
  30
  31     The default model coefficients correspond to the following:
  32     @verbatim
  33         LaunderGibsonRSTMCoeffs
  34         {
  35             Cmu         0.09;
  36             kappa       0.41;
  37             Clg1        1.8;
  38             Clg2        0.6;
  39             C1          1.44;
  40             C2          1.92;
  41             C1Ref       0.5;
  42             C2Ref       0.3;
  43             Cs          0.25;
  44             Ceps        0.15;
  45             sigmaEps    1.3;
  46             sigmaR      0.81967;
  47             couplingFactor  0.0;
  48         }
  49     @endverbatim
  50
  51 SourceFiles
  52     LaunderGibsonRSTM.C
  53
  54 \*---------------------------------------------------------------------------*/
  55
  56 #ifndef LaunderGibsonRSTM_H
  57 #define LaunderGibsonRSTM_H
  58
  59 #include "RASModel.H"
  60 #include "wallDistReflection.H"
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 namespace Foam
  65 {
  66 namespace incompressible
  67 {
  68 namespace RASModels
  69 {
  70
  71 /*---------------------------------------------------------------------------*\
  72                            Class LaunderGibsonRSTM Declaration
  73 \*---------------------------------------------------------------------------*/
  74
  75 class LaunderGibsonRSTM
  76 :
  77     public RASModel
  78 {
  79     // Private data
  80
  81         // Model coefficients
  82
  83             dimensionedScalar Cmu_;
  84             dimensionedScalar kappa_;
  85
  86             dimensionedScalar Clg1_;
  87             dimensionedScalar Clg2_;
  88
  89             dimensionedScalar C1_;
  90             dimensionedScalar C2_;
  91             dimensionedScalar Cs_;
  92             dimensionedScalar Ceps_;
  93             dimensionedScalar sigmaR_;
  94             dimensionedScalar sigmaEps_;
  95
  96             dimensionedScalar C1Ref_;
  97             dimensionedScalar C2Ref_;
  98
  99             dimensionedScalar couplingFactor_;
 100
 101
 102         // Fields
 103
 104             wallDistReflection yr_;
 105
 106             volSymmTensorField R_;
 107             volScalarField k_;
 108             volScalarField epsilon_;
 109             volScalarField nut_;
 110
 111
 112 public:
 113
 114     //- Runtime type information
 115     TypeName("LaunderGibsonRSTM");
 116
 117     // Constructors
 118
 119         //- Construct from components
 120         LaunderGibsonRSTM
 121         (
 122             const volVectorField& U,
 123             const surfaceScalarField& phi,
 124             transportModel& transport
 125         );
 126
 127
 128     //- Destructor
 129     virtual ~LaunderGibsonRSTM()
 130     {}
 131
 132
 133     // Member Functions
 134
 135         //- Return the turbulence viscosity
 136         virtual tmp<volScalarField> nut() const
 137         {
 138             return nut_;
 139         }
 140
 141         //- Return the effective diffusivity for R
 142         tmp<volScalarField> DREff() const
 143         {
 144             return tmp<volScalarField>
 145             (
 146                 new volScalarField("DREff", nut_/sigmaR_ + nu())
 147             );
 148         }
 149
 150         //- Return the effective diffusivity for epsilon
 151         tmp<volScalarField> DepsilonEff() const
 152         {
 153             return tmp<volScalarField>
 154             (
 155                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
 156             );
 157         }
 158
 159         //- Return the turbulence kinetic energy
 160         virtual tmp<volScalarField> k() const
 161         {
 162             return k_;
 163         }
 164
 165         //- Return the turbulence kinetic energy dissipation rate
 166         virtual tmp<volScalarField> epsilon() const
 167         {
 168             return epsilon_;
 169         }
 170
 171         //- Return the Reynolds stress tensor
 172         virtual tmp<volSymmTensorField> R() const
 173         {
 174             return R_;
 175         }
 176
 177         //- Return the effective stress tensor including the laminar stress
 178         virtual tmp<volSymmTensorField> devReff() const;
 179
 180         //- Return the source term for the momentum equation
 181         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 182
 183         //- Solve the turbulence equations and correct the turbulence viscosity
 184         virtual void correct();
 185
 186         //- Read RASProperties dictionary
 187         virtual bool read();
 188 };
 189
 190
 191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 192
 193 } // End namespace RASModels
 194 } // End namespace incompressible
 195 } // End namespace Foam
 196
 197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 198
 199 #endif
 200
 201 // ************************************************************************* //