Open MPI logo

MPI_Graph_create(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Graph_createR] - Makes a new communicator to which topology information has been attached.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Graph_create(MPI_Comm comm_old, int nnodes, const int index[], const int edges[], int reorder, MPI_Comm *comm_graph)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GRAPH_CREATE(COMM_OLD, NNODES, INDEX, EDGES, REORDER, COMM_GRAPH, IERROR) INTEGER COMM_OLD, NNODES, INDEX(*), EDGES(*) INTEGER COMM_GRAPH, IERROR LOGICAL REORDERR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Graph_create(comm_old, nnodes, index, edges, reorder, comm_graph, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm_old INTEGER, INTENT(IN) :: nnodes, index(nnodes), edges(*) LOGICAL, INTENT(IN) :: reorder TYPE(MPI_Comm), INTENT(OUT) :: comm_graph INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]comm_oldR] : Input communicator without topology (handle).
[bu]
C]nnodesR] : Number of nodes in graph (integer).
[bu]
C]indexR] : Array of integers describing node degrees (see below).
[bu]
C]edgesR] : Array of integers describing graph edges (see below).
[bu]
C]reorderR] : Ranking may be reordered (true) or not (false) (logical).

Output Parameters

[bu]
C]comm_graphR] : Communicator with graph topology added (handle).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Graph_createR] returns a handle to a new communicator to which the graph topology information is attached. If C]reorderR] = false then the rank of each process in the new group is identical to its rank in the old group. Otherwise, the function may C]reorderR] the processes. If the size, C]nnodesR], of the graph is smaller than the size of the group of C]comm_oldR], then some processes are returned C]MPI_COMM_NULLR], in analogy to C]MPI_Cart_createR] and C]MPI_Comm_splitR]. The call is erroneous if it specifies a graph that is larger than the group size of the input communicator.

The three parameters C]nnodesR], C]indexR], and C]edgesR] define the graph structure. C]nnodesR] is the number of nodes of the graph. The nodes are numbered from 0 to C]nnodesR]-1. The ith entry of array C]indexR] stores the total number of neighbors of the first i graph nodes. The lists of neighbors of nodes 0, 1, ..., C]nnodesR]-1 are stored in consecutive locations in array C]edgesR]. The array C]edgesR] is a flattened representation of the edge lists. The total number of entries in C]indexR] is C]nnodesR] and the total number of entries in C]edgesR] is equal to the number of graph C]edgesR].

The definitions of the arguments C]nnodesR], C]indexR], and C]edgesR] are illustrated with the following simple example.

Example: Assume there are four processes 0, 1, 2, 3 with the following adjacency matrix:

ProcessNeighbors
0 1, 3
1 0
2 3
3 0, 2

Then, the input arguments are: * C]nodesR] = 4 * C]indexR] = 2, 3, 4, 6 * C]edgesR] = 1, 3, 0, 3, 0, 2

Thus, in C, C]index[0]R] is the degree of C]nodeR] zero, and C]index[i]R] - C]index[i-1]R] is the degree of C]nodeR] i, i=1, . . . , nnodes-1; the list of neighbors of node zero is stored in C]edges[j]R], for 0 <= j <= C]index[0] - 1R] and the list of neighbors of C]nodeR] i, i > 0 , is stored in C]edges[j]R], C]index[i-1]R] <= j <= C]index[i] - 1R].

In Fortran, C]index(1)R] is the degree of C]nodeR] zero, and C]index(i+1)R] - C]index(i)R] is the degree of C]nodeR] i, i=1, . . . , nnodes-1; the list of neighbors of C]nodeR] zero is stored in C]edges(j)R], for 1 <= j <= C]index(1)R] and the list of neighbors of C]nodeR] i, i > 0, is stored in C]edges(j)R], C]index(i) + 1R] <= j <= C]index(i + 1)R].

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.

See Also

C]MPI_Graph_getR](3) C]MPI_Graphdims_getR](3)


Table of Contents

« Return to documentation listing