DOLFIN
DOLFIN C++ interface
Public Member Functions | List of all members
dolfin::Matrix Class Reference

#include <Matrix.h>

Inheritance diagram for dolfin::Matrix:
Inheritance graph
[legend]
Collaboration diagram for dolfin::Matrix:
Collaboration graph
[legend]

Public Member Functions

 Matrix ()
 Create empty matrix.
 
 Matrix (MPI_Comm comm)
 Create empty matrix.
 
 Matrix (const Matrix &A)
 Copy constructor.
 
 Matrix (const GenericMatrix &A)
 Create a Vector from a GenericVector.
 
virtual ~Matrix ()
 Destructor.
 
virtual void init (const TensorLayout &tensor_layout)
 Initialize zero tensor using tensor layout.
 
virtual bool empty () const
 Return true if matrix is empty.
 
virtual std::size_t size (std::size_t dim) const
 Return size of given dimension.
 
virtual std::pair< std::int64_t, std::int64_t > local_range (std::size_t dim) const
 Return local ownership range.
 
virtual std::size_t nnz () const
 Return number of non-zero entries in matrix (collective)
 
virtual void zero ()
 Set all entries to zero and keep any sparse structure.
 
virtual void apply (std::string mode)
 Finalize assembly of tensor.
 
MPI_Comm mpi_comm () const
 Return MPI communicator.
 
virtual std::string str (bool verbose) const
 Return informal string representation (pretty-print)
 
virtual std::shared_ptr< GenericMatrixcopy () const
 Return copy of matrix.
 
virtual void init_vector (GenericVector &y, std::size_t dim) const
 
virtual 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.
 
virtual 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.
 
virtual 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.
 
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 block of values using global indices.
 
virtual 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.
 
virtual void axpy (double a, const GenericMatrix &A, bool same_nonzero_pattern)
 Add multiple of given matrix (AXPY operation)
 
virtual double norm (std::string norm_type) const
 Return norm of matrix.
 
virtual void getrow (std::size_t row, std::vector< std::size_t > &columns, std::vector< double > &values) const
 Get non-zero values of given row.
 
virtual void setrow (std::size_t row, const std::vector< std::size_t > &columns, const std::vector< double > &values)
 Set values for given row.
 
virtual void zero (std::size_t m, const dolfin::la_index *rows)
 Set given rows to zero.
 
virtual void zero_local (std::size_t m, const dolfin::la_index *rows)
 Set given rows (local row indices) to zero.
 
virtual void ident (std::size_t m, const dolfin::la_index *rows)
 Set given rows (global row indices) to identity matrix.
 
virtual void ident_local (std::size_t m, const dolfin::la_index *rows)
 Set given rows (local row indices) to identity matrix.
 
virtual void mult (const GenericVector &x, GenericVector &y) const
 Compute matrix-vector product y = Ax.
 
virtual void transpmult (const GenericVector &x, GenericVector &y) const
 
virtual void get_diagonal (GenericVector &x) const
 Get diagonal of a matrix.
 
virtual void set_diagonal (const GenericVector &x)
 Set diagonal of a matrix.
 
virtual const Matrixoperator*= (double a)
 Multiply matrix by given number.
 
virtual const Matrixoperator/= (double a)
 Divide matrix by given number.
 
virtual const GenericMatrixoperator= (const GenericMatrix &A)
 Assignment operator.
 
virtual bool is_symmetric (double tol) const
 Test if matrix is symmetric.
 
virtual GenericLinearAlgebraFactoryfactory () const
 Return linear algebra backend factory.
 
virtual const GenericMatrixinstance () const
 Return concrete instance / unwrap (const version)
 
virtual GenericMatrixinstance ()
 Return concrete instance / unwrap (non-const version)
 
virtual std::shared_ptr< const LinearAlgebraObjectshared_instance () const
 Return concrete shared ptr instance / unwrap (const version)
 
virtual std::shared_ptr< LinearAlgebraObjectshared_instance ()
 Return concrete shared ptr instance / unwrap (non-const version)
 
const Matrixoperator= (const Matrix &A)
 Assignment operator.
 
- Public Member Functions inherited from dolfin::GenericMatrix
virtual ~GenericMatrix ()
 Destructor.
 
virtual std::size_t rank () const
 Return tensor rank (number of dimensions)
 
virtual void get (double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows) const
 Get block of values.
 
virtual void set (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
 Set block of values using global indices.
 
virtual void set_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
 Set block of values using local indices.
 
virtual void add (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
 Add block of values using global indices.
 
virtual void add_local (const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
 Add block of values using local indices.
 
virtual void add (const double *block, const std::vector< ArrayView< const dolfin::la_index >> &rows)
 Add block of values using global indices.
 
virtual void add_local (const double *block, const std::vector< ArrayView< const dolfin::la_index >> &rows)
 Add block of values using local indices.
 
const GenericMatrixoperator+= (const GenericMatrix &A)
 Add given matrix.
 
const GenericMatrixoperator-= (const GenericMatrix &A)
 Subtract given matrix.
 
virtual double operator() (dolfin::la_index i, dolfin::la_index j) const
 Get value of given entry.
 
virtual double getitem (std::pair< dolfin::la_index, dolfin::la_index > ij) const
 Get value of given entry.
 
virtual void setitem (std::pair< dolfin::la_index, dolfin::la_index > ij, double value)
 
virtual void ident_zeros (double tol=DOLFIN_EPS)
 Insert one on the diagonal for all zero rows.
 
- Public Member Functions inherited from dolfin::GenericTensor
virtual ~GenericTensor ()
 Destructor.
 
- Public Member Functions inherited from dolfin::Variable
 Variable ()
 Create unnamed variable.
 
 Variable (const std::string name, const std::string label)
 Create variable with given name and label.
 
 Variable (const Variable &variable)
 Copy constructor.
 
virtual ~Variable ()
 Destructor.
 
const Variableoperator= (const Variable &variable)
 Assignment operator.
 
void rename (const std::string name, const std::string label)
 Rename variable.
 
std::string name () const
 Return name.
 
std::string label () const
 Return label (description)
 
std::size_t id () const
 

Additional Inherited Members

- Public Attributes inherited from dolfin::Variable
Parameters parameters
 Parameters.
 
- Protected Member Functions inherited from dolfin::GenericLinearOperator
virtual void init_layout (const GenericVector &x, const GenericVector &y, GenericLinearOperator *wrapper)
 

Detailed Description

This class provides the default DOLFIN matrix class, based on the default DOLFIN linear algebra backend.

Member Function Documentation

◆ init_vector()

virtual void dolfin::Matrix::init_vector ( GenericVector y,
std::size_t  dim 
) const
inlinevirtual

Resize vector y such that is it compatible with matrix for multiplication Ax = b (dim = 0 -> b, dim = 1 -> x) In parallel case, size and layout are important.

Implements dolfin::GenericMatrix.

◆ transpmult()

virtual void dolfin::Matrix::transpmult ( const GenericVector x,
GenericVector y 
) const
inlinevirtual

Matrix-vector product, y = A^T x. The y vector must either be zero-sized or have correct size and parallel layout.

Implements dolfin::GenericMatrix.


The documentation for this class was generated from the following file: