reactingMixture.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 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
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, mesh and phase name
77  reactingMixture(const dictionary&, const fvMesh&, const word&);
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  {
93  }
94 
96  {
98  }
99 
100  const Reaction<ThermoType>& operator [] (const label i) const
101  {
103  }
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #ifdef NoRepository
114 # include "reactingMixture.C"
115 #endif
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:61
Reaction< ThermoType > & operator[](const label i)
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void read(const dictionary &)
Read dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
friend Ostream & operator(Ostream &, const PtrList< Reaction< ThermoType > > &)
Namespace for OpenFOAM.
Foam::reactingMixture.
virtual ~reactingMixture()
Destructor.
Simple extension of ReactionThermo to handle reaction kinetics in addition to the equilibrium thermod...
Definition: Reaction.H:53
Foam::multiComponentMixture.
A wordList with hashed indices for faster lookup by name.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
ThermoType thermoType
The type of thermo package this mixture is instantiated for.