/usr/include/dolfin/la/PETScMatrix.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 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 | // Copyright (C) 2004-2012 Johan Hoffman, Johan Jansson and Anders Logg
//
// 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 Andy R. Terrel 2005
// Modified by Garth N. Wells 2006-2009
// Modified by Kent-Andre Mardal 2008
// Modified by Ola Skavhaug 2008
// Modified by Fredrik Valdmanis 2011
//
// First added: 2004-01-01
// Last changed: 2012-08-22
#ifndef __PETSC_MATRIX_H
#define __PETSC_MATRIX_H
#ifdef HAS_PETSC
#include <map>
#include <string>
#include <memory>
#include <petscmat.h>
#include <petscsys.h>
#include "GenericMatrix.h"
#include "PETScBaseMatrix.h"
namespace dolfin
{
class PETScVector;
class TensorLayout;
/// This class provides a simple matrix class based on PETSc.
/// It is a wrapper for a PETSc matrix pointer (Mat)
/// implementing the GenericMatrix interface.
///
/// The interface is intentionally simple. For advanced usage,
/// access the PETSc Mat pointer using the function mat() and
/// use the standard PETSc interface.
class PETScMatrix : public GenericMatrix, public PETScBaseMatrix
{
public:
/// Create empty matrix
PETScMatrix(bool use_gpu=false);
/// Create a wrapper around a PETSc Mat pointer
explicit PETScMatrix(Mat A);
/// Copy constructor
PETScMatrix(const PETScMatrix& A);
/// Destructor
virtual ~PETScMatrix();
//--- Implementation of the GenericTensor interface ---
/// Initialize zero tensor using tensor layout
void init(const TensorLayout& tensor_layout);
/// Return true if empty
bool empty() const;
/// Return size of given dimension
std::size_t size(std::size_t dim) const
{ return PETScBaseMatrix::size(dim); }
/// Return local ownership range
std::pair<std::size_t, std::size_t> local_range(std::size_t dim) const
{ return PETScBaseMatrix::local_range(dim); }
/// Set all entries to zero and keep any sparse structure
virtual void zero();
/// Finalize assembly of tensor. The following values are recognized
/// for the mode parameter:
///
/// add - corresponds to PETSc MatAssemblyBegin+End(MAT_FINAL_ASSEMBLY)
/// insert - corresponds to PETSc MatAssemblyBegin+End(MAT_FINAL_ASSEMBLY)
/// flush - corresponds to PETSc MatAssemblyBegin+End(MAT_FLUSH_ASSEMBLY)
virtual void apply(std::string mode);
/// Return MPI communicator
MPI_Comm mpi_comm() const;
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const;
//--- Implementation of the GenericMatrix interface --
/// Return copy of matrix
virtual std::shared_ptr<GenericMatrix> copy() const;
/// Intialize 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
{ PETScBaseMatrix::init_vector(z, dim); }
/// 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;
/// Set block of values
virtual void set(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols);
/// Add block of values
virtual void add(const double* block,
std::size_t m, const dolfin::la_index* rows,
std::size_t n, const dolfin::la_index* cols);
/// Add multiple of given matrix (AXPY operation)
virtual void axpy(double a, const GenericMatrix& A,
bool same_nonzero_pattern);
/// Get non-zero values of given row
virtual void getrow(std::size_t row,
std::vector<std::size_t>& columns,
std::vector<double>& values) const;
/// Set values for given row
virtual void setrow(std::size_t row,
const std::vector<std::size_t>& columns,
const std::vector<double>& values);
/// Set given rows to zero
virtual void zero(std::size_t m, const dolfin::la_index* rows);
/// Set given rows to identity matrix
virtual void ident(std::size_t m, const dolfin::la_index* rows);
// Matrix-vector product, y = Ax
virtual void mult(const GenericVector& x, GenericVector& y) const;
// Matrix-vector product, y = A^T x
virtual void transpmult(const GenericVector& x, GenericVector& y) const;
/// Set diagonal of a matrix
virtual void set_diagonal(const GenericVector& x);
/// Multiply matrix by given number
virtual const PETScMatrix& operator*= (double a);
/// Divide matrix by given number
virtual const PETScMatrix& operator/= (double a);
/// Assignment operator
virtual const GenericMatrix& operator= (const GenericMatrix& A);
/// Test if matrix is symmetric
virtual bool is_symmetric(double tol) const;
//--- Special functions ---
/// Return linear algebra backend factory
virtual GenericLinearAlgebraFactory& factory() const;
//--- Special PETScFunctions ---
/// Return norm of matrix
double norm(std::string norm_type) const;
/// Assignment operator
const PETScMatrix& operator= (const PETScMatrix& A);
/// Dump matrix to PETSc binary format
void binary_dump(std::string file_name) const;
private:
// PETSc norm types
static const std::map<std::string, NormType> norm_types;
// PETSc matrix architecture
const bool _use_gpu;
};
}
#endif
#endif
|