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