/usr/include/libmesh/petsc_nonlinear_solver.h is in libmesh-dev 0.7.1-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | // $Id: petsc_nonlinear_solver.h 4278 2011-03-21 15:23:30Z roystgnr $
// The libMesh Finite Element Library.
// Copyright (C) 2002-2008 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 __petsc_nonlinear_solver_h__
#define __petsc_nonlinear_solver_h__
// C++ includes
// Local includes
#include "libmesh_config.h"
// Petsc include files.
#ifdef LIBMESH_HAVE_PETSC
#include "nonlinear_solver.h"
#include "petsc_macro.h"
EXTERN_C_FOR_PETSC_BEGIN
# include <petscsnes.h>
EXTERN_C_FOR_PETSC_END
namespace libMesh
{
/**
* This class provides an interface to PETSc
* iterative solvers that is compatible with the \p libMesh
* \p NonlinearSolver<>
*
* @author Benjamin Kirk, 2002-2007
*/
template <typename T>
class PetscNonlinearSolver : public NonlinearSolver<T>
{
public:
/**
* The type of system
*/
typedef NonlinearImplicitSystem sys_type;
/**
* Constructor. Initializes Petsc data structures
*/
PetscNonlinearSolver (sys_type& system);
/**
* Destructor.
*/
~PetscNonlinearSolver ();
/**
* Release all memory and clear data structures.
*/
virtual void clear ();
/**
* Initialize data structures if not done so already.
*/
virtual void init ();
/**
* Returns the raw PETSc snes context pointer.
*/
SNES snes() { this->init(); return _snes; }
/**
* Call the Petsc solver. It calls the method below, using the
* same matrix for the system and preconditioner matrices.
*/
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
/**
* Prints a useful message about why the latest nonlinear solve
* con(di)verged.
*/
virtual void print_converged_reason();
/**
* Returns the currently-available (or most recently obtained, if the SNES object has
* been destroyed) convergence reason. Refer to PETSc docs for the meaning of different
* SNESConvergedReasons.
*/
SNESConvergedReason get_converged_reason();
private:
/**
* Nonlinear solver context
*/
SNES _snes;
/**
* Store the reason for SNES convergence/divergence for use even after the _snes
* has been cleared. Note that print_converged_reason() will always *try* to
* get the current reason with SNESGetConvergedReason(), but if the SNES object
* has already been cleared, it will fall back on this stored value. Note that
* this value is therefore necessarily *not* cleared by the clear() function.
*/
SNESConvergedReason _reason;
};
/*----------------------- functions ----------------------------------*/
template <typename T>
inline
PetscNonlinearSolver<T>::PetscNonlinearSolver (sys_type& system) :
NonlinearSolver<T>(system),
_reason(SNES_CONVERGED_ITERATING/*==0*/) // Arbitrary initial value...
{
}
template <typename T>
inline
PetscNonlinearSolver<T>::~PetscNonlinearSolver ()
{
this->clear ();
}
} // namespace libMesh
#endif // #ifdef LIBMESH_HAVE_PETSC
#endif // #ifdef __petsc_nonlinear_solver_h__
|