Newer
Older
Oliver Sander
committed
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
// $Id$
#ifndef DUNE_COMMUNICATOR
#define DUNE_COMMUNICATOR
#include "remoteindices.hh"
#include "interface.hh"
#include <dune/common/exceptions.hh>
#include <dune/common/typetraits.hh>
#include <dune/common/stdstreams.hh>
#if HAVE_MPI
// MPI header
#include <mpi.h>
namespace Dune
{
/** @defgroup Common_Parallel Parallel Computing based on Indexsets
* @ingroup ParallelCommunication
Oliver Sander
committed
* @brief Provides classes for syncing distributed indexed
* data structures.
*
* In a parallel representation a container \f$x\f$,
* 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 \f$x_p\f$, \f$p=0, \ldots, P-1\f$, where \f$x_p\f$ is the piece stored on
* process \f$p\f$ of the \f$P\f$ processes participating in the calculation.
* Although the global representation of the container is not
* available on any process, a process \f$p\f$ needs to know how the entries
* of it's local piece \f$x_p\f$ correspond to the entries of the global
* container \f$x\f$, 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.
*
* @section IndexSet Parallel Index Sets
*
* Form an abstract point of view a random access container \f$x: I
* \rightarrow K\f$ provides a
* mapping from an index set \f$I \subset N_0\f$ onto a set of objects
* \f$K\f$. Note that we do not require \f$I\f$ to be consecutive. The piece
* \f$x_p\f$ of the container \f$x\f$ stored on process \f$p\f$ is a mapping \f$x_p:I_p
* \rightarrow K\f$, where \f$I_p \subset I\f$. Due to efficiency the entries
* of \f$x_p\f$ should be stored in consecutive memory.
*
* This means that for the local computation the data must be addressable
* by a consecutive index starting from \f$0\f$. 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
Oliver Sander
committed
*
* 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
* <em>global index</em>.
*
* 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.
*
* @section remote Remote Index Information
*
* 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.
*
* @section comm Communication
*
* 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 dependant communicators can be setup using BufferedCommunicator,
* DatatypeCommunicator VariableSizeCommunicator based on the interface
* information. In contrast to the former
* the latter is independant of the class Interface can work on a map
* from process number to a pair of index lists describing which local indices
* are send and received from that processs, respectively.
Oliver Sander
committed
*/
/** @addtogroup Common_Parallel
Oliver Sander
committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
*
* @{
*/
/**
* @file
* @brief Provides utility classes for syncing distributed data via
* MPI communication.
* @author Markus Blatt
*/
/**
* @brief Flag for marking indexed data structures where data at
* each index is of the same size.
* @see VariableSize
*/
struct SizeOne
{};
/**
* @brief Flag for marking indexed data structures where the data at each index may
* be a variable multiple of another type.
* @see SizeOne
*/
struct VariableSize
{};
/**
* @brief Default policy used for communicating an indexed type.
*
* This
*/
template<class V>
struct CommPolicy
{
/**
* @brief The type the policy is for.
*
* It has to provide the mode
* \code Type::IndexedType operator[](int i);\endcode
* for
* the access of the value at index i and a typedef IndexedType.
* It is assumed
* that only one entry is at each index (as in scalar
* vector.
*/
typedef V Type;
/**
* @brief The type we get at each index with operator[].
*
* The default is the value_type typedef of the container.
*/
typedef typename V::value_type IndexedType;
/**
* @brief Whether the indexed type has variable size or there
* is always one value at each index.
*/
typedef SizeOne IndexedTypeFlag;
/**
* @brief Get the address of entry at an index.
*
* The default implementation uses operator[] to
* get the address.
* @param v An existing representation of the type that has more elements than index.
* @param index The index of the entry.
*/
static const void* getAddress(const V& v, int index);
/**
* @brief Get the number of primitve elements at that index.
*
* The default always returns 1.
*/
static int getSize(const V&, int index);
};
template<class K, int n> class FieldVector;
template<class B, class A> class VariableBlockVector;
template<class K, class A, int n>
struct CommPolicy<VariableBlockVector<FieldVector<K, n>, A> >
{
typedef VariableBlockVector<FieldVector<K, n>, A> Type;
typedef typename Type::B IndexedType;
typedef VariableSize IndexedTypeFlag;
static const void* getAddress(const Type& v, int i);
static int getSize(const Type& v, int i);
};
/**
* @brief Error thrown if there was a problem with the communication.
*/
class CommunicationError : public IOError
{};
/**
* @brief GatherScatter default implementation that just copies data.
*/
template<class T>
struct CopyGatherScatter
{
typedef typename CommPolicy<T>::IndexedType IndexedType;
static const IndexedType& gather(const T& vec, std::size_t i);
static void scatter(T& vec, const IndexedType& v, std::size_t i);
};
/**
* @brief An utility class for communicating distributed data structures via MPI datatypes.
*
* This communicator creates special MPI datatypes that address the non contiguous elements
* to be send and received. The idea was to prevent the copying to an additional buffer and
* the mpi implementation decide whether to allocate buffers or use buffers offered by the
* interconnection network.
*
* Unfortunately the implementation of MPI datatypes seems to be poor. Therefore for most MPI
* implementations using a BufferedCommunicator will be more efficient.
*/
template<typename T>
class DatatypeCommunicator : public InterfaceBuilder
{
public:
/**
* @brief Type of the index set.
*/
typedef T ParallelIndexSet;
/**
* @brief Type of the underlying remote indices class.
*/
typedef Dune::RemoteIndices<ParallelIndexSet> RemoteIndices;
/**
* @brief The type of the global index.
*/
typedef typename RemoteIndices::GlobalIndex GlobalIndex;
/**
* @brief The type of the attribute.
*/
typedef typename RemoteIndices::Attribute Attribute;
/**
* @brief The type of the local index.
*/
typedef typename RemoteIndices::LocalIndex LocalIndex;
/**
* @brief Creates a new DatatypeCommunicator.
*/
DatatypeCommunicator();
/**
* @brief Destructor.
*/
~DatatypeCommunicator();
/**
* @brief Builds the interface between the index sets.
*
* Has to be called before the actual communication by forward or backward
* can be called. Nonpublic indices will be ignored!
*
*
* The types T1 and T2 are classes representing a set of
* enumeration values of type DatatypeCommunicator::Attribute.
* They have to provide
* a (static) method
* \code
* bool contains(Attribute flag) const;
* \endcode
* for checking whether the set contains a specfic flag.
* This functionality is for example provided the classes
* EnumItem, EnumRange and Combine.
*
* @param remoteIndices The indices present on remote processes.
* @param sourceFlags The set of attributes which mark indices we send to other
* processes.
* @param sendData The indexed data structure whose data will be send.
* @param destFlags The set of attributes which mark the indices we might
* receive values from.
* @param receiveData The indexed data structure for which we receive data.
*/
template<class T1, class T2, class V>
void build(const RemoteIndices& remoteIndices, const T1& sourceFlags, V& sendData, const T2& destFlags, V& receiveData);
/**
* @brief Sends the primitive values from the source to the destination.
*/
void forward();
/**
* @brief Sends the primitive values from the destination to the source.
*/
void backward();
/**
* @brief Deallocates the MPI requests and data types.
*/
void free();
private:
enum {
/**
* @brief Tag for the MPI communication.
*/
commTag_ = 234
};
/**
* @brief The indices also known at other processes.
*/
const RemoteIndices* remoteIndices_;
typedef std::map<int,std::pair<MPI_Datatype,MPI_Datatype> >
MessageTypeMap;
/**
* @brief The datatypes built according to the communication interface.
*/
MessageTypeMap messageTypes;
/**
* @brief The pointer to the data whose entries we communicate.
*/
void* data_;
MPI_Request* requests_[2];
/**
* @brief True if the request and data types were created.
*/
bool created_;
/**
* @brief Creates the MPI_Requests for the forward communication.
*/
template<class V, bool FORWARD>
void createRequests(V& sendData, V& receiveData);
/**
* @brief Creates the data types needed for the unbuffered receive.
*/
template<class T1, class T2, class V, bool send>
void createDataTypes(const T1& source, const T2& destination, V& data);
/**
* @brief Initiates the sending and receive.
*/
void sendRecv(MPI_Request* req);
/**
* @brief Information used for setting up the MPI Datatypes.
*/
struct IndexedTypeInformation
{
/**
* @brief Allocate space for setting up the MPI datatype.
*
* @param i The number of values the datatype will have.
*/
void build(int i)
{
length = new int[i];
displ = new MPI_Aint[i];
size = i;
}
/**
* @brief Free the allocated space.
*/
void free()
{
delete[] length;
delete[] displ;
}
/** @brief The number of values at each index. */
int* length;
/** @brief The displacement at each index. */
MPI_Aint* displ;
/**
* @brief The number of elements we send.
* In case of variable sizes this will differ from
* size.
*/
int elements;
/**
* @param The number of indices in the data type.
*/
int size;
};
/**
* @brief Functor for the InterfaceBuilder.
*
* It will record the information needed to build the MPI_Datatypes.
*/
template<class V>
struct MPIDatatypeInformation
{
/**
* @brief Constructor.
* @param data The data we construct an MPI data type for.
*/
MPIDatatypeInformation(const V& data) : data_(data)
{}
/**
* @brief Reserver space for the information about the datatype.
* @param proc The rank of the process this information is for.
* @param size The number of indices the datatype will contain.
*/
void reserve(int proc, int size)
{
information_[proc].build(size);
}
/**
* @brief Add a new index to the datatype.
* @param proc The rank of the process this index is send to
* or received from.
* @param local The index to add.
*/
void add(int proc, int local)
{
IndexedTypeInformation& info=information_[proc];
assert(info.elements<info.size);
MPI_Address( const_cast<void*>(CommPolicy<V>::getAddress(data_, local)),
info.displ+info.elements);
info.length[info.elements]=CommPolicy<V>::getSize(data_, local);
info.elements++;
}
/**
* @brief The information about the datatypes to send to or
* receive from each process.
*/
std::map<int,IndexedTypeInformation> information_;
/**
* @brief A representative of the indexed data we send.
*/
const V& data_;
};
};
/**
* @brief A communicator that uses buffers to gather and scatter
* the data to be send or received.
*
* Before the data is sent it it copied to a consecutive buffer and
* then that buffer is sent.
* The data is received in another buffer and then copied to the actual
* position.
*/
class BufferedCommunicator
{
public:
/**
* @brief Constructor.
*/
BufferedCommunicator();
/**
* @brief Build the buffers and information for the communication process.
*
*
* @param interface The interface that defines what indices are to be communicated.
*/
template<class Data, class Interface>
typename enable_if<is_same<SizeOne,typename CommPolicy<Data>::IndexedTypeFlag>::value, void>::type
build(const Interface& interface);
/**
* @brief Build the buffers and information for the communication process.
*
* @param source The source in a forward send. The values will be copied from here to the send buffers.
* @param target The target in a forward send. The received values will be copied to here.
* @param interface The interface that defines what indices are to be communicated.
*/
template<class Data, class Interface>
void build(const Data& source, const Data& target, const Interface& interface);
/**
* @brief Send from source to target.
*
* The template parameter GatherScatter (e.g. CopyGatherScatter) has to have a static method
* \code
* // 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is SizeOne
* and
*
* \code
* 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is VariableSize. Here subindex is the
* subindex of the block at index.
* @warning The source and target data have to have the same layout as the ones given
* to the build function in case of variable size values at the indices.
* @param source The values will be copied from here to the send buffers.
* @param dest The received values will be copied to here.
*/
template<class GatherScatter, class Data>
void forward(const Data& source, Data& dest);
/**
* @brief 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
* \code
* // 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is SizeOne
* and
*
* \code
* 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is VariableSize. Here subindex is the
* subindex of the block at index.
* @warning The source and target data have to have the same layout as the ones given
* to the build function in case of variable size values at the indices.
* @param dest The values will be copied from here to the send buffers.
* @param source The received values will be copied to here.
*/
template<class GatherScatter, class Data>
void backward(Data& source, const Data& dest);
/**
* @brief Forward send where target and source are the same.
*
* The template parameter GatherScatter has to have a static method
* \code
* // 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is SizeOne
* and
*
* \code
* 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is VariableSize. Here subindex is the
* subindex of the block at index.
* @param data Source and target of the communication.
*/
template<class GatherScatter, class Data>
void forward(Data& data);
/**
* @brief Backward send where target and source are the same.
*
* The template parameter GatherScatter has to have a static method
* \code
* // 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is SizeOne
* and
*
* \code
* 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);
* \endcode
* in the case where CommPolicy<Data>::IndexedTypeFlag is VariableSize. Here subindex is the
* subindex of the block at index.
* @param data Source and target of the communication.
*/
template<class GatherScatter, class Data>
void backward(Data& data);
/**
* @brief Free the allocated memory (i.e. buffers and message information.
*/
void free();
/**
* @brief Destructor.
*/
~BufferedCommunicator();
private:
/**
* @brief The type of the map that maps interface information to processors.
*/
typedef std::map<int,std::pair<InterfaceInformation,InterfaceInformation> >
InterfaceMap;
/**
* @brief Functors for message size caculation
*/
template<class Data, typename IndexedTypeFlag>
struct MessageSizeCalculator
{};
/**
* @brief Functor for message size caculation for datatypes
* where at each index is only one value.
*/
template<class Data>
struct MessageSizeCalculator<Data,SizeOne>
{
/**
* @brief Calculate the number of values in message
* @param info The information about the interface corresponding
* to the message.
* @return The number of values in th message.
*/
inline int operator()(const InterfaceInformation& info) const;
/**
* @brief Calculate the number of values in message
*
* @param info The information about the interface corresponding
* to the message.
* @param data ignored.
* @return The number of values in th message.
*/
inline int operator()(const Data& data, const InterfaceInformation& info) const;
};
/**
* @brief Functor for message size caculation for datatypes
* where at each index can be a variable number of values.
*/
template<class Data>
struct MessageSizeCalculator<Data,VariableSize>
{
/**
* @brief Calculate the number of values in message
*
* @param info The information about the interface corresponding
* to the message.
* @param data A representative of the data we send.
* @return The number of values in th message.
*/
inline int operator()(const Data& data, const InterfaceInformation& info) const;
};
/**
* @brief Functors for message data gathering.
*/
template<class Data, class GatherScatter, bool send, typename IndexedTypeFlag>
struct MessageGatherer
{};
/**
* @brief Functor for message data gathering for datatypes
* where at each index is only one value.
*/
template<class Data, class GatherScatter, bool send>
struct MessageGatherer<Data,GatherScatter,send,SizeOne>
{
/** @brief The type of the values we send. */
typedef typename CommPolicy<Data>::IndexedType Type;
/**
* @brief The type of the functor that does the actual copying
* during the data Scattering.
*/
typedef GatherScatter Gatherer;
enum {
/**
* @brief The communication mode
*
Oliver Sander
committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
*/
forward=send
};
/**
* @brief Copies the values to send into the buffer.
* @param interface The interface used in the send.
* @param data The data from which we copy the values.
* @param buffer The send buffer to copy to.
* @param bufferSize The size of the buffer in bytes. For checks.
*/
inline void operator()(const InterfaceMap& interface, const Data& data, Type* buffer, size_t bufferSize) const;
};
/**
* @brief Functor for message data scattering for datatypes
* where at each index can be a variable size of values
*/
template<class Data, class GatherScatter, bool send>
struct MessageGatherer<Data,GatherScatter,send,VariableSize>
{
/** @brief The type of the values we send. */
typedef typename CommPolicy<Data>::IndexedType Type;
/**
* @brief The type of the functor that does the actual copying
* during the data Scattering.
*/
typedef GatherScatter Gatherer;
enum {
/**
* @brief The communication mode
*
Oliver Sander
committed
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
*/
forward=send
};
/**
* @brief Copies the values to send into the buffer.
* @param interface The interface used in the send.
* @param data The data from which we copy the values.
* @param buffer The send buffer to copy to.
* @param bufferSize The size of the buffer in bytes. For checks.
*/
inline void operator()(const InterfaceMap& interface, const Data& data, Type* buffer, size_t bufferSize) const;
};
/**
* @brief Functors for message data scattering.
*/
template<class Data, class GatherScatter, bool send, typename IndexedTypeFlag>
struct MessageScatterer
{};
/**
* @brief Functor for message data gathering for datatypes
* where at each index is only one value.
*/
template<class Data, class GatherScatter, bool send>
struct MessageScatterer<Data,GatherScatter,send,SizeOne>
{
/** @brief The type of the values we send. */
typedef typename CommPolicy<Data>::IndexedType Type;
/**
* @brief The type of the functor that does the actual copying
* during the data Scattering.
*/
typedef GatherScatter Scatterer;
enum {
/**
* @brief The communication mode
*
Oliver Sander
committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
*/
forward=send
};
/**
* @brief Copy the message data from the receive buffer to the data.
* @param interface The interface used in the send.
* @param data The data to which we copy the values.
* @param buffer The receive buffer to copy from.
* @param proc The rank of the process the message is from.
*/
inline void operator()(const InterfaceMap& interface, Data& data, Type* buffer, const int& proc) const;
};
/**
* @brief Functor for message data scattering for datatypes
* where at each index can be a variable size of values
*/
template<class Data, class GatherScatter, bool send>
struct MessageScatterer<Data,GatherScatter,send,VariableSize>
{
/** @brief The type of the values we send. */
typedef typename CommPolicy<Data>::IndexedType Type;
/**
* @brief The type of the functor that does the actual copying
* during the data Scattering.
*/
typedef GatherScatter Scatterer;
enum {
/**
* @brief The communication mode
*
Oliver Sander
committed
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
*/
forward=send
};
/**
* @brief Copy the message data from the receive buffer to the data.
* @param interface The interface used in the send.
* @param data The data to which we copy the values.
* @param buffer The receive buffer to copy from.
* @param proc The rank of the process the message is from.
*/
inline void operator()(const InterfaceMap& interface, Data& data, Type* buffer, const int& proc) const;
};
/**
* @brief Information about a message to send.
*/
struct MessageInformation
{
/** @brief Constructor. */
MessageInformation()
: start_(0), size_(0)
{}
/**
* @brief Constructor.
* @param start The start of the message in the global buffer.
* Not in bytes but in number of values from the beginning of
* the buffer
* @param size The size of the message in bytes.
*/
MessageInformation(size_t start, size_t size)
: start_(start), size_(size)
{}
/**
* @brief Start of the message in the buffer counted in number of value.
*/
size_t start_;
/**
* @brief Number of bytes in the message.
*/
size_t size_;
};
/**
* @brief Type of the map of information about the messages to send.
*
* The key is the process number to communicate with and the value is
Oliver Sander
committed
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
* the pair of information about sending and receiving messages.
*/
typedef std::map<int,std::pair<MessageInformation,MessageInformation> >
InformationMap;
/**
* @brief Gathered information about the messages to send.
*/
InformationMap messageInformation_;
/**
* @brief Communication buffers.
*/
char* buffers_[2];
/**
* @brief The size of the communication buffers
*/
size_t bufferSize_[2];
enum {
/**
* @brief The tag we use for communication.
*/
commTag_
};
/**
* @brief The interface we currently work with.
*/
std::map<int,std::pair<InterfaceInformation,InterfaceInformation> > interfaces_;
MPI_Comm communicator_;
/**
* @brief Send and receive Data.
*/
template<class GatherScatter, bool FORWARD, class Data>
void sendRecv(const Data& source, Data& target);
};
#ifndef DOXYGEN
template<class V>
inline const void* CommPolicy<V>::getAddress(const V& v, int index)
{
return &(v[index]);
}
template<class V>
inline int CommPolicy<V>::getSize(const V& v, int index)
{
DUNE_UNUSED_PARAMETER(v);
DUNE_UNUSED_PARAMETER(index);
Oliver Sander
committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
return 1;
}
template<class K, class A, int n>
inline const void* CommPolicy<VariableBlockVector<FieldVector<K, n>, A> >::getAddress(const Type& v, int index)
{
return &(v[index][0]);
}
template<class K, class A, int n>
inline int CommPolicy<VariableBlockVector<FieldVector<K, n>, A> >::getSize(const Type& v, int index)
{
return v[index].getsize();
}
template<class T>
inline const typename CopyGatherScatter<T>::IndexedType& CopyGatherScatter<T>::gather(const T & vec, std::size_t i)
{
return vec[i];
}
template<class T>
inline void CopyGatherScatter<T>::scatter(T& vec, const IndexedType& v, std::size_t i)
{
vec[i]=v;
}
template<typename T>
DatatypeCommunicator<T>::DatatypeCommunicator()
: remoteIndices_(0), created_(false)
{
requests_[0]=0;
requests_[1]=0;
}
template<typename T>
DatatypeCommunicator<T>::~DatatypeCommunicator()
{
free();
}
template<typename T>
template<class T1, class T2, class V>
inline void DatatypeCommunicator<T>::build(const RemoteIndices& remoteIndices,
const T1& source, V& sendData,
const T2& destination, V& receiveData)
{
remoteIndices_ = &remoteIndices;
free();
createDataTypes<T1,T2,V,false>(source,destination, receiveData);
createDataTypes<T1,T2,V,true>(source,destination, sendData);
createRequests<V,true>(sendData, receiveData);
createRequests<V,false>(receiveData, sendData);
created_=true;
}
template<typename T>
void DatatypeCommunicator<T>::free()
{
if(created_) {
delete[] requests_[0];
delete[] requests_[1];
typedef MessageTypeMap::iterator iterator;
typedef MessageTypeMap::const_iterator const_iterator;
const const_iterator end=messageTypes.end();
for(iterator process = messageTypes.begin(); process != end; ++process) {
MPI_Datatype *type = &(process->second.first);
int finalized=0;
#if MPI_2
MPI_Finalized(&finalized);
#endif
if(*type!=MPI_DATATYPE_NULL && !finalized)
MPI_Type_free(type);
type = &(process->second.second);
if(*type!=MPI_DATATYPE_NULL && !finalized)
MPI_Type_free(type);
}
messageTypes.clear();
created_=false;
}
}
template<typename T>
template<class T1, class T2, class V, bool send>
void DatatypeCommunicator<T>::createDataTypes(const T1& sourceFlags, const T2& destFlags, V& data)
{
MPIDatatypeInformation<V> dataInfo(data);
this->template buildInterface<RemoteIndices,T1,T2,MPIDatatypeInformation<V>,send>(*remoteIndices_,sourceFlags, destFlags, dataInfo);