/usr/include/dolfin/nls/NewtonSolver.h is in libdolfin1.0-dev 1.0.0-1.
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 | // Copyright (C) 2005-2008 Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Anders Logg 2006-2011.
// Modified by Anders E. Johansen 2011.
//
// First added: 2005-10-23
// Last changed: 2011-07-11
#ifndef __NEWTON_SOLVER_H
#define __NEWTON_SOLVER_H
#include <utility>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <dolfin/common/Variable.h>
namespace dolfin
{
// Forward declarations
class GenericLinearSolver;
class LinearAlgebraFactory;
class GenericMatrix;
class GenericVector;
class NonlinearProblem;
/// This class defines a Newton solver for nonlinear systems of
/// equations of the form :math:`F(x) = 0`.
class NewtonSolver : public Variable
{
public:
/// Create nonlinear solver with default linear solver and default
/// linear algebra backend
NewtonSolver(std::string solver_type="lu",
std::string pc_type="default");
/// Create nonlinear solver using provided linear solver and linear algebra
/// backend determined by factory
///
/// *Arguments*
/// solver (_GenericLinearSolver_)
/// The linear solver.
/// factory (_LinearAlgebraFactory_)
/// The factory.
NewtonSolver(GenericLinearSolver& solver, LinearAlgebraFactory& factory);
/// Destructor
virtual ~NewtonSolver();
/// Solve abstract nonlinear problem :math:`F(x) = 0` for given
/// :math:`F` and Jacobian :math:`\dfrac{\partial F}{\partial x}`.
///
/// *Arguments*
/// nonlinear_function (_NonlinearProblem_)
/// The nonlinear problem.
/// x (_GenericVector_)
/// The vector.
///
/// *Returns*
/// std::pair<uint, bool>
/// Pair of number of Newton iterations, and whether
/// iteration converged)
std::pair<uint, bool> solve(NonlinearProblem& nonlinear_function,
GenericVector& x);
/// Return Newton iteration number
///
/// *Returns*
/// uint
/// The iteration number.
uint iteration() const;
/// Return current residual
///
/// *Returns*
/// double
/// Current residual.
double residual() const;
/// Return current relative residual
///
/// *Returns*
/// double
/// Current relative residual.
double relative_residual() const;
/// Return the linear solver
///
/// *Returns*
/// _GenericLinearSolver_
/// The linear solver.
GenericLinearSolver& linear_solver() const;
/// Default parameter values
///
/// *Returns*
/// _Parameters_
/// Parameter values.
static Parameters default_parameters();
private:
/// Convergence test
virtual bool converged(const GenericVector& b, const GenericVector& dx,
const NonlinearProblem& nonlinear_problem);
/// Current number of Newton iterations
uint newton_iteration;
/// Most recent residual and intitial residual
double _residual, residual0;
/// Solver
boost::shared_ptr<GenericLinearSolver> solver;
/// Jacobian matrix
boost::shared_ptr<GenericMatrix> A;
/// Solution vector
boost::scoped_ptr<GenericVector> dx;
/// Resdiual vector
boost::scoped_ptr<GenericVector> b;
};
}
#endif
|