[This is preliminary documentation and is subject to change.]
The CartesianCommunicator type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| Abort |
Terminates all processes in this communicator. In most systems, this terminates all processes.
(Inherited from Communicator.) | |
| Allgather | Overloaded. | |
| Allreduce | Overloaded. | |
| Alltoall | Overloaded. | |
| Barrier |
Wait until all processes in the communicator have reached the same barrier.
(Inherited from Communicator.) | |
| Broadcast | Overloaded. | |
| 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.
(Inherited from Communicator.) | |
| Compare |
Compare two MPI communicators.
(Inherited from Communicator.) | |
| ComputeDimensions |
Suggests a size for each dimension for a Cartesian topology, given the number of nodes and dimensions.
| |
| 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.
(Inherited from Communicator.) | |
| Dispose |
Free the MPI communicator.
(Inherited from Communicator.) | |
| Equals | (Inherited from Object.) | |
| ExclusiveScan | Overloaded. | |
| Finalize |
Finalizer that frees the MPI communicator.
(Inherited from Communicator.) | |
| Gather | Overloaded. | |
| GetCartesianCoordinates |
Provides the coordinates in the communicator's grid of a process, given its rank.
| |
| GetCartesianRank |
Returns a process' rank given its coordinates in the CartesianCommunicator's grid.
| |
| 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.) | |
| 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.
(Inherited from Communicator.) | |
| ImmediateReceive | Overloaded. | |
| ImmediateSend | Overloaded. | |
| Map |
Returns a recommended configuration for a new Cartesian grid.
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| NeighborsOf |
Retrieve the neighbors of another process.
(Overrides TopologicalCommunicator..::.NeighborsOf(Int32).) | |
| 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).
(Inherited from Communicator.) | |
| Receive | Overloaded. | |
| Reduce | Overloaded. | |
| ReduceScatter | Overloaded. | |
| Scan | Overloaded. | |
| Scatter | Overloaded. | |
| Send | Overloaded. | |
| Shift |
Finds the source and destination ranks necessary to shift data along the grid.
| |
| Split |
Splits a communicator into several different communicators, each of which is identified
by a particular color value.
(Inherited from Communicator.) | |
| Subgrid |
Construct a lower dimensional subgrid from an existing CartesianCommunicator.
| |
| ToString | (Inherited from Object.) |