EpetraMatrix.h

Note

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

class EpetraMatrix

Parent class(es)

This class provides a simple matrix class based on Epetra. It is a simple wrapper for an Epetra matrix object (Epetra_FECrsMatrix) implementing the GenericMatrix interface.

The interface is intentionally simple. For advanced usage, access the Epetra_FECrsMatrix object using the function mat() and use the standard Epetra interface.

EpetraMatrix()

Create empty matrix

EpetraMatrix(const EpetraMatrix &A)

Copy constuctor

explicit EpetraMatrix(Teuchos::RCP<Epetra_FECrsMatrix> A)

Create matrix from given Epetra_FECrsMatrix pointer

explicit EpetraMatrix(boost::shared_ptr<Epetra_FECrsMatrix> A)

Create matrix from given Epetra_FECrsMatrix pointer

explicit EpetraMatrix(const Epetra_CrsGraph &graph)

Create matrix from given Epetra_CrsGraph

void init(const TensorLayout &tensor_layout)

Initialize zero tensor using tensor layout

std::size_t size(std::size_t dim) const

Return size of given dimension

std::pair<std::size_t, std::size_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 following values are recognized for the mode parameter:

add - corresponding to Epetra GlobalAssemble(Add) insert - corresponding to Epetra GlobalAssemble(Insert)
std::string str(bool verbose) const

Return informal string representation (pretty-print)

boost::shared_ptr<GenericMatrix> copy() const

Return copy of matrix

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

Resize 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

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

void axpy(double a, const GenericMatrix &A, bool same_nonzero_pattern)

Add multiple of given matrix (AXPY operation)

double norm(std::string norm_type) const

Return norm of matrix

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 to zero

void ident(std::size_t m, const dolfin::la_index *rows)

Set given rows to identity matrix

const EpetraMatrix &operator*=(double a)

Multiply matrix by given number

const EpetraMatrix &operator/=(double a)

Divide matrix by given number

const GenericMatrix &operator=(const GenericMatrix &x)

Assignment operator

GenericLinearAlgebraFactory &factory() const

Return linear algebra backend factory

boost::shared_ptr<Epetra_FECrsMatrix> mat() const

Return Epetra_FECrsMatrix pointer

const EpetraMatrix &operator=(const EpetraMatrix &x)

Assignment operator