1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Comm_dup 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Comm_dup \fP \- Duplicates an existing communicator with all its cached information. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Comm_dup(MPI_Comm \fIcomm\fP, MPI_Comm\fI *newcomm\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_COMM_DUP(\fICOMM, NEWCOMM, IERROR\fP) |
---|
18 | INTEGER \fICOMM, NEWCOMM, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | Intracomm Intracomm::Dup() const |
---|
24 | |
---|
25 | Intercomm Intercomm::Dup() const |
---|
26 | |
---|
27 | .SH INPUT PARAMETER |
---|
28 | .ft R |
---|
29 | .TP 1i |
---|
30 | comm |
---|
31 | Communicator (handle). |
---|
32 | |
---|
33 | .SH OUTPUT PARAMETERS |
---|
34 | .ft R |
---|
35 | .TP 1i |
---|
36 | newcomm |
---|
37 | Copy of comm (handle). |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | IERROR |
---|
41 | Fortran only: Error status (integer). |
---|
42 | |
---|
43 | .SH DESCRIPTION |
---|
44 | .ft R |
---|
45 | MPI_Comm_dup duplicates the existing communicator comm with associated key |
---|
46 | 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, "Functionality"). |
---|
47 | |
---|
48 | .SH NOTES |
---|
49 | This operation is used to provide a parallel |
---|
50 | 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, "Process Topologies," in the MPI-1 Standard). This call is valid even if there are pending point-to-point communications involving the communicator comm. A typical call might involve an MPI_Comm_dup at the beginning of the parallel call, and an MPI_Comm_free of that duplicated communicator at the end of the call. Other models of communicator management are also possible. |
---|
51 | .sp |
---|
52 | This call applies to both intra- and intercommunicators. |
---|
53 | |
---|
54 | .SH ERRORS |
---|
55 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
56 | .sp |
---|
57 | Before the error value is returned, the current MPI error handler is |
---|
58 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN 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. |
---|
59 | |
---|
60 | |
---|