Reference documentation for deal.II version GIT relicensing-489-g2d48aca8cc 2024-04-28 17:30: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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace > Class Template Reference

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

Public Types

using size_type = size_t
 
using NodeType = Tpetra::KokkosCompat::KokkosDeviceWrapperNode< typename MemorySpace::kokkos_space::execution_space, typename MemorySpace::kokkos_space >
 

Public Member Functions

 Iterator (const SparsityPattern< MemorySpace > *sparsity_pattern, const size_type row, const size_type index)
 
 Iterator (const Iterator< MemorySpace > &i)
 
Iterator< MemorySpace > & operator++ ()
 
Iterator operator++ (int)
 
const Accessor< MemorySpace > & operator* () const
 
const Accessor< MemorySpace > * operator-> () const
 
bool operator== (const Iterator< MemorySpace > &) const
 
bool operator!= (const Iterator< MemorySpace > &) const
 
bool operator< (const Iterator< MemorySpace > &) const
 

Static Public Member Functions

static ::ExceptionBaseExcInvalidIndexWithinRow (size_type arg1, size_type arg2)
 

Private Attributes

Accessor< MemorySpace > accessor
 

Friends

class TpetraWrappers::SparsityPattern< MemorySpace >
 

Detailed Description

template<typename MemorySpace = ::MemorySpace::Host>
class LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >

Iterator class for sparsity patterns of type TrilinosWrappers::SparsityPattern. Access to individual elements of the sparsity pattern is handled by the Accessor class in this namespace.

Definition at line 192 of file trilinos_tpetra_sparsity_pattern.h.

Member Typedef Documentation

◆ size_type

template<typename MemorySpace = ::MemorySpace::Host>
using LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::size_type = size_t

Declare type for container size.

Definition at line 198 of file trilinos_tpetra_sparsity_pattern.h.

◆ NodeType

template<typename MemorySpace = ::MemorySpace::Host>
using LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::NodeType = Tpetra::KokkosCompat::KokkosDeviceWrapperNode< typename MemorySpace::kokkos_space::execution_space, typename MemorySpace::kokkos_space>

Typedef for the NodeType

Definition at line 204 of file trilinos_tpetra_sparsity_pattern.h.

Constructor & Destructor Documentation

◆ Iterator() [1/2]

template<typename MemorySpace = ::MemorySpace::Host>
LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::Iterator ( const SparsityPattern< MemorySpace > *  sparsity_pattern,
const size_type  row,
const size_type  index 
)

Constructor. Create an iterator into the matrix matrix for the given row and the index within it.

◆ Iterator() [2/2]

template<typename MemorySpace = ::MemorySpace::Host>
LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::Iterator ( const Iterator< MemorySpace > &  i)

Copy constructor.

Member Function Documentation

◆ operator++() [1/2]

template<typename MemorySpace = ::MemorySpace::Host>
Iterator< MemorySpace > & LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator++ ( )

Prefix increment.

◆ operator++() [2/2]

template<typename MemorySpace = ::MemorySpace::Host>
Iterator LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator++ ( int  )

Postfix increment.

◆ operator*()

template<typename MemorySpace = ::MemorySpace::Host>
const Accessor< MemorySpace > & LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator* ( ) const

Dereferencing operator.

◆ operator->()

template<typename MemorySpace = ::MemorySpace::Host>
const Accessor< MemorySpace > * LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator-> ( ) const

Dereferencing operator.

◆ operator==()

template<typename MemorySpace = ::MemorySpace::Host>
bool LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator== ( const Iterator< MemorySpace > &  ) const

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

◆ operator!=()

template<typename MemorySpace = ::MemorySpace::Host>
bool LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator!= ( const Iterator< MemorySpace > &  ) const

Inverse of ==.

◆ operator<()

template<typename MemorySpace = ::MemorySpace::Host>
bool LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::operator< ( const Iterator< MemorySpace > &  ) const

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.

Friends And Related Symbol Documentation

◆ TpetraWrappers::SparsityPattern< MemorySpace >

template<typename MemorySpace = ::MemorySpace::Host>
friend class TpetraWrappers::SparsityPattern< MemorySpace >
friend

Definition at line 284 of file trilinos_tpetra_sparsity_pattern.h.

Member Data Documentation

◆ accessor

template<typename MemorySpace = ::MemorySpace::Host>
Accessor<MemorySpace> LinearAlgebra::TpetraWrappers::SparsityPatternIterators::Iterator< MemorySpace >::accessor
private

Store an object of the accessor class.

Definition at line 284 of file trilinos_tpetra_sparsity_pattern.h.


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