MPI_COMM_DISCONNECT(3)
π MPI_COMM_DISCONNECT π
okay bestie, gather round, because this is the Open MPI page for MPI_Comm_disconnect, and it's genuinely iconic. it deallocates a communicator object and sets the handle to MPI_COMM_NULL. that's it. that's the whole job. and it does the job flawlessly. β¨
π NAME π
MPI_Comm_disconnect β deallocates the communicator object and sets the handle to MPI_COMM_NULL. no cap. π
πΈ SYNTAX πΈ
β¨ C Syntax β¨
#include <mpi.h>
int MPI_Comm_disconnect(MPI_Comm *comm)
β¨ Fortran Syntax β¨
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_DISCONNECT(COMM, IERROR)
INTEGER COMM, IERROR
β¨ Fortran 2008 Syntax β¨
USE mpi_f08
MPI_Comm_disconnect(comm, ierror)
TYPE(MPI_Comm), INTENT(INOUT) :: comm
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
π«Ά INPUT/OUTPUT PARAMETER π«Ά
commβ the communicator, as a handle. it goes in, and (spoiler) its handle comes back out set toMPI_COMM_NULL. it's giving β¨transformation arcβ¨.
π OUTPUT PARAMETER π
ierrorβ Fortran only, bestie: the error status, as an integer.
π¦ DESCRIPTION π¦
so here's the tea. π MPI_Comm_disconnect waits for all pending communication on comm to complete internally, deallocates the communicator object, and sets the handle to MPI_COMM_NULL. done and dusted.
it is a collective operation. everyone's in on it together. periodt.
β οΈ it may not be called with the communicatorMPI_COMM_WORLDorMPI_COMM_SELF. like, do not. it's simply not that girl's job.
MPI_Comm_disconnect may be called only if all communication is complete and matched, so that buffered data can be delivered to its destination. this requirement is, and I quote the vibes, the same as for MPI_Finalize. π
and the way that it's basically the sibling of MPI_Comm_free: MPI_Comm_disconnect has the same action as MPI_Comm_free, except that it waits for pending communication to finish internally and enables the guarantee about the behavior of disconnected processes. that's the extra β¨sauceβ¨, that's the whole point, iykyk. π
π NOTES π
to disconnect two processes you may need to call MPI_Comm_disconnect, MPI_Win_free, and MPI_File_close to remove all communication paths between the two processes. every single one. no leftovers. π
and note that it may be necessary to disconnect several communicators (or to free several windows or files) before two processes are completely independent. one communicator is not always enough, bestie β sometimes you gotta do the whole cleanup arc before anyone's truly free. π
π ERRORS π
almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines 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. π (dramatic, but true.)
Open MPI includes three predefined error handlers that can be used:
MPI_ERRORS_ARE_FATALβ causes the program to abort all connected MPI processes. π it's giving nuclear option.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. the polite one. π«Ά
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. π fr fr, it's not a "keep going bestie" situation.
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_Comm_connect
π Copyright π
2003-2026, The Open MPI Community
okay that's the whole page, you ate it, you read it, you're basically an MPI girlie now. π§β¨ this was MPI_COMM_DISCONNECT(3) from the Open MPI fam, dated Sep 10, 2026 β go disconnect something (not MPI_COMM_WORLD, bestie, I'm begging π). mwah π
π¦ where this page comes from
- ubuntu stonking: openmpi-doc 5.0.10-6 Β· other
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms