Reaktoro 
A unified framework for modeling chemically reactive systems
OptimumResult.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright (C) 2014-2015 Allan Leal
4 //
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // This program 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
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18 #pragma once
19 
20 namespace Reaktoro {
21 
24 {
26  bool succeeded = false;
27 
29  unsigned iterations = 0;
30 
32  unsigned num_objective_evals = 0;
33 
35  double convergence_rate = 0;
36 
38  double error = 0;
39 
41  double time = 0;
42 
45 
48 
50  double time_linear_systems = 0;
51 
53  auto operator+=(const OptimumResult& other) -> OptimumResult&;
54 };
55 
56 } // namespace Reaktoro
double convergence_rate
The convergence rate of the optimisation calculation near the solution.
Definition: OptimumResult.hpp:35
unsigned num_objective_evals
The number of evaluations of the objective function in the optimisation calculation.
Definition: OptimumResult.hpp:32
double time_linear_systems
The wall time spent for all linear system solutions (in units of s)
Definition: OptimumResult.hpp:50
double time_constraint_evals
The wall time spent for all contraint evaluations (in units of s)
Definition: OptimumResult.hpp:47
double error
The final residual error of the optimisation calculation.
Definition: OptimumResult.hpp:38
double time
The wall time spent for the optimisation calculation (in units of s)
Definition: OptimumResult.hpp:41
double time_objective_evals
The wall time spent for all objective evaluations (in units of s)
Definition: OptimumResult.hpp:44
auto operator+=(const OptimumResult &other) -> OptimumResult &
Update this OptimumResult instance with another by addition.
Definition: OptimumResult.cpp:22
unsigned iterations
The number of iterations in the optimisation calculation.
Definition: OptimumResult.hpp:29
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
A type that describes the result of an optimisation calculation.
Definition: OptimumResult.hpp:23
bool succeeded
The flag that indicates if the optimisation calculation converged.
Definition: OptimumResult.hpp:26