applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 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
  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::compressible::RASModels::PDRkEpsilon
  26
  27 Description
  28     Standard k-epsilon turbulence model with additional source terms
  29     corresponding to PDR basic drag model (\link basic.H \endlink)
  30
  31     The default model coefficients correspond to the following:
  32     @verbatim
  33         PDRkEpsilonCoeffs
  34         {
  35             Cmu         0.09;
  36             C1          1.44;
  37             C2          1.92;
  38             C3          -0.33;  // only for compressible
  39             C4          0.1;
  40             sigmak      1.0;    // only for compressible
  41             sigmaEps    1.3;
  42             Prt         1.0;    // only for compressible
  43         }
  44     @endverbatim
  45
  46     The turbulence source term \f$ G_{R} \f$ appears in the
  47     \f$ \kappa-\epsilon \f$ equation for the generation of turbulence due to
  48     interaction with unresolved obstacles.
  49
  50     In the \f$ \epsilon  \f$ equation \f$ C_{1} G_{R} \f$ is added as a source
  51     term.
  52
  53     In the \f$ \kappa \f$ equation \f$ G_{R} \f$ is added as a source term.
  54
  55 SourceFiles
  56     PDRkEpsilon.C
  57
  58 \*---------------------------------------------------------------------------*/
  59
  60 #ifndef compressiblePDRkEpsilon_H
  61 #define compressiblePDRkEpsilon_H
  62
  63
  64 #include "kEpsilon.H"
  65
  66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  67
  68 namespace Foam
  69 {
  70 namespace compressible
  71 {
  72 namespace RASModels
  73 {
  74
  75 /*---------------------------------------------------------------------------*\
  76                            Class PDRkEpsilon Declaration
  77 \*---------------------------------------------------------------------------*/
  78
  79 class PDRkEpsilon
  80 :
  81     public kEpsilon
  82 {
  83     // Private data
  84
  85         // Model coefficients
  86         dimensionedScalar C4_;
  87
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("PDRkEpsilon");
  93
  94
  95     // Constructors
  96
  97         //- Construct from components
  98         PDRkEpsilon
  99         (
 100             const volScalarField& rho,
 101             const volVectorField& U,
 102             const surfaceScalarField& phi,
 103             const basicThermo& thermophysicalModel,
 104             const word& turbulenceModelName = turbulenceModel::typeName,
 105             const word& modelName = typeName
 106         );
 107
 108
 109     //- Destructor
 110     virtual ~PDRkEpsilon();
 111
 112
 113     // Member Functions
 114
 115         //- Solve the turbulence equations and correct the turbulence viscosity
 116         void correct();
 117
 118         //- Read turbulenceProperties dictionary
 119         bool read();
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace RASModels
 126 } // End namespace compressible
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //