Synopsis
int MPI_Comm_split(MPI_Comm comm, int color, int key, MPI_Comm *newcomm)
Input Parameters
- comm
-
communicator (handle)
- color
-
control of subset assignment (integer)
- key
-
control of rank assignment (integer)
Output Parameters
- newcomm
-
new communicator (handle)
Description
MPI_Comm_split partitions the group associated with a communicator into disjoint subgroups based on color and creates a new communicator for each subgroup.
This is a collective operation over the group or groups associated with comm. Each subgroup contains all MPI processes of the same color, ranked in the order defined by key with ties broken according to rank in the old group. An MPI process may supply MPI_UNDEFINED as color, in which case MPI_COMM_NULL is returned in newcomm. Each MPI process is permitted to provide different values for color and key. No cached information propagates from comm to newcomm and no virtual topology information is added to the created communicators. The value of color must be nonnegative or MPI_UNDEFINED. For inter-communicators, MPI processes on the left with the same color as those on the right combine to create a new inter-communicator; colors specified only on one side result in MPI_COMM_NULL. Multiple calls to MPI_COMM_SPLIT may be used to create overlapping communication structures.
Notes
The color must be non-negative or MPI_UNDEFINED.
Algorithm
1. Use `MPI_Allgather` to get the color and key from each process
2. Count the number of processes with the same color; create a
communicator with that many processes. If this process has
'MPI_UNDEFINED' as the color, create a process with a single member.
3. Use key to order the ranks
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.
Notes for Fortran
All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
Errors
All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with 'MPI_Comm_set_errhandler' (for communicators),
'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for
RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but
its use is deprecated. The predefined error handler
'MPI_ERRORS_RETURN' may be used to cause error values to be returned.
Note that MPI does not guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.