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