Reaktoro 
A unified framework for modeling chemically reactive systems
OptimumSolverBase.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 // C++ includes
21 #include <memory>
22 
23 // Reaktoro includes
24 #include <Reaktoro/Math/Matrix.hpp>
25 
26 namespace Reaktoro {
27 
28 // Forward declarations
29 struct OptimumOptions;
30 struct OptimumProblem;
31 struct OptimumResult;
32 struct OptimumState;
33 
36 {
37 public:
39  virtual ~OptimumSolverBase() = 0;
40 
44  virtual auto solve(const OptimumProblem& problem, OptimumState& state) -> OptimumResult = 0;
45 
50  virtual auto solve(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult = 0;
51 
55  virtual auto dxdp(const Vector& dgdp, const Vector& dbdp) -> Vector = 0;
56 
58  virtual auto clone() const -> OptimumSolverBase* = 0;
59 };
60 
61 } // namespace Reaktoro
A type that describes the non-linear constrained optimisation problem.
Definition: OptimumProblem.hpp:48
virtual auto clone() const -> OptimumSolverBase *=0
Return a clone of this instance.
virtual auto solve(const OptimumProblem &problem, OptimumState &state) -> OptimumResult=0
Solve an optimisation problem.
The base class for all optimization algorithms.
Definition: OptimumSolverBase.hpp:35
Eigen::VectorXd Vector
Define an alias to the vector type of the Eigen library.
Definition: Matrix.hpp:384
A type that describes the options of a optimisation calculation.
Definition: OptimumOptions.hpp:186
virtual ~OptimumSolverBase()=0
Pure virtual destructor.
Definition: OptimumSolverBase.cpp:22
A type that describes the state of an optimum solution.
Definition: OptimumState.hpp:28
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
virtual auto dxdp(const Vector &dgdp, const Vector &dbdp) -> Vector=0
Return the sensitivity dx/dp of the solution x with respect to a vector of parameters p...
A type that describes the result of an optimisation calculation.
Definition: OptimumResult.hpp:23