Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp > Class Template Reference

interface for DoF iterators of discrete functions More...

#include <dune/fem/function/common/dofiterator.hh>

Public Types
typedef DofImp	DofType
	type of the DoFs
typedef DofIteratorImp	DofIteratorType
	type of the implementation (Barton-Nackman)

Public Member Functions
DofIteratorType &	operator= (const DofIteratorType &other)
	assign another DoF iterator to this one More...
DofType &	operator* ()
	obtain reference to current DoF More...
const DofType &	operator* () const
	obtain reference to current DoF More...
DofIteratorType &	operator++ ()
	increment the iterator More...
bool	operator== (const DofIteratorType &other) const
	check for equality More...
bool	operator!= (const DofIteratorType &other) const
	check for inequality More...
int	index () const
	get the global number of the current DoF More...
void	reset ()
	reset iterator to the first position

Detailed Description

template<class DofImp, class DofIteratorImp>
class Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >

interface for DoF iterators of discrete functions

The DoF iterator is an efficient way of walking through the DoFs of a discrete function.

Member Function Documentation

index()

template<class DofImp , class DofIteratorImp >

int Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::index ( ) const

inline

get the global number of the current DoF

Returns

global number of the current DoF

operator!=()

template<class DofImp , class DofIteratorImp >

bool Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator!= ( const DofIteratorType &  other ) const

inline

check for inequality

Parameters

[in]

other

DoF iterator to compare this one to

Returns

true if the iterators are the different, false otherewise

operator*() [1/2]

template<class DofImp , class DofIteratorImp >

DofType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator* ( )

inline

obtain reference to current DoF

Returns

a reference to the current DoF

operator*() [2/2]

template<class DofImp , class DofIteratorImp >

const DofType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator* ( ) const

inline

obtain reference to current DoF

Returns

a constant reference to the current DoF

operator++()

template<class DofImp , class DofIteratorImp >

DofIteratorType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator++ ( )

inline

increment the iterator

Lets the iterator point to the next DoF.

Returns

reference the the incremented iterator (i.e., *this)

operator=()

template<class DofImp , class DofIteratorImp >

DofIteratorType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator= ( const DofIteratorType &  other )

inline

assign another DoF iterator to this one

Parameters

[in]

other

DoF iterator to copy

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION.

operator==()

template<class DofImp , class DofIteratorImp >

bool Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator== ( const DofIteratorType &  other ) const

inline

check for equality

Parameters

[in]

other

DoF iterator to compare this one to

Returns

true if the iterators are the same, false otherewise

---

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

• dune/fem/function/common/dofiterator.hh