src/thermophysicalModels/chemistryModel/chemistryModel/psiChemistryModel/psiChemistryModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-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::psiChemistryModel
  27
  28 Description
  29     Chemistry model for compressibility-based thermodynamics
  30
  31 SourceFiles
  32     psiChemistryModelI.H
  33     psiChemistryModel.C
  34     newChemistryModel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef psiChemistryModel_H
  39 #define psiChemistryModel_H
  40
  41 #include "basicChemistryModel.H"
  42 #include "autoPtr.H"
  43 #include "runTimeSelectionTables.H"
  44 #include "hCombustionThermo.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 class fvMesh;
  53
  54 /*---------------------------------------------------------------------------*\
  55                      class psiChemistryModel Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class psiChemistryModel
  59 :
  60     public basicChemistryModel
  61 {
  62     // Private Member Functions
  63
  64         //- Construct as copy (not implemented)
  65         psiChemistryModel(const psiChemistryModel&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const psiChemistryModel&);
  69
  70
  71 protected:
  72
  73     // Protected data
  74
  75         //- Thermo package
  76         autoPtr<hCombustionThermo> thermo_;
  77
  78
  79 public:
  80
  81     //- Runtime type information
  82     TypeName("psiChemistryModel");
  83
  84
  85     //- Declare run-time constructor selection tables
  86     declareRunTimeSelectionTable
  87     (
  88         autoPtr,
  89         psiChemistryModel,
  90         fvMesh,
  91         (
  92             const fvMesh& mesh,
  93             const word& compTypeName,
  94             const word& thermoTypeName
  95         ),
  96         (mesh, compTypeName, thermoTypeName)
  97     );
  98
  99
 100     // Constructors
 101
 102         //- Construct from mesh
 103         psiChemistryModel(const fvMesh& mesh, const word& thermoTypeName);
 104
 105
 106     //- Selector
 107     static autoPtr<psiChemistryModel> New(const fvMesh& mesh);
 108
 109
 110     //- Destructor
 111     virtual ~psiChemistryModel();
 112
 113
 114     // Member Functions
 115
 116         //- Return access to the thermo package
 117         inline hCombustionThermo& thermo();
 118
 119         //- Return const access to the thermo package
 120         inline const hCombustionThermo& thermo() const;
 121 };
 122
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 } // End namespace Foam
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #include "psiChemistryModelI.H"
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //