/usr/include/dolfin/la/GenericLinearAlgebraFactory.h is in libdolfin-dev 2017.2.0.post0-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 | // Copyright (C) 2007 Ola Skavhaug
//
// 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-2012
//
// First added: 2007-11-30
// Last changed: 2012-08-22
#ifndef __GENERIC_LINEAR_ALGEBRA_FACTORY_H
#define __GENERIC_LINEAR_ALGEBRA_FACTORY_H
#include <string>
#include <vector>
#include <memory>
#include <dolfin/common/MPI.h>
#include <dolfin/common/types.h>
#include <dolfin/log/log.h>
// Included here so we can define dummy class below
#include "GenericLinearOperator.h"
namespace dolfin
{
class GenericLinearSolver;
class GenericMatrix;
class GenericVector;
class TensorLayout;
/// Base class for LinearAlgebra factories
class GenericLinearAlgebraFactory
{
public:
/// Constructor
GenericLinearAlgebraFactory() {}
/// Destructor
virtual ~GenericLinearAlgebraFactory() {}
/// Create empty matrix
virtual std::shared_ptr<GenericMatrix> create_matrix(MPI_Comm comm) const = 0;
/// Create empty vector
virtual std::shared_ptr<GenericVector>
create_vector(MPI_Comm comm) const = 0;
/// Create empty tensor layout
virtual std::shared_ptr<TensorLayout>
create_layout(MPI_Comm comm, std::size_t rank) const = 0;
/// Create empty linear operator
virtual std::shared_ptr<GenericLinearOperator>
create_linear_operator(MPI_Comm comm) const = 0;
/// Create LU solver
virtual std::shared_ptr<GenericLinearSolver>
create_lu_solver(MPI_Comm comm, std::string method) const = 0;
/// Create Krylov solver
virtual std::shared_ptr<GenericLinearSolver>
create_krylov_solver(MPI_Comm comm,
std::string method,
std::string preconditioner) const = 0;
/// Return a list of available LU solver methods. This function
/// should be overloaded by subclass if non-empty.
virtual std::map<std::string, std::string> lu_solver_methods() const
{ return std::map<std::string, std::string>(); }
/// Return a list of available Krylov solver methods. This
/// function should be overloaded by subclass if non-empty.
virtual std::map<std::string, std::string> krylov_solver_methods() const
{ return std::map<std::string, std::string>(); }
/// Return a list of available preconditioners.
/// This function should be overloaded by subclass if non-empty.
virtual std::map<std::string, std::string>
krylov_solver_preconditioners() const
{ return std::map<std::string, std::string>(); }
protected:
// Dummy class that can be returned for linear algebra backends
// that do not support the GenericLinearOperator interface
class NotImplementedLinearOperator : public GenericLinearOperator
{
public:
std::size_t size(std::size_t dim) const
{ return 0; }
void mult(const GenericVector& x, GenericVector& y) const
{ dolfin_not_implemented(); }
MPI_Comm mpi_comm() const
{ dolfin_not_implemented(); return MPI_COMM_WORLD; }
std::string str(bool verbose) const
{ dolfin_not_implemented(); return ""; }
};
};
}
#endif
|