LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace > Class Template Reference

#include <deal.II/lac/trilinos_tpetra_sparse_matrix.h>

Inheritance diagram for LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >:

Public Types
using	size_type = ::types::global_dof_index

Public Member Functions
	AccessorBase (SparseMatrix< Number, MemorySpace > *matrix, const size_type row, const size_type index)
size_type	row () const
size_type	index () const
size_type	column () const

Protected Member Functions
void	visit_present_row ()

Protected Attributes
SparseMatrix< Number, MemorySpace > *	matrix
size_type	a_row
size_type	a_index
std::shared_ptr< std::vector<::types::signed_global_dof_index > >	colnum_cache
std::shared_ptr< std::vector< Number > >	value_cache

Friends
class	Iterator< Number, MemorySpace, false >
class	Iterator< Number, MemorySpace, true >

Detailed Description

template<typename Number, typename MemorySpace>
class LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >

Handling of indices for both constant and non constant Accessor objects

For a regular SparseMatrix, we would use an accessor for the sparsity pattern. For Trilinos matrices, this does not seem so simple, therefore, we write a little base class here.

Definition at line 1298 of file trilinos_tpetra_sparse_matrix.h.

Member Typedef Documentation

size_type

template<typename Number , typename MemorySpace >

using LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::size_type = ::types::global_dof_index

Declare the type for container size.

Definition at line 1304 of file trilinos_tpetra_sparse_matrix.h.

Constructor & Destructor Documentation

AccessorBase()

template<typename Number , typename MemorySpace >

LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::AccessorBase ( SparseMatrix< Number, MemorySpace > * matrix, const size_type row, const size_type index )

inline

Constructor.

Definition at line 1973 of file trilinos_tpetra_sparse_matrix.h.

Member Function Documentation

row()

template<typename Number , typename MemorySpace >

AccessorBase< Number, MemorySpace >::size_type LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::row ( ) const

inline

Row number of the element represented by this object.

Definition at line 1987 of file trilinos_tpetra_sparse_matrix.h.

index()

template<typename Number , typename MemorySpace >

AccessorBase< Number, MemorySpace >::size_type LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::index ( ) const

inline

Index in row of the element represented by this object.

Definition at line 2005 of file trilinos_tpetra_sparse_matrix.h.

column()

template<typename Number , typename MemorySpace >

AccessorBase< Number, MemorySpace >::size_type LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::column ( ) const

inline

Column number of the element represented by this object.

Definition at line 1996 of file trilinos_tpetra_sparse_matrix.h.

visit_present_row()

template<typename Number , typename MemorySpace >

void LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::visit_present_row ( )

protected

Discard the old row caches (they may still be used by other accessors) and generate new ones for the row pointed to presently by this accessor.

Definition at line 2015 of file trilinos_tpetra_sparse_matrix.h.

Friends And Related Symbol Documentation

Iterator< Number, MemorySpace, false >

template<typename Number , typename MemorySpace >

friend class Iterator< Number, MemorySpace, false >

friend

Definition at line 1375 of file trilinos_tpetra_sparse_matrix.h.

Iterator< Number, MemorySpace, true >

template<typename Number , typename MemorySpace >

friend class Iterator< Number, MemorySpace, true >

friend

Definition at line 1375 of file trilinos_tpetra_sparse_matrix.h.

Member Data Documentation

matrix

template<typename Number , typename MemorySpace >

SparseMatrix<Number, MemorySpace>* LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::matrix

mutableprotected

Pointer to the matrix object. This object should be handled as a const pointer or non-const by the appropriate derived classes. In order to be able to implement both, it is not const here, so handle with care!

Definition at line 1338 of file trilinos_tpetra_sparse_matrix.h.

a_row

template<typename Number , typename MemorySpace >

size_type LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::a_row

protected

Current row number.

Definition at line 1342 of file trilinos_tpetra_sparse_matrix.h.

a_index

template<typename Number , typename MemorySpace >

size_type LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::a_index

protected

Current index in row.

Definition at line 1347 of file trilinos_tpetra_sparse_matrix.h.

colnum_cache

template<typename Number , typename MemorySpace >

std::shared_ptr<std::vector<::types::signed_global_dof_index> > LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::colnum_cache

protected

Cache where we store the column indices of the present row. This is necessary, since Trilinos makes access to the elements of its matrices rather hard, and it is much more efficient to copy all column entries of a row once when we enter it than repeatedly asking Trilinos for individual ones. This also makes some sense since it is likely that we will access them sequentially anyway.

In order to make copying of iterators/accessor of acceptable performance, we keep a shared pointer to these entries so that more than one accessor can access this data if necessary.

Definition at line 1370 of file trilinos_tpetra_sparse_matrix.h.

value_cache

template<typename Number , typename MemorySpace >

std::shared_ptr<std::vector<Number> > LinearAlgebra::TpetraWrappers::SparseMatrixIterators::AccessorBase< Number, MemorySpace >::value_cache

protected

Cache for the values of this row.

Definition at line 1375 of file trilinos_tpetra_sparse_matrix.h.

---

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

• include/deal.II/lac/trilinos_tpetra_sparse_matrix.h