Reaktoro
A unified framework for modeling chemically reactive systems
OptimumSolverIpOpt.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright (C) 2014-2018 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/Optimization/OptimumSolverBase.hpp>
22 
23 namespace Reaktoro {
24 
25 // Forward declarations
26 struct OptimumOptions;
27 struct OptimumProblem;
28 struct OptimumResult;
29 struct OptimumState;
30 
34 {
35 public:
38 
41 
43  virtual ~OptimumSolverIpOpt();
44 
47 
51  virtual auto solve(const OptimumProblem& problem, OptimumState& state) -> OptimumResult;
52 
57  virtual auto solve(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult;
58 
62  virtual auto dxdp(VectorConstRef dgdp, VectorConstRef dbdp) -> Vector;
63 
65  virtual auto clone() const -> OptimumSolverBase*;
66 
67 private:
68  struct Impl;
69 
70  std::unique_ptr<Impl> pimpl;
71 };
72 
73 } // namespace Reaktoro
The base class for all optimization algorithms.
Definition: OptimumSolverBase.hpp:36
A type that describes the non-linear constrained optimisation problem.
Definition: OptimumProblem.hpp:49
virtual auto dxdp(VectorConstRef dgdp, VectorConstRef dbdp) -> Vector
Return the sensitivity dx/dp of the solution x with respect to a vector of parameters p.
Definition: OptimumSolverIpOpt.cpp:521
virtual auto solve(const OptimumProblem &problem, OptimumState &state) -> OptimumResult
Solve an optimisation problem.
Definition: OptimumSolverIpOpt.cpp:511
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
auto operator=(OptimumSolverIpOpt other) -> OptimumSolverIpOpt &
Assign an OptimumSolverIpOpt instance to this.
Definition: OptimumSolverIpOpt.cpp:505
OptimumSolverIpOpt()
Construct a default OptimumSolverIpOpt instance.
Definition: OptimumSolverIpOpt.cpp:494
A type that describes the options of a optimisation calculation.
Definition: OptimumOptions.hpp:187
A type that describes the state of an optimum solution.
Definition: OptimumState.hpp:29
A type that describes the result of an optimisation calculation.
Definition: OptimumResult.hpp:24
virtual ~OptimumSolverIpOpt()
Destroy this OptimumSolverIpOpt instance.
Definition: OptimumSolverIpOpt.cpp:502
virtual auto clone() const -> OptimumSolverBase *
Return a clone of this instance.
Definition: OptimumSolverIpOpt.cpp:528
Eigen::Ref< const Eigen::VectorXd > VectorConstRef
< Alias to Eigen type Ref<VectorXd>.
Definition: Matrix.hpp:31
The class that implements the IpOpt algorithm using an interior-point method.
Definition: OptimumSolverIpOpt.hpp:34