src/turbulenceModels/RAS/incompressible/LamBremhorstKE/LamBremhorstKE.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::LamBremhorstKE
  27
  28 Description
  29     Lam and Bremhorst low-Reynolds number k-epsilon turbulence model
  30     for incompressible flows
  31
  32 SourceFiles
  33     LamBremhorstKE.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef LamBremhorstKE_H
  38 #define LamBremhorstKE_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 LamBremhorstKE Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class LamBremhorstKE
  57 :
  58     public RASModel
  59 {
  60     // Private data
  61
  62         dimensionedScalar Cmu_;
  63         dimensionedScalar C1_;
  64         dimensionedScalar C2_;
  65         dimensionedScalar alphaEps_;
  66
  67         volScalarField k_;
  68         volScalarField epsilon_;
  69
  70         wallDist y_;
  71         volScalarField Rt_;
  72
  73         volScalarField fMu_;
  74         volScalarField nut_;
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("LamBremhorstKE");
  81
  82
  83     // Constructors
  84
  85         //- from components
  86         LamBremhorstKE
  87         (
  88             const volVectorField& U,
  89             const surfaceScalarField& phi,
  90             transportModel& transport
  91         );
  92
  93
  94     // Destructor
  95
  96         ~LamBremhorstKE()
  97         {}
  98
  99
 100     // Member Functions
 101
 102         //- Return the turbulence viscosity
 103         tmp<volScalarField> nut() const
 104         {
 105             return nut_;
 106         }
 107
 108         //- Return the effective diffusivity for k
 109         tmp<volScalarField> DkEff() const
 110         {
 111             return tmp<volScalarField>
 112             (
 113                 new volScalarField("DkEff", nut_ + nu())
 114             );
 115         }
 116
 117         //- Return the effective diffusivity for epsilon
 118         tmp<volScalarField> DepsilonEff() const
 119         {
 120             return tmp<volScalarField>
 121             (
 122                 new volScalarField("DepsilonEff", alphaEps_*nut_ + nu())
 123             );
 124         }
 125
 126         //- Return the turbulence kinetic energy
 127         tmp<volScalarField> k() const
 128         {
 129             return k_;
 130         }
 131
 132         //- Return the turbulence kinetic energy dissipation rate
 133         tmp<volScalarField> epsilon() const
 134         {
 135             return epsilon_;
 136         }
 137
 138         //- Return the Reynolds stress tensor
 139         tmp<volSymmTensorField> R() const;
 140
 141         //- Return the effective stress tensor including the laminar stress
 142         tmp<volSymmTensorField> devReff() const;
 143
 144         //- Return the source term for the momentum equation
 145         tmp<fvVectorMatrix> divDevReff(volVectorField& U) const;
 146
 147         //- Solve the turbulence equations and correct the turbulence viscosity
 148         void correct();
 149
 150         //- Read turbulenceProperties dictionary
 151         bool read();
 152 };
 153
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 } // End namespace RASModels
 158 } // End namespace incompressible
 159 } // End namespace Foam
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 #endif
 164
 165 // ************************************************************************* //