src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.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::foamChemistryReader
  27
  28 Description
  29     Chemistry reader for OpenFOAM format
  30
  31 SourceFiles
  32     foamChemistryReader.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef foamChemistryReader_H
  37 #define foamChemistryReader_H
  38
  39 #include "chemistryReader.H"
  40 #include "fileName.H"
  41 #include "typeInfo.H"
  42 #include "HashPtrTable.H"
  43 #include "SLPtrList.H"
  44 #include "labelList.H"
  45 #include "speciesTable.H"
  46 #include "atomicWeights.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                        Class foamChemistry Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 template<class ThermoType>
  58 class foamChemistryReader
  59 :
  60     public chemistryReader<ThermoType>
  61 {
  62         //- Table of the thermodynamic data given in the foamChemistry file
  63         HashPtrTable<ThermoType> speciesThermo_;
  64
  65         //- Table of species
  66         speciesTable speciesTable_;
  67
  68         //- List of the reactions
  69         SLPtrList<Reaction<ThermoType> > reactions_;
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         foamChemistryReader(const foamChemistryReader&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const foamChemistryReader&);
  79
  80
  81 public:
  82
  83     //- Runtime type information
  84     TypeName("foamChemistryReader");
  85
  86
  87     // Constructors
  88
  89         //- Construct from foamChemistry and thermodynamics file names
  90         foamChemistryReader
  91         (
  92             const fileName& reactionsFileName,
  93             const fileName& thermoFileName
  94         );
  95
  96         //- Construct by getting the foamChemistry and thermodynamics file names
  97         //  from dictionary
  98         foamChemistryReader(const dictionary& thermoDict);
  99
 100
 101     //- Destructor
 102     virtual ~foamChemistryReader()
 103     {}
 104
 105
 106     // Member functions
 107
 108         //- Table of species
 109         const speciesTable& species() const
 110         {
 111             return speciesTable_;
 112         }
 113
 114         //- Table of the thermodynamic data given in the foamChemistry file
 115         const HashPtrTable<ThermoType>& speciesThermo() const
 116         {
 117             return speciesThermo_;
 118         }
 119
 120         //- List of the reactions
 121         const SLPtrList<Reaction<ThermoType> >& reactions() const
 122         {
 123             return reactions_;
 124         }
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #ifdef NoRepository
 135 #   include "foamChemistryReader.C"
 136 #endif
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 #endif
 141
 142 // ************************************************************************* //