Synopsis
int MPI_Comm_create_from_group(MPI_Group group, const char *stringtag,
MPI_Info info, MPI_Errhandler errhandler,
MPI_Comm *newcomm)
Input Parameters
- group
-
group (handle)
- stringtag
-
unique identifier for this operation (string)
- info
-
info object (handle)
- errhandler
-
error handler to be attached to new intra-communicator (handle)
Output Parameters
- newcomm
-
new communicator (handle)
Description
MPI_Comm_create_from_group creates a new intra-communicator from a specified group without requiring an existing communicator as input.
All MPI processes in the nonempty group must call the function with identical arguments, including the same members in the same order and identical stringtag values. The stringtag argument differentiates concurrent communicator creation operations in a multithreaded environment. If MPI_GROUP_EMPTY is supplied as the group argument, the call is a local operation and MPI_COMM_NULL is returned as newcomm. No cached information or virtual topology information is propagated to the new communicator. The errhandler argument specifies an error handler to be attached to the new intra-communicator. The info argument provides hints and assertions to guide communicator creation.
If multiple threads at a given MPI process perform concurrent MPI_COMM_CREATE_FROM_GROUP operations, users must distinguish these operations by providing different stringtag arguments. The stringtag shall not exceed MPI_MAX_STRINGTAG_LEN characters in length.
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_ERRHANDLER - Invalid error handler argument.
-
MPI_ERR_GROUP - Null or invalid group passed to function.
-
MPI_ERR_INFO - Invalid Info
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.