optimization_solver.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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"
31 
32 // C++ includes
33 #include <cstddef>
34 
35 namespace libMesh
36 {
37 
38 // forward declarations
39 template <typename T> class SparseMatrix;
40 template <typename T> class NumericVector;
41 template <typename T> class Preconditioner;
42 
51 template <typename T>
52 class OptimizationSolver : public ReferenceCountedObject<OptimizationSolver<T> >,
53  public ParallelObject
54 {
55 public:
60 
64  explicit
65  OptimizationSolver (sys_type & s);
66 
70  virtual ~OptimizationSolver ();
71 
76  static UniquePtr<OptimizationSolver<T> > build(sys_type & s,
77  const SolverPackage solver_package = libMesh::default_solver_package());
78 
83  bool initialized () const { return _is_initialized; }
84 
88  virtual void clear () {}
89 
93  virtual void init () = 0;
94 
98  virtual void solve () = 0;
99 
105  virtual void get_dual_variables()
106  { libmesh_not_implemented(); }
107 
112  virtual void print_converged_reason() { libmesh_not_implemented(); }
113 
123  virtual int get_converged_reason() { return 0; }
124 
130 
136 
142 
148 
153 
159 
164 
169 
174  const sys_type & system () const { return _system; }
175 
180  sys_type & system () { return _system; }
181 
186 
191 
195  bool verbose;
196 
197 protected:
198 
202  sys_type & _system;
203 
208 
209 };
210 
211 } // namespace libMesh
212 
213 
214 #endif // LIBMESH_OPTIMIZATION_SOLVER_H
OptimizationSystem::ComputeObjective * objective_object
static UniquePtr< 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
std::unique_ptr< T > UniquePtr
Definition: auto_ptr.h:46
OptimizationSystem::ComputeInequalityConstraints * inequality_constraints_object
SolverPackage default_solver_package()
Definition: libmesh.C:995
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