Dune Core Modules (2.6.0)

A collective iterator for moving over the remote indices for all processes collectively. More...

#include <dune/common/parallel/remoteindices.hh>

Classes

class  iterator
 Iterator over the valid underlying iterators. More...
 

Public Types

typedef std::map< int, std::pair< RemoteIndexList *, RemoteIndexList * > > RemoteIndexMap
 The type of the map from rank to remote index list.
 

Public Member Functions

 CollectiveIterator (const RemoteIndexMap &map_, bool send)
 Constructor. More...
 
void advance (const GlobalIndex &global)
 Advances all underlying iterators. More...
 
void advance (const GlobalIndex &global, const Attribute &attribute)
 Advances all underlying iterators. More...
 
bool empty ()
 Checks whether there are still iterators in the map.
 

Detailed Description

template<class T, class A>
class Dune::CollectiveIterator< T, A >

A collective iterator for moving over the remote indices for all processes collectively.

Constructor & Destructor Documentation

◆ CollectiveIterator()

template<typename T , typename A >
Dune::CollectiveIterator< T, A >::CollectiveIterator ( const RemoteIndexMap map_,
bool  send 
)
inline

Constructor.

Parameters
map_The map of the remote indices.
sendTrue if we want iterate over the remote indices used for sending.

References Dune::SLList< T, A >::begin(), and Dune::SLList< T, A >::end().

Member Function Documentation

◆ advance() [1/2]

template<typename T , typename A >
void Dune::CollectiveIterator< T, A >::advance ( const GlobalIndex &  global)
inline

Advances all underlying iterators.

All iterators are advanced until they point to a remote index whose global id is bigger or equal to global. Iterators pointing to their end are removed.

Parameters
globalThe index we search for.

◆ advance() [2/2]

template<typename T , typename A >
void Dune::CollectiveIterator< T, A >::advance ( const GlobalIndex &  global,
const Attribute &  attribute 
)
inline

Advances all underlying iterators.

All iterators are advanced until they point to a remote index whose global id is bigger or equal to global. Iterators pointing to their end are removed.

Parameters
globalThe index we search for.
attributeThe attribute we search for.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)