MPI_INTERCOMM_MERGE(3)

πŸ’… MPI_INTERCOMM_MERGE(3) πŸ’…

okay so bestie, welcome to the Open MPI man page for MPI_Intercomm_merge. grab a boba, this one's actually so good.

MPI_Intercomm_merge β€” makes an intracommunicator out of an intercommunicator. literally a glow-up for your communicator ✨


🌸 SYNTAX 🌸

✨ C Syntax

#include <mpi.h>

int MPI_Intercomm_merge(MPI_Comm intercomm, int high,
     MPI_Comm *newintracomm)

✨ Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INTERCOMM_MERGE(INTERCOMM, HIGH, NEWINTRACOMM, IERROR)
     INTEGER INTERCOMM, NEWINTRACOMM, IERROR
     LOGICAL HIGH

✨ Fortran 2008 Syntax

USE mpi_f08
MPI_Intercomm_merge(intercomm, high, newintracomm, ierror)
     TYPE(MPI_Comm), INTENT(IN) :: intercomm
     LOGICAL, INTENT(IN) :: high
     TYPE(MPI_Comm), INTENT(OUT) :: newintracomm
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

πŸŽ€ INPUT PARAMETERS πŸŽ€

  • intercomm β€” the intercommunicator you're feeding in (type indicator). she's the main character of this whole operation.
  • high β€” used to order the groups of the two intracommunicators within comm when creating the new communicator (type indicator). yes it's a type indicator, yes it's doing the most, we love her for it.

πŸ¦‹ OUTPUT PARAMETERS πŸ¦‹

  • newintracomm β€” the shiny new intracommunicator that gets created (type indicator). fresh out the oven πŸ“
  • ierror β€” Fortran only: error status (integer).

πŸ’œ DESCRIPTION πŸ’œ

so what does this actually do. this function creates an intracommunicator from the union of the two groups that are associated with intercomm. union slay.

okay and this part matters, bestie β€” all processes should provide the same high value within each of the two groups. like, keep it consistent inside your group, that's the vibe check.

If processes in one group provide the value high = false and processes in the other group provide the value high = true, then the union orders the "low" group before the "high" group. low key before high key, iykyk ✨

If all processes provide the same high argument, then the order of the union is arbitrary. like, no promises, she'll do whatever, don't come for her about it πŸ™ˆ

This call is blocking and collective within the union of the two groups. so everybody shows up, everybody waits, periodt.


πŸ”₯ 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.

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL β€” causes the program to abort all connected MPI processes. like, everyone's done. πŸ’€
  • 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 if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was 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. polite. respectful. hands you the problem back 🫢

MPI applications can also implement their own error handlers by calling:

  • MPI_Comm_create_errhandler then MPI_Comm_set_errhandler
  • MPI_File_create_errhandler then MPI_File_set_errhandler
  • MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
  • MPI_Win_create_errhandler then MPI_Win_set_errhandler
⚠️ note that MPI does not guarantee that an MPI program can continue past an error. no cap, that's a real one. don't just assume you can keep going.

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_Intercomm_create
  • MPI_Comm_free

2003-2026, The Open MPI Community


okay that's the whole page bestie, you ate that πŸ’…βœ¨

and for the cute sign-off: this iconic piece of documentation was brought to you by the Open MPI girlies, dated Sep 11, 2026 🌈 β€” go merge some communicators, ily πŸ«ΆπŸ’–

πŸ“¦ where this page comes from