src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.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::LienLeschzinerLowRe
  26
  27 Description
  28     Lien and Leschziner low-Reynolds k-epsilon turbulence model for
  29     incompressible flows.
  30
  31 SourceFiles
  32     LienLeschzinerLowRe.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef LienLeschzinerLowRe_H
  37 #define LienLeschzinerLowRe_H
  38
  39 #include "RASModel.H"
  40 #include "wallDist.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace incompressible
  47 {
  48 namespace RASModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class LienLeschzinerLowRe Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class LienLeschzinerLowRe
  56 :
  57     public RASModel
  58 {
  59
  60 protected:
  61
  62     // Protected data
  63
  64         // Model coefficients
  65
  66             dimensionedScalar C1_;
  67             dimensionedScalar C2_;
  68             dimensionedScalar sigmak_;
  69             dimensionedScalar sigmaEps_;
  70             dimensionedScalar Cmu_;
  71             dimensionedScalar kappa_;
  72
  73             dimensionedScalar Am_;
  74             dimensionedScalar Aepsilon_;
  75             dimensionedScalar Amu_;
  76
  77
  78         // Fields
  79
  80             volScalarField k_;
  81             volScalarField epsilon_;
  82
  83             wallDist y_;
  84
  85             volScalarField yStar_;
  86
  87             volScalarField nut_;
  88
  89
  90 public:
  91
  92     TypeName("LienLeschzinerLowRe");
  93
  94     // Constructors
  95
  96         //- Construct from components
  97         LienLeschzinerLowRe
  98         (
  99             const volVectorField& U,
 100             const surfaceScalarField& phi,
 101             transportModel& transport,
 102             const word& turbulenceModelName = turbulenceModel::typeName,
 103             const word& modelName = typeName
 104         );
 105
 106
 107     //- Destructor
 108     virtual ~LienLeschzinerLowRe()
 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 // ************************************************************************* //