Reference documentation for deal.II version 8.4.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
BlockMatrixIterators::Accessor< BlockMatrixType, true > Class Template Reference

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

Inheritance diagram for BlockMatrixIterators::Accessor< BlockMatrixType, true >:
[legend]

Public Types

typedef types::global_dof_index size_type
 
typedef const BlockMatrixType MatrixType
 
typedef BlockMatrixType::value_type value_type
 
- Public Types inherited from BlockMatrixIterators::AccessorBase< BlockMatrixType >
typedef types::global_dof_index size_type
 
typedef BlockMatrixType::value_type value_type
 

Public Member Functions

 Accessor (const BlockMatrixType *m, const size_type row, const size_type col)
 
 Accessor (const Accessor< BlockMatrixType, false > &)
 
size_type row () const
 
size_type column () const
 
value_type value () const
 
- Public Member Functions inherited from BlockMatrixIterators::AccessorBase< BlockMatrixType >
 AccessorBase ()
 
unsigned int block_row () const
 
unsigned int block_column () const
 

Protected Member Functions

void advance ()
 
bool operator== (const Accessor &a) const
 

Protected Attributes

const BlockMatrixType * matrix
 
BlockMatrixType::BlockType::const_iterator base_iterator
 
- Protected Attributes inherited from BlockMatrixIterators::AccessorBase< BlockMatrixType >
unsigned int row_block
 
unsigned int col_block
 

Friends

template<typename >
class ::MatrixIterator
 

Detailed Description

template<class BlockMatrixType>
class BlockMatrixIterators::Accessor< BlockMatrixType, true >

Block matrix accessor for constant matrices, implementing the stepping through a matrix.

Definition at line 198 of file block_matrix_base.h.

Member Typedef Documentation

template<class BlockMatrixType >
typedef types::global_dof_index BlockMatrixIterators::Accessor< BlockMatrixType, true >::size_type

Declare type for container size.

Definition at line 206 of file block_matrix_base.h.

template<class BlockMatrixType >
typedef const BlockMatrixType BlockMatrixIterators::Accessor< BlockMatrixType, true >::MatrixType

Type of the matrix used in this accessor.

Definition at line 211 of file block_matrix_base.h.

template<class BlockMatrixType >
typedef BlockMatrixType::value_type BlockMatrixIterators::Accessor< BlockMatrixType, true >::value_type

Typedef the value type of the matrix we point into.

Definition at line 216 of file block_matrix_base.h.

Constructor & Destructor Documentation

template<class BlockMatrixType >
BlockMatrixIterators::Accessor< BlockMatrixType, true >::Accessor ( const BlockMatrixType *  m,
const size_type  row,
const size_type  col 
)

Constructor. Since we use accessors only for read access, a const matrix pointer is sufficient.

Place the iterator at the beginning of the given row of the matrix, or create the end pointer if row equals the total number of rows in the matrix.

template<class BlockMatrixType >
BlockMatrixIterators::Accessor< BlockMatrixType, true >::Accessor ( const Accessor< BlockMatrixType, false > &  )

Initialize const accessor from non const accessor.

Member Function Documentation

template<class BlockMatrixType >
size_type BlockMatrixIterators::Accessor< BlockMatrixType, true >::row ( ) const

Row number of the element represented by this object.

template<class BlockMatrixType >
size_type BlockMatrixIterators::Accessor< BlockMatrixType, true >::column ( ) const

Column number of the element represented by this object.

template<class BlockMatrixType >
value_type BlockMatrixIterators::Accessor< BlockMatrixType, true >::value ( ) const

Value of the entry at the current position.

template<class BlockMatrixType >
void BlockMatrixIterators::Accessor< BlockMatrixType, true >::advance ( )
protected

Move ahead one element.

template<class BlockMatrixType >
bool BlockMatrixIterators::Accessor< BlockMatrixType, true >::operator== ( const Accessor< BlockMatrixType, true > &  a) const
protected

Compare this accessor with another one for equality.

Friends And Related Function Documentation

template<class BlockMatrixType >
template<typename >
friend class ::MatrixIterator
friend

Let the iterator class be a friend.

Definition at line 274 of file block_matrix_base.h.

Member Data Documentation

template<class BlockMatrixType >
const BlockMatrixType* BlockMatrixIterators::Accessor< BlockMatrixType, true >::matrix
protected

The matrix accessed.

Definition at line 253 of file block_matrix_base.h.

template<class BlockMatrixType >
BlockMatrixType::BlockType::const_iterator BlockMatrixIterators::Accessor< BlockMatrixType, true >::base_iterator
protected

Iterator of the underlying matrix class.

Definition at line 258 of file block_matrix_base.h.


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