Open MPI logo

MPI_Comm_dup(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Comm_dupR] - Duplicates an existing communicator with all its cached information.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Comm_dup(MPI_Comm comm, MPI_Comm *newcomm)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_COMM_DUP(COMM, NEWCOMM, IERROR) INTEGER COMM, NEWCOMM, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Comm_dup(comm, newcomm, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm TYPE(MPI_Comm), INTENT(OUT) :: newcomm INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameter

[bu]
C]commR] : Communicator (handle).

Output Parameters

[bu]
C]newcommR] : Copy of comm (handle).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Comm_dupR] duplicates the existing communicator C]commR] with associated key values. For each key value, the respective copy callback function determines the attribute value associated with this key in the new communicator; one particular action that a copy callback may take is to delete the attribute from the new communicator. Returns in newcomm a new communicator with the same group, any copied cached information, but a new context (see Section 5.7.1 of the MPI-1 Standard, [lq]Functionality[rq]).

Notes

This operation is used to provide a parallel library call with a duplicate communication space that has the same properties as the original communicator. This includes any attributes (see below) and topologies (see Chapter 6, [lq]Process Topologies,[rq] in the MPI-1 Standard). This call is valid even if there are pending point-to-point communications involving the communicator C]commR]. A typical call might involve an C]MPI_Comm_dupR] at the beginning of the parallel call, and an C]MPI_Comm_freeR] of that duplicated communicator at the end of the call. Other models of communicator management are also possible. This call applies to both intra- and intercommunicators. Note that it is not defined by the MPI standard what happens if the attribute copy callback invokes other MPI functions. In Open MPI, it is not valid for attribute copy callbacks (or any of their children) to add or delete attributes on the same object on which the attribute copy callback is being invoked.

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_Comm_dup_with_infoR](3) C]MPI_Comm_idupR](3)


Table of Contents

« Return to documentation listing