Synopsis
int MPI_Graph_create(MPI_Comm comm_old, int nnodes, const int indx[],
const int edges[], int reorder, MPI_Comm *comm_graph)
Input Parameters
- comm_old
-
input communicator (handle)
- nnodes
-
number of nodes in graph (integer)
- indx
-
array of integers describing node degrees (see below)
- edges
-
array of integers describing graph edges (see below)
- reorder
-
ranking may be reordered (true) or not (false)
Output Parameters
- comm_graph
-
communicator with graph topology added (handle)
Description
MPI_Graph_create creates a new communicator with graph topology information attached.
This collective operation returns a handle to a new communicator to which the graph topology information is attached. If reorder = false, the rank of each process in the new communicator is identical to its rank in comm_old; if reorder = true, the function may reorder the ranks. If nnodes is smaller than the size of the group of comm_old, some processes return MPI_COMM_NULL; if nnodes = 0, MPI_COMM_NULL is returned in all processes. Each process specifies all nodes and edges in the graph, and all input arguments must have identical values on all processes. The call is erroneous if the specified graph is larger than the group size. A process may be defined multiple times in the list of neighbors of a process, and a process may be a neighbor to itself. Performance implications of using multiple edges or a nonsymmetric adjacency matrix are not defined, and the definition of a node-neighbor edge does not imply a direction of communication.
Notes
Each process must provide a description of the entire graph, not just the neighbors of the calling process.
Algorithm
We ignore the reorder info currently.
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_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.