MPI_Comm_dup(3)

1MPI_Comm_dup(3)                     LAM/MPI                    MPI_Comm_dup(3)
2
3
4

NAME

6       MPI_Comm_dup -  Duplicates an existing communicator with all its cached
7       information
8

SYNOPSIS

10       #include <mpi.h>
11       int MPI_Comm_dup(MPI_Comm comm, MPI_Comm* newcomm)
12

INPUT PARAMETER

14       comm   - communicator (handle)
15
16

OUTPUT PARAMETER

18       newcomm
19              - copy of comm (handle)
20
21

NOTES

23       As per standard, this is a collective call over all processes in comm .
24
25
26

NOTES FOR FORTRAN

28       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )  have
29       an  additional  argument ierr at the end of the argument list.  ierr is
30       an integer and has the same meaning as the return value of the  routine
31       in  C.   In Fortran, MPI routines are subroutines, and are invoked with
32       the call statement.
33
34       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
35       Fortran.
36
37

ERRORS

39       If an error occurs in an MPI function, the current MPI error handler is
40       called to handle it.  By default, this error  handler  aborts  the  MPI
41       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
42       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
43       values  to  be  returned  (in C and Fortran; this error handler is less
44       useful in with the C++ MPI  bindings.   The  predefined  error  handler
45       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
46       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
47       program can continue past an error.
48
49       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
50       value; C routines as the value of the function and Fortran routines  in
51       the  last  argument.  The C++ bindings for MPI do not return error val‐
52       ues; instead, error values are communicated by throwing  exceptions  of
53       type  MPI::Exception  (but not by default).  Exceptions are only thrown
54       if the error value is not MPI::SUCCESS .
55
56
57       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
58       functions  will  return  upon an error, there will be no way to recover
59       what the actual error value was.
60       MPI_SUCCESS
61              - No error; MPI routine completed successfully.
62       MPI_ERR_COMM
63              - Invalid communicator.  A common error is to use a null  commu‐
64              nicator in a call (not even allowed in MPI_Comm_rank ).
65       MPI_ERR_ARG
66              - Invalid argument.  Some argument is invalid and is not identi‐
67              fied by a specific  error  class.   This  is  typically  a  NULL
68              pointer or other such error.
69       MPI_ERR_INTERN
70              -  An  internal error has been detected.  This is fatal.  Please
71              send a bug report to the LAM mailing list  (see  http://www.lam-
72              mpi.org/contact.php ).
73       MPI_ERR_OTHER
74              - This error is returned when some part of the LAM/MPI implemen‐
75              tation is unable to acquire memory.
76
77

MORE INFORMATION

83       For more information, please see the official MPI Forum web site, which
84       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
85       ments contain detailed information about each  MPI  function  (most  of
86       which is not duplicated in these man pages).
87
88       http://www.mpi-forum.org/
89
90
91

ACKNOWLEDGEMENTS

93       The  LAM Team would like the thank the MPICH Team for the handy program
94       to generate man pages  ("doctext"  from  ftp://ftp.mcs.anl.gov/pub/sow‐
95       ing/sowing.tar.gz  ), the initial formatting, and some initial text for
96       most of the MPI-1 man pages.
97

LOCATION

99       cdup.c
100
101
102
103LAM/MPI 7.1.2                      2/23/2006                   MPI_Comm_dup(3)