Home
Publications
Presentations
Support
Download
Examples
Developers
Class Docs
Namespaces
Classes
Files
Mailing Lists
Gallery
Wiki

petsc_nonlinear_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2012 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_PETSC_NONLINEAR_SOLVER_H
#define LIBMESH_PETSC_NONLINEAR_SOLVER_H

#include "libmesh/libmesh_config.h"

// Petsc include files.
#ifdef LIBMESH_HAVE_PETSC

// Local includes
#include "libmesh/nonlinear_solver.h"
#include "libmesh/petsc_macro.h"

// PETSc includes
EXTERN_C_FOR_PETSC_BEGIN
# include <petscsnes.h>
EXTERN_C_FOR_PETSC_END

// C++ includes

namespace libMesh
{
  // Allow users access to these functions in case they want to reuse them.  Note that users shouldn't
  // need access to these most of the time as they are used internally by this object.
  extern "C"
  {
    PetscErrorCode __libmesh_petsc_snes_monitor (SNES, PetscInt its, PetscReal fnorm, void *);
    PetscErrorCode __libmesh_petsc_snes_residual (SNES, Vec x, Vec r, void *ctx);
    PetscErrorCode __libmesh_petsc_snes_jacobian (SNES, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx);
  }

template <typename T>
class PetscNonlinearSolver : public NonlinearSolver<T>
{
public:
  typedef NonlinearImplicitSystem sys_type;

  explicit
  PetscNonlinearSolver (sys_type& system);

  ~PetscNonlinearSolver ();

  virtual void clear ();

  virtual void init ();

  SNES snes() { this->init(); return _snes; }

  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); // N. Iterations

  virtual void print_converged_reason();

  SNESConvergedReason get_converged_reason();

  virtual int get_total_linear_iterations();

  virtual unsigned get_current_nonlinear_iteration_number() const { return _current_nonlinear_iteration_number; }

  void set_current_nonlinear_iteration_number(unsigned num) { _current_nonlinear_iteration_number = num; }

  SNES _snes;

  SNESConvergedReason _reason;

  int _n_linear_iterations;

  unsigned _current_nonlinear_iteration_number;

 private:
#if !PETSC_VERSION_LESS_THAN(3,3,0)
  void build_mat_null_space(NonlinearImplicitSystem::ComputeVectorSubspace* computeSubspaceObject,
                            void (*)(std::vector<NumericVector<Number>*>&, sys_type&),
                            MatNullSpace*);
#endif
};



} // namespace libMesh


#endif // #ifdef LIBMESH_HAVE_PETSC
#endif // LIBMESH_PETSC_NONLINEAR_SOLVER_H

---

Site Created By: libMesh Developers
Last modified: February 05 2013 19:54:48 UTC

Hosted By: