TpetraMatrix.h¶

Note

The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.

class TpetraMatrix¶

Parent class(es)

GenericMatrix

This class provides a simple matrix class based on Tpetra. It is a wrapper for a Tpetra matrix pointer (Teuchos::RCP<matrix_type>) implementing the GenericMatrix interface.

The interface is intentionally simple. For advanced usage, access the Tpetra::RCP<matrix_type> pointer using the function mat() and use the standard Tpetra interface.

TpetraMatrix()¶: Create empty matrix

explicit TpetraMatrix(Teuchos::RCP<matrix_type> A)¶: Create a wrapper around a Teuchos::RCP<matrix_type> pointer

TpetraMatrix(const TpetraMatrix &A)¶: Copy constructor

void init(const TensorLayout &tensor_layout)¶: Initialize zero tensor using tensor layout

bool empty() const¶: Return true if empty

std::size_t size(std::size_t dim) const¶: Return size of given dimension

std::pair<std::int64_t, std::int64_t> local_range(std::size_t dim) const¶: Return local ownership range

void zero()¶: Set all entries to zero and keep any sparse structure

void apply(std::string mode)¶: Finalize assembly of tensor. The mode parameter is ignored.

MPI_Comm mpi_comm() const¶: Return MPI communicator

std::string str(bool verbose) const¶: Return informal string representation (pretty-print)

std::shared_ptr<GenericMatrix> copy() const¶: Return copy of matrix

void init_vector(GenericVector &z, std::size_t dim) const¶

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

void get(double *block, std::size_t m, const dolfin::la_index *rows, std::size_t n, const dolfin::la_index *cols) const¶: Get block of values

void set(const double *block, std::size_t m, const dolfin::la_index *rows, std::size_t n, const dolfin::la_index *cols)¶: Set block of values using global indices

void set_local(const double *block, std::size_t m, const dolfin::la_index *rows, std::size_t n, const dolfin::la_index *cols)¶: Set block of values using local indices

void add(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 using global indices

void add_local(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 using local indices

void axpy(double a, const GenericMatrix &A, bool same_nonzero_pattern)¶: Add multiple of given matrix (AXPY operation)

void getrow(std::size_t row, std::vector<std::size_t> &columns, std::vector<double> &values) const¶: Get non-zero values of given row

void setrow(std::size_t row, const std::vector<std::size_t> &columns, const std::vector<double> &values)¶: Set values for given row

void zero(std::size_t m, const dolfin::la_index *rows)¶: Set given rows (global row indices) to zero

void zero_local(std::size_t m, const dolfin::la_index *rows)¶: Set given rows (local row indices) to zero

void ident(std::size_t m, const dolfin::la_index *rows)¶: Set given rows (global row indices) to identity matrix

void ident_local(std::size_t m, const dolfin::la_index *rows)¶: Set given rows (local row indices) to identity matrix

void get_diagonal(GenericVector &x) const¶: Get diagonal of a matrix

void set_diagonal(const GenericVector &x)¶: Set diagonal of a matrix

const TpetraMatrix &operator*=(double a)¶: Multiply matrix by given number

const TpetraMatrix &operator/=(double a)¶: Divide matrix by given number

const GenericMatrix &operator=(const GenericMatrix &A)¶: Assignment operator

bool is_symmetric(double tol) const¶: Test if matrix is symmetric

GenericLinearAlgebraFactory &factory() const¶: Return linear algebra backend factory

double norm(std::string norm_type) const¶: Return norm of matrix

const TpetraMatrix &operator=(const TpetraMatrix &A)¶: Assignment operator