Reaktoro 
A unified framework for modeling chemically reactive systems
OptimumSolverRefiner.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 // 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 
33 {
34 public:
37 
40 
42  virtual ~OptimumSolverRefiner();
43 
46 
50  virtual auto solve(const OptimumProblem& problem, OptimumState& state) -> OptimumResult;
51 
56  virtual auto solve(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult;
57 
61  virtual auto dxdp(const Vector& dgdp, const Vector& dbdp) -> Vector;
62 
64  virtual auto clone() const -> OptimumSolverBase*;
65 
66 private:
67  struct Impl;
68 
69  std::unique_ptr<Impl> pimpl;
70 };
71 
72 } // namespace Reaktoro
virtual auto dxdp(const Vector &dgdp, const Vector &dbdp) -> Vector
Return the sensitivity dx/dp of the solution x with respect to a vector of parameters p...
Definition: OptimumSolverRefiner.cpp:348
A type that describes the non-linear constrained optimisation problem.
Definition: OptimumProblem.hpp:48
OptimumSolverRefiner()
Construct a default OptimumSolverRefiner instance.
Definition: OptimumSolverRefiner.cpp:321
auto operator=(OptimumSolverRefiner other) -> OptimumSolverRefiner &
Assign an OptimumSolverRefiner instance to this.
Definition: OptimumSolverRefiner.cpp:332
virtual auto solve(const OptimumProblem &problem, OptimumState &state) -> OptimumResult
Solve an optimisation problem.
Definition: OptimumSolverRefiner.cpp:338
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 ~OptimumSolverRefiner()
Destroy this OptimumSolverRefiner instance.
Definition: OptimumSolverRefiner.cpp:329
The class that implements a refinement operation of the optimal solution.
Definition: OptimumSolverRefiner.hpp:32
virtual auto clone() const -> OptimumSolverBase *
Return a clone of this instance.
Definition: OptimumSolverRefiner.cpp:355
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
A type that describes the result of an optimisation calculation.
Definition: OptimumResult.hpp:23