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) 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::LienLeschzinerLowRe
  27
  28 Description
  29     Lien and Leschziner low-Reynolds k-epsilon turbulence model for
  30     incompressible flows.
  31
  32 SourceFiles
  33     LienLeschzinerLowRe.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef LienLeschzinerLowRe_H
  38 #define LienLeschzinerLowRe_H
  39
  40 #include "RASModel.H"
  41 #include "wallDist.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace incompressible
  48 {
  49 namespace RASModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class LienLeschzinerLowRe Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class LienLeschzinerLowRe
  57 :
  58     public RASModel
  59 {
  60     // Private data
  61
  62         // Model coefficients
  63
  64             dimensionedScalar C1_;
  65             dimensionedScalar C2_;
  66             dimensionedScalar sigmak_;
  67             dimensionedScalar sigmaEps_;
  68             dimensionedScalar Cmu_;
  69             dimensionedScalar kappa_;
  70
  71             dimensionedScalar Am_;
  72             dimensionedScalar Aepsilon_;
  73             dimensionedScalar Amu_;
  74
  75
  76         // Fields
  77
  78             volScalarField k_;
  79             volScalarField epsilon_;
  80
  81             wallDist y_;
  82
  83             volScalarField yStar_;
  84
  85             volScalarField nut_;
  86
  87
  88 public:
  89
  90     TypeName("LienLeschzinerLowRe");
  91
  92     // Constructors
  93
  94         //- Construct from components
  95         LienLeschzinerLowRe
  96         (
  97             const volVectorField& U,
  98             const surfaceScalarField& phi,
  99             transportModel& transport
 100         );
 101
 102
 103     //- Destructor
 104     virtual ~LienLeschzinerLowRe()
 105     {}
 106
 107
 108     // Member Functions
 109
 110         //- Return the turbulence viscosity
 111         virtual tmp<volScalarField> nut() const
 112         {
 113             return nut_;
 114         }
 115
 116         //- Return the effective diffusivity for k
 117         tmp<volScalarField> DkEff() const
 118         {
 119             return tmp<volScalarField>
 120             (
 121                 new volScalarField("DkEff", nut_/sigmak_ + nu())
 122             );
 123         }
 124
 125         //- Return the effective diffusivity for epsilon
 126         tmp<volScalarField> DepsilonEff() const
 127         {
 128             return tmp<volScalarField>
 129             (
 130                 new volScalarField("DepsilonEff", nut_/sigmaEps_ + nu())
 131             );
 132         }
 133
 134         //- Return the turbulence kinetic energy
 135         virtual tmp<volScalarField> k() const
 136         {
 137             return k_;
 138         }
 139
 140         //- Return the turbulence kinetic energy dissipation rate
 141         virtual tmp<volScalarField> epsilon() const
 142         {
 143             return epsilon_;
 144         }
 145
 146         //- Return the Reynolds stress tensor
 147         virtual tmp<volSymmTensorField> R() const;
 148
 149         //- Return the effective stress tensor including the laminar stress
 150         virtual tmp<volSymmTensorField> devReff() const;
 151
 152         //- Return the source term for the momentum equation
 153         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 154
 155         //- Solve the turbulence equations and correct the turbulence viscosity
 156         virtual void correct();
 157
 158         //- Read RASProperties dictionary
 159         virtual bool read();
 160 };
 161
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 } // End namespace RASModels
 166 } // End namespace incompressible
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #endif
 172
 173 // ************************************************************************* //