/usr/include/dolfin/la/PETScMatrix.h is in libdolfin1.0-dev 1.0.0-1.
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 | // Copyright (C) 2004-2009 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.
//
// First added: 2004-01-01
// Last changed: 2009-12-14
#ifndef __PETSC_MATRIX_H
#define __PETSC_MATRIX_H
#ifdef HAS_PETSC
#include <map>
#include <string>
#include <boost/shared_ptr.hpp>
#include <petscmat.h>
#include "GenericMatrix.h"
#include "PETScBaseMatrix.h"
namespace dolfin
{
class PETScVector;
/// 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();
/// Copy constructor
PETScMatrix(const PETScMatrix& A);
/// Create matrix from given PETSc Mat pointer
explicit PETScMatrix(boost::shared_ptr<Mat> A);
/// Destructor
virtual ~PETScMatrix();
//--- Implementation of the GenericTensor interface ---
/// Return true if matrix is distributed
bool distributed() const;
/// Initialize zero tensor using sparsity pattern
virtual void init(const GenericSparsityPattern& sparsity_pattern);
/// Return copy of tensor
virtual PETScMatrix* copy() const;
/// Return size of given dimension
uint size(uint dim) const { return PETScBaseMatrix::size(dim); }
/// Return local ownership range
std::pair<uint, uint> local_range(uint 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 - corresponding to PETSc MatAssemblyBegin+End(MAT_FINAL_ASSEMBLY)
/// insert - corresponding to PETSc MatAssemblyBegin+End(MAT_FINAL_ASSEMBLY)
/// flush - corresponding to PETSc MatAssemblyBegin+End(MAT_FLUSH_ASSEMBLY)
virtual void apply(std::string mode);
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const;
//--- Implementation of the GenericMatrix interface --
/// Resize matrix to M x N
virtual void resize(uint M, uint N);
/// Resize vector y such that is it compatible with matrix for
/// multuplication Ax = b (dim = 0 -> b, dim = 1 -> x) In parallel
/// case, size and layout are important.
void resize(GenericVector& y, uint dim) const
{ PETScBaseMatrix::resize(y, dim); }
/// Get block of values
virtual void get(double* block, uint m, const uint* rows, uint n, const uint* cols) const;
/// Set block of values
virtual void set(const double* block, uint m, const uint* rows, uint n, const uint* cols);
/// Add block of values
virtual void add(const double* block, uint m, const uint* rows, uint n, const uint* 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(uint row, std::vector<uint>& columns, std::vector<double>& values) const;
/// Set values for given row
virtual void setrow(uint row, const std::vector<uint>& columns, const std::vector<double>& values);
/// Set given rows to zero
virtual void zero(uint m, const uint* rows);
/// Set given rows to identity matrix
virtual void ident(uint m, const uint* 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;
/// 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);
//--- Special functions ---
/// Return linear algebra backend factory
virtual LinearAlgebraFactory& 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;
};
}
#endif
#endif
|