dune-common 2.9.0
|
The indices present on remote processes. More...
#include <dune/common/parallel/remoteindices.hh>
Public Types | |
typedef T | ParallelIndexSet |
Type of the index set we use, e.g. ParallelLocalIndexSet. | |
typedef CollectiveIterator< T, A > | CollectiveIteratorT |
The type of the collective iterator over all remote indices. | |
typedef ParallelIndexSet::GlobalIndex | GlobalIndex |
The type of the global index. | |
typedef ParallelIndexSet::LocalIndex | LocalIndex |
The type of the local index. | |
typedef LocalIndex::Attribute | Attribute |
The type of the attribute. | |
typedef Dune::RemoteIndex< GlobalIndex, Attribute > | RemoteIndex |
Type of the remote indices we manage. | |
using | Allocator = typename std::allocator_traits< A >::template rebind_alloc< RemoteIndex > |
The type of the allocator for the remote index list. | |
typedef Dune::SLList< RemoteIndex, Allocator > | RemoteIndexList |
The type of the remote index list. | |
typedef std::map< int, std::pair< RemoteIndexList *, RemoteIndexList * > > | RemoteIndexMap |
The type of the map from rank to remote index list. | |
typedef RemoteIndexMap::const_iterator | const_iterator |
Public Member Functions | |
RemoteIndices (const ParallelIndexSet &source, const ParallelIndexSet &destination, const MPI_Comm &comm, const std::vector< int > &neighbours=std::vector< int >(), bool includeSelf=false) | |
Constructor. | |
RemoteIndices () | |
void | setIncludeSelf (bool includeSelf) |
Tell whether sending from indices of the processor to other indices on the same processor is enabled even if the same indexset is used on both the sending and receiving side. | |
void | setIndexSets (const ParallelIndexSet &source, const ParallelIndexSet &destination, const MPI_Comm &comm, const std::vector< int > &neighbours=std::vector< int >()) |
Set the index sets and communicator we work with. | |
template<typename C > | |
void | setNeighbours (const C &neighbours) |
const std::set< int > & | getNeighbours () const |
~RemoteIndices () | |
Destructor. | |
template<bool ignorePublic> | |
void | rebuild () |
Rebuilds the set of remote indices. | |
bool | operator== (const RemoteIndices &ri) const |
bool | isSynced () const |
Checks whether the remote indices are synced with the indexsets. | |
MPI_Comm | communicator () const |
Get the mpi communicator used. | |
template<bool mode, bool send> | |
RemoteIndexListModifier< T, A, mode > | getModifier (int process) |
Get a modifier for a remote index list. | |
const_iterator | find (int proc) const |
Find an iterator over the remote index lists of a specific process. | |
const_iterator | begin () const |
Get an iterator over all remote index lists. | |
const_iterator | end () const |
Get an iterator over all remote index lists. | |
template<bool send> | |
CollectiveIteratorT | iterator () const |
Get an iterator for colletively iterating over the remote indices of all remote processes. | |
void | free () |
Free the index lists. | |
int | neighbours () const |
Get the number of processors we share indices with. | |
const ParallelIndexSet & | sourceIndexSet () const |
Get the index set at the source. | |
const ParallelIndexSet & | destinationIndexSet () const |
Get the index set at destination. | |
template<bool ignorePublic> | |
void | packEntries (IndexPair< GlobalIndex, LocalIndex > **pairs, const ParallelIndexSet &indexSet, char *p_out, MPI_Datatype type, int bufferSize, int *position, int n) |
The indices present on remote processes.
To set up communication between the set of processes active in the communication every process needs to know which indices are also known to other processes and which attributes are attached to them on the remote side.
This information is managed by this class. The information can either be computed automatically calling rebuild (which requires information to be sent in a ring) or set up by hand using the RemoteIndexListModifiers returned by function getModifier(int).
T | The type of the underlying index set. |
A | The type of the allocator to use. |
using Dune::RemoteIndices< T, A >::Allocator = typename std::allocator_traits<A>::template rebind_alloc<RemoteIndex> |
The type of the allocator for the remote index list.
typedef LocalIndex::Attribute Dune::RemoteIndices< T, A >::Attribute |
The type of the attribute.
typedef CollectiveIterator<T,A> Dune::RemoteIndices< T, A >::CollectiveIteratorT |
The type of the collective iterator over all remote indices.
typedef RemoteIndexMap::const_iterator Dune::RemoteIndices< T, A >::const_iterator |
typedef ParallelIndexSet::GlobalIndex Dune::RemoteIndices< T, A >::GlobalIndex |
The type of the global index.
typedef ParallelIndexSet::LocalIndex Dune::RemoteIndices< T, A >::LocalIndex |
The type of the local index.
typedef T Dune::RemoteIndices< T, A >::ParallelIndexSet |
Type of the index set we use, e.g. ParallelLocalIndexSet.
typedef Dune::RemoteIndex<GlobalIndex,Attribute> Dune::RemoteIndices< T, A >::RemoteIndex |
Type of the remote indices we manage.
typedef Dune::SLList<RemoteIndex,Allocator> Dune::RemoteIndices< T, A >::RemoteIndexList |
The type of the remote index list.
typedef std::map<int, std::pair<RemoteIndexList*,RemoteIndexList*> > Dune::RemoteIndices< T, A >::RemoteIndexMap |
The type of the map from rank to remote index list.
|
inline |
Constructor.
comm | The communicator to use. |
source | The indexset which represents the global to local mapping at the source of the communication |
destination | The indexset to which the communication which represents the global to local mapping at the destination of the communication. May be the same as the source indexset. |
neighbours | Optional: The neighbours the process shares indices with. If this parameter is omitted a ring communication with all indices will take place to calculate this information which is O(P). |
includeSelf | If true, sending from indices of the processor to other indices on the same processor is enabled even if the same indexset is used on both the sending and receiving side. |
Dune::RemoteIndices< T, A >::RemoteIndices | ( | ) |
Dune::RemoteIndices< T, A >::~RemoteIndices | ( | ) |
Destructor.
|
inline |
Get an iterator over all remote index lists.
|
inline |
Get the mpi communicator used.
|
inline |
Get the index set at destination.
|
inline |
Get an iterator over all remote index lists.
|
inline |
Find an iterator over the remote index lists of a specific process.
proc | The identifier of the process. |
|
inline |
Free the index lists.
|
inline |
Get a modifier for a remote index list.
Sometimes the user knows in advance which indices will be present on other processors, too. Then he can set them up using this modifier.
mode | If true the index set corresponding to the remote indices might get modified. Therefore the internal pointers to the indices need to be repaired. |
send | If true the remote index information at the sending side will be modified, if false the receiving side. |
|
inline |
|
inline |
Checks whether the remote indices are synced with the indexsets.
If they are not synced the remote indices need to be rebuild.
|
inline |
Get an iterator for colletively iterating over the remote indices of all remote processes.
|
inline |
Get the number of processors we share indices with.
bool Dune::RemoteIndices< T, A >::operator== | ( | const RemoteIndices< T, A > & | ri | ) | const |
|
inline |
|
inline |
Rebuilds the set of remote indices.
This has to be called whenever the underlying index sets change.
If the template parameter ignorePublic is true all indices will be treated as public.
void Dune::RemoteIndices< T, A >::setIncludeSelf | ( | bool | includeSelf | ) |
Tell whether sending from indices of the processor to other indices on the same processor is enabled even if the same indexset is used on both the sending and receiving side.
includeSelf | If true it is enabled. |
void Dune::RemoteIndices< T, A >::setIndexSets | ( | const ParallelIndexSet & | source, |
const ParallelIndexSet & | destination, | ||
const MPI_Comm & | comm, | ||
const std::vector< int > & | neighbours = std::vector<int>() |
||
) |
Set the index sets and communicator we work with.
comm | The communicator to use. |
source | The indexset which represents the global to local mapping at the source of the communication |
destination | The indexset to which the communication which represents the global to local mapping at the destination of the communication. May be the same as the source indexset. |
neighbours | Optional: The neighbours the process shares indices with. If this parameter is omitted a ring communication with all indices will take place to calculate this information which is O(P). |
|
inline |
|
inline |
Get the index set at the source.