nonlinear_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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_NONLINEAR_SOLVER_H
#define LIBMESH_NONLINEAR_SOLVER_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/enum_solver_package.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/nonlinear_implicit_system.h"
#include "libmesh/libmesh.h"
#include "libmesh/parallel_object.h"
#include "libmesh/auto_ptr.h"

// C++ includes
#include <cstddef>

namespace libMesh
{

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

template <typename T>
class NonlinearSolver : public ReferenceCountedObject<NonlinearSolver<T> >,
                        public ParallelObject
{
public:
  typedef NonlinearImplicitSystem sys_type;

  explicit
  NonlinearSolver (sys_type& s);

  virtual ~NonlinearSolver ();

  static UniquePtr<NonlinearSolver<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 (const char* name = NULL) = 0;

  virtual std::pair<unsigned int, Real> solve (SparseMatrix<T>&,  // System Jacobian Matrix
                                               NumericVector<T>&, // Solution vector
                                               NumericVector<T>&, // Residual vector
                                               const double,      // Stopping tolerance
                                               const unsigned int) = 0; // N. Iterations

  virtual void print_converged_reason() { libmesh_not_implemented(); }

  virtual int get_total_linear_iterations() = 0;

  virtual unsigned get_current_nonlinear_iteration_number() const = 0;

  void (* residual) (const NumericVector<Number>& X,
                     NumericVector<Number>& R,
                     sys_type& S);

  NonlinearImplicitSystem::ComputeResidual *residual_object;

  void (* jacobian) (const NumericVector<Number>& X,
                     SparseMatrix<Number>& J,
                     sys_type& S);

  NonlinearImplicitSystem::ComputeJacobian *jacobian_object;

  void (* matvec) (const NumericVector<Number>& X,
                   NumericVector<Number>* R,
                   SparseMatrix<Number>*  J,
                   sys_type& S);

  NonlinearImplicitSystem::ComputeResidualandJacobian *residual_and_jacobian_object;

  void (* bounds) (NumericVector<Number>& XL,
                   NumericVector<Number>& XU,
                   sys_type& S);
  NonlinearImplicitSystem::ComputeBounds *bounds_object;

  void (* nullspace) (std::vector<NumericVector<Number>*>& sp, sys_type& S);

  NonlinearImplicitSystem::ComputeVectorSubspace *nullspace_object;

  void (* nearnullspace) (std::vector<NumericVector<Number>*>& sp, sys_type& S);

  NonlinearImplicitSystem::ComputeVectorSubspace *nearnullspace_object;


  void (* user_presolve)(sys_type& S);

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

  sys_type & system () { return _system; }

  void attach_preconditioner(Preconditioner<T> * preconditioner);

  unsigned int max_nonlinear_iterations;

  unsigned int max_function_evaluations;

  Real absolute_residual_tolerance;
  Real relative_residual_tolerance;

  Real absolute_step_tolerance;
  Real relative_step_tolerance;

  unsigned int max_linear_iterations;

  Real initial_linear_tolerance;

  Real minimum_linear_tolerance;

  bool converged;

protected:
  sys_type& _system;

  bool _is_initialized;

  Preconditioner<T> * _preconditioner;
};




/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
NonlinearSolver<T>::NonlinearSolver (sys_type& s) :
  ParallelObject               (s),
  residual                     (NULL),
  residual_object              (NULL),
  jacobian                     (NULL),
  jacobian_object              (NULL),
  matvec                       (NULL),
  residual_and_jacobian_object (NULL),
  bounds                       (NULL),
  bounds_object                (NULL),
  nullspace                    (NULL),
  nullspace_object             (NULL),
  nearnullspace                (NULL),
  nearnullspace_object         (NULL),
  user_presolve                (NULL),
  max_nonlinear_iterations(0),
  max_function_evaluations(0),
  absolute_residual_tolerance(0),
  relative_residual_tolerance(0),
  absolute_step_tolerance(0),
  relative_step_tolerance(0),
  max_linear_iterations(0),
  initial_linear_tolerance(0),
  minimum_linear_tolerance(0),
  converged(false),
  _system(s),
  _is_initialized (false),
  _preconditioner (NULL)
{
}



template <typename T>
inline
NonlinearSolver<T>::~NonlinearSolver ()
{
  this->clear ();
}


} // namespace libMesh


#endif // LIBMESH_NONLINEAR_SOLVER_H