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