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