/usr/include/dolfin/la/PETScBaseMatrix.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 | // Copyright (C) 2005-2006 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 Fredrik Valdmanis, 2011
//
// First added: 2005-01-17
// Last changed: 2011-09-07
#ifndef __PETSC_BASE_MATRIX_H
#define __PETSC_BASE_MATRIX_H
#ifdef HAS_PETSC
#include <cinttypes>
#include <cstddef>
#include <memory>
#include <string>
#include <utility>
#include <petscmat.h>
#include <dolfin/common/types.h>
#include <dolfin/common/Variable.h>
#include "PETScObject.h"
#include "PETScVector.h"
namespace dolfin
{
class GenericVector;
class PETScVector;
/// This class is a base class for matrices that can be used in
/// PETScKrylovSolver.
class PETScBaseMatrix : public PETScObject, public virtual Variable
{
public:
/// Constructor
PETScBaseMatrix() : _matA(nullptr) {}
/// Constructor
explicit PETScBaseMatrix(Mat A);
/// Copy constructor
PETScBaseMatrix(const PETScBaseMatrix& A);
/// Destructor
~PETScBaseMatrix();
/// Return number of rows (dim = 0) or columns (dim = 1)
std::size_t size(std::size_t dim) const;
/// Return number of rows and columns (num_rows, num_cols). PETSc
/// returns -1 if size has not been set.
std::pair<std::int64_t, std::int64_t> size() const;
/// Return local range along dimension dim
std::pair<std::int64_t, std::int64_t> local_range(std::size_t dim) const;
/// Initialize vector 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
void init_vector(GenericVector& z, std::size_t dim) const;
/// Return PETSc Mat pointer
Mat mat() const
{ return _matA; }
/// Return the MPI communicator
MPI_Comm mpi_comm() const;
/// Return informal string representation (pretty-print)
virtual std::string str(bool verbose) const = 0;
protected:
// PETSc Mat pointer
Mat _matA;
};
}
#endif
#endif
|