In a parallel representation a container , e.g. a plain C-array, cannot be stored with all entries on each process because of limited memory and efficiency reasons. Therefore it is represented by individual pieces
,
, where
is the piece stored on process
of the
processes participating in the calculation. Although the global representation of the container is not available on any process, a process
needs to know how the entries of it's local piece
correspond to the entries of the global container
, which would be used in a sequential program. In this module we present classes describing the mapping of the local pieces to the global view and the communication interfaces.
This means that for the local computation the data must be addressable by a consecutive index starting from . When using adaptive discretisation methods there might be the need to reorder the indices after adding and/or deleting some of the discretisation points. Therefore this index does not have to be persistent. Further on we will call this index local index.
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.
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 inidices. | ||||
file | localindex.hh | |||
Provides classes for use as the local index in ParallelIndexSet. | ||||
file | owneroverlapcopy.hh | |||
Classes providing communication interfaces for overlapping Schwarz methods. | ||||
file | plocalindex.hh | |||
Provides classes for use as the local index in ParallelIndexSet for distributed computing. | ||||
file | remoteindices.hh | |||
Classes discribing a distributed indexset. | ||||
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< T > | |||
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... | ||||
class | Dune::InvalidIndexSetState | |||
Exception indicating that the index set is not in the expected state. 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... | ||||
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::IndicesSyncer< T > | |||
Class for recomputing missing indices of a distributed index set. More... | ||||
class | Dune::Interface< T > | |||
Communication interface between remote and local indices. More... | ||||
class | Dune::LocalIndex | |||
An index present on the local process. More... | ||||
class | Dune::MPITraits< T > | |||
A traits class describing the mapping of types onto MPI_Datatypes. More... | ||||
struct | Dune::OwnerOverlapCopyAttributeSet | |||
Attribute set for overlapping schwarz. More... | ||||
class | Dune::IndexInfoFromGrid< G, L > | |||
Information about the index distribution. More... | ||||
class | Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType > | |||
A class setting up standard communication for a two-valued attribute set with owner/overlap/copy semantics. More... | ||||
class | Dune::ParallelLocalIndex< T > | |||
An index present on the local process with an additional attribute flag. More... | ||||
class | Dune::MPITraits< ParallelLocalIndex< T > > | |||
class | Dune::MPITraits< IndexPair< TG, ParallelLocalIndex< TA > > > | |||
class | Dune::RemoteIndex< T1, T2 > | |||
Information about an index residing on another processor. More... | ||||
class | Dune::RemoteIndices< T > | |||
The indices present on remote processes. More... | ||||
Typedefs | ||||
typedef TG | Dune::IndexPair::GlobalIndex | |||
the type of the global index. | ||||
typedef TL | Dune::IndexPair::LocalIndex | |||
the type of the local index. | ||||
typedef TG | Dune::ParallelIndexSet::GlobalIndex | |||
the type of the global index. This type has to provide at least a operator< for sorting. | ||||
typedef TL | Dune::ParallelIndexSet::LocalIndex | |||
The type of the local index, e.g. ParallelLocalIndex. | ||||
typedef Dune::IndexPair < GlobalIndex, LocalIndex > | Dune::ParallelIndexSet::IndexPair | |||
The type of the pair stored. | ||||
typedef ArrayList< IndexPair, N >::const_iterator | Dune::ParallelIndexSet::const_iterator | |||
The constant iterator over the pairs. | ||||
typedef ParallelIndexSet::LocalIndex | Dune::GlobalLookupIndexSet::LocalIndex | |||
The type of the local index. | ||||
typedef ParallelIndexSet::GlobalIndex | Dune::GlobalLookupIndexSet::GlobalIndex | |||
The type of the global index. | ||||
typedef ParallelIndexSet::const_iterator | Dune::GlobalLookupIndexSet::const_iterator | |||
The iterator over the index pairs. | ||||
typedef ParallelIndexSet::IndexPair | Dune::IndicesSyncer::IndexPair | |||
The type of the index pair. | ||||
typedef ParallelIndexSet::GlobalIndex | Dune::IndicesSyncer::GlobalIndex | |||
Type of the global index used in the index set. | ||||
typedef ParallelIndexSet::LocalIndex::Attribute | Dune::IndicesSyncer::Attribute | |||
Type of the attribute used in the index set. | ||||
typedef Dune::RemoteIndices < ParallelIndexSet > | Dune::IndicesSyncer::RemoteIndices | |||
Type of the remote indices. | ||||
Enumerations | ||||
enum | Dune::ParallelIndexSetState { Dune::GROUND, Dune::RESIZE } | |||
The states the index set can be in. More... | ||||
enum | { Dune::ParallelIndexSet::arraySize = (N>0)?N:1 } | |||
enum | Dune::LocalIndexState | |||
The states avaiable 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. | ||||
Dune::IndexPair::IndexPair (const GlobalIndex &global, const LocalIndex &local) | ||||
Constructs a new Pair. | ||||
Dune::IndexPair::IndexPair () | ||||
Construct a new Pair. | ||||
Dune::IndexPair::IndexPair (const GlobalIndex &global) | ||||
Constructs a new Pair. | ||||
const GlobalIndex & | Dune::IndexPair::global () const | |||
Get the global index. | ||||
LocalIndex & | Dune::IndexPair::local () | |||
Get the local index. | ||||
const LocalIndex & | Dune::IndexPair::local () const | |||
Get the local index. | ||||
void | Dune::IndexPair::setLocal (int index) | |||
Set the local index. | ||||
Dune::ParallelIndexSet::ParallelIndexSet () | ||||
Constructor. | ||||
const ParallelIndexSetState & | Dune::ParallelIndexSet::state () | |||
Get the state the index set is in. | ||||
void | Dune::ParallelIndexSet::beginResize () throw (InvalidIndexSetState) | |||
Indicate that the index set is to be resized.
| ||||
void | Dune::ParallelIndexSet::add (const GlobalIndex &global) throw (InvalidIndexSetState) | |||
Add an new index to the set. | ||||
void | Dune::ParallelIndexSet::add (const GlobalIndex &global, const LocalIndex &local) throw (InvalidIndexSetState) | |||
Add an new index to the set. | ||||
void | Dune::ParallelIndexSet::markAsDeleted (const iterator &position) throw (InvalidIndexSetState) | |||
Mark an index as deleted. | ||||
void | Dune::ParallelIndexSet::endResize () throw (InvalidIndexSetState) | |||
Indicate that the resizing finishes. | ||||
IndexPair & | Dune::ParallelIndexSet::operator[] (const GlobalIndex &global) | |||
Find the index pair with a specific global id. | ||||
const IndexPair & | Dune::ParallelIndexSet::operator[] (const GlobalIndex &global) const | |||
Find the index pair with a specific global id. | ||||
iterator | Dune::ParallelIndexSet::begin () | |||
Get an iterator over the indices positioned at the first index. | ||||
iterator | Dune::ParallelIndexSet::end () | |||
Get an iterator over the indices positioned after the last index. | ||||
const_iterator | Dune::ParallelIndexSet::begin () const | |||
Get an iterator over the indices positioned at the first index. | ||||
const_iterator | Dune::ParallelIndexSet::end () const | |||
Get an iterator over the indices positioned after the last index. | ||||
void | Dune::ParallelIndexSet::renumberLocal () | |||
Renumbers the local index numbers. | ||||
int | Dune::ParallelIndexSet::seqNo () const | |||
Get the internal sequence number. | ||||
size_t | Dune::ParallelIndexSet::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::GlobalLookupIndexSet (const ParallelIndexSet &indexset, std::size_t size) | ||||
Constructor. | ||||
Dune::GlobalLookupIndexSet::GlobalLookupIndexSet (const ParallelIndexSet &indexset) | ||||
Constructor. | ||||
Dune::GlobalLookupIndexSet::~GlobalLookupIndexSet () | ||||
Destructor. | ||||
const IndexPair & | Dune::GlobalLookupIndexSet::operator[] (const GlobalIndex &global) const | |||
Find the index pair with a specific global id. | ||||
const IndexPair * | Dune::GlobalLookupIndexSet::pair (const std::size_t &local) const | |||
Get the index pair corresponding to a local index. | ||||
const_iterator | Dune::GlobalLookupIndexSet::begin () const | |||
Get an iterator over the indices positioned at the first index. | ||||
const_iterator | Dune::GlobalLookupIndexSet::end () const | |||
Get an iterator over the indices positioned after the last index. | ||||
int | Dune::GlobalLookupIndexSet::seqNo () const | |||
Get the internal sequence number. | ||||
size_t | Dune::GlobalLookupIndexSet::size () const | |||
Get the total number (public and nonpublic) indices. | ||||
Dune::IndicesSyncer::IndicesSyncer (ParallelIndexSet &indexSet, RemoteIndices &remoteIndices) | ||||
Constructor. | ||||
void | Dune::IndicesSyncer::sync () | |||
Sync the index set. | ||||
template<typename T1> | ||||
void | Dune::IndicesSyncer::sync (T1 &numberer) | |||
Synce the index set and assign local numbers to new indices. | ||||
Dune::IndicesSyncer::Iterators::Iterators (RemoteIndexList &remoteIndices, GlobalIndexList &globalIndices, BoolList &booleans) | ||||
Constructor. | ||||
Dune::IndicesSyncer::Iterators::Iterators () | ||||
Default constructor. | ||||
Iterators & | Dune::IndicesSyncer::Iterators::operator++ () | |||
Increment all iteraors. | ||||
void | Dune::IndicesSyncer::Iterators::insert (const RemoteIndex &index, const GlobalIndex &global) | |||
Insert a new remote index to the underlying remote index list. | ||||
RemoteIndex & | Dune::IndicesSyncer::Iterators::remoteIndex () const | |||
Get the remote index at current position. | ||||
GlobalIndex & | Dune::IndicesSyncer::Iterators::globalIndex () const | |||
Get the global index of the remote index at current position. | ||||
bool | Dune::IndicesSyncer::Iterators::isOld () const | |||
Was this entry already in the remote index list before the sync process? | ||||
void | Dune::IndicesSyncer::Iterators::reset (RemoteIndexList &remoteIndices, GlobalIndexList &globalIndices, BoolList &booleans) | |||
Reset all the underlying iterators. | ||||
bool | Dune::IndicesSyncer::Iterators::isNotAtEnd () const | |||
Are we not at the end of the list? | ||||
bool | Dune::IndicesSyncer::Iterators::isAtEnd () const | |||
Are we at the end of the list? | ||||
template<typename T, typename A> | ||||
void | Dune::repairLocalIndexPointers (std::map< int, SLList< typename T::GlobalIndex, A > > &globalMap, RemoteIndices< T > &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. | ||||
static const void * | Dune::CommPolicy::getAddress (const V &v, int index) | |||
Get the address of entry at an index. | ||||
static int | Dune::CommPolicy::getSize (const V &, int index) | |||
Get the number of primitve elements at that index. | ||||
Dune::BufferedCommunicator::BufferedCommunicator () | ||||
Constructor. | ||||
template<class Data> | ||||
EnableIf< is_same< SizeOne, typename CommPolicy< Data > ::IndexedTypeFlag >::value, void >::Type | Dune::BufferedCommunicator::build (const Interface &interface) | |||
Build the buffers and information for the communication process. | ||||
template<class Data> | ||||
void | Dune::BufferedCommunicator::build (const Data &source, const Data &target, const Interface &interface) | |||
Build the buffers and information for the communication process. | ||||
void | Dune::BufferedCommunicator::free () | |||
Free the allocated memory (i.e. buffers and message information. | ||||
Dune::BufferedCommunicator::~BufferedCommunicator () | ||||
Destructor. | ||||
int | Dune::BufferedCommunicator::MessageSizeCalculator< Data, SizeOne >::operator() (const InterfaceInformation &info) const | |||
Calculate the number of values in message. | ||||
int | Dune::BufferedCommunicator::MessageSizeCalculator< Data, SizeOne >::operator() (const Data &data, const InterfaceInformation &info) const | |||
Calculate the number of values in message. | ||||
int | Dune::BufferedCommunicator::MessageSizeCalculator< Data, VariableSize >::operator() (const Data &data, const InterfaceInformation &info) const | |||
Calculate the number of values in message. | ||||
template<class GatherScatter, class Data> | ||||
void | Dune::BufferedCommunicator::forward (Data &data) | |||
Forward send where target and source are the same. | ||||
template<class GatherScatter, class Data> | ||||
void | Dune::BufferedCommunicator::backward (Data &data) | |||
Backward send where target and source are the same. | ||||
template<class GatherScatter, class Data> | ||||
void | Dune::BufferedCommunicator::forward (const Data &source, Data &dest) | |||
Send from source to target. | ||||
template<class GatherScatter, class Data> | ||||
void | Dune::BufferedCommunicator::backward (Data &source, const Data &dest) | |||
Communicate in the reverse direction, i.e. send from target to source. | ||||
template<class T1, class T2, class Op, bool send> | ||||
void | Dune::InterfaceBuilder::buildInterface (const RemoteIndices &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. | ||||
void | Dune::Interface::print () const | |||
Print the interface to std::out for debugging. | ||||
template<typename T1, typename T2> | ||||
void | Dune::Interface::build (const RemoteIndices &remoteIndices, const T1 &sourceFlags, const T2 &destFlags) | |||
Builds the interface. | ||||
void | Dune::Interface::free () | |||
Frees memory allocated during the build. | ||||
virtual | Dune::Interface::~Interface () | |||
Destructor. | ||||
const std::ptrdiff_t & | Dune::LocalIndex::local () const | |||
get the local index. | ||||
Dune::LocalIndex::operator std::ptrdiff_t () const | ||||
Convert to the local index represented by an int. | ||||
LocalIndex & | Dune::LocalIndex::operator= (std::ptrdiff_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::ParallelLocalIndex (const Attribute &attribute, bool isPublic) | ||||
Constructor. | ||||
Dune::ParallelLocalIndex::ParallelLocalIndex (size_t localIndex, const Attribute &attribute, bool isPublic=true) | ||||
Constructor. | ||||
Dune::ParallelLocalIndex::ParallelLocalIndex () | ||||
Parameterless constructor. | ||||
const Attribute | Dune::ParallelLocalIndex::attribute () const | |||
Constructor. | ||||
void | Dune::ParallelLocalIndex::setAttribute (const Attribute &attribute) | |||
Set the attribute of the index. | ||||
size_t | Dune::ParallelLocalIndex::local () const | |||
get the local index. | ||||
Dune::ParallelLocalIndex::operator size_t () const | ||||
Convert to the local index represented by an int. | ||||
ParallelLocalIndex< Attribute > & | Dune::ParallelLocalIndex::operator= (size_t index) | |||
Assign a new local index. | ||||
bool | Dune::ParallelLocalIndex::isPublic () const | |||
Check whether the index might also be known other processes. | ||||
LocalIndexState | Dune::ParallelLocalIndex::state () const | |||
Get the state. | ||||
void | Dune::ParallelLocalIndex::setState (const LocalIndexState &state) | |||
Set the state. | ||||
Variables | ||||
int | Dune::IndicesSyncer::MessageInformation::publish | |||
The number of indices we publish for the other process. | ||||
int | Dune::IndicesSyncer::MessageInformation::pairs | |||
The number of pairs (attribute and process number) we publish to the neighbour process. |
typedef TG Dune::IndexPair< TG, TL >::GlobalIndex [inherited] |
the type of the global index.
This type has to provide at least a operator< for sorting.
typedef TL Dune::ParallelIndexSet< TG, TL, N >::LocalIndex [inherited] |
The type of the local index, e.g. ParallelLocalIndex.
This class to provide the following functions:
LocalIndex operator=(int); operator int() const; LocalIndexState state() const; void setState(LocalIndexState);
typedef TL Dune::IndexPair< TG, TL >::LocalIndex [inherited] |
the type of the local index.
This class to provide the following functions:
LocalIndex operator=(int); operator int() const; LocalIndexState state() const; void setState(LocalIndexState);
anonymous enum [inherited] |
The states the index set can be in.
void Dune::ParallelIndexSet< TG, TL, N >::add | ( | const GlobalIndex & | global, | |
const LocalIndex & | local | |||
) | throw (InvalidIndexSetState) [inline, inherited] |
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. |
void Dune::ParallelIndexSet< TG, TL, N >::add | ( | const GlobalIndex & | global | ) | throw (InvalidIndexSetState) [inline, inherited] |
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. |
References Dune::RESIZE.
Referenced by Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::OwnerOverlapCopyCommunication().
const T Dune::ParallelLocalIndex< T >::attribute | ( | ) | const [inline, inherited] |
Constructor.
globalIndex | The global index. | |
attribute | The attribute of the index. | |
local | The local index. | |
isPublic | True if the index might also be known to other processes. |
void Dune::BufferedCommunicator< T >::backward | ( | Data & | source, | |
const Data & | dest | |||
) | [inline, inherited] |
Communicate in the reverse direction, i.e. send from target to source.
The template parameter GatherScatter (e.g. CopyGatherScatter) has to have a static method
// Gather the data at index index of data static const typename CommPolicy<Data>::IndexedType>& gather(Data& data, int index); // Scatter the value at a index of data static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index);
static onst typename CommPolicy<Data>::IndexedType> gather(Data& data, int index, int subindex); static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index, int subindex);
dest | The values will be copied from here to the send buffers. | |
source | The received values will be copied to here. |
void Dune::BufferedCommunicator< T >::backward | ( | Data & | data | ) | [inline, inherited] |
Backward send where target and source are the same.
The template parameter GatherScatter has to have a static method
// Gather the data at index index of data static const typename CommPolicy<Data>::IndexedType>& gather(Data& data, int index); // Scatter the value at a index of data static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index);
static onst typename CommPolicy<Data>::IndexedType> gather(Data& data, int index, int subindex); static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index, int subindex);
data | Source and target of the communication. |
I::const_iterator Dune::GlobalLookupIndexSet< I >::begin | ( | ) | const [inline, inherited] |
Get an iterator over the indices positioned at the first index.
References Dune::ParallelIndexSet< TG, TL, N >::begin().
ParallelIndexSet< TG, TL, N >::const_iterator Dune::ParallelIndexSet< TG, TL, N >::begin | ( | ) | const [inline, inherited] |
Get an iterator over the indices positioned at the first index.
ParallelIndexSet< TG, TL, N >::iterator Dune::ParallelIndexSet< TG, TL, N >::begin | ( | ) | [inline, inherited] |
Get an iterator over the indices positioned at the first index.
Referenced by Dune::GlobalLookupIndexSet< I >::begin(), Dune::InterfaceBuilder< T >::buildInterface(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::dot(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::norm(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::OwnerOverlapCopyCommunication(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::project(), Dune::ParallelIndexSet< TG, TL, N >::renumberLocal(), and Dune::RemoteIndexListModifier< T, mode >::repairLocalIndexPointers().
void Dune::Interface< T >::build | ( | const RemoteIndices & | remoteIndices, | |
const T1 & | sourceFlags, | |||
const T2 & | destFlags | |||
) | [inline, inherited] |
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
bool contains(Attribute flag) const;
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. |
void Dune::BufferedCommunicator< T >::build | ( | const Data & | source, | |
const Data & | target, | |||
const Interface & | interface | |||
) | [inline, inherited] |
Build the buffers and information for the communication process.
source | The source in a forward send. The values will be copied from here to the send buffers. | |
target | The target in a forward send. The received values will be copied to here. | |
interface | The interface that defines what indices are to be communicated. |
References Dune::Interface< T >::interfaces().
EnableIf< is_same< SizeOne, typename CommPolicy< Data >::IndexedTypeFlag >::value, void >::Type Dune::BufferedCommunicator< T >::build | ( | const Interface & | interface | ) | [inline, inherited] |
Build the buffers and information for the communication process.
interface | The interface that defines what indices are to be communicated. |
References Dune::Interface< T >::communicator(), and Dune::Interface< T >::interfaces().
void Dune::InterfaceBuilder< T >::buildInterface | ( | const RemoteIndices & | remoteIndices, | |
const T1 & | sourceFlags, | |||
const T2 & | destFlags, | |||
Op & | functor | |||
) | const [inline, protected, inherited] |
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
bool contains(Attribute flag) const;
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 void reserve(int proc, int size); // Add an entry to the interface // We will send/receive size entries at index local to process proc void add(int proc, int local); |
References Dune::CollectiveIterator< T >::advance(), Dune::CollectiveIterator< T >::begin(), Dune::ParallelIndexSet< TG, TL, N >::begin(), Dune::RemoteIndices< T >::begin(), Dune::RemoteIndices< T >::communicator(), Dune::CollectiveIterator< T >::empty(), Dune::CollectiveIterator< T >::end(), Dune::ParallelIndexSet< TG, TL, N >::end(), Dune::RemoteIndices< T >::end(), Dune::RemoteIndices< T >::isSynced(), Dune::RemoteIndices< T >::source_, and Dune::RemoteIndices< T >::target_.
I::const_iterator Dune::GlobalLookupIndexSet< I >::end | ( | ) | const [inline, inherited] |
Get an iterator over the indices positioned after the last index.
References Dune::ParallelIndexSet< TG, TL, N >::end().
ParallelIndexSet< TG, TL, N >::const_iterator Dune::ParallelIndexSet< TG, TL, N >::end | ( | ) | const [inline, inherited] |
Get an iterator over the indices positioned after the last index.
ParallelIndexSet< TG, TL, N >::iterator Dune::ParallelIndexSet< TG, TL, N >::end | ( | ) | [inline, inherited] |
Get an iterator over the indices positioned after the last index.
Referenced by Dune::InterfaceBuilder< T >::buildInterface(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::dot(), Dune::GlobalLookupIndexSet< I >::end(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::norm(), Dune::operator<<(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::OwnerOverlapCopyCommunication(), Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::project(), Dune::ParallelIndexSet< TG, TL, N >::renumberLocal(), and Dune::RemoteIndexListModifier< T, mode >::repairLocalIndexPointers().
void Dune::ParallelIndexSet< TG, TL, N >::endResize | ( | ) | throw (InvalidIndexSetState) [inline, inherited] |
Indicate that the resizing finishes.
InvalidState | If index set was not in ParallelIndexSetState::RESIZE mode. |
References Dune::GROUND, and Dune::RESIZE.
Referenced by Dune::OwnerOverlapCopyCommunication< GlobalIdType, LocalIdType >::OwnerOverlapCopyCommunication(), and Dune::IndicesSyncer< T >::sync().
void Dune::BufferedCommunicator< T >::forward | ( | const Data & | source, | |
Data & | dest | |||
) | [inline, inherited] |
Send from source to target.
The template parameter GatherScatter (e.g. CopyGatherScatter) has to have a static method
// Gather the data at index index of data static const typename CommPolicy<Data>::IndexedType>& gather(Data& data, int index); // Scatter the value at a index of data static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index);
static const typename CommPolicy<Data>::IndexedType> gather(Data& data, int index, int subindex); static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index, int subindex);
source | The values will be copied from here to the send buffers. | |
dest | The received values will be copied to here. |
void Dune::BufferedCommunicator< T >::forward | ( | Data & | data | ) | [inline, inherited] |
Forward send where target and source are the same.
The template parameter GatherScatter has to have a static method
// Gather the data at index index of data static const typename CommPolicy<Data>::IndexedType>& gather(Data& data, int index); // Scatter the value at a index of data static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index);
static onst typename CommPolicy<Data>::IndexedType> gather(Data& data, int index, int subindex); static void scatter(Data& data, typename CommPolicy<Data>::IndexedType> value, int index, int subindex);
data | Source and target of the communication. |
const void * Dune::CommPolicy< V >::getAddress | ( | const V & | v, | |
int | index | |||
) | [inline, static, inherited] |
Get the address of entry at an index.
The default implementation uses operator[] to get the address.
v | An existing representation of the type that has more elements than index. | |
index | The index of the entry. |
int Dune::CommPolicy< V >::getSize | ( | const V & | v, | |
int | index | |||
) | [inline, static, inherited] |
Get the number of primitve elements at that index.
The default always returns 1.
const TG & Dune::IndexPair< TG, TL >::global | ( | ) | const [inline, inherited] |
Get the global index.
IndicesSyncer< T >::GlobalIndex & Dune::IndicesSyncer< T >::Iterators::globalIndex | ( | ) | const [inline, inherited] |
Get the global index of the remote index at current position.
Dune::GlobalLookupIndexSet< I >::GlobalLookupIndexSet | ( | const ParallelIndexSet & | indexset | ) | [inherited] |
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 | |||
) | [inherited] |
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 | ( | const GlobalIndex & | global | ) | [inline, inherited] |
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 | |||
) | [inherited] |
Constructs a new Pair.
global | The global index. | |
local | The local index. |
Dune::IndicesSyncer< T >::IndicesSyncer | ( | ParallelIndexSet & | indexSet, | |
RemoteIndices & | remoteIndices | |||
) | [inline, inherited] |
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. |
References Dune::RemoteIndices< T >::communicator(), Dune::RemoteIndices< T >::source_, and Dune::RemoteIndices< T >::target_.
void Dune::IndicesSyncer< T >::Iterators::insert | ( | const RemoteIndex & | index, | |
const GlobalIndex & | global | |||
) | [inline, inherited] |
Insert a new remote index to the underlying remote index list.
index | The remote index. | |
global | The global index corresponding to the remote index. |
const std::map< int, std::pair< InterfaceInformation, InterfaceInformation > > & Dune::Interface< T >::interfaces | ( | ) | const [inline, inherited] |
Get information about the interfaces.
Referenced by Dune::BufferedCommunicator< T >::build().
bool Dune::IndicesSyncer< T >::Iterators::isAtEnd | ( | ) | const [inline, inherited] |
Are we at the end of the list?
bool Dune::IndicesSyncer< T >::Iterators::isNotAtEnd | ( | ) | const [inline, inherited] |
Are we not at the end of the list?
bool Dune::IndicesSyncer< T >::Iterators::isOld | ( | ) | const [inline, inherited] |
Was this entry already in the remote index list before the sync process?
bool Dune::ParallelLocalIndex< T >::isPublic | ( | ) | const [inline, inherited] |
Check whether the index might also be known other processes.
Dune::IndicesSyncer< T >::Iterators::Iterators | ( | RemoteIndexList & | remoteIndices, | |
GlobalIndexList & | globalIndices, | |||
BoolList & | booleans | |||
) | [inline, inherited] |
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 coresponding 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. |
size_t Dune::ParallelLocalIndex< T >::local | ( | ) | const [inline, inherited] |
get the local index.
const std::ptrdiff_t & Dune::LocalIndex::local | ( | ) | const [inline, inherited] |
get the local index.
const TL & Dune::IndexPair< TG, TL >::local | ( | ) | const [inline, inherited] |
Get the local index.
TL & Dune::IndexPair< TG, TL >::local | ( | ) | [inline, inherited] |
Get the local index.
void Dune::ParallelIndexSet< TG, TL, N >::markAsDeleted | ( | const iterator & | position | ) | throw (InvalidIndexSetState) [inline, inherited] |
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. |
References Dune::RESIZE.
int Dune::BufferedCommunicator< T >::MessageSizeCalculator< Data, VariableSize >::operator() | ( | const Data & | data, | |
const InterfaceInformation & | info | |||
) | const [inline, inherited] |
Calculate the number of values in message.
info | The information about the interface corresponding to the message. | |
data | A representative of the data we send. |
int Dune::BufferedCommunicator< T >::MessageSizeCalculator< Data, SizeOne >::operator() | ( | const Data & | data, | |
const InterfaceInformation & | info | |||
) | const [inline, inherited] |
Calculate the number of values in message.
info | The information about the interface corresponding to the message. | |
data | ignored. |
int Dune::BufferedCommunicator< T >::MessageSizeCalculator< Data, SizeOne >::operator() | ( | const InterfaceInformation & | info | ) | const [inline, inherited] |
Calculate the number of values in message.
info | The information about the interface corresponding to the message. |
std::ostream& Dune::operator<< | ( | std::ostream & | os, | |
const ParallelLocalIndex< T > & | index | |||
) | [inline] |
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 ParallelIndexSet< TG, TL, N > & | indexSet | |||
) | [inline] |
Print an index set.
os | The outputstream to print to. | |
indexSet | The index set to print. |
References Dune::ParallelIndexSet< TG, TL, N >::end().
std::ostream & Dune::operator<< | ( | std::ostream & | os, | |
const IndexPair< TG, TL > & | pair | |||
) | [inline] |
Print an index pair.
os | The outputstream to print to. | |
pair | The index pair to print. |
ParallelLocalIndex< T > & Dune::ParallelLocalIndex< T >::operator= | ( | size_t | index | ) | [inline, inherited] |
Assign a new local index.
index | The new local index. |
LocalIndex & Dune::LocalIndex::operator= | ( | std::ptrdiff_t | index | ) | [inline, inherited] |
Assign a new local index.
index | The new local index. |
const IndexPair< typename I::GlobalIndex, typename I::LocalIndex > & Dune::GlobalLookupIndexSet< I >::operator[] | ( | const GlobalIndex & | global | ) | const [inline, inherited] |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefor has complexity N log(N). This method is forwarded to the underlying index set.
global | The globally unique id of the pair. |
NoSuchEntry | Thrown if the global id is not known. |
const IndexPair< TG, TL > & Dune::ParallelIndexSet< TG, TL, N >::operator[] | ( | const GlobalIndex & | global | ) | const [inline, inherited] |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefor has complexity N log(N).
global | The globally unique id of the pair. |
NoSuchEntry | Thrown if the global id is not known. |
IndexPair< TG, TL > & Dune::ParallelIndexSet< TG, TL, N >::operator[] | ( | const GlobalIndex & | global | ) | [inline, inherited] |
Find the index pair with a specific global id.
This starts a binary search for the entry and therefor has complexity N log(N).
global | The globally unique id of the pair. |
NoSuchEntry | Thrown if the global id is not known. |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | ) | [inline, inherited] |
Parameterless constructor.
Needed for use in container classes.
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | size_t | localIndex, | |
const Attribute & | attribute, | |||
bool | isPublic = true | |||
) | [inline, inherited] |
Constructor.
localIndex | The local index. | |
attribute | The attribute of the index. | |
isPublic | True if the index might also be known to other processes. |
Dune::ParallelLocalIndex< T >::ParallelLocalIndex | ( | const Attribute & | attribute, | |
bool | isPublic | |||
) | [inline, inherited] |
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. |
IndicesSyncer< T >::RemoteIndex & Dune::IndicesSyncer< T >::Iterators::remoteIndex | ( | ) | const [inline, inherited] |
Get the remote index at current position.
void Dune::ParallelIndexSet< TG, TL, N >::renumberLocal | ( | ) | [inline, inherited] |
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 arbituary index pairs with $g_i<g_j$ then after renumbering $l_i<l_j$ will hold.
References Dune::ParallelIndexSet< TG, TL, N >::begin(), Dune::ParallelIndexSet< TG, TL, N >::end(), and Dune::RESIZE.
void Dune::repairLocalIndexPointers | ( | std::map< int, SLList< typename T::GlobalIndex, A > > & | globalMap, | |
RemoteIndices< T > & | remoteIndices, | |||
const T & | indexSet | |||
) | [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. |
References Dune::RemoteIndices< T >::remoteIndices_.
void Dune::IndicesSyncer< T >::Iterators::reset | ( | RemoteIndexList & | remoteIndices, | |
GlobalIndexList & | globalIndices, | |||
BoolList & | booleans | |||
) | [inline, inherited] |
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 coresponding 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. |
int Dune::GlobalLookupIndexSet< I >::seqNo | ( | ) | const [inline, inherited] |
Get the internal sequence number.
Is initially 0 is incremented for each resize.
References Dune::ParallelIndexSet< TG, TL, N >::seqNo().
int Dune::ParallelIndexSet< TG, TL, N >::seqNo | ( | ) | const [inline, inherited] |
Get the internal sequence number.
Is initially 0 is incremented for each resize.
Referenced by Dune::GlobalLookupIndexSet< I >::seqNo(), and Dune::IndicesSyncer< T >::sync().
void Dune::ParallelLocalIndex< T >::setAttribute | ( | const Attribute & | attribute | ) | [inline, inherited] |
Set the attribute of the index.
attribute | The associated attribute. |
void Dune::IndexPair< TG, TL >::setLocal | ( | int | index | ) | [inline, inherited] |
Set the local index.
index | The index to set it to. |
void Dune::ParallelLocalIndex< T >::setState | ( | const LocalIndexState & | state | ) | [inline, inherited] |
Set the state.
state | The state to set. |
void Dune::LocalIndex::setState | ( | LocalIndexState | state | ) | [inline, inherited] |
Set the state.
state | The state to set. |
size_t Dune::GlobalLookupIndexSet< I >::size | ( | ) | const [inline, inherited] |
Get the total number (public and nonpublic) indices.
size_t Dune::ParallelIndexSet< TG, TL, N >::size | ( | ) | const [inline, inherited] |
Get the total number (public and nonpublic) indices.
LocalIndexState Dune::ParallelLocalIndex< T >::state | ( | ) | const [inline, inherited] |
Get the state.
LocalIndexState Dune::LocalIndex::state | ( | ) | const [inline, inherited] |
Get the state.
const ParallelIndexSetState& Dune::ParallelIndexSet< TG, TL, N >::state | ( | ) | [inline, inherited] |
Get the state the index set is in.
Referenced by Dune::RemoteIndexListModifier< T, mode >::repairLocalIndexPointers().
void Dune::IndicesSyncer< T >::sync | ( | T1 & | numberer | ) | [inline, inherited] |
Synce 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. |
References Dune::RemoteIndices< T >::begin(), Dune::ParallelIndexSet< TG, TL, N >::beginResize(), Dune::RemoteIndices< T >::end(), Dune::ParallelIndexSet< TG, TL, N >::endResize(), Dune::RemoteIndices< T >::neighbours(), and Dune::ParallelIndexSet< TG, TL, N >::seqNo().
void Dune::IndicesSyncer< T >::sync | ( | ) | [inline, inherited] |
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()