Open MPI logo

MPI_Graph_get(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Graph_getR] - Retrieves graph topology information associated with a communicator.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Graph_get(MPI_Comm comm, int maxindex, int maxedges, int index[], int edges[])R]Fortran Syntax



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



C]USE mpi_f08MPI_Graph_get(comm, maxindex, maxedges, index, edges, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: maxindex, maxedges INTEGER, INTENT(OUT) :: index(maxindex), edges(maxedges) INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]commR] : Communicator with graph structure (handle).
[bu]
C]maxindexR] : Length of vector index in the calling program (integer).
[bu]
C]maxedgesR] : Length of vector edges in the calling program (integer).

Output Parameters

[bu]
C]indexR] : Array of integers containing the graph structure (for details see the definition of C]MPI_Graph_createR]).
[bu]
C]edgesR] : Array of integers containing the graph structure.
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

Functions C]MPI_Graphdims_getR] and C]MPI_Graph_getR] retrieve the graph-topology information that was associated with a communicator by C]MPI_Graph_createR].

The information provided by C]MPI_Graphdims_getR] can be used to dimension the vectors C]indexR] and C]edgesR] correctly for a call to C]MPI_Graph_getR].

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_createR](3) C]MPI_Graphdims_getR](3)


Table of Contents

« Return to documentation listing