Synopsis
int MPI_Comm_create_group(MPI_Comm comm, MPI_Group group, int tag,
MPI_Comm *newcomm)
Input Parameters
- comm
-
intra-communicator (handle)
- group
-
group, which is a subset of the group of comm (handle)
- tag
-
tag (integer)
Output Parameters
- newcomm
-
new communicator (handle)
Description
MPI_Comm_create_group creates a new intra-communicator from a subgroup of an existing intra-communicator, with participation limited to processes in the subgroup.
This function is collective over all MPI processes in group, not over all processes in comm. Each MPI process must provide a group argument that is a subgroup of the group associated with comm. If a nonempty group is specified, then all MPI processes in that group must call the function with the same arguments, including a group that contains the same members with the same ordering. If the calling MPI process is a member of the group given as the group argument, then newcomm is a communicator with group as its associated group. No cached information or virtual topology information propagates from comm to newcomm.
If the calling MPI process is not a member of group, including when group is MPI_GROUP_EMPTY, then the call is local and MPI_COMM_NULL is returned as newcomm. The tag argument does not conflict with tags used in point-to-point communication and wildcards are not permitted for tag. If multiple threads at a given MPI process perform concurrent MPI_COMM_CREATE_GROUP operations, they must distinguish these operations by providing different tag or comm arguments.
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_GROUP - Null or invalid group passed to function.
-
MPI_ERR_TAG - Invalid tag argument. Tags must be non-negative; tags in a receive ('MPI_Recv', 'MPI_Irecv', 'MPI_Sendrecv', etc.) may also be 'MPI_ANY_TAG'. The largest tag value is available through the the attribute 'MPI_TAG_UB'.
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.