|
Packit Service |
c5cf8c |
.TH MPI_Comm_get_name 3 "11/12/2019" " " "MPI"
|
|
Packit Service |
c5cf8c |
.SH NAME
|
|
Packit Service |
c5cf8c |
MPI_Comm_get_name \- Return the print name from the communicator
|
|
Packit Service |
c5cf8c |
.SH SYNOPSIS
|
|
Packit Service |
c5cf8c |
.nf
|
|
Packit Service |
c5cf8c |
int MPI_Comm_get_name(MPI_Comm comm, char *comm_name, int *resultlen)
|
|
Packit Service |
c5cf8c |
.fi
|
|
Packit Service |
c5cf8c |
.SH INPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B comm
|
|
Packit Service |
c5cf8c |
- Communicator to get name of (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH OUTPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B comm_name
|
|
Packit Service |
c5cf8c |
- On output, contains the name of the communicator. It must
|
|
Packit Service |
c5cf8c |
be an array of size at least
|
|
Packit Service |
c5cf8c |
.I MPI_MAX_OBJECT_NAME
|
|
Packit Service |
c5cf8c |
\&.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B resultlen
|
|
Packit Service |
c5cf8c |
- Number of characters in name
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Because MPI specifies that null objects (e.g.,
|
|
Packit Service |
c5cf8c |
.I MPI_COMM_NULL
|
|
Packit Service |
c5cf8c |
) are invalid
|
|
Packit Service |
c5cf8c |
as input to MPI routines unless otherwise specified, using
|
|
Packit Service |
c5cf8c |
.I MPI_COMM_NULL
|
|
Packit Service |
c5cf8c |
as input to this routine is an error.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH THREAD AND INTERRUPT SAFETY
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread and interrupt safe only if no MPI routine that
|
|
Packit Service |
c5cf8c |
updates or frees the same MPI object may be called concurrently
|
|
Packit Service |
c5cf8c |
with this routine.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The MPI standard defined a thread-safe interface but this does not
|
|
Packit Service |
c5cf8c |
mean that all routines may be called without any thread locks. For
|
|
Packit Service |
c5cf8c |
example, two threads must not attempt to change the contents of the
|
|
Packit Service |
c5cf8c |
same
|
|
Packit Service |
c5cf8c |
.I MPI_Info
|
|
Packit Service |
c5cf8c |
object concurrently. The user is responsible in this
|
|
Packit Service |
c5cf8c |
case for using some mechanism, such as thread locks, to ensure that
|
|
Packit Service |
c5cf8c |
only one thread at a time makes use of this routine.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES FOR FORTRAN
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for
|
|
Packit Service |
c5cf8c |
.I MPI_WTIME
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_WTICK
|
|
Packit Service |
c5cf8c |
) have
|
|
Packit Service |
c5cf8c |
an additional argument
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
at the end of the argument list.
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
.I call
|
|
Packit Service |
c5cf8c |
statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g.,
|
|
Packit Service |
c5cf8c |
.I MPI_Datatype
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Comm
|
|
Packit Service |
c5cf8c |
) are of type
|
|
Packit Service |
c5cf8c |
.I INTEGER
|
|
Packit Service |
c5cf8c |
in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH ERRORS
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except
|
|
Packit Service |
c5cf8c |
.I MPI_Wtime
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Wtick
|
|
Packit Service |
c5cf8c |
) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_errhandler
|
|
Packit Service |
c5cf8c |
(for communicators),
|
|
Packit Service |
c5cf8c |
.I MPI_File_set_errhandler
|
|
Packit Service |
c5cf8c |
(for files), and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_set_errhandler
|
|
Packit Service |
c5cf8c |
(for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine
|
|
Packit Service |
c5cf8c |
.I MPI_Errhandler_set
|
|
Packit Service |
c5cf8c |
may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
.I MPI_ERRORS_RETURN
|
|
Packit Service |
c5cf8c |
may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_SUCCESS
|
|
Packit Service |
c5cf8c |
- No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_COMM
|
|
Packit Service |
c5cf8c |
- Invalid communicator. A common error is to use a null
|
|
Packit Service |
c5cf8c |
communicator in a call (not even allowed in
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_rank
|
|
Packit Service |
c5cf8c |
).
|
|
Packit Service |
c5cf8c |
.PD 1
|