libMesh
tao_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_TAO_OPTIMIZATION_SOLVER_H
21 #define LIBMESH_TAO_OPTIMIZATION_SOLVER_H
22 
23 #include "libmesh/libmesh_config.h"
24 
25 // Petsc include files.
26 #if defined(LIBMESH_HAVE_PETSC_TAO) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
27 
28 // Local includes
29 #include "libmesh/petsc_macro.h"
30 #include "libmesh/optimization_solver.h"
31 
32 // Include header for the Tao optimization library
33 #include <petsctao.h>
34 
35 namespace libMesh
36 {
37 
38 // Allow users access to these functions in case they want to reuse them. Users shouldn't
39 // need access to these most of the time as they are used internally by this object.
40 extern "C"
41 {
42  PetscErrorCode __libmesh_tao_objective (Tao tao, Vec x, PetscReal * objective, void * ctx);
43  PetscErrorCode __libmesh_tao_gradient(Tao tao, Vec x, Vec g, void * ctx);
44  PetscErrorCode __libmesh_tao_hessian(Tao tao, Vec x, Mat h, Mat pc, void * ctx);
45  PetscErrorCode __libmesh_tao_equality_constraints(Tao tao, Vec x, Vec ce, void * ctx);
46  PetscErrorCode __libmesh_tao_equality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void * ctx);
47  PetscErrorCode __libmesh_tao_inequality_constraints(Tao tao, Vec x, Vec cineq, void * ctx);
48  PetscErrorCode __libmesh_tao_inequality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void * ctx);
49 }
50 
57 template <typename T>
59 {
60 public:
61 
66 
70  explicit
71  TaoOptimizationSolver (sys_type & system);
72 
77 
81  virtual void clear () libmesh_override;
82 
86  virtual void init () libmesh_override;
87 
91  Tao tao() { this->init(); return _tao; }
92 
96  virtual void solve () libmesh_override;
97 
103  virtual void get_dual_variables() libmesh_override;
104 
109  virtual void print_converged_reason() libmesh_override;
110 
117  virtual int get_converged_reason() libmesh_override;
118 
119 protected:
120 
124  Tao _tao;
125 
136  TaoConvergedReason _reason;
137 
138 private:
139 
140  friend PetscErrorCode __libmesh_tao_objective (Tao tao, Vec x, PetscReal * objective, void * ctx);
141  friend PetscErrorCode __libmesh_tao_gradient(Tao tao, Vec x, Vec g, void * ctx);
142  friend PetscErrorCode __libmesh_tao_hessian(Tao tao, Vec x, Mat h, Mat pc, void * ctx);
143  friend PetscErrorCode __libmesh_tao_equality_constraints(Tao tao, Vec x, Vec ce, void * ctx);
144  friend PetscErrorCode __libmesh_tao_equality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void * ctx);
145  friend PetscErrorCode __libmesh_tao_inequality_constraints(Tao tao, Vec x, Vec cineq, void * ctx);
146  friend PetscErrorCode __libmesh_tao_inequality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void * ctx);
147 };
148 
149 
150 
151 } // namespace libMesh
152 
153 
154 #endif // #if defined(LIBMESH_HAVE_PETSC_TAO) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
155 #endif // LIBMESH_TAO_OPTIMIZATION_SOLVER_H
friend PetscErrorCode __libmesh_tao_inequality_constraints(Tao tao, Vec x, Vec cineq, void *ctx)
This class provides an interface to the Tao optimization solvers.
friend PetscErrorCode __libmesh_tao_hessian(Tao tao, Vec x, Mat h, Mat pc, void *ctx)
OptimizationSystem sys_type
The type of system that we use in conjunction with this solver.
virtual void init() libmesh_override
Initialize data structures if not done so already.
friend PetscErrorCode __libmesh_tao_equality_constraints(Tao tao, Vec x, Vec ce, void *ctx)
The libMesh namespace provides an interface to certain functionality in the library.
PetscErrorCode Vec Mat Mat pc
const sys_type & system() const
virtual void clear() libmesh_override
Release all memory and clear data structures.
friend PetscErrorCode __libmesh_tao_equality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void *ctx)
PetscErrorCode __libmesh_tao_gradient(Tao tao, Vec x, Vec g, void *ctx)
PetscErrorCode __libmesh_tao_hessian(Tao tao, Vec x, Mat h, Mat pc, void *ctx)
PetscErrorCode Vec x
Tao _tao
Optimization solver context.
TaoOptimizationSolver(sys_type &system)
Constructor.
friend PetscErrorCode __libmesh_tao_inequality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void *ctx)
This System subclass enables us to assemble an objective function, gradient, Hessian and bounds for o...
friend PetscErrorCode __libmesh_tao_objective(Tao tao, Vec x, PetscReal *objective, void *ctx)
friend PetscErrorCode __libmesh_tao_gradient(Tao tao, Vec x, Vec g, void *ctx)
PetscErrorCode Vec Mat Mat void * ctx
virtual int get_converged_reason() libmesh_override
PetscErrorCode __libmesh_tao_objective(Tao tao, Vec x, PetscReal *objective, void *ctx)
virtual void get_dual_variables() libmesh_override
Get the current values of dual variables associated with inequality and equality constraints.
TaoConvergedReason _reason
Store the reason for Tao convergence/divergence for use even after _tao has been cleared.
This base class can be inherited from to provide interfaces to optimization solvers from different pa...
virtual void solve() libmesh_override
Call the Tao solver.
PetscErrorCode __libmesh_tao_equality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void *ctx)
virtual void print_converged_reason() libmesh_override
Prints a useful message about why the latest optimization solve con(di)verged.
PetscErrorCode __libmesh_tao_equality_constraints(Tao tao, Vec x, Vec ce, void *ctx)
PetscErrorCode __libmesh_tao_inequality_constraints_jacobian(Tao tao, Vec x, Mat J, Mat Jpre, void *ctx)
PetscErrorCode __libmesh_tao_inequality_constraints(Tao tao, Vec x, Vec cineq, void *ctx)