src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::reactingMixture
  26
  27 Description
  28     Foam::reactingMixture
  29
  30 SourceFiles
  31     reactingMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef reactingMixture_H
  36 #define reactingMixture_H
  37
  38 #include "speciesTable.H"
  39 #include "chemistryReader.H"
  40 #include "multiComponentMixture.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                       Class reactingMixture Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class ThermoType>
  52 class reactingMixture
  53 :
  54     public speciesTable,
  55     public autoPtr<chemistryReader<ThermoType> >,
  56     public multiComponentMixture<ThermoType>,
  57     public PtrList<Reaction<ThermoType> >
  58 {
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise copy construct
  62         reactingMixture(const reactingMixture&);
  63
  64         //- Disallow default bitwise assignment
  65         void operator=(const reactingMixture&);
  66
  67
  68 public:
  69
  70     //- The type of thermo package this mixture is instantiated for
  71     typedef ThermoType thermoType;
  72
  73
  74     // Constructors
  75
  76         //- Construct from dictionary and mesh
  77         reactingMixture(const dictionary&, const fvMesh&);
  78
  79
  80     //- Destructor
  81     virtual ~reactingMixture()
  82     {}
  83
  84
  85     // Member functions
  86
  87         //- Read dictionary
  88         void read(const dictionary&);
  89
  90         label size() const
  91         {
  92             return PtrList<Reaction<ThermoType> >::size();
  93         }
  94
  95         Reaction<ThermoType>& operator [] (const label i)
  96         {
  97             return PtrList<Reaction<ThermoType> >::operator[](i);
  98         }
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #ifdef NoRepository
 109 #   include "reactingMixture.C"
 110 #endif
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //