Reference documentation for deal.II version GIT b8135fa6eb 2023-03-25 15:55:02+00:00
TrilinosWrappers::SparseMatrixIterators::AccessorBase Class Reference

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

Inheritance diagram for TrilinosWrappers::SparseMatrixIterators::AccessorBase:
[legend]

## Public Types

using size_type = ::types::global_dof_index

## Public Member Functions

AccessorBase (SparseMatrix *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

SparseMatrixmatrix

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

## Detailed Description

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

## ◆ size_type

Declare the type for container size.

Definition at line 114 of file trilinos_sparse_matrix.h.

## ◆ AccessorBase()

 TrilinosWrappers::SparseMatrixIterators::AccessorBase::AccessorBase ( SparseMatrix * matrix, const size_type row, const size_type index )

Constructor.

## ◆ 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 ( )
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 142 of file trilinos_sparse_matrix.cc.

## ◆ matrix

 SparseMatrix* TrilinosWrappers::SparseMatrixIterators::AccessorBase::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 148 of file trilinos_sparse_matrix.h.

## ◆ a_row

 size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_row
protected

Current row number.

Definition at line 152 of file trilinos_sparse_matrix.h.

## ◆ a_index

 size_type TrilinosWrappers::SparseMatrixIterators::AccessorBase::a_index
protected

Current index in row.

Definition at line 157 of file trilinos_sparse_matrix.h.

## ◆ colnum_cache

 std::shared_ptr > TrilinosWrappers::SparseMatrixIterators::AccessorBase::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 179 of file trilinos_sparse_matrix.h.

## ◆ value_cache

 std::shared_ptr > TrilinosWrappers::SparseMatrixIterators::AccessorBase::value_cache
protected

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 files: