/usr/include/dolfin/la/PETScKrylovSolver.h is in libdolfin-dev 2016.2.0-2.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | // Copyright (C) 2004-2015 Johan Jansson and 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 2005-2012
// Modified by Johan Hoffman 2005
// Modified by Andy R. Terrel 2005
// Modified by Garth N. Wells 2005-2010
#ifndef __DOLFIN_PETSC_KRYLOV_SOLVER_H
#define __DOLFIN_PETSC_KRYLOV_SOLVER_H
#ifdef HAS_PETSC
#include <map>
#include <memory>
#include <string>
#include <petscksp.h>
#include <dolfin/common/types.h>
#include "GenericLinearSolver.h"
#include "PETScObject.h"
namespace dolfin
{
/// Forward declarations
class GenericMatrix;
class GenericVector;
class PETScBaseMatrix;
class PETScMatrix;
class PETScVector;
class PETScPreconditioner;
class PETScUserPreconditioner;
class PETScSNESSolver;
class VectorSpaceBasis;
/// This class implements Krylov methods for linear systems of the
/// form Ax = b. It is a wrapper for the Krylov solvers of PETSc.
class PETScKrylovSolver : public GenericLinearSolver, public PETScObject
{
public:
/// Norm types used in convergence testing. Not all solvers types
/// support all norm types (see
/// http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPSetNormType.html). Note
/// that 'default' is a reserved keyword, so we use 'default_norm'
enum class norm_type {none, default_norm, preconditioned, unpreconditioned, natural};
/// Create Krylov solver for a particular method and named
/// preconditioner
PETScKrylovSolver(MPI_Comm comm,
std::string method="default",
std::string preconditioner="default");
/// Create Krylov solver for a particular method and named
/// preconditioner
PETScKrylovSolver(std::string method="default",
std::string preconditioner="default");
/// Create Krylov solver for a particular method and
/// PETScPreconditioner (shared_ptr version)
PETScKrylovSolver(MPI_Comm comm,
std::string method,
std::shared_ptr<PETScPreconditioner> preconditioner);
/// Create Krylov solver for a particular method and
/// PETScPreconditioner (shared_ptr version)
PETScKrylovSolver(std::string method,
std::shared_ptr<PETScPreconditioner> preconditioner);
/// Create Krylov solver for a particular method and
/// PETScPreconditioner (shared_ptr version)
PETScKrylovSolver(MPI_Comm comm,
std::string method,
std::shared_ptr<PETScUserPreconditioner> preconditioner);
/// Create Krylov solver for a particular method and
/// PETScPreconditioner (shared_ptr version)
PETScKrylovSolver(std::string method,
std::shared_ptr<PETScUserPreconditioner> preconditioner);
/// Create solver wrapper of a PETSc KSP object
explicit PETScKrylovSolver(KSP ksp);
/// Destructor
~PETScKrylovSolver();
/// Set operator (matrix)
void set_operator(std::shared_ptr<const GenericLinearOperator> A);
/// Set operator (matrix) and preconditioner matrix
void set_operators(std::shared_ptr<const GenericLinearOperator> A,
std::shared_ptr<const GenericLinearOperator> P);
/// Solve linear system Ax = b and return number of iterations
std::size_t solve(GenericVector& x, const GenericVector& b);
/// Solve linear system Ax = b and return number of iterations
std::size_t solve(PETScVector& x, const PETScVector& b);
/// Solve linear system Ax = b and return number of iterations
std::size_t solve(const GenericLinearOperator& A, GenericVector& x,
const GenericVector& b);
/// Use nonzero intial guess for solution function
/// (nonzero_guess=true, the solution vector x will not be zeroed
/// before the solver starts)
void set_nonzero_guess(bool nonzero_guess);
/// Reuse preconditioner if true, even if matrix operator changes
/// (by default preconditioner will be re-built if the matrix
/// changes)
void set_reuse_preconditioner(bool reuse_pc);
/// Set tolerances (relative residual, alsolute residial, maximum
/// number of iterations)
void set_tolerances(double relative, double absolute, double diverged,
int max_iter);
/// Set norm type used in convergence testing - not all solvers
/// types support all norm types
void set_norm_type(norm_type type);
/// Get norm type used in convergence testing
norm_type get_norm_type() const;
/// Monitor residual at each iteration
void monitor(bool monitor_convergence);
/// Sets the prefix used by PETSc when searching the PETSc options
/// database
void set_options_prefix(std::string options_prefix);
/// Returns the prefix used by PETSc when searching the PETSc
/// options database
std::string get_options_prefix() const;
/// Set options from PETSc options database
void set_from_options() const;
/// Return informal string representation (pretty-print)
std::string str(bool verbose) const;
/// Return MPI communicator
MPI_Comm mpi_comm() const;
/// Return PETSc KSP pointer
KSP ksp() const;
/// Return a list of available solver methods
static std::map<std::string, std::string> methods();
/// Return a list of available named preconditioners
static std::map<std::string, std::string> preconditioners();
/// Default parameter values
static Parameters default_parameters();
/// Return parameter type: "krylov_solver" or "lu_solver"
std::string parameter_type() const
{ return "krylov_solver"; }
friend class PETScSNESSolver;
friend class PETScTAOSolver;
private:
// Return norm_type enum for norm string
static PETScKrylovSolver::norm_type get_norm_type(std::string norm);
// Set operator (matrix)
void _set_operator(std::shared_ptr<const PETScBaseMatrix> A);
// Set operator (matrix) and preconditioner matrix
void _set_operators(std::shared_ptr<const PETScBaseMatrix> A,
std::shared_ptr<const PETScBaseMatrix> P);
// Solve linear system Ax = b and return number of iterations
std::size_t _solve(const PETScBaseMatrix& A, PETScVector& x,
const PETScVector& b);
// Report the number of iterations
void write_report(int num_iterations, KSPConvergedReason reason);
void check_dimensions(const PETScBaseMatrix& A, const GenericVector& x,
const GenericVector& b) const;
// Available solvers
static const std::map<std::string, const KSPType> _methods;
// Available solvers descriptions
static const std::map<std::string, std::string> _methods_descr;
// PETSc solver pointer
KSP _ksp;
// DOLFIN-defined PETScUserPreconditioner
PETScUserPreconditioner* pc_dolfin;
// Preconditioner
std::shared_ptr<PETScPreconditioner> _preconditioner;
// Operator (the matrix)
std::shared_ptr<const PETScBaseMatrix> _matA;
// Matrix used to construct the preconditioner
std::shared_ptr<const PETScBaseMatrix> _matP;
bool preconditioner_set;
};
}
#endif
#endif
|