132 lines
2.7 KiB
Groff
132 lines
2.7 KiB
Groff
.TH MPI_Graph_get 3 "6/5/2019" " " "MPI"
|
|
.SH NAME
|
|
MPI_Graph_get \- Retrieves graph topology information associated with a communicator
|
|
.SH SYNOPSIS
|
|
.nf
|
|
int MPI_Graph_get(MPI_Comm comm, int maxindex, int maxedges, int indx[], int edges[])
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.PD 0
|
|
.TP
|
|
.B comm
|
|
- communicator with graph structure (handle)
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B maxindex
|
|
- length of vector
|
|
.I indx
|
|
in the calling program (integer)
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B maxedges
|
|
- length of vector
|
|
.I edges
|
|
in the calling program (integer)
|
|
.PD 1
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.PD 0
|
|
.TP
|
|
.B indx
|
|
- array of integers containing the graph structure (for details see the definition of
|
|
.I MPI_GRAPH_CREATE
|
|
)
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B edges
|
|
- array of integers containing the graph structure
|
|
.PD 1
|
|
|
|
.SH THREAD AND INTERRUPT SAFETY
|
|
|
|
This routine is both thread- and interrupt-safe.
|
|
This means that this routine may safely be used by multiple threads and
|
|
from within a signal handler.
|
|
|
|
.SH NOTES FOR FORTRAN
|
|
All MPI routines in Fortran (except for
|
|
.I MPI_WTIME
|
|
and
|
|
.I MPI_WTICK
|
|
) have
|
|
an additional argument
|
|
.I ierr
|
|
at the end of the argument list.
|
|
.I 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
|
|
.I call
|
|
statement.
|
|
|
|
All MPI objects (e.g.,
|
|
.I MPI_Datatype
|
|
,
|
|
.I MPI_Comm
|
|
) are of type
|
|
.I INTEGER
|
|
in Fortran.
|
|
|
|
.SH ERRORS
|
|
|
|
All MPI routines (except
|
|
.I MPI_Wtime
|
|
and
|
|
.I 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
|
|
.I MPI_Comm_set_errhandler
|
|
(for communicators),
|
|
.I MPI_File_set_errhandler
|
|
(for files), and
|
|
.I MPI_Win_set_errhandler
|
|
(for
|
|
RMA windows). The MPI-1 routine
|
|
.I MPI_Errhandler_set
|
|
may be used but
|
|
its use is deprecated. The predefined error handler
|
|
.I MPI_ERRORS_RETURN
|
|
may be used to cause error values to be returned.
|
|
Note that MPI does
|
|
.B not
|
|
guarentee that an MPI program can continue past
|
|
an error; however, MPI implementations will attempt to continue whenever
|
|
possible.
|
|
|
|
.PD 0
|
|
.TP
|
|
.B MPI_SUCCESS
|
|
- No error; MPI routine completed successfully.
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_TOPOLOGY
|
|
- Invalid topology. Either there is no topology
|
|
associated with this communicator, or it is not the correct type (e.g.,
|
|
.I MPI_CART
|
|
when expecting
|
|
.I MPI_GRAPH
|
|
).
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_COMM
|
|
- Invalid communicator. A common error is to use a null
|
|
communicator in a call (not even allowed in
|
|
.I MPI_Comm_rank
|
|
).
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_ARG
|
|
- Invalid argument. Some argument is invalid and is not
|
|
identified by a specific error class (e.g.,
|
|
.I MPI_ERR_RANK
|
|
).
|
|
.PD 1
|