Open MPI logo

MPI_Graph_map(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Graph_mapR] - Maps process to graph topology information.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Graph_map(MPI_Comm comm, int nnodes, const int index[], const int edges[], int *newrank)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GRAPH_MAP(COMM, NNODES, INDEX, EDGES, NEWRANK, IERROR) INTEGER COMM, NNODES, INDEX(*), EDGES(*), NEWRANK, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Graph_map(comm, nnodes, index, edges, newrank, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: nnodes, index(nnodes), edges(*) INTEGER, INTENT(OUT) :: newrank INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]commR] : Input communicator (handle).
[bu]
C]nnodesR] : Number of graph nodes (integer).
[bu]
C]indexR] : Integer array specifying the graph structure, see C]MPI_Graph_createR].
[bu]
C]edgesR] : Integer array specifying the graph structure.

Output Parameters

[bu]
C]newrankR] : Reordered rank of the calling process; MPI_UNDEFINED if the calling process does not belong to graph (integer).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Cart_mapR] and C]MPI_Graph_mapR] can be used to implement all other topology functions. In general they will not be called by the user directly, unless he or she is creating additional virtual topology capability other than that provided by MPI.

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_Cart_mapR](3)


Table of Contents

« Return to documentation listing