.TH MPI_Intercomm_merge 3 "11/12/2019" " " "MPI"
.SH NAME
MPI_Intercomm_merge \-  Creates an intracommuncator from an intercommunicator 
.SH SYNOPSIS
.nf
int MPI_Intercomm_merge(MPI_Comm intercomm, int high, MPI_Comm * newintracomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B intercomm 
- Intercommunicator (handle)
.PD 1
.PD 0
.TP
.B high 
- Used to order the groups within comm (logical)
when creating the new communicator.  This is a boolean value; the group
that sets high true has its processes ordered 
.B after
the group that sets
this value to false.  If all processes in the intercommunicator provide
the same value, the choice of which group is ordered first is arbitrary.
.PD 1

.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newintracomm 
- Created intracommunicator (handle)
.PD 1

.SH NOTES
While all processes may provide the same value for the 
.I high
parameter,
this requires the MPI implementation to determine which group of
processes should be ranked first.

.SH THREAD AND INTERRUPT SAFETY

This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as 
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.

.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for 
.I MPI_WTIME
and 
.I MPI_WTICK
) have
an additional argument 
.I ierr
at the end of the argument list.  
.I ierr
is an integer and has the same meaning as the return value of the routine
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.

All MPI objects (e.g., 
.I MPI_Datatype
, 
.I MPI_Comm
) are of type 
.I INTEGER
in Fortran.

.SH ALGORITHM
.nr e 1 1

\\neAllocate contexts
\\neLocal and remote group leaders swap high values
\\neDetermine the high value.
\\neMerge the two groups and make the intra-communicator
.rr e


.SH ERRORS

All MPI routines (except 
.I MPI_Wtime
and 
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument.  Before the value is returned, the current MPI error handler is
called.  By default, this error handler aborts the MPI job.  The error handler
may be changed with 
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and 
.I MPI_Win_set_errhandler
(for
RMA windows).  The MPI-1 routine 
.I MPI_Errhandler_set
may be used but
its use is deprecated.  The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does 
.B not
guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.

.PD 0
.TP
.B MPI_SUCCESS 
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM 
- Invalid communicator.  A common error is to use a null
communicator in a call (not even allowed in 
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_INTERN 
- This error is returned when some part of the MPICH 
implementation is unable to acquire memory.  
.PD 1

.SH SEE ALSO
MPI_Intercomm_create, MPI_Comm_free
.br