Reference documentation for deal.II version 9.3.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
TrilinosWrappers::SparseMatrixIterators::Accessor< true > Class Template 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

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


template<bool >
class Iterator

Detailed Description

class TrilinosWrappers::SparseMatrixIterators::Accessor< true >

The specialization for a const Accessor.

Definition at line 220 of file trilinos_sparse_matrix.h.

Member Typedef Documentation

◆ MatrixType

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

Definition at line 227 of file trilinos_sparse_matrix.h.

◆ size_type

Declare the type for container size.

Definition at line 117 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()

Value of this matrix entry.

◆ row()

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

Row number of the element represented by this object.

◆ index()

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

Index in row of the element represented by this object.

◆ column()

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

Column number of the element represented by this object.

◆ visit_present_row()

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

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 146 of file

Friends And Related Function Documentation

◆ Iterator

template<bool >
friend class Iterator

Definition at line 251 of file trilinos_sparse_matrix.h.

Member Data Documentation

◆ matrix

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

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

◆ a_row

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_row

Current row number.

Definition at line 155 of file trilinos_sparse_matrix.h.

◆ a_index

size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_index

Current index in row.

Definition at line 160 of file trilinos_sparse_matrix.h.

◆ colnum_cache

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

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

◆ value_cache

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

Cache for the values of this row.

Definition at line 187 of file trilinos_sparse_matrix.h.

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