Reference documentation for deal.II version GIT c415589cf0 2022-08-14 18:50:02+00:00
\(\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\}}\)
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | Friends | List of all members
ChunkSparseMatrixIterators::Accessor< number, false > Class Template Reference

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

Inheritance diagram for ChunkSparseMatrixIterators::Accessor< number, false >:
[legend]

Classes

class  Reference
 

Public Types

using MatrixType = ChunkSparseMatrix< number >
 
using size_type = types::global_dof_index
 

Public Member Functions

 Accessor (MatrixType *matrix, const unsigned int row)
 
 Accessor (MatrixType *matrix)
 
Reference value () const
 
MatrixTypeget_matrix () const
 
size_type row () const
 
std::size_t reduced_index () const
 
size_type column () const
 
bool is_valid_entry () const
 
bool operator== (const Accessor &) const
 
bool operator< (const Accessor &) const
 

Protected Member Functions

void advance ()
 

Protected Attributes

const ChunkSparsityPatternsparsity_pattern
 
SparsityPatternIterators::Accessor reduced_accessor
 
size_type chunk_row
 
size_type chunk_col
 

Private Attributes

MatrixTypematrix
 

Friends

template<typename , bool >
class Iterator
 

Detailed Description

template<typename number>
class ChunkSparseMatrixIterators::Accessor< number, false >

Accessor class for non-constant matrices, used in the iterators. This class builds on the accessor classes used for sparsity patterns to loop over all nonzero entries, and only adds the accessor functions to gain access to the actual value stored at a certain location.

Definition at line 162 of file chunk_sparse_matrix.h.

Member Typedef Documentation

◆ MatrixType

template<typename number >
using ChunkSparseMatrixIterators::Accessor< number, false >::MatrixType = ChunkSparseMatrix<number>

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

Definition at line 244 of file chunk_sparse_matrix.h.

◆ size_type

Declare the type for container size.

Definition at line 69 of file chunk_sparsity_pattern.h.

Constructor & Destructor Documentation

◆ Accessor() [1/2]

template<typename number >
ChunkSparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix,
const unsigned int  row 
)

Constructor.

◆ Accessor() [2/2]

template<typename number >
ChunkSparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix)

Constructor. Construct the end accessor for the given matrix.

Member Function Documentation

◆ value()

template<typename number >
Reference ChunkSparseMatrixIterators::Accessor< number, false >::value ( ) const

Value of this matrix entry, returned as a read- and writable reference.

◆ get_matrix()

template<typename number >
MatrixType& ChunkSparseMatrixIterators::Accessor< number, false >::get_matrix ( ) const

Return a reference to the matrix into which this accessor points. Note that in the present case, this is a non-constant reference.

◆ row()

size_type ChunkSparsityPatternIterators::Accessor::row ( ) const
inherited

Row number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

◆ reduced_index()

std::size_t ChunkSparsityPatternIterators::Accessor::reduced_index ( ) const
inherited

Return the global index from the reduced sparsity pattern.

◆ column()

size_type ChunkSparsityPatternIterators::Accessor::column ( ) const
inherited

Column number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

◆ is_valid_entry()

bool ChunkSparsityPatternIterators::Accessor::is_valid_entry ( ) const
inherited

Return whether the sparsity pattern entry pointed to by this iterator is valid or not. Note that after compressing the sparsity pattern, all entries are valid. However, before compression, the sparsity pattern allocated some memory to be used while still adding new nonzero entries; if you create iterators in this phase of the sparsity pattern's lifetime, you will iterate over elements that are not valid. If this is so, then this function will return false.

◆ operator==()

bool ChunkSparsityPatternIterators::Accessor::operator== ( const Accessor ) const
inherited

Comparison. True, if both iterators point to the same matrix position.

◆ operator<()

bool ChunkSparsityPatternIterators::Accessor::operator< ( const Accessor ) const
inherited

Comparison operator. Result is true if either the first row number is smaller or if the row numbers are equal and the first index is smaller.

This function is only valid if both iterators point into the same sparsity pattern.

◆ advance()

void ChunkSparsityPatternIterators::Accessor::advance ( )
protectedinherited

Move the accessor to the next nonzero entry in the matrix.

Friends And Related Function Documentation

◆ Iterator

template<typename number >
template<typename , bool >
friend class Iterator
friend

Definition at line 282 of file chunk_sparse_matrix.h.

Member Data Documentation

◆ matrix

template<typename number >
MatrixType* ChunkSparseMatrixIterators::Accessor< number, false >::matrix
private

Pointer to the matrix we use.

Definition at line 273 of file chunk_sparse_matrix.h.

◆ sparsity_pattern

const ChunkSparsityPattern* ChunkSparsityPatternIterators::Accessor::sparsity_pattern
protectedinherited

The sparsity pattern we operate on accessed.

Definition at line 135 of file chunk_sparsity_pattern.h.

◆ reduced_accessor

SparsityPatternIterators::Accessor ChunkSparsityPatternIterators::Accessor::reduced_accessor
protectedinherited

The accessor of the (reduced) sparsity pattern.

Definition at line 140 of file chunk_sparsity_pattern.h.

◆ chunk_row

size_type ChunkSparsityPatternIterators::Accessor::chunk_row
protectedinherited

Current chunk row number.

Definition at line 145 of file chunk_sparsity_pattern.h.

◆ chunk_col

size_type ChunkSparsityPatternIterators::Accessor::chunk_col
protectedinherited

Current chunk col number.

Definition at line 150 of file chunk_sparsity_pattern.h.


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