applications/solvers/combustion/PDRFoam/XiModels/XiGModels/KTS/KTS.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::XiGModels::KTS
  27
  28 Description
  29     Simple Kolmogorov time-scale model for the flame-wrinling generation rate.
  30
  31 SourceFiles
  32     KTS.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef KTS_H
  37 #define KTS_H
  38
  39 #include "XiGModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace XiGModels
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                           Class KTS Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class KTS
  53 :
  54     public XiGModel
  55 {
  56     // Private data
  57
  58         scalar GEtaCoef;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow copy construct
  64         KTS(const KTS&);
  65
  66         //- Disallow default bitwise assignment
  67         void operator=(const KTS&);
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("KTS");
  74
  75
  76     // Constructors
  77
  78         //- Construct from components
  79         KTS
  80         (
  81             const dictionary& XiGProperties,
  82             const hhuCombustionThermo& thermo,
  83             const compressible::RASModel& turbulence,
  84             const volScalarField& Su
  85         );
  86
  87
  88     // Destructor
  89
  90         virtual ~KTS();
  91
  92
  93     // Member Functions
  94
  95         //- Return the flame-wrinking generation rate
  96         virtual tmp<volScalarField> G() const;
  97
  98         //- Update properties from given dictionary
  99         virtual bool read(const dictionary& XiGProperties);
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace XiGModels
 106 } // End namespace Foam
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //