VTK  9.5.20250904
vtkMPICommunicator.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
27#ifndef vtkMPICommunicator_h
28#define vtkMPICommunicator_h
29
30#include "vtkCommunicator.h"
31#include "vtkMPI.h" // for MPI_Datatype
32#include "vtkParallelMPIModule.h" // For export macro
33
34VTK_ABI_NAMESPACE_BEGIN
36class vtkProcessGroup;
37
38class vtkMPICommunicatorOpaqueComm;
39class vtkMPICommunicatorOpaqueRequest;
40class vtkMPICommunicatorReceiveDataInfo;
41
42class VTKPARALLELMPI_EXPORT vtkMPICommunicator : public vtkCommunicator
43{
44public:
45 class VTKPARALLELMPI_EXPORT Request
46 {
47 public:
52 int Test();
53 void Cancel();
54 void Wait();
55 vtkMPICommunicatorOpaqueRequest* Req;
56 };
57
59 void PrintSelf(ostream& os, vtkIndent indent) override;
60
65
71
77
83 int SplitInitialize(vtkCommunicator* oldcomm, int color, int key);
84
86
92 const void* data, vtkIdType length, int type, int remoteProcessId, int tag) override;
94 void* data, vtkIdType length, int type, int remoteProcessId, int tag) override;
96
98
106 int NoBlockSend(const int* data, int length, int remoteProcessId, int tag, Request& req);
108 const unsigned long* data, int length, int remoteProcessId, int tag, Request& req);
109 int NoBlockSend(const char* data, int length, int remoteProcessId, int tag, Request& req);
111 const unsigned char* data, int length, int remoteProcessId, int tag, Request& req);
112 int NoBlockSend(const float* data, int length, int remoteProcessId, int tag, Request& req);
113 int NoBlockSend(const double* data, int length, int remoteProcessId, int tag, Request& req);
114 int NoBlockSend(const vtkTypeInt64* data, int length, int remoteProcessId, int tag, Request& req);
115
116 int NoBlockSend(const int* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
118 const unsigned long* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
120 const char* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
122 const unsigned char* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
124 const float* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
126 const double* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
128 const vtkTypeInt64* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
130
134 int NoBlockSend(const void* data, vtkTypeInt64 length, MPI_Datatype mpiType, int remoteProcessId,
135 int tag, Request& req);
136
138
145 int NoBlockReceive(int* data, int length, int remoteProcessId, int tag, Request& req);
146 int NoBlockReceive(unsigned long* data, int length, int remoteProcessId, int tag, Request& req);
147 int NoBlockReceive(char* data, int length, int remoteProcessId, int tag, Request& req);
148 int NoBlockReceive(unsigned char* data, int length, int remoteProcessId, int tag, Request& req);
149 int NoBlockReceive(float* data, int length, int remoteProcessId, int tag, Request& req);
150 int NoBlockReceive(double* data, int length, int remoteProcessId, int tag, Request& req);
151 int NoBlockReceive(vtkTypeInt64* data, int length, int remoteProcessId, int tag, Request& req);
152
153 int NoBlockReceive(int* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
155 unsigned long* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
156 int NoBlockReceive(char* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
158 unsigned char* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
159 int NoBlockReceive(float* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
160 int NoBlockReceive(double* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
162 vtkTypeInt64* data, vtkTypeInt64 length, int remoteProcessId, int tag, Request& req);
164
168 int AllToAllVVoidArray(const void* sendBuffer, const int* sendCounts, const int* sendOffsets,
169 void* recvBuffer, const int* recvCounts, const int* recvOffsets, int type);
170
172
177 void Barrier() override;
178 int BroadcastVoidArray(void* data, vtkIdType length, int type, int srcProcessId) override;
179 int GatherVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType length, int type,
180 int destProcessId) override;
181 int GatherVVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType sendLength,
182 vtkIdType* recvLengths, vtkIdType* offsets, int type, int destProcessId) override;
183 int ScatterVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType length, int type,
184 int srcProcessId) override;
185 int ScatterVVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType* sendLengths,
186 vtkIdType* offsets, vtkIdType recvLength, int type, int srcProcessId) override;
188 const void* sendBuffer, void* recvBuffer, vtkIdType length, int type) override;
189 int AllGatherVVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType sendLength,
190 vtkIdType* recvLengths, vtkIdType* offsets, int type) override;
191 int ReduceVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType length, int type,
192 int operation, int destProcessId) override;
193 int ReduceVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType length, int type,
194 Operation* operation, int destProcessId) override;
196 const void* sendBuffer, void* recvBuffer, vtkIdType length, int type, int operation) override;
197 int AllReduceVoidArray(const void* sendBuffer, void* recvBuffer, vtkIdType length, int type,
198 Operation* operation) override;
200
202
211 int Iprobe(int source, int tag, int* flag, int* actualSource);
212 int Iprobe(int source, int tag, int* flag, int* actualSource, int* type, int* size);
213 int Iprobe(int source, int tag, int* flag, int* actualSource, unsigned long* type, int* size);
214 int Iprobe(int source, int tag, int* flag, int* actualSource, const char* type, int* size);
215 int Iprobe(int source, int tag, int* flag, int* actualSource, float* type, int* size);
216 int Iprobe(int source, int tag, int* flag, int* actualSource, double* type, int* size);
217
218 int Iprobe(int source, int tag, int* flag, int* actualSource, int* type, vtkTypeInt64* size);
220 int source, int tag, int* flag, int* actualSource, unsigned long* type, vtkTypeInt64* size);
222 int source, int tag, int* flag, int* actualSource, const char* type, vtkTypeInt64* size);
223 int Iprobe(int source, int tag, int* flag, int* actualSource, float* type, vtkTypeInt64* size);
224 int Iprobe(int source, int tag, int* flag, int* actualSource, double* type, vtkTypeInt64* size);
226
230 bool CanProbe() override { return true; };
231
233
241 int Probe(int source, int tag, int* actualSource) override;
242 int Probe(int source, int tag, int* actualSource, int* type, int* size);
243 int Probe(int source, int tag, int* actualSource, unsigned long* type, int* size);
244 int Probe(int source, int tag, int* actualSource, const char* type, int* size);
245 int Probe(int source, int tag, int* actualSource, float* type, int* size);
246 int Probe(int source, int tag, int* actualSource, double* type, int* size);
247
248 int Probe(int source, int tag, int* actualSource, int* type, vtkTypeInt64* size);
249 int Probe(int source, int tag, int* actualSource, unsigned long* type, vtkTypeInt64* size);
250 int Probe(int source, int tag, int* actualSource, const char* type, vtkTypeInt64* size);
251 int Probe(int source, int tag, int* actualSource, float* type, vtkTypeInt64* size);
252 int Probe(int source, int tag, int* actualSource, double* type, vtkTypeInt64* size);
254
259 int WaitAll(int count, Request requests[]);
260
266 int WaitAny(int count, Request requests[], int& idx) VTK_SIZEHINT(requests, count);
267
273 int WaitSome(int count, Request requests[], int& NCompleted, int* completed)
274 VTK_SIZEHINT(requests, count);
275
281 int TestAll(int count, Request requests[], int& flag) VTK_SIZEHINT(requests, count);
282
286 int TestAny(int count, Request requests[], int& idx, int& flag) VTK_SIZEHINT(requests, count);
287
294 int TestSome(int count, Request requests[], int& NCompleted, int* completed)
295 VTK_SIZEHINT(requests, count);
296
297 friend class vtkMPIController;
298
299 vtkMPICommunicatorOpaqueComm* GetMPIComm() { return this->MPIComm; }
300
301 int InitializeExternal(vtkMPICommunicatorOpaqueComm* comm);
302
303 static char* Allocate(size_t size);
304 static void Free(char* ptr);
305
307
311 vtkSetClampMacro(UseSsend, int, 0, 1);
312 vtkGetMacro(UseSsend, int);
313 vtkBooleanMacro(UseSsend, int);
315
324
325protected:
328
329 // Obtain size and rank setting NumberOfProcesses and LocalProcessId Should
330 // not be called if the current communicator does not include this process
332
334
344 vtkSetMacro(KeepHandle, int);
345 vtkBooleanMacro(KeepHandle, int);
347
349
351
362
364
367 virtual int ReceiveDataInternal(char* data, int length, int sizeoftype, int remoteProcessId,
368 int tag, vtkMPICommunicatorReceiveDataInfo* info, int useCopy, int& senderId);
369 virtual int ReceiveDataInternal(char* data, vtkTypeInt64 length, int sizeoftype,
370 int remoteProcessId, int tag, vtkMPICommunicatorReceiveDataInfo* info, int useCopy,
371 int& senderId);
373
374 vtkMPICommunicatorOpaqueComm* MPIComm;
375
378
381 static int CheckForMPIError(int err);
382
383private:
384 vtkMPICommunicator(const vtkMPICommunicator&) = delete;
385 void operator=(const vtkMPICommunicator&) = delete;
386};
387
388VTK_ABI_NAMESPACE_END
389#endif
A custom operation to use in a reduce command.
Used to send/receive messages in a multiprocess environment.
a simple class to control print indentation
Definition vtkIndent.h:108
Request(const Request &)
vtkMPICommunicatorOpaqueRequest * Req
Request & operator=(const Request &)
Class for creating user defined MPI communicators.
bool CanProbe() override
Check if this communicator implements a probe operation (always true for MPI communicator)
int NoBlockReceive(vtkTypeInt64 *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockReceive(double *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockReceive(unsigned char *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
void InitializeCopy(vtkMPICommunicator *source)
static vtkMPICommunicator * WorldCommunicator
int Probe(int source, int tag, int *actualSource, const char *type, vtkTypeInt64 *size)
Blocking test for a message.
int Iprobe(int source, int tag, int *flag, int *actualSource, const char *type, vtkTypeInt64 *size)
Nonblocking test for a message.
int InitializeNumberOfProcesses()
int SplitInitialize(vtkCommunicator *oldcomm, int color, int key)
Used to initialize the communicator (i.e.
int Probe(int source, int tag, int *actualSource, double *type, vtkTypeInt64 *size)
Blocking test for a message.
int InitializeExternal(vtkMPICommunicatorOpaqueComm *comm)
static vtkMPICommunicator * New()
Creates an empty communicator.
int Initialize(vtkProcessGroup *group)
Used to initialize the communicator (i.e.
virtual int ReceiveDataInternal(char *data, int length, int sizeoftype, int remoteProcessId, int tag, vtkMPICommunicatorReceiveDataInfo *info, int useCopy, int &senderId)
Implementation for receive data.
int NoBlockSend(const unsigned char *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
static vtkMPICommunicator * GetWorldCommunicator()
Returns the singleton which behaves as the global communicator (MPI_COMM_WORLD)
int Iprobe(int source, int tag, int *flag, int *actualSource, unsigned long *type, vtkTypeInt64 *size)
Nonblocking test for a message.
int NoBlockSend(const char *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int ScatterVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int srcProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
static char * Allocate(size_t size)
int Iprobe(int source, int tag, int *flag, int *actualSource, double *type, vtkTypeInt64 *size)
Nonblocking test for a message.
int NoBlockReceive(int *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockSend(const double *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int NoBlockSend(const float *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int NoBlockReceive(unsigned long *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
void Barrier() override
More efficient implementations of collective operations that use the equivalent MPI commands.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMPICommunicatorOpaqueComm * MPIComm
int GatherVVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type, int destProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int Iprobe(int source, int tag, int *flag, int *actualSource, float *type, vtkTypeInt64 *size)
Nonblocking test for a message.
int Probe(int source, int tag, int *actualSource, float *type, vtkTypeInt64 *size)
Blocking test for a message.
int ReduceVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation, int destProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int Iprobe(int source, int tag, int *flag, int *actualSource, int *type, vtkTypeInt64 *size)
Nonblocking test for a message.
int Probe(int source, int tag, int *actualSource, double *type, int *size)
Blocking test for a message.
int NoBlockSend(const char *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int Probe(int source, int tag, int *actualSource, unsigned long *type, vtkTypeInt64 *size)
Blocking test for a message.
int NoBlockSend(const int *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int Iprobe(int source, int tag, int *flag, int *actualSource)
Nonblocking test for a message.
int SendVoidArray(const void *data, vtkIdType length, int type, int remoteProcessId, int tag) override
Performs the actual communication.
static void Free(char *ptr)
int WaitAny(int count, Request requests[], int &idx)
Blocks until one of the specified requests in the given request array completes.
int NoBlockSend(const void *data, vtkTypeInt64 length, MPI_Datatype mpiType, int remoteProcessId, int tag, Request &req)
Variant that permits dynamic type sends, like those create by MPI_Type_create_subarray.
int NoBlockReceive(double *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockReceive(unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int AllToAllVVoidArray(const void *sendBuffer, const int *sendCounts, const int *sendOffsets, void *recvBuffer, const int *recvCounts, const int *recvOffsets, int type)
Exchange variable-sized messages between all processes.
int AllGatherVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int ScatterVVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int type, int srcProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
virtual int ReceiveDataInternal(char *data, vtkTypeInt64 length, int sizeoftype, int remoteProcessId, int tag, vtkMPICommunicatorReceiveDataInfo *info, int useCopy, int &senderId)
Implementation for receive data.
int NoBlockSend(const vtkTypeInt64 *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int NoBlockReceive(int *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockSend(const int *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int Iprobe(int source, int tag, int *flag, int *actualSource, int *type, int *size)
Nonblocking test for a message.
int AllReduceVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int Probe(int source, int tag, int *actualSource, int *type, int *size)
Blocking test for a message.
int NoBlockSend(const vtkTypeInt64 *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int NoBlockSend(const unsigned long *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int TestAny(int count, Request requests[], int &idx, int &flag)
Check if at least one of the specified requests has completed.
void CopyFrom(vtkMPICommunicator *source)
Copies all the attributes of source, deleting previously stored data.
int Probe(int source, int tag, int *actualSource, const char *type, int *size)
Blocking test for a message.
int Iprobe(int source, int tag, int *flag, int *actualSource, unsigned long *type, int *size)
Nonblocking test for a message.
int NoBlockSend(const float *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int ReceiveVoidArray(void *data, vtkIdType length, int type, int remoteProcessId, int tag) override
Performs the actual communication.
int NoBlockSend(const unsigned long *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int NoBlockSend(const double *data, int length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int ReduceVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation, int destProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int BroadcastVoidArray(void *data, vtkIdType length, int type, int srcProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int NoBlockReceive(float *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockSend(const unsigned char *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method sends data to another process (non-blocking).
int TestSome(int count, Request requests[], int &NCompleted, int *completed)
Checks the status of all the given request communication object handles.
int Probe(int source, int tag, int *actualSource, unsigned long *type, int *size)
Blocking test for a message.
int NoBlockReceive(char *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int AllGatherVVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type) override
More efficient implementations of collective operations that use the equivalent MPI commands.
int Probe(int source, int tag, int *actualSource, float *type, int *size)
Blocking test for a message.
~vtkMPICommunicator() override
int WaitAll(int count, Request requests[])
Given the request objects of a set of non-blocking operations (send and/or receive) this method block...
int Iprobe(int source, int tag, int *flag, int *actualSource, float *type, int *size)
Nonblocking test for a message.
int AllReduceVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation) override
More efficient implementations of collective operations that use the equivalent MPI commands.
static int CheckForMPIError(int err)
int Probe(int source, int tag, int *actualSource) override
Blocking test for a message.
int WaitSome(int count, Request requests[], int &NCompleted, int *completed)
Blocks until one or more of the specified requests in the given request request array completes.
int NoBlockReceive(vtkTypeInt64 *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int GatherVoidArray(const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int destProcessId) override
More efficient implementations of collective operations that use the equivalent MPI commands.
vtkMPICommunicatorOpaqueComm * GetMPIComm()
void Duplicate(vtkMPICommunicator *source)
Copies all the attributes of source, deleting previously stored data EXCEPT the MPI communicator hand...
int NoBlockReceive(float *data, int length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int Iprobe(int source, int tag, int *flag, int *actualSource, const char *type, int *size)
Nonblocking test for a message.
int NoBlockReceive(char *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int NoBlockReceive(unsigned char *data, vtkTypeInt64 length, int remoteProcessId, int tag, Request &req)
This method receives data from a corresponding send (non-blocking).
int Iprobe(int source, int tag, int *flag, int *actualSource, double *type, int *size)
Nonblocking test for a message.
int TestAll(int count, Request requests[], int &flag)
Checks if the given communication request objects are complete.
int Probe(int source, int tag, int *actualSource, int *type, vtkTypeInt64 *size)
Blocking test for a message.
Process communication using MPI.
A subgroup of processes from a communicator.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition vtkType.h:332
#define VTK_SIZEHINT(...)