Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
MineralReaction.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/Reactions.hpp>
22 #include <Reaktoro/Utils/MineralReactionRateModel.hpp>
23 
24 namespace Reaktoro {
25 
28 {
29 public:
32  explicit MineralReaction(String const& mineral);
33 
34  // Consider GeneralReaction::setRateModel methods as well.
36 
39 
42 
48 
50  auto mineral() const -> String const&;
51 };
52 
53 } // namespace Reaktoro
Used to define a general reaction.
Definition: Reactions.hpp:58
auto setRateModel(ReactionRateModel const &model) -> GeneralReaction &
Set the reaction rate model of the reaction.
The class used to configure mineral dissolution/precipitation reactions.
Definition: MineralReaction.hpp:28
auto setRateModel(MineralReactionRateModel const &model) -> MineralReaction &
Set the mineral reaction rate model of the reaction as a rate function.
auto setRateModel(MineralReactionRateModelGenerator const &model_generator) -> MineralReaction &
Set the mineral reaction rate model of the reaction as a model generator function.
MineralReaction(String const &mineral)
Construct a MineralReaction object with given mineral name.
auto setRateFunction(MineralReactionRateModel const &model) -> MineralReaction &
Set the mineral reaction rate model of the reaction as a rate function.
auto mineral() const -> String const &
Return the name of the mineral.
Definition: Model.hpp:30
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29
std::string String
Convenient alias for std::string.
Definition: Types.hpp:52
Fn< MineralReactionRateModel(ReactionRateModelGeneratorArgs args)> MineralReactionRateModelGenerator
The type of functions that construct a MineralReactionRateModel for a mineral reaction.
Definition: MineralReactionRateModel.hpp:66