TrilinosWrappers::SparseMatrixIterators::Accessor< Constess > Class Template Reference

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

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

Public Types
using	size_type = ::types::global_dof_index

Public Member Functions
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

Private Member Functions
TrilinosScalar	value () const
TrilinosScalar &	value ()

Detailed Description

template<bool Constess>
class TrilinosWrappers::SparseMatrixIterators::Accessor< Constess >

General template for sparse matrix accessors. The first template argument denotes the underlying numeric type, the second the constness of the matrix.

The general template is not implemented, only the specializations for the two possible values of the second template argument. Therefore, the interface listed here only serves as a template provided since doxygen does not link the specializations.

Definition at line 198 of file trilinos_sparse_matrix.h.

Member Typedef Documentation

size_type

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

inherited

Declare the type for container size.

Definition at line 114 of file trilinos_sparse_matrix.h.

Member Function Documentation

value() [1/2]

template<bool Constess>

TrilinosScalar TrilinosWrappers::SparseMatrixIterators::Accessor< Constess >::value ( ) const

private

Value of this matrix entry.

value() [2/2]

template<bool Constess>

TrilinosScalar & TrilinosWrappers::SparseMatrixIterators::Accessor< Constess >::value ( )

private

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

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

a_row

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_row

protectedinherited

Current row number.

Definition at line 152 of file trilinos_sparse_matrix.h.

a_index

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_index

protectedinherited

Current index in row.

Definition at line 157 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 179 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 184 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