TrilinosWrappers::SparseMatrixIterators::Accessor< true > Class Reference

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

Inheritance diagram for TrilinosWrappers::SparseMatrixIterators::Accessor< true >:

Public Types
using	MatrixType = const SparseMatrix
using	size_type = ::types::global_dof_index

Public Member Functions
	Accessor (MatrixType *matrix, const size_type row, const size_type index)
template<bool Other>
	Accessor (const Accessor< Other > &a)
TrilinosScalar	value () const
size_type	row () const
size_type	index () const
size_type	column () const

Protected Member Functions
void	visit_present_row ()

Protected Attributes
SparseMatrix *	matrix
size_type	a_row
size_type	a_index
std::shared_ptr< std::vector< size_type > >	colnum_cache
std::shared_ptr< std::vector< TrilinosScalar > >	value_cache

Friends
template<bool >
class	Iterator

Detailed Description

The specialization for a const Accessor.

Definition at line 218 of file trilinos_sparse_matrix.h.

Member Typedef Documentation

MatrixType

using TrilinosWrappers::SparseMatrixIterators::Accessor< true >::MatrixType = const SparseMatrix

Typedef for the type (including constness) of the matrix to be used here.

Definition at line 225 of file trilinos_sparse_matrix.h.

size_type

using TrilinosWrappers::SparseMatrixIterators::AccessorBase::size_type = ::types::global_dof_index

inherited

Declare the type for container size.

Definition at line 113 of file trilinos_sparse_matrix.h.

Constructor & Destructor Documentation

Accessor() [1/2]

TrilinosWrappers::SparseMatrixIterators::Accessor< true >::Accessor	(	MatrixType *	matrix,
		const size_type	row,
		const size_type	index )

Constructor. Since we use accessors only for read access, a const matrix pointer is sufficient.

Accessor() [2/2]

template<bool Other>

TrilinosWrappers::SparseMatrixIterators::Accessor< true >::Accessor

(

const Accessor< Other > &

a

)

Copy constructor to get from a const or non-const accessor to a const accessor.

Member Function Documentation

value()

TrilinosScalar TrilinosWrappers::SparseMatrixIterators::Accessor< true >::value

(

)

const

Value of this matrix entry.

row()

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::row ( ) const

inherited

Row number of the element represented by this object.

index()

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::index ( ) const

inherited

Index in row of the element represented by this object.

column()

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::column ( ) const

inherited

Column number of the element represented by this object.

visit_present_row()

void TrilinosWrappers::SparseMatrixIterators::AccessorBase::visit_present_row ( )

protectedinherited

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 141 of file trilinos_sparse_matrix.cc.

Friends And Related Symbol Documentation

Iterator

template<bool >

friend class Iterator

friend

Definition at line 249 of file trilinos_sparse_matrix.h.

Member Data Documentation

matrix

SparseMatrix* TrilinosWrappers::SparseMatrixIterators::AccessorBase::matrix

mutableprotectedinherited

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 147 of file trilinos_sparse_matrix.h.

a_row

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_row

protectedinherited

Current row number.

Definition at line 151 of file trilinos_sparse_matrix.h.

a_index

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_index

protectedinherited

Current index in row.

Definition at line 156 of file trilinos_sparse_matrix.h.

colnum_cache

std::shared_ptr<std::vector<size_type> > TrilinosWrappers::SparseMatrixIterators::AccessorBase::colnum_cache

protectedinherited

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 178 of file trilinos_sparse_matrix.h.

value_cache

std::shared_ptr<std::vector<TrilinosScalar> > TrilinosWrappers::SparseMatrixIterators::AccessorBase::value_cache

protectedinherited

Cache for the values of this row.

Definition at line 183 of file trilinos_sparse_matrix.h.

---

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

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