Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
ReactionRateModel.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright © 2014-2024 Allan Leal
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library. If not, see <http://www.gnu.org/licenses/>.
17 
18 #pragma once
19 
20 // Reaktoro includes
21 #include <Reaktoro/Core/Model.hpp>
22 #include <Reaktoro/Core/ReactionRate.hpp>
23 
24 namespace Reaktoro {
25 
26 // Forward declarations
27 class ChemicalProps;
28 class Database;
29 class PhaseList;
30 class ReactionEquation;
31 class SpeciesList;
32 class SurfaceList;
33 
40 
45 {
47  String const& name;
48 
51 
54 
57 
59  PhaseList const& phases;
60 
63 };
64 
68 
69 } // namespace Reaktoro
The class that computes chemical properties of a chemical system.
Definition: ChemicalProps.hpp:34
The class used to store and retrieve data of chemical species.
Definition: Database.hpp:32
A type used as a collection of phases.
Definition: PhaseList.hpp:29
A type used to represent the equation of a reaction.
Definition: ReactionEquation.hpp:37
The result of a reaction rate model evaluation.
Definition: ReactionRate.hpp:28
A type used as a collection of species.
Definition: SpeciesList.hpp:29
A type used as a collection of surfaces.
Definition: SurfaceList.hpp:29
Model< ReactionRate(ChemicalProps const &props)> ReactionRateModel
The type of functions for calculation of reaction rates (in mol/s).
Definition: ReactionRateModel.hpp:39
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29
Fn< ReactionRateModel(ReactionRateModelGeneratorArgs args)> ReactionRateModelGenerator
The function signature for functions that generates a ReactionRateModel for a reaction.
Definition: ReactionRateModel.hpp:67
std::string String
Convenient alias for std::string.
Definition: Types.hpp:52
std::function< F > Fn
Convenient alias for std::function<R(Args...)>.
Definition: Types.hpp:110
The data provided to a ReactionRateModelGenerator to construct the ReactionRateModel of a reaction.
Definition: ReactionRateModel.hpp:45
PhaseList const & phases
The phases in the chemical system where the reaction belongs to.
Definition: ReactionRateModel.hpp:59
SurfaceList const & surfaces
The surfaces in the chemical system where the reaction belongs to.
Definition: ReactionRateModel.hpp:62
SpeciesList const & species
The species in the chemical system where the reaction belongs to.
Definition: ReactionRateModel.hpp:56
ReactionEquation const & equation
The equation of the reaction for which the rate model is generated.
Definition: ReactionRateModel.hpp:50
String const & name
The name of the reaction for which the rate model is generated.
Definition: ReactionRateModel.hpp:47
Database const & database
The thermodynamic database used to construct the chemical system where the reaction belongs to.
Definition: ReactionRateModel.hpp:53