/usr/include/dolfin/la/TrilinosPreconditioner.h is in libdolfin-dev 1.4.0+dfsg-4.
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 | // 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/>.
//
#ifndef __DOLFIN_TRILINOS_PRECONDITIONER_H
#define __DOLFIN_TRILINOS_PRECONDITIONER_H
#ifdef HAS_TRILINOS
#include <string>
#include <vector>
#include <memory>
#include <Teuchos_ParameterList.hpp>
#include <Teuchos_RCP.hpp>
#include <dolfin/common/types.h>
#include <dolfin/common/Variable.h>
#include <dolfin/parameter/Parameters.h>
#include "GenericPreconditioner.h"
// Trilinos forward declarations
class Epetra_MultiVector;
class Epetra_RowMatrix;
class Epetra_Operator;
class Ifpack_Preconditioner;
namespace Belos
{
template<class ScalarType, class MV, class OP>
class LinearProblem;
}
namespace ML_Epetra
{
class MultiLevelPreconditioner;
}
namespace Teuchos
{
class ParameterList;
}
// some typdefs for Belos
typedef double BelosScalarType;
typedef Epetra_MultiVector BelosMultiVector;
typedef Epetra_Operator BelosOperator;
typedef Belos::LinearProblem<BelosScalarType, BelosMultiVector, BelosOperator>
BelosLinearProblem;
namespace dolfin
{
// Forward declarations
class EpetraKrylovSolver;
class EpetraMatrix;
class GenericVector;
class VectorSpaceBasis;
/// This class is a wrapper for configuring Epetra
/// preconditioners. It does not own a preconditioner. It can take a
/// EpetraKrylovSolver and set the preconditioner type and
/// parameters.
class TrilinosPreconditioner : public GenericPreconditioner, public Variable
{
public:
/// Create Krylov solver for a particular method and preconditioner
explicit TrilinosPreconditioner(std::string method="default");
/// Destructor
virtual ~TrilinosPreconditioner();
/// Set the precondtioner and matrix used in preconditioner
virtual void set(BelosLinearProblem& problem,
const EpetraMatrix& P
);
/// Set the Trilonos preconditioner parameters list
void set_parameters(std::shared_ptr<const Teuchos::ParameterList> list);
/// Set the Trilonos preconditioner parameters list (for use from
/// Python)
void set_parameters(Teuchos::RCP<Teuchos::ParameterList> list);
/// Set basis for the null space of the operator. Setting this is
/// critical to the performance of some preconditioners, e.g. ML.
/// The vectors spanning the null space are copied.
void set_nullspace(const VectorSpaceBasis& null_space);
/// Return preconditioner name
std::string name() const;
/// Return informal string representation (pretty-print)
std::string str(bool verbose) const;
/// Return a list of available preconditioners
static std::vector<std::pair<std::string, std::string> > preconditioners();
/// Default parameter values
static Parameters default_parameters();
private:
/// Setup the ML precondtioner
void set_ml(BelosLinearProblem& problem,
const Epetra_RowMatrix& P);
/// Named preconditioner
std::string _preconditioner;
// Available named preconditioners
static const std::map<std::string, int> _preconditioners;
// Available named preconditionersdescriptions
static const std::vector<std::pair<std::string, std::string> >
_preconditioners_descr;
// The Preconditioner
std::shared_ptr<Ifpack_Preconditioner> _ifpack_preconditioner;
std::shared_ptr<ML_Epetra::MultiLevelPreconditioner> _ml_preconditioner;
// Parameter list
std::shared_ptr<const Teuchos::ParameterList> parameter_list;
// Vectors spanning the null space
std::shared_ptr<Epetra_MultiVector> _nullspace;
// Teuchos::ParameterList pointer, used when initialized with a
// Teuchos::RCP shared_ptr
Teuchos::RCP<const Teuchos::ParameterList> parameter_ref_keeper;
};
}
#endif
#endif
|