dune-common 2.10
|
Provides classes for syncing distributed indexed data structures. More...
Files | |
file | communicator.hh |
Provides utility classes for syncing distributed data via MPI communication. | |
file | indexset.hh |
Provides a map between global and local indices. | |
file | indicessyncer.hh |
Class for adding missing indices of a distributed index set in a local communication. | |
file | interface.hh |
Provides classes for building the communication interface between remote indices. | |
file | localindex.hh |
Provides classes for use as the local index in ParallelIndexSet. | |
file | plocalindex.hh |
Provides classes for use as the local index in ParallelIndexSet for distributed computing. | |
file | remoteindices.hh |
Classes describing a distributed indexset. | |
file | selection.hh |
Provides classes for selecting indices based on attribute flags. | |
file | variablesizecommunicator.hh |
A communicator that only needs to know the number of elements per index at the sender side. | |
Classes | |
struct | Dune::SizeOne |
Flag for marking indexed data structures where data at each index is of the same size. More... | |
struct | Dune::VariableSize |
Flag for marking indexed data structures where the data at each index may be a variable multiple of another type. More... | |
struct | Dune::CommPolicy< V > |
Default policy used for communicating an indexed type. More... | |
class | Dune::BufferedCommunicator |
A communicator that uses buffers to gather and scatter the data to be send or received. More... | |
class | Dune::IndexPair< TG, TL > |
A pair consisting of a global and local index. More... | |
struct | Dune::MPITraits< T > |
A traits class describing the mapping of types onto MPI_Datatypes. More... | |
class | Dune::InvalidIndexSetState |
Exception indicating that the index set is not in the expected state. More... | |
class | Dune::GlobalLookupIndexSet< I > |
Decorates an index set with the possibility to find a global index that is mapped to a specific local. More... | |
class | Dune::ParallelIndexSet< TG, TL, N > |
Manager class for the mapping between local indices and globally unique indices. More... | |
class | Dune::ParallelIndexSet< TG, TL, N >::iterator |
The iterator over the pairs. More... | |
struct | Dune::LocalIndexComparator< T > |
struct | Dune::IndexSetSortFunctor< TG, TL > |
class | Dune::IndicesSyncer< T > |
Class for recomputing missing indices of a distributed index set. More... | |
class | Dune::Interface |
Communication interface between remote and local indices. More... | |
class | Dune::LocalIndex |
An index present on the local process. More... | |
class | Dune::ParallelLocalIndex< T > |
An index present on the local process with an additional attribute flag. More... | |
struct | Dune::LocalIndexComparator< ParallelLocalIndex< T > > |
class | Dune::MPITraits< ParallelLocalIndex< T > > |
class | Dune::MPITraits< IndexPair< TG, ParallelLocalIndex< TA > > > |
class | Dune::RemoteIndices< T, A > |
The indices present on remote processes. More... | |
class | Dune::RemoteIndex< T1, T2 > |
Information about an index residing on another processor. More... | |
class | Dune::RemoteIndexListModifier< T, A, mode > |
Modifier for adding and/or deleting remote indices from the remote index list. More... | |
class | Dune::CollectiveIterator< T, A > |
A collective iterator for moving over the remote indices for all processes collectively. More... | |
class | Dune::OwnerOverlapCopyCommunication< T1, T2 > |
class | Dune::SelectionIterator< TS, TG, TL, N > |
A const iterator over an uncached selection. More... | |
class | Dune::UncachedSelection< TS, TG, TL, N > |
An uncached selection of indices. More... | |
class | Dune::Selection< TS, TG, TL, N > |
A cached selection of indices. More... | |
class | Dune::VariableSizeCommunicator< Allocator > |
A buffered communicator where the amount of data sent does not have to be known a priori. More... | |
Enumerations | |
enum | Dune::ParallelIndexSetState { Dune::GROUND , Dune::RESIZE } |
The states the index set can be in. More... | |
enum | Dune::LocalIndexState { Dune::VALID , Dune::DELETED } |
The states available for the local indices. More... | |
Functions | |
template<class TG , class TL > | |
std::ostream & | Dune::operator<< (std::ostream &os, const IndexPair< TG, TL > &pair) |
Print an index pair. | |
template<class TG , class TL > | |
bool | Dune::operator== (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator!= (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator< (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator> (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator<= (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator>= (const IndexPair< TG, TL > &a, const IndexPair< TG, TL > &b) |
template<class TG , class TL > | |
bool | Dune::operator== (const IndexPair< TG, TL > &a, const TG &b) |
template<class TG , class TL > | |
bool | Dune::operator!= (const IndexPair< TG, TL > &a, const TG &b) |
template<class TG , class TL > | |
bool | Dune::operator< (const IndexPair< TG, TL > &a, const TG &b) |
template<class TG , class TL > | |
bool | Dune::operator> (const IndexPair< TG, TL > &a, const TG &b) |
template<class TG , class TL > | |
bool | Dune::operator<= (const IndexPair< TG, TL > &a, const TG &b) |
template<class TG , class TL > | |
bool | Dune::operator>= (const IndexPair< TG, TL > &a, const TG &b) |
Dune::IndexPair< TG, TL >::IndexPair (const GlobalIndex &global, const LocalIndex &local) | |
Constructs a new Pair. | |
Dune::IndexPair< TG, TL >::IndexPair () | |
Construct a new Pair. | |
Dune::IndexPair< TG, TL >::IndexPair (const GlobalIndex &global) | |
Constructs a new Pair. | |
const GlobalIndex & | Dune::IndexPair< TG, TL >::global () const |
Get the global index. | |
LocalIndex & | Dune::IndexPair< TG, TL >::local () |
Get the local index. | |
const LocalIndex & | Dune::IndexPair< TG, TL >::local () const |
Get the local index. | |
void | Dune::IndexPair< TG, TL >::setLocal (int index) |
Set the local index. | |
Dune::ParallelIndexSet< TG, TL, N >::iterator::iterator (ParallelIndexSet< TG, TL, N > &indexSet, const Father &father) | |
Dune::ParallelIndexSet< TG, TL, N >::ParallelIndexSet () | |
Constructor. | |
const ParallelIndexSetState & | Dune::ParallelIndexSet< TG, TL, N >::state () |
Get the state the index set is in. | |
void | Dune::ParallelIndexSet< TG, TL, N >::beginResize () |
Indicate that the index set is to be resized. | |
void | Dune::ParallelIndexSet< TG, TL, N >::add (const GlobalIndex &global) |
Add an new index to the set. | |
void | Dune::ParallelIndexSet< TG, TL, N >::add (const GlobalIndex &global, const LocalIndex &local) |
Add an new index to the set. | |
void | Dune::ParallelIndexSet< TG, TL, N >::markAsDeleted (const iterator &position) |
Mark an index as deleted. | |
void | Dune::ParallelIndexSet< TG, TL, N >::endResize () |
Indicate that the resizing finishes. | |
IndexPair & | Dune::ParallelIndexSet< TG, TL, N >::operator[] (const GlobalIndex &global) |
Find the index pair with a specific global id. | |
IndexPair & | Dune::ParallelIndexSet< TG, TL, N >::at (const GlobalIndex &global) |
Find the index pair with a specific global id. | |
bool | Dune::ParallelIndexSet< TG, TL, N >::exists (const GlobalIndex &global) const |
Find the index pair with a specific global id. | |
const IndexPair & | Dune::ParallelIndexSet< TG, TL, N >::operator[] (const GlobalIndex &global) const |
Find the index pair with a specific global id. | |
const IndexPair & | Dune::ParallelIndexSet< TG, TL, N >::at (const GlobalIndex &global) const |
Find the index pair with a specific global id. | |
iterator | Dune::ParallelIndexSet< TG, TL, N >::begin () |
Get an iterator over the indices positioned at the first index. | |
iterator | Dune::ParallelIndexSet< TG, TL, N >::end () |
Get an iterator over the indices positioned after the last index. | |
const_iterator | Dune::ParallelIndexSet< TG, TL, N >::begin () const |
Get an iterator over the indices positioned at the first index. | |
const_iterator | Dune::ParallelIndexSet< TG, TL, N >::end () const |
Get an iterator over the indices positioned after the last index. | |
void | Dune::ParallelIndexSet< TG, TL, N >::renumberLocal () |
Renumbers the local index numbers. | |
int | Dune::ParallelIndexSet< TG, TL, N >::seqNo () const |
Get the internal sequence number. | |
size_t | Dune::ParallelIndexSet< TG, TL, N >::size () const |
Get the total number (public and nonpublic) indices. | |
template<class TG , class TL , int N> | |
std::ostream & | Dune::operator<< (std::ostream &os, const ParallelIndexSet< TG, TL, N > &indexSet) |
Print an index set. | |
Dune::GlobalLookupIndexSet< I >::GlobalLookupIndexSet (const ParallelIndexSet &indexset, std::size_t size) | |
Constructor. | |
Dune::GlobalLookupIndexSet< I >::GlobalLookupIndexSet (const ParallelIndexSet &indexset) | |
Constructor. | |
Dune::GlobalLookupIndexSet< I >::~GlobalLookupIndexSet () | |
Destructor. | |
const IndexPair & | Dune::GlobalLookupIndexSet< I >::operator[] (const GlobalIndex &global) const |
Find the index pair with a specific global id. | |
const IndexPair * | Dune::GlobalLookupIndexSet< I >::pair (const std::size_t &local) const |
Get the index pair corresponding to a local index. | |
const_iterator | Dune::GlobalLookupIndexSet< I >::begin () const |
Get an iterator over the indices positioned at the first index. | |
const_iterator | Dune::GlobalLookupIndexSet< I >::end () const |
Get an iterator over the indices positioned after the last index. | |
int | Dune::GlobalLookupIndexSet< I >::seqNo () const |
Get the internal sequence number. | |
size_t | Dune::GlobalLookupIndexSet< I >::size () const |
Get the total number (public and nonpublic) indices. | |
static bool | Dune::LocalIndexComparator< T >::compare (const T &t1, const T &t2) |
bool | Dune::IndexSetSortFunctor< TG, TL >::operator() (const IndexPair< TG, TL > &i1, const IndexPair< TG, TL > &i2) |
Dune::IndicesSyncer< T >::IndicesSyncer (ParallelIndexSet &indexSet, RemoteIndices &remoteIndices) | |
Constructor. | |
void | Dune::IndicesSyncer< T >::sync () |
Sync the index set. | |
template<typename T1 > | |
void | Dune::IndicesSyncer< T >::sync (T1 &numberer, bool useFixedOrder=false) |
Sync the index set and assign local numbers to new indices. | |
Dune::IndicesSyncer< T >::MessageInformation::MessageInformation () | |
std::size_t | Dune::IndicesSyncer< T >::DefaultNumberer::operator() (const GlobalIndex &global) |
Provide the local index, always std::numeric_limits<size_t>::max() | |
Dune::IndicesSyncer< T >::Iterators::Iterators (RemoteIndexList &remoteIndices, GlobalIndexList &globalIndices, BoolList &booleans) | |
Constructor. | |
Dune::IndicesSyncer< T >::Iterators::Iterators () | |
Default constructor. | |
Iterators & | Dune::IndicesSyncer< T >::Iterators::operator++ () |
Increment all iterators. | |
void | Dune::IndicesSyncer< T >::Iterators::insert (const RemoteIndex &index, const std::pair< GlobalIndex, Attribute > &global) |
Insert a new remote index to the underlying remote index list. | |
RemoteIndex & | Dune::IndicesSyncer< T >::Iterators::remoteIndex () const |
Get the remote index at current position. | |
std::pair< GlobalIndex, Attribute > & | Dune::IndicesSyncer< T >::Iterators::globalIndexPair () const |
Get the global index of the remote index at current position. | |
Attribute & | Dune::IndicesSyncer< T >::Iterators::attribute () const |
bool | Dune::IndicesSyncer< T >::Iterators::isOld () const |
Was this entry already in the remote index list before the sync process? | |
void | Dune::IndicesSyncer< T >::Iterators::reset (RemoteIndexList &remoteIndices, GlobalIndexList &globalIndices, BoolList &booleans) |
Reset all the underlying iterators. | |
bool | Dune::IndicesSyncer< T >::Iterators::isNotAtEnd () const |
Are we not at the end of the list? | |
bool | Dune::IndicesSyncer< T >::Iterators::isAtEnd () const |
Are we at the end of the list? | |
template<typename TG , typename TA > | |
bool | Dune::operator< (const IndexPair< TG, ParallelLocalIndex< TA > > &i1, const std::pair< TG, TA > &i2) |
template<typename TG , typename TA > | |
bool | Dune::operator< (const std::pair< TG, TA > &i1, const IndexPair< TG, ParallelLocalIndex< TA > > &i2) |
template<typename TG , typename TA > | |
bool | Dune::operator== (const IndexPair< TG, ParallelLocalIndex< TA > > &i1, const std::pair< TG, TA > &i2) |
template<typename TG , typename TA > | |
bool | Dune::operator!= (const IndexPair< TG, ParallelLocalIndex< TA > > &i1, const std::pair< TG, TA > &i2) |
template<typename TG , typename TA > | |
bool | Dune::operator== (const std::pair< TG, TA > &i2, const IndexPair< TG, ParallelLocalIndex< TA > > &i1) |
template<typename TG , typename TA > | |
bool | Dune::operator!= (const std::pair< TG, TA > &i2, const IndexPair< TG, ParallelLocalIndex< TA > > &i1) |
template<typename T , typename A , typename A1 > | |
void | Dune::storeGlobalIndicesOfRemoteIndices (std::map< int, SLList< std::pair< typename T::GlobalIndex, typename T::LocalIndex::Attribute >, A > > &globalMap, const RemoteIndices< T, A1 > &remoteIndices) |
Stores the corresponding global indices of the remote index information. | |
template<typename T , typename A , typename A1 > | |
void | Dune::repairLocalIndexPointers (std::map< int, SLList< std::pair< typename T::GlobalIndex, typename T::LocalIndex::Attribute >, A > > &globalMap, RemoteIndices< T, A1 > &remoteIndices, const T &indexSet) |
Repair the pointers to the local indices in the remote indices. | |
template<class T > | |
std::ostream & | Dune::operator<< (std::ostream &os, const ParallelLocalIndex< T > &index) |
Print the local index to a stream. | |
template<typename T > | |
bool | Dune::operator== (const ParallelLocalIndex< T > &p1, const ParallelLocalIndex< T > &p2) |
template<typename T > | |
bool | Dune::operator!= (const ParallelLocalIndex< T > &p1, const ParallelLocalIndex< T > &p2) |
template<typename T1 , typename T2 > | |
std::ostream & | Dune::operator<< (std::ostream &os, const RemoteIndex< T1, T2 > &index) |
template<class T , class A > | |
std::ostream & | Dune::operator<< (std::ostream &os, const RemoteIndices< T, A > &indices) |
template<typename TG , typename TA > | |
std::ostream & | Dune::operator<< (std::ostream &os, const RemoteIndex< TG, TA > &index) |
template<class R , class T1 , class T2 , class Op , bool send> | |
void | Dune::InterfaceBuilder::buildInterface (const R &remoteIndices, const T1 &sourceFlags, const T2 &destFlags, Op &functor) const |
Builds the interface between remote processes. | |
MPI_Comm | Dune::Interface::communicator () const |
Get the MPI Communicator. | |
const InformationMap & | Dune::Interface::interfaces () const |
Get information about the interfaces. | |
InformationMap & | Dune::Interface::interfaces () |
Get information about the interfaces. | |
void | Dune::Interface::print () const |
Print the interface to std::out for debugging. | |
template<typename R , typename T1 , typename T2 > | |
void | Dune::Interface::build (const R &remoteIndices, const T1 &sourceFlags, const T2 &destFlags) |
Builds the interface. | |
void | Dune::Interface::strip () |
void | Dune::Interface::free () |
Frees memory allocated during the build. | |
virtual | Dune::Interface::~Interface () |
Destructor. | |
const std::size_t & | Dune::LocalIndex::local () const |
get the local index. | |
Dune::LocalIndex::operator std::size_t () const | |
Convert to the local index represented by an int. | |
LocalIndex & | Dune::LocalIndex::operator= (std::size_t index) |
Assign a new local index. | |
LocalIndexState | Dune::LocalIndex::state () const |
Get the state. | |
void | Dune::LocalIndex::setState (LocalIndexState state) |
Set the state. | |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex (const Attribute &attribute, bool isPublic) | |
Constructor. | |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex (size_t localIndex, const Attribute &attribute, bool isPublic=true) | |
Constructor. | |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex () | |
Parameterless constructor. | |
const Attribute | Dune::ParallelLocalIndex< T >::attribute () const |
Get the attribute of the index. | |
void | Dune::ParallelLocalIndex< T >::setAttribute (const Attribute &attribute) |
Set the attribute of the index. | |
size_t | Dune::ParallelLocalIndex< T >::local () const |
get the local index. | |
Dune::ParallelLocalIndex< T >::operator size_t () const | |
Convert to the local index represented by an int. | |
ParallelLocalIndex< Attribute > & | Dune::ParallelLocalIndex< T >::operator= (size_t index) |
Assign a new local index. | |
bool | Dune::ParallelLocalIndex< T >::isPublic () const |
Check whether the index might also be known other processes. | |
LocalIndexState | Dune::ParallelLocalIndex< T >::state () const |
Get the state. | |
void | Dune::ParallelLocalIndex< T >::setState (const LocalIndexState &state) |
Set the state. | |
static MPI_Datatype | Dune::MPITraits< ParallelLocalIndex< T > >::getType () |
static MPI_Datatype | Dune::MPITraits< IndexPair< TG, ParallelLocalIndex< TA > > >::getType () |
Dune::RemoteIndex< T1, T2 >::RemoteIndex (const T2 &attribute, const PairType *local) | |
Constructor. | |
Dune::RemoteIndex< T1, T2 >::RemoteIndex (const T2 &attribute) | |
Constructor. Private as it should only be called from within Indexset. | |
Dune::RemoteIndex< T1, T2 >::RemoteIndex () | |
Parameterless Constructor. | |
bool | Dune::RemoteIndex< T1, T2 >::operator== (const RemoteIndex &ri) const |
bool | Dune::RemoteIndex< T1, T2 >::operator!= (const RemoteIndex &ri) const |
const Attribute | Dune::RemoteIndex< T1, T2 >::attribute () const |
Get the attribute of the index on the remote process. | |
const PairType & | Dune::RemoteIndex< T1, T2 >::localIndexPair () const |
Get the corresponding local index pair. | |
Dune::RemoteIndices< T, A >::RemoteIndices (const ParallelIndexSet &source, const ParallelIndexSet &destination, const MPI_Comm &comm, const std::vector< int > &neighbours=std::vector< int >(), bool includeSelf=false) | |
Constructor. | |
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. | |
Dune::RemoteIndices< T, A >::RemoteIndices () | |
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. | |
const ParallelIndexSet & | Dune::RemoteIndices< T, A >::sourceIndexSet () const |
Get the index set at the source. | |
const ParallelIndexSet & | Dune::RemoteIndices< T, A >::destinationIndexSet () const |
Get the index set at destination. | |
Dune::RemoteIndices< T, A >::~RemoteIndices () | |
Destructor. | |
template<bool ignorePublic> | |
void | Dune::RemoteIndices< T, A >::packEntries (IndexPair< GlobalIndex, LocalIndex > **pairs, const ParallelIndexSet &indexSet, char *p_out, MPI_Datatype type, int bufferSize, int *position, int n) |
void | Dune::RemoteIndices< T, A >::free () |
Free the index lists. | |
int | Dune::RemoteIndices< T, A >::neighbours () const |
Get the number of processors we share indices with. | |
template<bool ignorePublic> | |
void | Dune::RemoteIndices< T, A >::rebuild () |
Rebuilds the set of remote indices. | |
bool | Dune::RemoteIndices< T, A >::isSynced () const |
Checks whether the remote indices are synced with the indexsets. | |
template<bool mode, bool send> | |
RemoteIndexListModifier< T, A, mode > | Dune::RemoteIndices< T, A >::getModifier (int process) |
Get a modifier for a remote index list. | |
const_iterator | Dune::RemoteIndices< T, A >::find (int proc) const |
Find an iterator over the remote index lists of a specific process. | |
const_iterator | Dune::RemoteIndices< T, A >::begin () const |
Get an iterator over all remote index lists. | |
const_iterator | Dune::RemoteIndices< T, A >::end () const |
Get an iterator over all remote index lists. | |
bool | Dune::RemoteIndices< T, A >::operator== (const RemoteIndices &ri) const |
Dune::RemoteIndexListModifier< T, A, mode >::RemoteIndexListModifier (const RemoteIndexListModifier &) | |
void | Dune::RemoteIndexListModifier< T, A, mode >::repairLocalIndexPointers () |
Repair the pointers to the local index pairs. | |
void | Dune::RemoteIndexListModifier< T, A, mode >::insert (const RemoteIndex &index) |
Insert an index to the list. | |
void | Dune::RemoteIndexListModifier< T, A, mode >::insert (const RemoteIndex &index, const GlobalIndex &global) |
Insert an index to the list. | |
bool | Dune::RemoteIndexListModifier< T, A, mode >::remove (const GlobalIndex &global) |
Remove a remote index. | |
template<bool send> | |
CollectiveIteratorT | Dune::RemoteIndices< T, A >::iterator () const |
Get an iterator for collectively iterating over the remote indices of all remote processes. | |
MPI_Comm | Dune::RemoteIndices< T, A >::communicator () const |
Get the mpi communicator used. | |
Dune::CollectiveIterator< T, A >::CollectiveIterator (const RemoteIndexMap &map_, bool send) | |
Constructor. | |
void | Dune::CollectiveIterator< T, A >::advance (const GlobalIndex &global) |
Advances all underlying iterators. | |
void | Dune::CollectiveIterator< T, A >::advance (const GlobalIndex &global, const Attribute &attribute) |
Advances all underlying iterators. | |
CollectiveIterator & | Dune::CollectiveIterator< T, A >::operator++ () |
bool | Dune::CollectiveIterator< T, A >::empty () const |
Checks whether there are still iterators in the map. | |
iterator | Dune::CollectiveIterator< T, A >::begin () |
iterator | Dune::CollectiveIterator< T, A >::end () |
void | Dune::Selection< TS, TG, TL, N >::setIndexSet (const ParallelIndexSet &indexset) |
Set the index set of the selection. | |
const_iterator | Dune::Selection< TS, TG, TL, N >::begin () const |
Get the index set we are a selection for. | |
const_iterator | Dune::Selection< TS, TG, TL, N >::end () const |
Get an iterator over the selected indices. | |
void | Dune::Selection< TS, TG, TL, N >::free () |
Free allocated memory. | |
Dune::Selection< TS, TG, TL, N >::~Selection () | |
const_iterator | Dune::UncachedSelection< TS, TG, TL, N >::begin () const |
Get the index set we are a selection for. | |
const_iterator | Dune::UncachedSelection< TS, TG, TL, N >::end () const |
Get an iterator over the selected indices. | |
void | Dune::UncachedSelection< TS, TG, TL, N >::setIndexSet (const ParallelIndexSet &indexset) |
Set the index set of the selection. | |
Variables | |
static constexpr int | Dune::ParallelIndexSet< TG, TL, N >::arraySize = (N>0) ? N : 1 |
The size of the individual arrays in the underlying ArrayList. | |
int | Dune::IndicesSyncer< T >::MessageInformation::publish |
The number of indices we publish for the other process. | |
int | Dune::IndicesSyncer< T >::MessageInformation::pairs |
The number of pairs (attribute and process number) we publish to the neighbour process. | |
Provides classes for syncing distributed indexed data structures.
In a parallel representation a container
Form an abstract point of view a random access container
This means that for the local computation the data must be addressable by a consecutive index starting from
For the communication phases of our algorithms these locally stored entries must also be addressable by a global identifier to be able to store the received values tagged with the global identifiers at the correct local index in the consecutive local memory chunk. To ease the addition and removal of discretisation points this global identifier has to be persistent. Further on we will call this global identifier global index.
Classes to build the mapping are ParallelIndexSet and ParallelLocalIndex. As these just provide a mapping from the global index to the local index, the wrapper class GlobalLookupIndexSet facilitates the reverse lookup.
To setup communication between the processes every process needs to know what indices are also known to other processes and what attributes are attached to them on the remote side. This information is calculated and encapsulated in class RemoteIndices.
Based on the information about the distributed index sets, data independent interfaces between different sets of the index sets can be setup using the class Interface. For the actual communication data dependent communicators can be setup using BufferedCommunicator, DatatypeCommunicator VariableSizeCommunicator based on the interface information. In contrast to the former the latter is independent of the class Interface which can work on a map from process number to a pair of index lists describing which local indices are sent and received from that process.
ParallelIndexSet::LocalIndex::Attribute Dune::IndicesSyncer< T >::Attribute |
Type of the attribute used in the index set.
ParallelIndexSet::const_iterator Dune::GlobalLookupIndexSet< I >::const_iterator |
The iterator over the index pairs.
ArrayList<IndexPair,N>::const_iterator Dune::ParallelIndexSet< TG, TL, N >::const_iterator |
The constant iterator over the pairs.
ParallelIndexSet::GlobalIndex Dune::GlobalLookupIndexSet< I >::GlobalIndex |
The type of the global index.
TG Dune::IndexPair< TG, TL >::GlobalIndex |
the type of the global index.
This type has to provide at least a operator< for sorting.
ParallelIndexSet::GlobalIndex Dune::IndicesSyncer< T >::GlobalIndex |
Type of the global index used in the index set.
TG Dune::ParallelIndexSet< TG, TL, N >::GlobalIndex |
the type of the global index. This type has to provide at least a operator< for sorting.
Dune::IndexPair<typename I::GlobalIndex, typename I::LocalIndex> Dune::GlobalLookupIndexSet< I >::IndexPair |
ParallelIndexSet::IndexPair Dune::IndicesSyncer< T >::IndexPair |
The type of the index pair.
Dune::IndexPair<GlobalIndex,LocalIndex> Dune::ParallelIndexSet< TG, TL, N >::IndexPair |
The type of the pair stored.
ParallelIndexSet::LocalIndex Dune::GlobalLookupIndexSet< I >::LocalIndex |
The type of the local index.
TL Dune::IndexPair< TG, TL >::LocalIndex |
the type of the local index.
This class to provide the following functions:
TL Dune::ParallelIndexSet< TG, TL, N >::LocalIndex |
The type of the local index, e.g. ParallelLocalIndex.
This class to provide the following functions:
I Dune::GlobalLookupIndexSet< I >::ParallelIndexSet |
The type of the index set.
T Dune::IndicesSyncer< T >::ParallelIndexSet |
The type of the index set.
Dune::RemoteIndices<ParallelIndexSet> Dune::IndicesSyncer< T >::RemoteIndices |
Type of the remote indices.
The states the index set can be in.
|
inline |
Add an new index to the set.
The local index is created by the default constructor.
global | The globally unique id of the index. |
InvalidState | If index set is not in ParallelIndexSetState::RESIZE mode. |
|
inline |
Add an new index to the set.
global | The globally unique id of the index. |
local | The local index. |
InvalidState | If index set is not in ParallelIndexSetState::RESIZE mode. |
|
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.
global | The index we search for. |
|
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.
global | The index we search for. |
attribute | The attribute we search for. |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N).
global | The globally unique id of the pair. |
RangeError | Thrown if the global id is not known. |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N).
global | The globally unique id of the pair. |
RangeError | Thrown if the global id is not known. |
Attribute & Dune::IndicesSyncer< T >::Iterators::attribute | ( | ) | const |
|
inline |
Get the attribute of the index.
|
inline |
Get the attribute of the index on the remote process.
|
inline |
|
inline |
Get an iterator over the indices positioned at the first index.
|
inline |
Get an iterator over the indices positioned at the first index.
|
inline |
Get an iterator over the indices positioned at the first index.
|
inline |
Get an iterator over all remote index lists.
uint32_t * Dune::Selection< TS, TG, TL, N >::begin | ( | ) | const |
Get the index set we are a selection for.
Get an iterator over the selected indices.
SelectionIterator< TS, TG, TL, N > Dune::UncachedSelection< TS, TG, TL, N >::begin | ( | ) | const |
Get the index set we are a selection for.
Get an iterator over the selected indices.
void Dune::ParallelIndexSet< TG, TL, N >::beginResize | ( | ) |
Indicate that the index set is to be resized.
InvalidState | If index set was not in ParallelIndexSetState::GROUND mode. |
|
inline |
Builds the interface.
The types T1 and T2 are classes representing a set of enumeration values of type Interface::Attribute. They have to provide a (static) method
for checking whether the set contains a specific flag. This functionality is for example provided the classes EnumItem, EnumRange and Combine.
remoteIndices | The indices known to remote processes. |
sourceFlags | The set of flags marking indices we send from. |
destFlags | The set of flags marking indices we receive for. |
|
protected |
Builds the interface between remote processes.
The types T1 and T2 are classes representing a set of enumeration values of type InterfaceBuilder::Attribute. They have to provide a (static) method
for checking whether the set contains a specific flag. This functionality is for example provided the classes EnumItem, EnumRange and Combine.
If the template parameter send is true the sending side of the interface will be built, otherwise the information for receiving will be built.
If the template parameter send is true we create interface for sending in a forward communication.
remoteIndices | The indices known to remote processes. |
sourceFlags | The set of flags marking source indices. |
destFlags | The setof flags markig destination indices. |
functor | A functor for callbacks. It should provide the following methods: // Reserve memory for the interface to processor proc. The interface
// has to hold size entries
// Add an entry to the interface
// We will send/receive size entries at index local to process proc
void add(int proc, int local);
constexpr std::integral_constant< std::size_t, sizeof...(II)> size(std::integer_sequence< T, II... >) Return the size of the sequence. Definition integersequence.hh:75 |
|
inline |
Constructor.
map_ | The map of the remote indices. |
send | True if we want iterate over the remote indices used for sending. |
|
inline |
Get the MPI Communicator.
|
inline |
Get the mpi communicator used.
|
inlinestatic |
|
inline |
Get the index set at destination.
|
inline |
Checks whether there are still iterators in the map.
|
inline |
|
inline |
Get an iterator over the indices positioned after the last index.
|
inline |
Get an iterator over the indices positioned after the last index.
|
inline |
Get an iterator over the indices positioned after the last index.
|
inline |
Get an iterator over all remote index lists.
uint32_t * Dune::Selection< TS, TG, TL, N >::end | ( | ) | const |
Get an iterator over the selected indices.
SelectionIterator< TS, TG, TL, N > Dune::UncachedSelection< TS, TG, TL, N >::end | ( | ) | const |
Get an iterator over the selected indices.
void Dune::ParallelIndexSet< TG, TL, N >::endResize | ( | ) |
Indicate that the resizing finishes.
InvalidState | If index set was not in ParallelIndexSetState::RESIZE mode. |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N).
global | The globally unique id of the pair. |
RangeError | Thrown if the global id is not known. |
|
inline |
Find an iterator over the remote index lists of a specific process.
proc | The identifier of the process. |
|
inline |
Frees memory allocated during the build.
|
inline |
Free the index lists.
|
inline |
Free allocated memory.
|
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. |
|
inlinestatic |
|
static |
|
inline |
Get the global index.
|
inline |
Get the global index of the remote index at current position.
Dune::GlobalLookupIndexSet< I >::GlobalLookupIndexSet | ( | const ParallelIndexSet & | indexset | ) |
Constructor.
indexset | The index set we want to be able to lookup the corresponding global index of a local index. |
Dune::GlobalLookupIndexSet< I >::GlobalLookupIndexSet | ( | const ParallelIndexSet & | indexset, |
std::size_t | size ) |
Constructor.
indexset | The index set we want to be able to lookup the corresponding global index of a local index. |
size | The number of indices present, i.e. one more than the maximum local index. |
Dune::IndexPair< TG, TL >::IndexPair | ( | ) |
Construct a new Pair.
Dune::IndexPair< TG, TL >::IndexPair | ( | const GlobalIndex & | global | ) |
Constructs a new Pair.
The local index will be 0.
global | The global index. |
Dune::IndexPair< TG, TL >::IndexPair | ( | const GlobalIndex & | global, |
const LocalIndex & | local ) |
Constructs a new Pair.
global | The global index. |
local | The local index. |
Dune::IndicesSyncer< T >::IndicesSyncer | ( | ParallelIndexSet & | indexSet, |
RemoteIndices & | remoteIndices ) |
Constructor.
The source as well as the target index set of the remote indices have to be the same as the provided index set.
indexSet | The index set with the information of the locally present indices. |
remoteIndices | The remoteIndices. |
|
inline |
Insert a new remote index to the underlying remote index list.
index | The remote index. |
global | The global index corresponding to the remote index. |
|
inline |
Insert an index to the list.
Moves to the position where the index fits and inserts it. After the insertion only indices with an bigger global index than the inserted can be inserted.
This method is only available if MODIFYINDEXSET is false.
index | The index to insert. |
InvalidPosition | Thrown if the index at the current position or the one before has bigger global index than the one to be inserted. |
|
inline |
Insert an index to the list.
Moves to the position where the index fits and inserts it. After the insertion only indices with an bigger global index than the inserted can be inserted.
This method is only available if MODIFYINDEXSET is true.
index | The index to insert. |
global | The global index of the remote index. |
InvalidPosition | Thrown if the index at the current position or the one before has bigger global index than the one to be inserted. |
|
inlineprotected |
Get information about the interfaces.
|
inline |
Get information about the interfaces.
|
inline |
Are we at the end of the list?
|
inline |
Are we not at the end of the list?
|
inline |
Was this entry already in the remote index list before the sync process?
|
inline |
Check whether the index might also be known other processes.
|
inline |
Checks whether the remote indices are synced with the indexsets.
If they are not synced the remote indices need to be rebuild.
|
inline |
|
inline |
Get an iterator for collectively iterating over the remote indices of all remote processes.
Dune::IndicesSyncer< T >::Iterators::Iterators | ( | ) |
Default constructor.
Dune::IndicesSyncer< T >::Iterators::Iterators | ( | RemoteIndexList & | remoteIndices, |
GlobalIndexList & | globalIndices, | ||
BoolList & | booleans ) |
Constructor.
Initializes all iterator to first entry and the one before the first entry, respectively.
remoteIndices | The list of the remote indices. |
globalIndices | The list of the corresponding global indices. This is needed because the the pointers to the local index will become invalid due to the merging of the index sets. |
booleans | Whether the remote index was there before the sync process started. |
|
inline |
Get the local index.
|
inline |
Get the local index.
|
inline |
get the local index.
|
inline |
get the local index.
|
inline |
Get the corresponding local index pair.
|
inline |
Mark an index as deleted.
The index will be deleted during endResize().
position | An iterator at the position we want to delete. |
InvalidState | If index set is not in ParallelIndexSetState::RESIZE mode. |
|
inline |
|
inline |
Get the number of processors we share indices with.
|
inline |
Convert to the local index represented by an int.
|
inline |
Convert to the local index represented by an int.
bool Dune::operator!= | ( | const IndexPair< TG, ParallelLocalIndex< TA > > & | i1, |
const std::pair< TG, TA > & | i2 ) |
|
inline |
|
inline |
bool Dune::operator!= | ( | const ParallelLocalIndex< T > & | p1, |
const ParallelLocalIndex< T > & | p2 ) |
bool Dune::operator!= | ( | const std::pair< TG, TA > & | i2, |
const IndexPair< TG, ParallelLocalIndex< TA > > & | i1 ) |
|
inline |
|
inline |
|
inline |
Provide the local index, always std::numeric_limits<size_t>::max()
global | The global index (ignored). |
|
inline |
|
inline |
Increment all iterators.
bool Dune::operator< | ( | const IndexPair< TG, ParallelLocalIndex< TA > > & | i1, |
const std::pair< TG, TA > & | i2 ) |
|
inline |
|
inline |
bool Dune::operator< | ( | const std::pair< TG, TA > & | i1, |
const IndexPair< TG, ParallelLocalIndex< TA > > & | i2 ) |
|
inline |
Print an index pair.
os | The outputstream to print to. |
pair | The index pair to print. |
|
inline |
Print an index set.
os | The outputstream to print to. |
indexSet | The index set to print. |
std::ostream & Dune::operator<< | ( | std::ostream & | os, |
const ParallelLocalIndex< T > & | index ) |
Print the local index to a stream.
os | The output stream to print to. |
index | The index to print. |
std::ostream & Dune::operator<< | ( | std::ostream & | os, |
const RemoteIndex< T1, T2 > & | index ) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Assign a new local index.
index | The new local index. |
|
inline |
Assign a new local index.
index | The new local index. |
bool Dune::operator== | ( | const IndexPair< TG, ParallelLocalIndex< TA > > & | i1, |
const std::pair< TG, TA > & | i2 ) |
|
inline |
|
inline |
bool Dune::operator== | ( | const ParallelLocalIndex< T > & | p1, |
const ParallelLocalIndex< T > & | p2 ) |
bool Dune::operator== | ( | const std::pair< TG, TA > & | i2, |
const IndexPair< TG, ParallelLocalIndex< TA > > & | i1 ) |
|
inline |
bool Dune::RemoteIndices< T, A >::operator== | ( | const RemoteIndices< T, A > & | ri | ) | const |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N). This method is forwarded to the underlying index set.
global | The globally unique id of the pair. |
RangeError | Thrown if the global id is not known. |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N).
global | The globally unique id of the pair. |
|
inline |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefore has complexity log(N).
global | The globally unique id of the pair. |
|
inline |
|
inline |
Get the index pair corresponding to a local index.
Dune::ParallelIndexSet< TG, TL, N >::ParallelIndexSet | ( | ) |
Constructor.
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | ) |
Parameterless constructor.
Needed for use in container classes.
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | const Attribute & | attribute, |
bool | isPublic ) |
Constructor.
The local index will be initialized to 0.
attribute | The attribute of the index. |
isPublic | True if the index might also be known to other processes. |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | size_t | localIndex, |
const Attribute & | attribute, | ||
bool | isPublic = true ) |
Constructor.
localIndex | The local index. |
attribute | The attribute of the index. |
isPublic | True if the index might also be known to other processes. |
|
inline |
Print the interface to std::out for debugging.
|
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.
Dune::RemoteIndex< T1, T2 >::RemoteIndex | ( | ) |
Parameterless Constructor.
Dune::RemoteIndex< T1, T2 >::RemoteIndex | ( | const T2 & | attribute | ) |
Constructor. Private as it should only be called from within Indexset.
attribute | The attribute of the index on the remote processor. |
Dune::RemoteIndex< T1, T2 >::RemoteIndex | ( | const T2 & | attribute, |
const PairType * | local ) |
Constructor.
attribute | The attribute of the index on the remote processor. |
local | The corresponding local index. |
|
inline |
Get the remote index at current position.
Dune::RemoteIndexListModifier< T, A, mode >::RemoteIndexListModifier | ( | const RemoteIndexListModifier< T, A, mode > & | other | ) |
Dune::RemoteIndices< T, A >::RemoteIndices | ( | ) |
|
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. |
bool Dune::RemoteIndexListModifier< T, A, mode >::remove | ( | const GlobalIndex & | global | ) |
Remove a remote index.
global | The global index corresponding to the remote index. |
InvalidPostion | If there was an insertion or deletion of a remote index corresponding to a bigger global index before. |
|
inline |
Renumbers the local index numbers.
After this function returns the indices are consecutively numbered beginning from 0. Let $(g_i,l_i)$, $(g_j,l_j)$ be two arbitrary index pairs with $g_i<g_j$ then after renumbering $l_i<l_j$ will hold.
|
inline |
Repair the pointers to the local index pairs.
Due to adding new indices or/and deleting indices in the index set all pointers to the local index pair might become invalid during ParallelIndexSet::endResize(). This method repairs them.
InvalidIndexSetState | Thrown if the underlying index set is not in ParallelIndexSetState::GROUND mode (only when compiled with DUNE_ISTL_WITH_CHECKING!). |
|
inline |
Repair the pointers to the local indices in the remote indices.
globalMap | The map of the process number to the list of global indices corresponding to the remote index list of the process. |
remoteIndices | The known remote indices. |
indexSet | The set of local indices of the current process. |
|
inline |
Reset all the underlying iterators.
Position them to first list entry and the entry before the first entry respectively.
remoteIndices | The list of the remote indices. |
globalIndices | The list of the corresponding global indices. This is needed because the the pointers to the local index will become invalid due to the merging of the index sets. |
booleans | Whether the remote index was there before the sync process started. |
|
inline |
Get the internal sequence number.
Is initially 0 is incremented for each resize.
|
inline |
Get the internal sequence number.
Is initially 0 is incremented for each resize.
|
inline |
Set the attribute of the index.
attribute | The associated attribute. |
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. |
|
inline |
Set the index set of the selection.
indexset | The index set to use. |
void Dune::UncachedSelection< TS, TG, TL, N >::setIndexSet | ( | const ParallelIndexSet & | indexset | ) |
Set the index set of the selection.
indexset | The index set to use. |
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 |
Set the local index.
index | The index to set it to. |
|
inline |
Set the state.
state | The state to set. |
|
inline |
Set the state.
state | The state to set. |
|
inline |
Get the total number (public and nonpublic) indices.
|
inline |
Get the total number (public and nonpublic) indices.
|
inline |
Get the index set at the source.
|
inline |
Get the state.
|
inline |
Get the state the index set is in.
|
inline |
Get the state.
void Dune::storeGlobalIndicesOfRemoteIndices | ( | std::map< int, SLList< std::pair< typename T::GlobalIndex, typename T::LocalIndex::Attribute >, A > > & | globalMap, |
const RemoteIndices< T, A1 > & | remoteIndices ) |
Stores the corresponding global indices of the remote index information.
Whenever a ParallelIndexSet is resized all RemoteIndices that use it will be invalided as the pointers to the index set are invalid after calling ParallelIndexSet::Resize() One can rebuild them by storing the global indices in a map with this function and later repairing the pointers by calling repairLocalIndexPointers.
globalMap | Map to store the corresponding global indices in. |
remoteIndices | The remote index information we need to store the corresponding global indices of. |
indexSet | The index set that is for both the sending and receiving side of the remote index information. |
|
inline |
|
inline |
Sync the index set.
Computes the missing indices in the local and the remote index list and adds them. No global communication is necessary! All indices added to the index will become the local index std::numeric_limits<size_t>::max()
void Dune::IndicesSyncer< T >::sync | ( | T1 & | numberer, |
bool | useFixedOrder = false ) |
Sync the index set and assign local numbers to new indices.
Computes the missing indices in the local and the remote index list and adds them. No global communication is necessary!
numberer | Functor providing the local indices for the added global indices. has to provide a function size_t operator()(const TG& global) that provides the local index to a global one. It will be called for ascending global indices. |
useFixedOrder | Flag indicating if the new indices should be created in a fixed order. If set to true, this makes the runs reproducible but might slow down performance. |
Dune::GlobalLookupIndexSet< I >::~GlobalLookupIndexSet | ( | ) |
Destructor.
|
inlinevirtual |
Destructor.
Dune::RemoteIndices< T, A >::~RemoteIndices | ( | ) |
Destructor.
|
inline |
|
staticconstexpr |
The size of the individual arrays in the underlying ArrayList.
The default value is 100.
int Dune::IndicesSyncer< T >::MessageInformation::pairs |
The number of pairs (attribute and process number) we publish to the neighbour process.
int Dune::IndicesSyncer< T >::MessageInformation::publish |
The number of indices we publish for the other process.