MPI_Comm_set_name − Set a name on a communicator
MPI_Comm_set_name(MPI_Comm comm, char *name)
- Pointer to the name of communicator
This function associates a name with a communicator, which can be useful for debugging purposes. The function MPI_Comm_get_name can be used to retrieve name that was previously set with MPI_Comm_set_name .
The MPI_COMM_WORLD , MPI_COMM_SELF , and parent communicator (if an application was launched via MPI_Comm_spawn or MPI_Comm_spawn_multiple ) have the predefined names MPI_COMM_WORLD , MPI_COMM_SELF , and MPI_COMM_PARENT , respectively. It is legal to change any of these names with calls to MPI_Comm_set_name .
Names passed in C must include the null terminator, and can be of maximum length MPI_MAX_OBJECT_NAME (including the null terminator). Names passed in Fortran can also have a maximum length of MPI_MAX_OBJECT_NAME .
Setting a name on a communicator that already has a name associated with it replaces the old name.
If an error occurs in an MPI function, the current MPI error handler is called to handle it. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned (in C and Fortran; this error handler is less useful in with the C++ MPI bindings. The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered). Note that MPI does not guarantee that an MPI program can continue past an error.
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. The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing exceptions of type MPI::Exception (but not by default). Exceptions are only thrown if the error value is not MPI::SUCCESS .
Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover what the actual error value was.
- No error; MPI routine completed successfully.
- Invalid communicator. A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank ).
- Invalid argument. Some argument is invalid and is not identified by a specific error class. This is typically a NULL pointer or other such error.
MPI_Comm_get_name, MPI_Type_get_name, MPI_Type_set_name, MPI_Win_get_name, MPI_Win_set_name
For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards. These documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).