Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
EquilibriumUtils.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/Common/Matrix.hpp>
22 
23 namespace Reaktoro {
24 
25 // Forward declarations
26 class ChemicalState;
27 class EquilibriumRestrictions;
28 struct EquilibriumOptions;
29 struct EquilibriumResult;
30 
37 auto equilibrate(ChemicalState& state, const EquilibriumOptions& options) -> EquilibriumResult;
38 auto equilibrate(ChemicalState& state, const EquilibriumRestrictions& restrictions) -> EquilibriumResult;
39 auto equilibrate(ChemicalState& state, const EquilibriumRestrictions& restrictions, const EquilibriumOptions& options) -> EquilibriumResult;
40 
44 auto equilibrate(ChemicalState& state, const EquilibriumRestrictions& restrictions, const EquilibriumOptions& options, ArrayXdConstRef b0) -> EquilibriumResult;
46 
47 } // namespace Reaktoro
The chemical state of a chemical system.
Definition: ChemicalState.hpp:41
The class used to define reactivity restrictions in a chemical equilibrium calculation.
Definition: EquilibriumRestrictions.hpp:28
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29
auto equilibrate(ChemicalState &state) -> EquilibriumResult
Perform a chemical equilibrium calculation on a given chemical state.
Eigen::Ref< const ArrayXd > ArrayXdConstRef
Convenient alias to Eigen type.
Definition: Matrix.hpp:105
The options for the equilibrium calculations.
Definition: EquilibriumOptions.hpp:43
A type used to describe the result of an equilibrium calculation.
Definition: EquilibriumResult.hpp:28