Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
EquilibriumOptions.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 // Optima includes
21 #include <Optima/Options.hpp>
22 
23 namespace Reaktoro {
24 
26 enum class GibbsHessian
27 {
29  Exact,
30 
33 
35  Approx,
36 
39 };
40 
43 {
45  Optima::Options optima;
46 
48  double epsilon = 1e-16;
49 
52 
62  bool warmstart = true;
63 
66 
69 };
70 
71 } // namespace Reaktoro
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29
GibbsHessian
The options for the description of the Hessian of the Gibbs energy function.
Definition: EquilibriumOptions.hpp:27
@ Exact
The Hessian of the Gibbs energy function is fully exact.
@ PartiallyExact
The Hessian of the Gibbs energy function is partially exact, partially approximated.
@ Approx
The Hessian of the Gibbs energy function is approximated using ideal thermodynamic models.
@ ApproxDiagonal
The Hessian of the Gibbs energy function is a diagonal matrix approximation using ideal thermodynamic...
The options for the equilibrium calculations.
Definition: EquilibriumOptions.hpp:43
double epsilon
The default lower bound for the amounts of the species.
Definition: EquilibriumOptions.hpp:48
bool use_ideal_activity_models
The flag indicating if ideal activity models should be used in the calculations.
Definition: EquilibriumOptions.hpp:65
GibbsHessian hessian
The calculation mode of the Hessian of the Gibbs energy function.
Definition: EquilibriumOptions.hpp:68
bool warmstart
The flag indicating if warm-start strategy should be used when possible.
Definition: EquilibriumOptions.hpp:62
double logarithm_barrier_factor
The value multiplied by epsilon to compute the logarithm barrier penalty parameter .
Definition: EquilibriumOptions.hpp:51
Optima::Options optima
The options for the optimisation solver.
Definition: EquilibriumOptions.hpp:45