optimization_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_OPTIMIZATION_SOLVER_H
#define LIBMESH_OPTIMIZATION_SOLVER_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/parallel_object.h"
#include "libmesh/auto_ptr.h" // deprecated
#include "libmesh/optimization_system.h"

#ifdef LIBMESH_FORWARD_DECLARE_ENUMS
namespace libMesh
{
enum SolverPackage : int;
}
#else
#include "libmesh/enum_solver_package.h"
#endif

// C++ includes
#include <cstddef>
#include <memory>

namespace libMesh
{

// forward declarations
template <typename T> class SparseMatrix;
template <typename T> class NumericVector;
template <typename T> class Preconditioner;

template <typename T>
class OptimizationSolver : public ReferenceCountedObject<OptimizationSolver<T>>,
                           public ParallelObject
{
public:
  typedef OptimizationSystem sys_type;

  explicit
  OptimizationSolver (sys_type & s);

  virtual ~OptimizationSolver ();

  static std::unique_ptr<OptimizationSolver<T>> build(sys_type & s,
                                                      const SolverPackage solver_package = libMesh::default_solver_package());

  bool initialized () const { return _is_initialized; }

  virtual void clear () {}

  virtual void init () = 0;

  virtual void solve () = 0;

  virtual void get_dual_variables()
  { libmesh_not_implemented(); }

  virtual void print_converged_reason() { libmesh_not_implemented(); }

  virtual int get_converged_reason() { return 0; }

  OptimizationSystem::ComputeObjective * objective_object;

  OptimizationSystem::ComputeGradient * gradient_object;

  OptimizationSystem::ComputeHessian * hessian_object;

  OptimizationSystem::ComputeEqualityConstraints * equality_constraints_object;

  OptimizationSystem::ComputeEqualityConstraintsJacobian * equality_constraints_jacobian_object;

  OptimizationSystem::ComputeInequalityConstraints * inequality_constraints_object;

  OptimizationSystem::ComputeInequalityConstraintsJacobian * inequality_constraints_jacobian_object;

  OptimizationSystem::ComputeLowerAndUpperBounds * lower_and_upper_bounds_object;

  const sys_type & system () const { return _system; }

  sys_type & system () { return _system; }

  unsigned int max_objective_function_evaluations;

  Real objective_function_relative_tolerance;

  bool verbose;

protected:

  sys_type & _system;

  bool _is_initialized;

};

} // namespace libMesh


#endif // LIBMESH_OPTIMIZATION_SOLVER_H