optimization_solver.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_OPTIMIZATION_SOLVER_H
21 #define LIBMESH_OPTIMIZATION_SOLVER_H
22 
23 // Local includes
24 #include "libmesh/libmesh_common.h"
27 #include "libmesh/libmesh.h"
29 #include "libmesh/auto_ptr.h" // deprecated
31 
32 // C++ includes
33 #include <cstddef>
34 #include <memory>
35 
36 namespace libMesh
37 {
38 
39 // forward declarations
40 template <typename T> class SparseMatrix;
41 template <typename T> class NumericVector;
42 template <typename T> class Preconditioner;
43 
52 template <typename T>
53 class OptimizationSolver : public ReferenceCountedObject<OptimizationSolver<T>>,
54  public ParallelObject
55 {
56 public:
61 
65  explicit
66  OptimizationSolver (sys_type & s);
67 
71  virtual ~OptimizationSolver ();
72 
77  static std::unique_ptr<OptimizationSolver<T>> build(sys_type & s,
78  const SolverPackage solver_package = libMesh::default_solver_package());
79 
84  bool initialized () const { return _is_initialized; }
85 
89  virtual void clear () {}
90 
94  virtual void init () = 0;
95 
99  virtual void solve () = 0;
100 
106  virtual void get_dual_variables()
107  { libmesh_not_implemented(); }
108 
113  virtual void print_converged_reason() { libmesh_not_implemented(); }
114 
124  virtual int get_converged_reason() { return 0; }
125 
131 
137 
143 
149 
154 
160 
165 
170 
175  const sys_type & system () const { return _system; }
176 
181  sys_type & system () { return _system; }
182 
187 
192 
196  bool verbose;
197 
198 protected:
199 
203  sys_type & _system;
204 
209 
210 };
211 
212 } // namespace libMesh
213 
214 
215 #endif // LIBMESH_OPTIMIZATION_SOLVER_H
OptimizationSystem::ComputeObjective * objective_object
static std::unique_ptr< OptimizationSolver< T > > build(sys_type &s, const SolverPackage solver_package=libMesh::default_solver_package())
OptimizationSystem::ComputeGradient * gradient_object
const sys_type & system() const
OptimizationSystem::ComputeHessian * hessian_object
OptimizationSystem::ComputeInequalityConstraints * inequality_constraints_object
SolverPackage default_solver_package()
Definition: libmesh.C:994
OptimizationSystem::ComputeEqualityConstraintsJacobian * equality_constraints_jacobian_object
unsigned int max_objective_function_evaluations
OptimizationSystem::ComputeLowerAndUpperBounds * lower_and_upper_bounds_object
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
OptimizationSystem::ComputeInequalityConstraintsJacobian * inequality_constraints_jacobian_object
OptimizationSystem::ComputeEqualityConstraints * equality_constraints_object