BlockMatrixIterators::Accessor< BlockMatrixType, false > Class Template Reference

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

Inheritance diagram for BlockMatrixIterators::Accessor< BlockMatrixType, false >:

Public Types
using	size_type = types::global_dof_index
using	MatrixType = BlockMatrixType
using	value_type = typename BlockMatrixType::value_type

Public Member Functions
	Accessor (BlockMatrixType *m, const size_type row, const size_type col)
size_type	row () const
size_type	column () const
value_type	value () const
void	set_value (value_type newval) const
unsigned int	block_row () const
unsigned int	block_column () const

Protected Member Functions
void	advance ()
bool	operator== (const Accessor &a) const

Protected Attributes
BlockMatrixType *	matrix
BlockMatrixType::BlockType::iterator	base_iterator
unsigned int	row_block
unsigned int	col_block

Friends
template<typename >
class	::MatrixIterator
class	Accessor< BlockMatrixType, true >

Detailed Description

template<typename BlockMatrixType>
class BlockMatrixIterators::Accessor< BlockMatrixType, false >

Block matrix accessor for non const matrices.

Definition at line 117 of file block_matrix_base.h.

Member Typedef Documentation

size_type

template<typename BlockMatrixType >

using BlockMatrixIterators::Accessor< BlockMatrixType, false >::size_type = types::global_dof_index

Declare type for container size.

Definition at line 123 of file block_matrix_base.h.

MatrixType

template<typename BlockMatrixType >

using BlockMatrixIterators::Accessor< BlockMatrixType, false >::MatrixType = BlockMatrixType

Type of the matrix used in this accessor.

Definition at line 128 of file block_matrix_base.h.

value_type

template<typename BlockMatrixType >

using BlockMatrixIterators::Accessor< BlockMatrixType, false >::value_type = typename BlockMatrixType::value_type

Typedef the value type of the matrix we point into.

Definition at line 133 of file block_matrix_base.h.

Constructor & Destructor Documentation

Accessor()

template<typename BlockMatrixType >

BlockMatrixIterators::Accessor< BlockMatrixType, false >::Accessor	(	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.

Member Function Documentation

row()

template<typename BlockMatrixType >

size_type BlockMatrixIterators::Accessor< BlockMatrixType, false >::row

(

)

const

Row number of the element represented by this object.

column()

template<typename BlockMatrixType >

size_type BlockMatrixIterators::Accessor< BlockMatrixType, false >::column

(

)

const

Column number of the element represented by this object.

value()

template<typename BlockMatrixType >

value_type BlockMatrixIterators::Accessor< BlockMatrixType, false >::value

(

)

const

Value of the entry at the current position.

set_value()

template<typename BlockMatrixType >

void BlockMatrixIterators::Accessor< BlockMatrixType, false >::set_value

(

value_type

newval

)

const

Set new value.

advance()

template<typename BlockMatrixType >

void BlockMatrixIterators::Accessor< BlockMatrixType, false >::advance ( )

protected

Move ahead one element.

operator==()

template<typename BlockMatrixType >

bool BlockMatrixIterators::Accessor< BlockMatrixType, false >::operator== ( const Accessor< BlockMatrixType, false > &  a ) const

protected

Compare this accessor with another one for equality.

block_row()

template<typename BlockMatrixType >

unsigned int BlockMatrixIterators::AccessorBase< BlockMatrixType >::block_row ( ) const

inherited

Block row of the element represented by this object.

block_column()

template<typename BlockMatrixType >

unsigned int BlockMatrixIterators::AccessorBase< BlockMatrixType >::block_column ( ) const

inherited

Block column of the element represented by this object.

Friends And Related Symbol Documentation

::MatrixIterator

template<typename BlockMatrixType >

template<typename >

friend class ::MatrixIterator

friend

Definition at line 193 of file block_matrix_base.h.

Accessor< BlockMatrixType, true >

template<typename BlockMatrixType >

friend class Accessor< BlockMatrixType, true >

friend

Definition at line 193 of file block_matrix_base.h.

Member Data Documentation

matrix

template<typename BlockMatrixType >

BlockMatrixType* BlockMatrixIterators::Accessor< BlockMatrixType, false >::matrix

protected

The matrix accessed.

Definition at line 173 of file block_matrix_base.h.

base_iterator

template<typename BlockMatrixType >

BlockMatrixType::BlockType::iterator BlockMatrixIterators::Accessor< BlockMatrixType, false >::base_iterator

protected

Iterator of the underlying matrix class.

Definition at line 178 of file block_matrix_base.h.

row_block

template<typename BlockMatrixType >

unsigned int BlockMatrixIterators::AccessorBase< BlockMatrixType >::row_block

protectedinherited

Block row into which we presently point.

Definition at line 96 of file block_matrix_base.h.

col_block

template<typename BlockMatrixType >

unsigned int BlockMatrixIterators::AccessorBase< BlockMatrixType >::col_block

protectedinherited

Block column into which we presently point.

Definition at line 101 of file block_matrix_base.h.

---

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

• include/deal.II/lac/block_matrix_base.h