/usr/include/dolfin/la/GenericMatrix.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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | // Copyright (C) 2006-2011 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 Johan Jansson 2006
// Modified by Anders Logg 2006-2012
// Modified by Ola Skavhaug 2007-2008
// Modified by Kent-Andre Mardal 2008
// Modified by Martin Alnæs 2008
// Modified by Mikael Mortensen 2011
//
// First added: 2006-04-24
// Last changed: 2012-08-20
#ifndef __GENERIC_MATRIX_H
#define __GENERIC_MATRIX_H
#include <tuple>
#include <vector>
#include "GenericTensor.h"
#include "GenericLinearOperator.h"
namespace dolfin
{
class GenericVector;
class TensorLayout;
/// This class defines a common interface for matrices.
class GenericMatrix : public GenericTensor, public GenericLinearOperator
{
public:
/// Destructor
virtual ~GenericMatrix() {}
//--- Implementation of the GenericTensor interface ---
/// Return tensor rank (number of dimensions)
virtual std::size_t rank() const
{ return 2; }
/// Return size of given dimension
virtual std::size_t size(std::size_t dim) const = 0;
/// Return local ownership range
virtual std::pair<std::int64_t, std::int64_t>
local_range(std::size_t dim) const = 0;
/// Return number of non-zero entries in matrix (collective)
virtual std::size_t nnz() const = 0;
/// Get block of values
virtual void get(double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows) const
{ get(block, num_rows[0], rows[0], num_rows[1], rows[1]); }
/// Set block of values using global indices
virtual void set(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{ set(block, num_rows[0], rows[0], num_rows[1], rows[1]); }
/// Set block of values using local indices
virtual void set_local(const double* block,
const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{ set_local(block, num_rows[0], rows[0], num_rows[1], rows[1]); }
/// Add block of values using global indices
virtual void add(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{ add(block, num_rows[0], rows[0], num_rows[1], rows[1]); }
/// Add block of values using local indices
virtual void add_local(const double* block,
const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{ add_local(block, num_rows[0], rows[0], num_rows[1], rows[1]); }
/// Add block of values using global indices
virtual void
add(const double* block,
const std::vector<ArrayView<const dolfin::la_index>>& rows)
{
add(block, rows[0].size(), rows[0].data(),
rows[1].size(), rows[1].data());
}
/// Add block of values using local indices
virtual void
add_local(const double* block,
const std::vector<ArrayView<const dolfin::la_index>>& rows)
{
add_local(block, rows[0].size(), rows[0].data(),
rows[1].size(), rows[1].data());
}
/// Set all entries to zero and keep any sparse structure
virtual void zero() = 0;
/// Finalize assembly of tensor
virtual void apply(std::string mode) = 0;
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const = 0;
//--- Matrix interface ---
/// Return copy of matrix
virtual std::shared_ptr<GenericMatrix> copy() const = 0;
/// Initialize vector z to be compatible with the matrix-vector
/// product y = Ax. In the parallel case, both size and layout are
/// important.
///
/// *Arguments*
/// dim (std::size_t)
/// The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
virtual void init_vector(GenericVector& z, std::size_t dim) const = 0;
/// Get block of values
virtual void get(double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols) const = 0;
/// Set block of values using global indices
virtual void set(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols) = 0;
/// Set block of values using local indices
virtual void set_local(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols) = 0;
/// Add block of values using global indices
virtual void add(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols) = 0;
/// Add block of values using local indices
virtual void add_local(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols) = 0;
/// Add multiple of given matrix (AXPY operation)
virtual void axpy(double a, const GenericMatrix& A,
bool same_nonzero_pattern) = 0;
/// Return norm of matrix
virtual double norm(std::string norm_type) const = 0;
/// Get non-zero values of given row (global index) on local process
virtual void getrow(std::size_t row, std::vector<std::size_t>& columns,
std::vector<double>& values) const = 0;
/// Set values for given row (global index) on local process
virtual void setrow(std::size_t row,
const std::vector<std::size_t>& columns,
const std::vector<double>& values) = 0;
/// Set given rows (global row indices) to zero
virtual void zero(std::size_t m, const dolfin::la_index* rows) = 0;
/// Set given rows (local row indices) to zero
virtual void zero_local(std::size_t m, const dolfin::la_index* rows) = 0;
/// Set given rows (global row indices) to identity matrix
virtual void ident(std::size_t m, const dolfin::la_index* rows) = 0;
/// Set given rows (local row indices) to identity matrix
virtual void ident_local(std::size_t m, const dolfin::la_index* rows) = 0;
/// Matrix-vector product, y = A^T x. The y vector must either be
/// zero-sized or have correct size and parallel layout.
virtual void transpmult(const GenericVector& x, GenericVector& y) const = 0;
/// Get diagonal of a matrix
virtual void get_diagonal(GenericVector& x) const = 0;
/// Set diagonal of a matrix
virtual void set_diagonal(const GenericVector& x) = 0;
/// Multiply matrix by given number
virtual const GenericMatrix& operator*= (double a) = 0;
/// Divide matrix by given number
virtual const GenericMatrix& operator/= (double a) = 0;
/// Add given matrix
const GenericMatrix& operator+= (const GenericMatrix& A)
{
axpy(1.0, A, false);
return *this;
}
/// Subtract given matrix
const GenericMatrix& operator-= (const GenericMatrix& A)
{
axpy(-1.0, A, false);
return *this;
}
/// Test if matrix is symmetric
virtual bool is_symmetric(double tol) const
{
dolfin_error("GenericMatrix.h",
"test if matrix is symmetric",
"Not implemented by current linear algebra backend");
return false;
}
/// Assignment operator
virtual const GenericMatrix& operator= (const GenericMatrix& x) = 0;
//--- Convenience functions ---
/// Get value of given entry
virtual double operator() (dolfin::la_index i, dolfin::la_index j) const
{ double value(0); get(&value, 1, &i, 1, &j); return value; }
/// Get value of given entry
virtual double getitem(std::pair<dolfin::la_index,
dolfin::la_index> ij) const
{
double value(0);
get(&value, 1, &ij.first, 1, &ij.second);
return value;
}
/// Set given entry to value. apply("insert") must be called
/// before using using the object.
virtual void setitem(std::pair<dolfin::la_index, dolfin::la_index> ij,
double value)
{ set(&value, 1, &ij.first, 1, &ij.second); }
/// Insert one on the diagonal for all zero rows
virtual void ident_zeros();
};
}
#endif
|