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-2020 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 "Reaction.H"
39 #include "speciesTable.H"
40 #include "PtrList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class ReactionList Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class ThermoType>
52 class ReactionList
53 :
54  public PtrList<Reaction<ThermoType>>
55 {
56 
57 public:
58 
59  // Constructors
60 
61  //- Construct empty
62  ReactionList()
63  {}
64 
65  //- Construct from thermo list and dictionary
67  (
68  const speciesTable& species,
69  const PtrList<ThermoType>& speciesThermo,
70  const dictionary& dict
71  );
72 
73  //- Construct from thermo list, objectRegistry and dictionary
75  (
76  const speciesTable& species,
77  const PtrList<ThermoType>& speciesThermo,
78  const objectRegistry& ob,
79  const dictionary& dict
80  );
81 
82  //- Construct copy
83  ReactionList(const ReactionList<ThermoType>& reactions) = delete;
84 
85 
86  // Public Member Functions
87 
88  //- Write
89  void write(Ostream& os) const;
90 
91 
92  // Member Operators
93 
94  //- Disallow default bitwise assignment
95  void operator=(const ReactionList&) = delete;
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #ifdef NoRepository
106  #include "ReactionList.C"
107 #endif
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
dictionary dict
void write(Ostream &os) const
Write.
Definition: ReactionList.C:128
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
ReactionList()
Construct empty.
Definition: ReactionList.H:61
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
List of templated reactions.
Definition: ReactionList.H:51
A wordList with hashed indices for faster lookup by name.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
Registry of regIOobjects.
void operator=(const ReactionList &)=delete
Disallow default bitwise assignment.
Namespace for OpenFOAM.