#include <eigen_sparse_matrix.h>

Inheritance diagram for libMesh::EigenSparseMatrix< T >:

[legend]

Public Types
typedef EigenSM	DataType

typedef Eigen::Triplet< T, eigen_idx_type >	TripletType

Public Member Functions
	EigenSparseMatrix (const Parallel::Communicator &comm)

	EigenSparseMatrix (EigenSparseMatrix &&)=default

	EigenSparseMatrix (const EigenSparseMatrix &)=default

EigenSparseMatrix &	operator= (const EigenSparseMatrix &)=default

EigenSparseMatrix &	operator= (EigenSparseMatrix &&)=default

virtual	~EigenSparseMatrix ()=default

virtual void	init (const numeric_index_type m, const numeric_index_type n, const numeric_index_type m_l, const numeric_index_type n_l, const numeric_index_type nnz=30, const numeric_index_type noz=10, const numeric_index_type blocksize=1) override

virtual void	init () override

virtual void	clear () override

virtual void	zero () override

virtual void	close () override

virtual numeric_index_type	m () const override

virtual numeric_index_type	n () const override

virtual numeric_index_type	row_start () const override

virtual numeric_index_type	row_stop () const override

virtual void	set (const numeric_index_type i, const numeric_index_type j, const T value) override

virtual void	add (const numeric_index_type i, const numeric_index_type j, const T value) override

virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) override

virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices) override

virtual void	add (const T a, const SparseMatrix< T > &X) override

virtual T	operator() (const numeric_index_type i, const numeric_index_type j) const override

virtual Real	l1_norm () const override

virtual Real	linfty_norm () const override

virtual bool	closed () const override

virtual void	print_personal (std::ostream &os=libMesh::out) const override

virtual void	get_diagonal (NumericVector< T > &dest) const override

virtual void	get_transpose (SparseMatrix< T > &dest) const override

virtual bool	initialized () const

void	attach_dof_map (const DofMap &dof_map)

virtual bool	need_full_sparsity_pattern () const

virtual void	update_sparsity_pattern (const SparsityPattern::Graph &)

virtual void	zero_rows (std::vector< numeric_index_type > &rows, T diag_value=0.0)

virtual void	flush ()

virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)

virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices)

void	print (std::ostream &os=libMesh::out, const bool sparse=false) const

template<>
void	print (std::ostream &os, const bool sparse) const

virtual void	print_matlab (const std::string &="") const

virtual void	create_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const

virtual void	reinit_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const

void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const

void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static std::unique_ptr< SparseMatrix< T > >	build (const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())

static std::string	get_info ()

static void	print_info (std::ostream &out=libMesh::out)

static unsigned int	n_objects ()

static void	enable_print_counter_info ()

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts

Protected Member Functions
virtual void	_get_submatrix (SparseMatrix< T > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &, const bool) const

void	increment_constructor_count (const std::string &name)

void	increment_destructor_count (const std::string &name)

Protected Attributes
DofMap const *	_dof_map

bool	_is_initialized

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts

static Threads::atomic< unsigned int >	_n_objects

static Threads::spin_mutex	_mutex

static bool	_enable_print_counter = true

Private Attributes
DataType	_mat

bool	_closed

Friends
class	EigenSparseVector< T >

class	EigenSparseLinearSolver< T >

Detailed Description

template<typename T>
class libMesh::EigenSparseMatrix< T >

The EigenSparseMatrix class wraps a sparse matrix object from the Eigen library. All overridden virtual functions are documented in sparse_matrix.h.

Author: Benjamin S. Kirk

Date: 2013

Definition at line 54 of file eigen_sparse_matrix.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information. The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ DataType

template<typename T>

typedef EigenSM libMesh::EigenSparseMatrix< T >::DataType

Convenient typedefs

Definition at line 83 of file eigen_sparse_matrix.h.

◆ TripletType

template<typename T>

typedef Eigen::Triplet<T,eigen_idx_type> libMesh::EigenSparseMatrix< T >::TripletType

Definition at line 84 of file eigen_sparse_matrix.h.

Constructor & Destructor Documentation

◆ EigenSparseMatrix() [1/3]

template<typename T >

libMesh::EigenSparseMatrix< T >::EigenSparseMatrix ( const Parallel::Communicator & comm )

Constructor; initializes the matrix to be empty, without any structure, i.e. the matrix is not usable at all. This constructor is therefore only useful for matrices which are members of a class. All other matrices should be created at a point in the data flow where all necessary information is available.

You have to initialize the matrix before usage with init(...).

Definition at line 161 of file eigen_sparse_matrix.C.

                                                                              :
   SparseMatrix<T>(comm_in),
   _closed (false)
 {
 }

◆ EigenSparseMatrix() [2/3]

template<typename T>

libMesh::EigenSparseMatrix< T >::EigenSparseMatrix ( EigenSparseMatrix< T > && )

default

The 5 special functions can be defaulted for this class, as it does not manage any memory itself.

◆ EigenSparseMatrix() [3/3]

template<typename T>

libMesh::EigenSparseMatrix< T >::EigenSparseMatrix ( const EigenSparseMatrix< T > & )

default

◆ ~EigenSparseMatrix()

template<typename T>

virtual libMesh::EigenSparseMatrix< T >::~EigenSparseMatrix ( )

virtualdefault

Member Function Documentation

◆ _get_submatrix()

template<typename T>

virtual void libMesh::SparseMatrix< T >::_get_submatrix	(	SparseMatrix< T > &	,
		const std::vector< numeric_index_type > &	,
		const std::vector< numeric_index_type > &	,
		const bool
	)		const

inlineprotectedvirtualinherited

Protected implementation of the create_submatrix and reinit_submatrix routines.

Note: This function must be overridden in derived classes for it to work properly!

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 414 of file sparse_matrix.h.

Referenced by libMesh::SparseMatrix< ValOut >::create_submatrix(), and libMesh::SparseMatrix< ValOut >::reinit_submatrix().

   {
     libmesh_not_implemented();
   }

◆ add() [1/2]

template<typename T >

void libMesh::EigenSparseMatrix< T >::add	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const T	value
	)

overridevirtual

Add value to the element (i,j). Throws an error if the entry does not exist. Zero values can be "added" to non-existent entries.

Implements libMesh::SparseMatrix< T >.

Definition at line 239 of file eigen_sparse_matrix.C.

References libMesh::initialized(), and value.

 {
   libmesh_assert (this->initialized());
   libmesh_assert_less (i, this->m());
   libmesh_assert_less (j, this->n());
 
   _mat.coeffRef(i,j) += value;
 }

◆ add() [2/2]

template<typename T >

void libMesh::EigenSparseMatrix< T >::add	(	const T	a,
		const SparseMatrix< T > &	X
	)

overridevirtual

Compute $A \leftarrow A + a*X$ for scalar a, matrix X.

Implements libMesh::SparseMatrix< T >.

Definition at line 262 of file eigen_sparse_matrix.C.

References libMesh::EigenSparseMatrix< T >::_mat, libMesh::initialized(), libMesh::SparseMatrix< T >::m(), and libMesh::SparseMatrix< T >::n().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (this->m(), X_in.m());
   libmesh_assert_equal_to (this->n(), X_in.n());
 
   const EigenSparseMatrix<T> & X =
     cast_ref<const EigenSparseMatrix<T> &> (X_in);
 
   _mat += X._mat*a_in;
 }

◆ add_block_matrix() [1/2]

template<typename T>

void libMesh::SparseMatrix< T >::add_block_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	brows,
		const std::vector< numeric_index_type > &	bcols
	)

virtualinherited

Add the full matrix dm to the SparseMatrix. This is useful for adding an element matrix at assembly time. The matrix is assumed blocked, and brow, bcol correspond to the block row and column indices.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 56 of file sparse_matrix.C.

Referenced by libMesh::SparseMatrix< ValOut >::add_block_matrix().

 {
   libmesh_assert_equal_to (dm.m() / brows.size(), dm.n() / bcols.size());
 
   const numeric_index_type blocksize = cast_int<numeric_index_type>
     (dm.m() / brows.size());
 
   libmesh_assert_equal_to (dm.m()%blocksize, 0);
   libmesh_assert_equal_to (dm.n()%blocksize, 0);
 
   std::vector<numeric_index_type> rows, cols;
 
   rows.reserve(blocksize*brows.size());
   cols.reserve(blocksize*bcols.size());
 
   for (std::size_t ib=0; ib<brows.size(); ib++)
     {
       numeric_index_type i=brows[ib]*blocksize;
 
       for (unsigned int v=0; v<blocksize; v++)
         rows.push_back(i++);
     }
 
   for (std::size_t jb=0; jb<bcols.size(); jb++)
     {
       numeric_index_type j=bcols[jb]*blocksize;
 
       for (unsigned int v=0; v<blocksize; v++)
         cols.push_back(j++);
     }
 
   this->add_matrix (dm, rows, cols);
 }

◆ add_block_matrix() [2/2]

template<typename T>

virtual void libMesh::SparseMatrix< T >::add_block_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

inlinevirtualinherited

Same as add_block_matrix(), but assumes the row and column maps are the same. Thus the matrix dm must be square.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 253 of file sparse_matrix.h.

255 { this->add_block_matrix (dm, dof_indices, dof_indices); }

libMesh::SparseMatrix::add_block_matrix

virtual void add_block_matrix(const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)

Definition: sparse_matrix.C:56

◆ add_matrix() [1/2]

template<typename T >

void libMesh::EigenSparseMatrix< T >::add_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)

overridevirtual

Add the full matrix dm to the SparseMatrix. This is useful for adding an element matrix at assembly time.

Implements libMesh::SparseMatrix< T >.

Definition at line 121 of file eigen_sparse_matrix.C.

References libMesh::initialized(), libMesh::DenseMatrixBase< T >::m(), and libMesh::DenseMatrixBase< T >::n().

 {
   libmesh_assert (this->initialized());
   unsigned int n_rows = cast_int<unsigned int>(rows.size());
   unsigned int n_cols = cast_int<unsigned int>(cols.size());
   libmesh_assert_equal_to (dm.m(), n_rows);
   libmesh_assert_equal_to (dm.n(), n_cols);
 
 
   for (unsigned int i=0; i<n_rows; i++)
     for (unsigned int j=0; j<n_cols; j++)
       this->add(rows[i],cols[j],dm(i,j));
 }

◆ add_matrix() [2/2]

template<typename T >

void libMesh::EigenSparseMatrix< T >::add_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

overridevirtual

Same as add_matrix, but assumes the row and column maps are the same. Thus the matrix dm must be square.

Implements libMesh::SparseMatrix< T >.

Definition at line 253 of file eigen_sparse_matrix.C.

 {
   this->add_matrix (dm, dof_indices, dof_indices);
 }

◆ attach_dof_map()

template<typename T>

void libMesh::SparseMatrix< T >::attach_dof_map ( const DofMap & dof_map )

inlineinherited

Get a pointer to the DofMap to use.

Definition at line 109 of file sparse_matrix.h.

Referenced by libMesh::__libmesh_tao_hessian(), and libMesh::DofMap::attach_matrix().

110 { _dof_map = &dof_map; }

libMesh::SparseMatrix::_dof_map

DofMap const * _dof_map

Definition: sparse_matrix.h:425

◆ build()

template<typename T >

std::unique_ptr< SparseMatrix< T > > libMesh::SparseMatrix< T >::build	(	const Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a SparseMatrix<T> using the linear solver package specified by solver_package

Definition at line 130 of file sparse_matrix.C.

Referenced by libMesh::ImplicitSystem::add_matrix(), libMesh::EigenSystem::init_data(), and libMesh::EigenSystem::init_matrices().

 {
   // Avoid unused parameter warnings when no solver packages are enabled.
   libmesh_ignore(comm);
 
   // Build the appropriate vector
   switch (solver_package)
     {
 
 #ifdef LIBMESH_HAVE_LASPACK
     case LASPACK_SOLVERS:
       return libmesh_make_unique<LaspackMatrix<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_HAVE_PETSC
     case PETSC_SOLVERS:
       return libmesh_make_unique<PetscMatrix<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_TRILINOS_HAVE_EPETRA
     case TRILINOS_SOLVERS:
       return libmesh_make_unique<EpetraMatrix<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_HAVE_EIGEN
     case EIGEN_SOLVERS:
       return libmesh_make_unique<EigenSparseMatrix<T>>(comm);
 #endif
 
     default:
       libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
     }
 }

◆ clear()

template<typename T >

void libMesh::EigenSparseMatrix< T >::clear ( )

overridevirtual

Restores the SparseMatrix<T> to a pristine state.

Implements libMesh::SparseMatrix< T >.

Definition at line 170 of file eigen_sparse_matrix.C.

References libMesh::libMeshPrivateData::_is_initialized.

 {
   _mat.resize(0,0);
 
   _closed = false;
   this->_is_initialized = false;
 }

◆ close()

template<typename T>

virtual void libMesh::EigenSparseMatrix< T >::close ( )

inlineoverridevirtual

Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across processors.

Implements libMesh::SparseMatrix< T >.

Definition at line 100 of file eigen_sparse_matrix.h.

References libMesh::EigenSparseMatrix< T >::_closed.

Referenced by libMesh::EigenSparseLinearSolver< T >::solve().

100 { this->_closed = true; }

libMesh::EigenSparseMatrix::_closed

bool _closed

Definition: eigen_sparse_matrix.h:152

◆ closed()

template<typename T>

virtual bool libMesh::EigenSparseMatrix< T >::closed ( ) const

inlineoverridevirtual

Returns: true if the matrix has been assembled.

Implements libMesh::SparseMatrix< T >.

Definition at line 134 of file eigen_sparse_matrix.h.

References libMesh::EigenSparseMatrix< T >::_closed.

134 { return _closed; }

libMesh::EigenSparseMatrix::_closed

bool _closed

Definition: eigen_sparse_matrix.h:152

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ create_submatrix()

template<typename T>

virtual void libMesh::SparseMatrix< T >::create_submatrix	(	SparseMatrix< T > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function creates a matrix called "submatrix" which is defined by the row and column indices given in the "rows" and "cols" entries. Currently this operation is only defined for the PetscMatrix type.

Definition at line 354 of file sparse_matrix.h.

   {
     this->_get_submatrix(submatrix,
                          rows,
                          cols,
                          false); // false means DO NOT REUSE submatrix
   }

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::LibMeshInit().

 {
   _enable_print_counter = false;
   return;
 }

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ flush()

template<typename T>

virtual void libMesh::SparseMatrix< T >::flush ( )

inlinevirtualinherited

For PETSc matrix , this function is similar to close but without shrinking memory. This is useful when we want to switch between ADD_VALUES and INSERT_VALUES. close should be called before using the matrix.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 182 of file sparse_matrix.h.

182 { close(); }

libMesh::SparseMatrix::close

virtual void close()=0

◆ get_diagonal()

template<typename T >

void libMesh::EigenSparseMatrix< T >::get_diagonal ( NumericVector< T > & dest ) const

overridevirtual

Copies the diagonal part of the matrix into dest.

Implements libMesh::SparseMatrix< T >.

Definition at line 141 of file eigen_sparse_matrix.C.

References libMesh::EigenSparseVector< T >::_vec.

 {
   EigenSparseVector<T> & dest = cast_ref<EigenSparseVector<T> &>(dest_in);
 
   dest._vec = _mat.diagonal();
 }

◆ get_info()

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

Referenced by libMesh::ReferenceCounter::print_info().

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
 
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_transpose()

template<typename T >

void libMesh::EigenSparseMatrix< T >::get_transpose ( SparseMatrix< T > & dest ) const

overridevirtual

Copies the transpose of the matrix into dest, which may be *this.

Implements libMesh::SparseMatrix< T >.

Definition at line 151 of file eigen_sparse_matrix.C.

References libMesh::EigenSparseMatrix< T >::_mat.

 {
   EigenSparseMatrix<T> & dest = cast_ref<EigenSparseMatrix<T> &>(dest_in);
 
   dest._mat = _mat.transpose();
 }

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectedinherited

Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectedinherited

Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ init() [1/2]

template<typename T>

virtual void libMesh::EigenSparseMatrix< T >::init	(	const numeric_index_type	m,
		const numeric_index_type	n,
		const numeric_index_type	m_l,
		const numeric_index_type	n_l,
		const numeric_index_type	nnz = `30`,
		const numeric_index_type	noz = `10`,
		const numeric_index_type	blocksize = `1`
	)

overridevirtual

Initialize SparseMatrix with the specified sizes.

Parameters

m	The global number of rows.
n	The global number of columns.
m_l	The local number of rows.
n_l	The local number of columns.
nnz	The number of on-diagonal nonzeros per row (defaults to 30).
noz	The number of off-diagonal nonzeros per row (defaults to 10).
blocksize	Optional value indicating dense coupled blocks for systems with multiple variables all of the same type.

Implements libMesh::SparseMatrix< T >.

◆ init() [2/2]

template<typename T >

void libMesh::EigenSparseMatrix< T >::init ( )

overridevirtual

Initialize this matrix using the sparsity structure computed by dof_map.

Implements libMesh::SparseMatrix< T >.

Definition at line 63 of file eigen_sparse_matrix.C.

References libMesh::libMeshPrivateData::_is_initialized, and libMesh::initialized().

 {
   // Ignore calls on initialized objects
   if (this->initialized())
     return;
 
   // We need the DofMap for this!
   libmesh_assert(this->_dof_map);
 
   // Clear initialized matrices
   if (this->initialized())
     this->clear();
 
   const numeric_index_type n_rows   = this->_dof_map->n_dofs();
   const numeric_index_type n_cols   = n_rows;
 
 #ifndef NDEBUG
   // The following variables are only used for assertions,
   // so avoid declaring them when asserts are inactive.
   const numeric_index_type n_l = this->_dof_map->n_dofs_on_processor(0);
   const numeric_index_type m_l = n_l;
 #endif
 
   // Laspack Matrices only work for uniprocessor cases
   libmesh_assert_equal_to (n_rows, n_cols);
   libmesh_assert_equal_to (m_l, n_rows);
   libmesh_assert_equal_to (n_l, n_cols);
 
   const std::vector<numeric_index_type> & n_nz = this->_dof_map->get_n_nz();
 
 #ifndef NDEBUG
   // The following variables are only used for assertions,
   // so avoid declaring them when asserts are inactive.
   const std::vector<numeric_index_type> & n_oz = this->_dof_map->get_n_oz();
 #endif
 
   // Make sure the sparsity pattern isn't empty
   libmesh_assert_equal_to (n_nz.size(), n_l);
   libmesh_assert_equal_to (n_oz.size(), n_l);
 
   if (n_rows==0)
     {
       _mat.resize(0,0);
       return;
     }
 
   _mat.resize(n_rows,n_cols);
   _mat.reserve(n_nz);
 
   this->_is_initialized = true;
 
   libmesh_assert_equal_to (n_rows, this->m());
   libmesh_assert_equal_to (n_cols, this->n());
 }

◆ initialized()

template<typename T>

virtual bool libMesh::SparseMatrix< T >::initialized ( ) const

inlinevirtualinherited

Returns: true if the matrix has been initialized, false otherwise.

Definition at line 104 of file sparse_matrix.h.

Referenced by libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::ImplicitSystem::assemble(), and libMesh::ImplicitSystem::init_matrices().

104 { return _is_initialized; }

libMesh::SparseMatrix::_is_initialized

bool _is_initialized

Definition: sparse_matrix.h:430

◆ l1_norm()

template<typename T >

Real libMesh::EigenSparseMatrix< T >::l1_norm ( ) const

overridevirtual

Returns: The $\ell_1$ -norm of the matrix, that is the max column sum: $|M|_1 = \max_{j} \sum_{i} |M_{ij}|$

This is the natural matrix norm that is compatible with the $\ell_1$ -norm for vectors, i.e. $|Mv|_1 \leq |M|_1 |v|_1$ . (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 291 of file eigen_sparse_matrix.C.

References std::abs().

 {
   // There does not seem to be a straightforward way to iterate over
   // the columns of an EigenSparseMatrix.  So we use some extra
   // storage and keep track of the column sums while going over the
   // row entries...
   std::vector<Real> abs_col_sums(this->n());
 
   // For a row-major Eigen SparseMatrix like we're using, the
   // InnerIterator iterates over the non-zero entries of rows.
   for (unsigned row=0; row<this->m(); ++row)
     {
       EigenSM::InnerIterator it(_mat, row);
       for (; it; ++it)
         abs_col_sums[it.col()] += std::abs(it.value());
     }
 
   return *(std::max_element(abs_col_sums.begin(), abs_col_sums.end()));
 }

◆ linfty_norm()

template<typename T >

Real libMesh::EigenSparseMatrix< T >::linfty_norm ( ) const

overridevirtual

Returns: The $\ell_{\infty}$ -norm of the matrix, that is the max row sum:

$|M|_{\infty} = \max_{i} \sum_{j} |M_{ij}|$

This is the natural matrix norm that is compatible to the $\ell_{\infty}$ -norm of vectors, i.e. $|Mv|_{\infty} \leq |M|_{\infty} |v|_{\infty}$ . (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 314 of file eigen_sparse_matrix.C.

References std::abs(), std::max(), and libMesh::Real.

 {
   Real max_abs_row_sum = 0.;
 
   // For a row-major Eigen SparseMatrix like we're using, the
   // InnerIterator iterates over the non-zero entries of rows.
   for (unsigned row=0; row<this->m(); ++row)
     {
       Real current_abs_row_sum = 0.;
       EigenSM::InnerIterator it(_mat, row);
       for (; it; ++it)
         current_abs_row_sum += std::abs(it.value());
 
       max_abs_row_sum = std::max(max_abs_row_sum, current_abs_row_sum);
     }
 
   return max_abs_row_sum;
 }

◆ m()

template<typename T >

numeric_index_type libMesh::EigenSparseMatrix< T >::m ( ) const

overridevirtual

Returns: The row-dimension of the matrix.

Implements libMesh::SparseMatrix< T >.

Definition at line 189 of file eigen_sparse_matrix.C.

References libMesh::initialized().

 {
   libmesh_assert (this->initialized());
 
   return cast_int<numeric_index_type>(_mat.rows());
 }

◆ n()

template<typename T >

numeric_index_type libMesh::EigenSparseMatrix< T >::n ( ) const

overridevirtual

Returns: The column-dimension of the matrix.

Implements libMesh::SparseMatrix< T >.

Definition at line 199 of file eigen_sparse_matrix.C.

References libMesh::initialized().

 {
   libmesh_assert (this->initialized());
 
   return cast_int<numeric_index_type>(_mat.cols());
 }

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 95 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

96 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ need_full_sparsity_pattern()

template<typename T>

virtual bool libMesh::SparseMatrix< T >::need_full_sparsity_pattern ( ) const

inlinevirtualinherited

Returns: true if this sparse matrix format needs to be fed the graph of the sparse matrix.

This is true for LaspackMatrix, but not PetscMatrix. In the case where the full graph is not required, we can efficiently approximate it to provide a good estimate of the required size of the sparse matrix.

Reimplemented in libMesh::EpetraMatrix< T >, and libMesh::LaspackMatrix< T >.

Definition at line 121 of file sparse_matrix.h.

Referenced by libMesh::DofMap::attach_matrix().

122 { return false; }

◆ operator()()

template<typename T >

T libMesh::EigenSparseMatrix< T >::operator()	(	const numeric_index_type	i,
		const numeric_index_type	j
	)		const

overridevirtual

Returns: A copy of matrix entry (i,j).

Note: This may be an expensive operation, and you should always be careful where you call this function.

Implements libMesh::SparseMatrix< T >.

Definition at line 278 of file eigen_sparse_matrix.C.

References libMesh::initialized().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_less (i, this->m());
   libmesh_assert_less (j, this->n());
 
   return _mat.coeff(i,j);
 }

◆ operator=() [1/2]

template<typename T>

EigenSparseMatrix& libMesh::EigenSparseMatrix< T >::operator= ( const EigenSparseMatrix< T > & )

default

◆ operator=() [2/2]

template<typename T>

EigenSparseMatrix& libMesh::EigenSparseMatrix< T >::operator= ( EigenSparseMatrix< T > && )

default

◆ print() [1/2]

template<>

void libMesh::SparseMatrix< Complex >::print	(	std::ostream &	os,
		const bool	sparse
	)		const

inherited

Definition at line 96 of file sparse_matrix.C.

 {
   // std::complex<>::operator<<() is defined, but use this form
 
   if (sparse)
     {
       libmesh_not_implemented();
     }
 
   os << "Real part:" << std::endl;
   for (numeric_index_type i=0; i<this->m(); i++)
     {
       for (numeric_index_type j=0; j<this->n(); j++)
         os << std::setw(8) << (*this)(i,j).real() << " ";
       os << std::endl;
     }
 
   os << std::endl << "Imaginary part:" << std::endl;
   for (numeric_index_type i=0; i<this->m(); i++)
     {
       for (numeric_index_type j=0; j<this->n(); j++)
         os << std::setw(8) << (*this)(i,j).imag() << " ";
       os << std::endl;
     }
 }

◆ print() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::print	(	std::ostream &	os = `libMesh::out`,
		const bool	sparse = `false`
	)		const

inherited

Print the contents of the matrix to the screen in a uniform style, regardless of matrix/solver package being used.

Definition at line 200 of file sparse_matrix.C.

Referenced by libMesh::EigenSparseMatrix< T >::print_personal(), and libMesh::LaspackMatrix< T >::print_personal().

 {
   parallel_object_only();
 
   libmesh_assert (this->initialized());
 
   if (!this->_dof_map)
     libmesh_error_msg("Error!  Trying to print a matrix with no dof_map set!");
 
   // We'll print the matrix from processor 0 to make sure
   // it's serialized properly
   if (this->processor_id() == 0)
     {
       libmesh_assert_equal_to (this->_dof_map->first_dof(), 0);
       for (numeric_index_type i=this->_dof_map->first_dof();
            i!=this->_dof_map->end_dof(); ++i)
         {
           if (sparse)
             {
               for (numeric_index_type j=0; j<this->n(); j++)
                 {
                   T c = (*this)(i,j);
                   if (c != static_cast<T>(0.0))
                     {
                       os << i << " " << j << " " << c << std::endl;
                     }
                 }
             }
           else
             {
               for (numeric_index_type j=0; j<this->n(); j++)
                 os << (*this)(i,j) << " ";
               os << std::endl;
             }
         }
 
       std::vector<numeric_index_type> ibuf, jbuf;
       std::vector<T> cbuf;
       numeric_index_type currenti = this->_dof_map->end_dof();
       for (processor_id_type p=1; p < this->n_processors(); ++p)
         {
           this->comm().receive(p, ibuf);
           this->comm().receive(p, jbuf);
           this->comm().receive(p, cbuf);
           libmesh_assert_equal_to (ibuf.size(), jbuf.size());
           libmesh_assert_equal_to (ibuf.size(), cbuf.size());
 
           if (ibuf.empty())
             continue;
           libmesh_assert_greater_equal (ibuf.front(), currenti);
           libmesh_assert_greater_equal (ibuf.back(), ibuf.front());
 
           std::size_t currentb = 0;
           for (;currenti <= ibuf.back(); ++currenti)
             {
               if (sparse)
                 {
                   for (numeric_index_type j=0; j<this->n(); j++)
                     {
                       if (currentb < ibuf.size() &&
                           ibuf[currentb] == currenti &&
                           jbuf[currentb] == j)
                         {
                           os << currenti << " " << j << " " << cbuf[currentb] << std::endl;
                           currentb++;
                         }
                     }
                 }
               else
                 {
                   for (numeric_index_type j=0; j<this->n(); j++)
                     {
                       if (currentb < ibuf.size() &&
                           ibuf[currentb] == currenti &&
                           jbuf[currentb] == j)
                         {
                           os << cbuf[currentb] << " ";
                           currentb++;
                         }
                       else
                         os << static_cast<T>(0.0) << " ";
                     }
                   os << std::endl;
                 }
             }
         }
       if (!sparse)
         {
           for (; currenti != this->m(); ++currenti)
             {
               for (numeric_index_type j=0; j<this->n(); j++)
                 os << static_cast<T>(0.0) << " ";
               os << std::endl;
             }
         }
     }
   else
     {
       std::vector<numeric_index_type> ibuf, jbuf;
       std::vector<T> cbuf;
 
       // We'll assume each processor has access to entire
       // matrix rows, so (*this)(i,j) is valid if i is a local index.
       for (numeric_index_type i=this->_dof_map->first_dof();
            i!=this->_dof_map->end_dof(); ++i)
         {
           for (numeric_index_type j=0; j<this->n(); j++)
             {
               T c = (*this)(i,j);
               if (c != static_cast<T>(0.0))
                 {
                   ibuf.push_back(i);
                   jbuf.push_back(j);
                   cbuf.push_back(c);
                 }
             }
         }
       this->comm().send(0,ibuf);
       this->comm().send(0,jbuf);
       this->comm().send(0,cbuf);
     }
 }

◆ print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 87 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

◆ print_matlab()

template<typename T>

virtual void libMesh::SparseMatrix< T >::print_matlab ( const std::string & = "" ) const

inlinevirtualinherited

Print the contents of the matrix in Matlab's sparse matrix format. Optionally prints the matrix to the file named name. If name is not specified it is dumped to the screen.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 344 of file sparse_matrix.h.

   {
     libmesh_not_implemented();
   }

◆ print_personal()

template<typename T>

virtual void libMesh::EigenSparseMatrix< T >::print_personal ( std::ostream & os = libMesh::out ) const

inlineoverridevirtual

Print the contents of the matrix to the screen in a package-personalized style, if available.

Implements libMesh::SparseMatrix< T >.

Definition at line 136 of file eigen_sparse_matrix.h.

References libMesh::SparseMatrix< T >::print().

136 { this->print(os); }

libMesh::SparseMatrix::print

void print(std::ostream &os=libMesh::out, const bool sparse=false) const

Definition: sparse_matrix.C:200

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

102 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ reinit_submatrix()

template<typename T>

virtual void libMesh::SparseMatrix< T >::reinit_submatrix	(	SparseMatrix< T > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function is similar to the one above, but it allows you to reuse the existing sparsity pattern of "submatrix" instead of reallocating it again. This should hopefully be more efficient if you are frequently extracting submatrices of the same size.

Definition at line 370 of file sparse_matrix.h.

   {
     this->_get_submatrix(submatrix,
                          rows,
                          cols,
                          true); // true means REUSE submatrix
   }

◆ row_start()

template<typename T >

numeric_index_type libMesh::EigenSparseMatrix< T >::row_start ( ) const

overridevirtual

Returns: The index of the first matrix row stored on this processor.

Implements libMesh::SparseMatrix< T >.

Definition at line 209 of file eigen_sparse_matrix.C.

 {
   return 0;
 }

◆ row_stop()

template<typename T >

numeric_index_type libMesh::EigenSparseMatrix< T >::row_stop ( ) const

overridevirtual

Returns: The index of the last matrix row (+1) stored on this processor.

Implements libMesh::SparseMatrix< T >.

Definition at line 217 of file eigen_sparse_matrix.C.

 {
   return this->m();
 }

◆ set()

template<typename T >

void libMesh::EigenSparseMatrix< T >::set	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const T	value
	)

overridevirtual

Set the element (i,j) to value. Throws an error if the entry does not exist. Zero values can be "stored" in non-existent fields.

Implements libMesh::SparseMatrix< T >.

Definition at line 225 of file eigen_sparse_matrix.C.

References libMesh::initialized(), and value.

 {
   libmesh_assert (this->initialized());
   libmesh_assert_less (i, this->m());
   libmesh_assert_less (j, this->n());
 
   _mat.coeffRef(i,j) = value;
 }

◆ update_sparsity_pattern()

template<typename T>

virtual void libMesh::SparseMatrix< T >::update_sparsity_pattern ( const SparsityPattern::Graph & )

inlinevirtualinherited

Updates the matrix sparsity pattern. When your SparseMatrix<T> implementation does not need this data, simply do not override this method.

Reimplemented in libMesh::EpetraMatrix< T >, and libMesh::LaspackMatrix< T >.

Definition at line 129 of file sparse_matrix.h.

Referenced by libMesh::DofMap::attach_matrix().

129 {}

◆ vector_mult()

template<typename T>

void libMesh::SparseMatrix< T >::vector_mult	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and stores the result in NumericVector dest.

Definition at line 170 of file sparse_matrix.C.

Referenced by libMesh::ImplicitSystem::qoi_parameter_hessian(), and libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product().

 {
   dest.zero();
   this->vector_mult_add(dest,arg);
 }

◆ vector_mult_add()

template<typename T>

void libMesh::SparseMatrix< T >::vector_mult_add	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and adds the result to the NumericVector dest.

Definition at line 180 of file sparse_matrix.C.

Referenced by libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

 {
   /* This functionality is actually implemented in the \p
      NumericVector class.  */
   dest.add_vector(arg,*this);
 }

◆ zero()

template<typename T >

void libMesh::EigenSparseMatrix< T >::zero ( )

overridevirtual

Set all entries to 0.

Implements libMesh::SparseMatrix< T >.

Definition at line 181 of file eigen_sparse_matrix.C.

 {
   _mat.setZero();
 }

◆ zero_rows()

template<typename T>

void libMesh::SparseMatrix< T >::zero_rows	(	std::vector< numeric_index_type > &	rows,
		T	diag_value = `0.0`
	)

virtualinherited

Sets all row entries to 0 then puts diag_value in the diagonal entry.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 191 of file sparse_matrix.C.

 {
   /* This functionality isn't implemented or stubbed in every subclass yet */
   libmesh_not_implemented();
 }

Friends And Related Function Documentation

◆ EigenSparseLinearSolver< T >

template<typename T>

friend class EigenSparseLinearSolver< T >

friend

Definition at line 158 of file eigen_sparse_matrix.h.

◆ EigenSparseVector< T >

template<typename T>

friend class EigenSparseVector< T >

friend

Make other Eigen datatypes friends

Definition at line 157 of file eigen_sparse_matrix.h.

Member Data Documentation

◆ _closed

template<typename T>

bool libMesh::EigenSparseMatrix< T >::_closed

private

Flag indicating if the matrix has been closed yet.

Definition at line 152 of file eigen_sparse_matrix.h.

Referenced by libMesh::EigenSparseMatrix< T >::close(), and libMesh::EigenSparseMatrix< T >::closed().

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 107 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _dof_map

template<typename T>

DofMap const* libMesh::SparseMatrix< T >::_dof_map

protectedinherited

The DofMap object associated with this object.

Definition at line 425 of file sparse_matrix.h.

Referenced by libMesh::SparseMatrix< ValOut >::attach_dof_map().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _is_initialized

template<typename T>

bool libMesh::SparseMatrix< T >::_is_initialized

protectedinherited

Flag indicating whether or not the matrix has been initialized.

Definition at line 430 of file sparse_matrix.h.

Referenced by libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::EpetraMatrix< T >::EpetraMatrix(), libMesh::PetscMatrix< T >::get_transpose(), libMesh::SparseMatrix< ValOut >::initialized(), and libMesh::PetscMatrix< T >::PetscMatrix().

◆ _mat

template<typename T>

DataType libMesh::EigenSparseMatrix< T >::_mat

private

Actual Eigen::SparseMatrix<> we are wrapping.

Definition at line 147 of file eigen_sparse_matrix.h.

Referenced by libMesh::EigenSparseMatrix< T >::add(), libMesh::EigenSparseMatrix< T >::get_transpose(), and libMesh::EigenSparseLinearSolver< T >::solve().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects. Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

template<typename T> class libMesh::EigenSparseMatrix< T >

Member Typedef Documentation

◆ Counts

◆ DataType

◆ TripletType

Constructor & Destructor Documentation

◆ EigenSparseMatrix() [1/3]

◆ EigenSparseMatrix() [2/3]

◆ EigenSparseMatrix() [3/3]

◆ ~EigenSparseMatrix()

Member Function Documentation

◆ _get_submatrix()

◆ add() [1/2]

◆ add() [2/2]

◆ add_block_matrix() [1/2]

◆ add_block_matrix() [2/2]

◆ add_matrix() [1/2]

◆ add_matrix() [2/2]

◆ attach_dof_map()

◆ build()

◆ clear()

◆ close()

◆ closed()

◆ comm()

◆ create_submatrix()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ flush()

◆ get_diagonal()

◆ get_info()

◆ get_transpose()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init() [1/2]

◆ init() [2/2]

◆ initialized()

◆ l1_norm()

◆ linfty_norm()

◆ m()

◆ n()

◆ n_objects()

◆ n_processors()

◆ need_full_sparsity_pattern()

◆ operator()()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ print_info()

◆ print_matlab()

◆ print_personal()

◆ processor_id()

◆ reinit_submatrix()

◆ row_start()

◆ row_stop()

◆ set()

◆ update_sparsity_pattern()

◆ vector_mult()

◆ vector_mult_add()

◆ zero()

◆ zero_rows()

Friends And Related Function Documentation

◆ EigenSparseLinearSolver< T >

◆ EigenSparseVector< T >

Member Data Documentation

◆ _closed

◆ _communicator

◆ _counts

◆ _dof_map

◆ _enable_print_counter

template<typename T>
class libMesh::EigenSparseMatrix< T >