MPI_GRAPH_GET(3)
π MPI_Graph_get β Open MPI (3)
okay so bestie, welcome to the MPI_GRAPH_GET(3) page π this is the Open MPI one, and it's literally about pulling the graph topology info back out of a communicator. let me walk you through it π«Ά
β¨ SYNTAX β¨
πΈ C Syntax
#include <mpi.h>
int MPI_Graph_get(MPI_Comm comm, int maxindex, int maxedges,
int index[], int edges[])
π Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GRAPH_GET(COMM, MAXINDEX, MAXEDGES, INDEX, EDGES, IERROR)
INTEGER COMM, MAXINDEX, MAXEDGES, INDEX(*)
INTEGER EDGES(*), IERROR
π¦ Fortran 2008 Syntax
USE mpi_f08
MPI_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) :: ierror
π INPUT PARAMETERS π
commβ the communicator that's got the graph structure, it's a handle, main character honestly πmaxindexβ the length of theindexvector in the calling program, integer bestie, don't fumble this one πmaxedgesβ the length of theedgesvector in the calling program, also an integer, also don't fumble it π
β OUTPUT PARAMETERS β
indexβ an array of integers holding the graph structure (for the full details, go peek at the definition ofMPI_Graph_create, iykyk) β¨edgesβ an array of integers holding the graph structure, yes again, both of them carry graph structure πierrorβ Fortran only, boo: the error status, an integer πΈ
π₯ DESCRIPTION π₯
so the functions MPI_Graphdims_get and MPI_Graph_get retrieve the graph-topology information that was associated with a communicator by MPI_Graph_create. like, it's giving "who did this communicator get matched with" energy π
and the information that MPI_Graphdims_get hands you can be used to dimension the vectors index and edges correctly for a call to MPI_Graph_get. literally size them right first, then go get them, periodt π
π§ ERRORS π§
almost all MPI routines return an error value bestie β C routines give it back as the return result of the function, and Fortran routines put it in the last argument π
before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. if no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. when MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. the initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. if no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. ngl that's a lot but it all matters π«Ά
Open MPI includes three predefined error handlers that can be used:
MPI_ERRORS_ARE_FATALβ causes the program to abort all connected MPI processes πMPI_ERRORS_ABORTβ an error handler that can be invoked on a communicator, window, file, or session. when called on a communicator, it acts as ifMPI_Abortwas called on that communicator. if called on a window or file, acts as ifMPI_Abortwas called on a communicator containing the group of processes in the corresponding window or file. if called on a session, aborts only the local process π₯MPI_ERRORS_RETURNβ returns an error code to the application, cute and polite β¨
MPI applications can also implement their own error handlers by calling:
MPI_Comm_create_errhandlerthenMPI_Comm_set_errhandlerMPI_File_create_errhandlerthenMPI_File_set_errhandlerMPI_Session_create_errhandlerthenMPI_Session_set_errhandleror atMPI_Session_initMPI_Win_create_errhandlerthenMPI_Win_set_errhandler
note that MPI does not guarantee that an MPI program can continue past an error. so like... don't count on it bestie π
see the MPI man page for a full list of MPI error codes π
see the Error Handling section of the MPI-3.1 standard for more information π
π SEE ALSO:
MPI_Graph_create
π COPYRIGHT π
2003-2026, The Open MPI Community
and that's the whole page bestie, slay π
β¨ the footer says π¦ Sep 11, 2026 π¦ and it's all from the MPI_GRAPH_GET(3) page of Open MPI β go forth and get those graphs ππ
π¦ where this page comes from
- arch rolling: openmpi 5.0.11-1 Β· BSD-3-Clause AND LicenseRef-MPICH
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms