src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::incompressible::RASModels::LienCubicKE
  26
  27 Description
  28     Lien cubic non-linear k-epsilon turbulence model for incompressible flows.
  29
  30 SourceFiles
  31     LienCubicKE.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef LienCubicKE_H
  36 #define LienCubicKE_H
  37
  38 #include "RASModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace incompressible
  45 {
  46 namespace RASModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class LienCubicKE Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class LienCubicKE
  54 :
  55     public RASModel
  56 {
  57     // Private data
  58
  59         // Model coefficients
  60
  61             dimensionedScalar C1_;
  62             dimensionedScalar C2_;
  63             dimensionedScalar sigmak_;
  64             dimensionedScalar sigmaEps_;
  65             dimensionedScalar A1_;
  66             dimensionedScalar A2_;
  67             dimensionedScalar Ctau1_;
  68             dimensionedScalar Ctau2_;
  69             dimensionedScalar Ctau3_;
  70             dimensionedScalar alphaKsi_;
  71
  72
  73         // Fields
  74
  75             volScalarField k_;
  76             volScalarField epsilon_;
  77
  78             volTensorField gradU_;
  79             volScalarField eta_;
  80             volScalarField ksi_;
  81             volScalarField Cmu_;
  82             volScalarField fEta_;
  83             volScalarField C5viscosity_;
  84
  85             volScalarField nut_;
  86
  87             volSymmTensorField nonlinearStress_;
  88
  89
  90 public:
  91
  92     //- Runtime type information
  93     TypeName("LienCubicKE");
  94
  95     // Constructors
  96
  97         //- Construct from components
  98         LienCubicKE
  99         (
 100             const volVectorField& U,
 101             const surfaceScalarField& phi,
 102             transportModel& transport
 103         );
 104
 105
 106     // Destructor
 107
 108         virtual ~LienCubicKE()
 109         {}
 110
 111
 112     // Member Functions
 113
 114         //- Return the turbulence viscosity
 115         virtual tmp<volScalarField> nut() const
 116         {
 117             return nut_;
 118         }
 119
 120         //- Return the effective diffusivity for k
 121         tmp<volScalarField> DkEff() const
 122         {
 123             return tmp<volScalarField>
 124             (
 125                 new volScalarField("DkEff", nut_/sigmak_ + nu())
 126             );
 127         }
 128
 129         //- Return the effective diffusivity for epsilon
 130         tmp<volScalarField> DepsilonEff() const
 131         {
 132             return tmp<volScalarField>
 133             (
 134                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
 135             );
 136         }
 137
 138         //- Return the turbulence kinetic energy
 139         virtual tmp<volScalarField> k() const
 140         {
 141             return k_;
 142         }
 143
 144         //- Return the turbulence kinetic energy dissipation rate
 145         virtual tmp<volScalarField> epsilon() const
 146         {
 147             return epsilon_;
 148         }
 149
 150         //- Return the Reynolds stress tensor
 151         virtual tmp<volSymmTensorField> R() const;
 152
 153         //- Return the effective stress tensor including the laminar stress
 154         virtual tmp<volSymmTensorField> devReff() const;
 155
 156         //- Return the source term for the momentum equation
 157         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 158
 159         //- Solve the turbulence equations and correct the turbulence viscosity
 160         virtual void correct();
 161
 162         //- Read RASProperties dictionary
 163         virtual bool read();
 164 };
 165
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 } // End namespace RASModels
 170 } // End namespace incompressible
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #endif
 176
 177 // ************************************************************************* //