[This is preliminary documentation and is subject to change.]
The Communicator type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| Abort |
Terminates all processes in this communicator. In most systems, this terminates all processes.
| |
| Adopt |
Adopts a low-level MPI communicator that was created with any of the low-level MPI facilities.
The resulting Communicator object will manage the lifetime of the low-level MPI communicator,
and will free the communicator when it is disposed or finalized.
| |
| Allgather | Overloaded. | |
| Allreduce | Overloaded. | |
| Alltoall | Overloaded. | |
| Barrier |
Wait until all processes in the communicator have reached the same barrier.
| |
| Broadcast | Overloaded. | |
| Clone |
Clones the communicator, creating a new (but distinct) communicator with the
same processes.
| |
| Compare |
Compare two MPI communicators.
| |
| Create |
Creates a new communicator containing all of the processes in the given group.
The resulting communicator may be null, if the calling process is not in this group.
| |
| Dispose |
Free the MPI communicator.
| |
| Equals | (Inherited from Object.) | |
| Finalize |
Finalizer that frees the MPI communicator.
(Overrides Object..::.Finalize()()().) | |
| Gather | Overloaded. | |
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| ImmediateReceive | Overloaded. | |
| ImmediateSend | Overloaded. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| Receive | Overloaded. | |
| Reduce | Overloaded. | |
| ReduceScatter | Overloaded. | |
| Scatter | Overloaded. | |
| Send | Overloaded. | |
| Split |
Splits a communicator into several different communicators, each of which is identified
by a particular color value.
| |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
| anySource |
Special value for the source argument to Receivec> that
indicates that the message can be received from any process in the communicator.
| |
| anyTag |
Special value for the tag argument to Receive that
indices that the message with any tag can be received by the receive operation.
| |
| self |
The "self" communicator is a simple communicator that contains only
the currently-executing process.
| |
| world |
The "world" communicator contains all of the processes that were
originally created by MPI.
|
Properties
| Name | Description | |
|---|---|---|
| Group |
Retrieve the group containing all of the processes in this communicator.
| |
| Rank |
Returns the rank of the currently executing process within this
communicator.
| |
| Size |
Returns the number of processes within this communicator.
|