Dune::Torus< Communication, d >::ProcListIterator Class Reference

#include <dune/grid/yaspgrid/torus.hh>

Public Member Functions
	ProcListIterator (typename std::deque< CommPartner >::const_iterator iter)
	make an iterator
int	rank () const
	return rank of neighboring process
iTupel	delta () const
	return distance vector
int	index () const
	return index in proclist
int	distance () const
	return 1-norm of distance vector
bool	operator== (const ProcListIterator &iter) const
	Return true when two iterators point to same member.
bool	operator!= (const ProcListIterator &iter) const
	Return true when two iterators do not point to same member.
ProcListIterator &	operator++ ()
	Increment iterator to next cell.

Detailed Description

template<class Communication, int d>
class Dune::Torus< Communication, d >::ProcListIterator

ProcListIterator provides access to a list of neighboring processes. There are always entries in such a list. Two lists are maintained, one for sending and one for receiving. The lists are sorted in such a way that in sequence message delivery ensures that e.g. a message send to the left neighbor is received as a message from the right neighbor.

Constructor & Destructor Documentation

ProcListIterator()

template<class Communication , int d>

Dune::Torus< Communication, d >::ProcListIterator::ProcListIterator ( typename std::deque< CommPartner >::const_iterator  iter )

inline

make an iterator

Member Function Documentation

delta()

template<class Communication , int d>

iTupel Dune::Torus< Communication, d >::ProcListIterator::delta ( ) const

inline

return distance vector

distance()

template<class Communication , int d>

int Dune::Torus< Communication, d >::ProcListIterator::distance ( ) const

inline

return 1-norm of distance vector

index()

template<class Communication , int d>

int Dune::Torus< Communication, d >::ProcListIterator::index ( ) const

inline

return index in proclist

operator!=()

template<class Communication , int d>

bool Dune::Torus< Communication, d >::ProcListIterator::operator!= ( const ProcListIterator &  iter ) const

inline

Return true when two iterators do not point to same member.

operator++()

template<class Communication , int d>

ProcListIterator & Dune::Torus< Communication, d >::ProcListIterator::operator++ ( )

inline

Increment iterator to next cell.

operator==()

template<class Communication , int d>

bool Dune::Torus< Communication, d >::ProcListIterator::operator== ( const ProcListIterator &  iter ) const

inline

Return true when two iterators point to same member.

rank()

template<class Communication , int d>

int Dune::Torus< Communication, d >::ProcListIterator::rank ( ) const

inline

return rank of neighboring process

---

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

• torus.hh