[This is preliminary documentation and is subject to change.]

The Communicator type exposes the following members.

Methods

  NameDescription
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.
AllgatherOverloaded.
AllreduceOverloaded.
AlltoallOverloaded.
Barrier
Wait until all processes in the communicator have reached the same barrier.
BoolToInt
Convert an array of booleans to an array of integers. Used for some low-level calls that require an array of logical ints to express boolean values.
BroadcastOverloaded.
Clone
Clones the communicator, creating a new (but distinct) communicator with the same processes. The attributes associated with the communicator are copied to the new communicator; which attributes are copied (and how) is dependent on how the Attributes were created.
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()()().)
GatherOverloaded.
GetHashCode (Inherited from Object.)
GetType (Inherited from Object.)
ImmediateProbe
Determine whether a message from the given source and with the specified tag is available, but don't try to receive the message. This routine will return immediately, regardless of whether a message is available, so it is useful for polling to determine whether any messages need to be handled at this time. If your program can't do any work until a message arrives (and the message is guaranteed to arrive, eventually), use Probe(Int32, Int32) instead.
ImmediateReceiveOverloaded.
ImmediateSendOverloaded.
IntToBool
Convert an array of integers to an array of booleans. Used for some low-level calls that return an array of logical ints to express boolean values.
MemberwiseClone (Inherited from Object.)
Probe
Wait for a message from the given source and with the specified tag to become available, but don't try to receive the message. This routine will wait indefinitely for a message meeting the given criteria to arrive, so it should only be invoked when you know a message is coming. If you just want to check whether a message is available use ImmediateProbe(Int32, Int32).
ReceiveOverloaded.
ReduceOverloaded.
ReduceScatterOverloaded.
ScatterOverloaded.
SendOverloaded.
Split
Splits a communicator into several different communicators, each of which is identified by a particular color value.
ToString (Inherited from Object.)

Fields

  NameDescription
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.
Attributes
The set of attributes attached to this communicator.
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

  NameDescription
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.

See Also