/usr/include/dolfin/la/PETScPreconditioner.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 | // Copyright (C) 2010 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 2011
//
// First added: 2010-02-25
// Last changed: 2014-07-09
#ifndef __DOLFIN_PETSC_PRECONDITIONER_H
#define __DOLFIN_PETSC_PRECONDITIONER_H
#ifdef HAS_PETSC
#include <string>
#include <vector>
#include <memory>
#include <petscpc.h>
#include <dolfin/common/types.h>
#include <dolfin/common/Variable.h>
#include <dolfin/la/PETScObject.h>
#include <dolfin/parameter/Parameters.h>
namespace dolfin
{
// Forward declarations
class PETScKrylovSolver;
class PETScSNESSolver;
class VectorSpaceBasis;
/// This class is a wrapper for configuring PETSc
/// preconditioners. It does not own a preconditioner. It can take a
/// PETScKrylovSolver and set the preconditioner type and
/// parameters.
class PETScPreconditioner : public PETScObject, public Variable
{
public:
static void set_type(PETScKrylovSolver& solver, std::string type);
/// Create a particular preconditioner object
explicit PETScPreconditioner(std::string type = "default");
/// Destructor
virtual ~PETScPreconditioner();
/// Set the preconditioner type and parameters
virtual void set(PETScKrylovSolver& solver);
/// Set the coordinates of the operator (matrix) rows and
/// geometric dimension d. This is can be used by required for
/// certain preconditioners, e.g. ML. The input for this function
/// can be generated using GenericDofMap::tabulate_all_dofs.
void set_coordinates(const std::vector<double>& x, std::size_t dim);
// FIXME: Document
void
set_fieldsplit(PETScKrylovSolver& solver,
const std::vector<std::vector<dolfin::la_index>>& fields,
const std::vector<std::string>& split_names);
/// Return informal string representation (pretty-print)
std::string str(bool verbose) const;
/// Return a list of available preconditioners
static std::map<std::string, std::string> preconditioners();
/// Default parameter values
//static Parameters default_parameters();
friend class PETScSNESSolver;
friend class PETScTAOSolver;
private:
/// Named preconditioner
std::string _type;
// Available names preconditioners
static const std::map<std::string, const PCType> _methods;
// Available preconditioner descriptions
static const std::map<std::string, std::string>
_methods_descr;
// Operator row coordinates
std::vector<double> _coordinates;
// Geometric dimension associates with coordinates
std::size_t gdim;
};
}
#endif
#endif
|