ReactionList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::ReactionList
26 
27 Description
28  List of templated reactions
29 
30 SourceFiles
31  ReactionList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ReactionList_H
36 #define ReactionList_H
37 
38 #include "PtrList.H"
39 #include "SLPtrList.H"
40 #include "speciesTable.H"
41 #include "HashPtrTable.H"
42 #include "Reaction.H"
43 #include "fileName.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class ReactionList Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class ThermoType>
55 class ReactionList
56 :
57  public SLPtrList<Reaction<ThermoType>>
58 {
59  // Private data
60 
61  //- Reference to the table of species
62  const speciesTable& species_;
63 
64  //- Reference to the thermo database
65  const HashPtrTable<ThermoType>& thermoDb_;
66 
67  //- The dictionary used for construction
68  const dictionary dict_;
69 
70 
71  // Private Member Functions
72 
73  //- Disallow default bitwise assignment
74  void operator=(const ReactionList&);
75 
76 
77 public:
78 
79  // Constructors
80 
81  //- Construct null
83  (
84  const speciesTable& species,
85  const HashPtrTable<ThermoType>& thermoDatabase
86  );
87 
88  //- Construct from dictionary
90  (
91  const speciesTable& species,
92  const HashPtrTable<ThermoType>& thermoDatabase,
93  const dictionary& dict
94  );
95 
96  //- Construct copy
97  ReactionList(const ReactionList<ThermoType>& reactions);
98 
99 
100  //- Destructor
101  ~ReactionList();
102 
103 
104  // Public Member Functions
105 
106  //- Read reactions from dictionary
107  bool readReactionDict();
108 
109  //- Write
110  void write(Ostream& os) const;
111 };
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #ifdef NoRepository
120  #include "ReactionList.C"
121 #endif
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
dictionary dict
ReactionList(const speciesTable &species, const HashPtrTable< ThermoType > &thermoDatabase)
Construct null.
Definition: ReactionList.C:34
void write(Ostream &os) const
Write.
Definition: ReactionList.C:114
bool readReactionDict()
Read reactions from dictionary.
Definition: ReactionList.C:83
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Template class for non-intrusive linked PtrLists.
Definition: LPtrList.H:47
~ReactionList()
Destructor.
Definition: ReactionList.C:76
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Non-intrusive singly-linked pointer list.
List of templated reactions.
Definition: ReactionList.H:54
A wordList with hashed indices for faster lookup by name.
Namespace for OpenFOAM.