applications/solvers/combustion/PDRFoam/XiModels/XiGModels/XiGModel/XiGModel.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::XiGModel
  27
  28 Description
  29     Base-class for all Xi generation models used by the b-Xi combustion model.
  30     See Technical Report SH/RE/01R for details on the PDR modelling. For details
  31     on the use of XiGModel see \link XiModel.H \endlink. The model available is
  32     \link instabilityG.H \endlink
  33
  34 SourceFiles
  35     XiGModel.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef XiGModel_H
  40 #define XiGModel_H
  41
  42 #include "IOdictionary.H"
  43 #include "hhuCombustionThermo.H"
  44 #include "RASModel.H"
  45 #include "runTimeSelectionTables.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                           Class XiGModel Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class XiGModel
  57 {
  58
  59 protected:
  60
  61     // Protected data
  62
  63         dictionary XiGModelCoeffs_;
  64
  65         const hhuCombustionThermo& thermo_;
  66         const compressible::RASModel& turbulence_;
  67         const volScalarField& Su_;
  68
  69
  70 private:
  71
  72     // Private Member Functions
  73
  74         //- Disallow copy construct
  75         XiGModel(const XiGModel&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const XiGModel&);
  79
  80
  81 public:
  82
  83     //- Runtime type information
  84     TypeName("XiGModel");
  85
  86
  87     // Declare run-time constructor selection table
  88
  89         declareRunTimeSelectionTable
  90         (
  91             autoPtr,
  92             XiGModel,
  93             dictionary,
  94             (
  95                 const dictionary& XiGProperties,
  96                 const hhuCombustionThermo& thermo,
  97                 const compressible::RASModel& turbulence,
  98                 const volScalarField& Su
  99             ),
 100             (
 101                 XiGProperties,
 102                 thermo,
 103                 turbulence,
 104                 Su
 105             )
 106         );
 107
 108
 109     // Selectors
 110
 111         //- Return a reference to the selected XiG model
 112         static autoPtr<XiGModel> New
 113         (
 114             const dictionary& XiGProperties,
 115             const hhuCombustionThermo& thermo,
 116             const compressible::RASModel& turbulence,
 117             const volScalarField& Su
 118         );
 119
 120
 121     // Constructors
 122
 123         //- Construct from components
 124         XiGModel
 125         (
 126             const dictionary& XiGProperties,
 127             const hhuCombustionThermo& thermo,
 128             const compressible::RASModel& turbulence,
 129             const volScalarField& Su
 130         );
 131
 132
 133     // Destructor
 134
 135         virtual ~XiGModel();
 136
 137
 138     // Member Functions
 139
 140         //- Return the flame-wrinking genration rate
 141         virtual tmp<volScalarField> G() const = 0;
 142
 143         //- Return the flame diffusivity
 144         virtual tmp<volScalarField> Db() const
 145         {
 146             return turbulence_.muEff();
 147         }
 148
 149         //- Update properties from given dictionary
 150         virtual bool read(const dictionary& XiGProperties) = 0;
 151 };
 152
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #endif
 161
 162 // ************************************************************************* //