#include <EigenMatrix.h>

Inheritance diagram for dolfin::EigenMatrix:

[legend]

Collaboration diagram for dolfin::EigenMatrix:

[legend]

Public Types
typedef Eigen::SparseMatrix< double, Eigen::RowMajor, int >	eigen_matrix_type
	Eigen Matrix type.

Public Member Functions
	EigenMatrix ()
	Create empty matrix.

	EigenMatrix (std::size_t M, std::size_t N)
	Create M x N matrix.

	EigenMatrix (const EigenMatrix &A)
	Copy constructor.

virtual	~EigenMatrix ()
	Destructor.

virtual void	init (const TensorLayout &tensor_layout)
	Initialize zero tensor using tenor layout.

virtual bool	empty () const
	Return true if 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.

std::size_t	nnz () const
	Return number of non-zero entries in matrix.

virtual void	zero ()
	Set all entries to zero and keep any sparse structure.

virtual void	apply (std::string mode)
	Finalize assembly of tensor.

virtual 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< GenericMatrix >	copy () const
	Return copy of matrix.

virtual void	resize (std::size_t M, std::size_t N)
	Resize matrix to M x N.

virtual void	init_vector (GenericVector &z, 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_idx, 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 (global row indices) 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 to identity matrix.

virtual void	ident_local (std::size_t m, const dolfin::la_index *rows)
	Set given rows to identity matrix.

virtual void	mult (const GenericVector &x, GenericVector &y) const
	Matrix-vector product, y = Ax.

virtual void	transpmult (const GenericVector &x, GenericVector &y) const
	Matrix-vector product, y = A^T x.

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 EigenMatrix &	operator*= (double a)
	Multiply matrix by given number.

virtual const EigenMatrix &	operator/= (double a)
	Divide matrix by given number.

virtual const GenericMatrix &	operator= (const GenericMatrix &A)
	Assignment operator.

virtual std::tuple< const int , const int , const double *, std::size_t >	data () const

virtual GenericLinearAlgebraFactory &	factory () const
	Return linear algebra backend factory.

const eigen_matrix_type &	mat () const
	Return reference to Eigen matrix (const version)

eigen_matrix_type &	mat ()
	Return reference to Eigen matrix (non-const version)

void	compress ()
	Compress matrix (eliminate all zeros from a sparse matrix)

double	operator() (dolfin::la_index i, dolfin::la_index j) const
	Access value of given entry.

const EigenMatrix &	operator= (const EigenMatrix &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 GenericMatrix &	operator+= (const GenericMatrix &A)
	Add given matrix.

const GenericMatrix &	operator-= (const GenericMatrix &A)
	Subtract given matrix.

virtual bool	is_symmetric (double tol) const
	Test if matrix is symmetric.

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::LinearAlgebraObject
virtual const LinearAlgebraObject *	instance () const
	Return concrete instance / unwrap (const version)

virtual LinearAlgebraObject *	instance ()
	Return concrete instance / unwrap (non-const version)

virtual std::shared_ptr< const LinearAlgebraObject >	shared_instance () const
	Return concrete shared ptr instance / unwrap (const version)

virtual std::shared_ptr< LinearAlgebraObject >	shared_instance ()
	Return concrete shared ptr instance / unwrap (non-const version)

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 Variable &	operator= (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 a sparse matrix class based on Eigen. It is a simple wrapper for Eigen::SparseMatrix implementing the GenericMatrix interface.

The interface is intentionally simple. For advanced usage, access the underlying Eigen matrix and use the standard Eigen interface which is documented at http://eigen.tuxfamily.org

Member Function Documentation

◆ data()

std::tuple< const int *, const int *, const double *, std::size_t > EigenMatrix::data ( ) const

virtual

Return pointers to underlying compressed storage data See GenericMatrix for documentation.

◆ init_vector()

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

virtual

Initialise vector z to be compatible with the matrix-vector product y = Ax.

Parameters

z	(GenericVector&) Vector to initialise
dim	(std::size_t) The dimension (axis): dim = 0 –> z = y, dim = 1 –> z = x

Implements dolfin::GenericMatrix.

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

/home/fenics/shared/dolfin/dolfin/la/EigenMatrix.h
/home/fenics/shared/dolfin/dolfin/la/EigenMatrix.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ data()

◆ init_vector()