Blame www/www3/MPI_Comm_dup_with_info.html

Packit 0848f5
Packit 0848f5
<HTML>
Packit 0848f5
<HEAD>
Packit 0848f5
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit 0848f5
<TITLE>MPI_Comm_dup_with_info</TITLE>
Packit 0848f5
</HEAD>
Packit 0848f5
<BODY BGCOLOR="FFFFFF">
Packit 0848f5

MPI_Comm_dup_with_info

Packit 0848f5
Duplicates an existing communicator with all its cached information 
Packit 0848f5

Synopsis

Packit 0848f5
Packit 0848f5
int MPI_Comm_dup_with_info(MPI_Comm comm, MPI_Info info, MPI_Comm * newcomm)
Packit 0848f5
Packit 0848f5

Input Parameters

Packit 0848f5
Packit 0848f5
comm
Communicator to be duplicated (handle)
Packit 0848f5
Packit 0848f5
info
info object (handle)
Packit 0848f5
Packit 0848f5

Packit 0848f5

Output Parameters

Packit 0848f5
newcomm
A new communicator over the same group as <tt>comm</tt> but with a new
Packit 0848f5
context. See notes.  (handle)
Packit 0848f5
Packit 0848f5

Packit 0848f5

Notes

Packit 0848f5
MPI_COMM_DUP_WITH_INFO behaves exactly as MPI_COMM_DUP except that
Packit 0848f5
the info hints associated with the communicator comm are not
Packit 0848f5
duplicated in newcomm.  The hints provided by the argument info are
Packit 0848f5
associated with the output communicator newcomm instead.
Packit 0848f5

Packit 0848f5

Thread and Interrupt Safety

Packit 0848f5

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

Packit 0848f5

Notes for Fortran

Packit 0848f5
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit 0848f5
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit 0848f5
</tt>is an integer and has the same meaning as the return value of the routine
Packit 0848f5
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit 0848f5
<tt>call</tt> statement.
Packit 0848f5

Packit 0848f5
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit 0848f5
</tt>in Fortran.
Packit 0848f5

Packit 0848f5

Errors

Packit 0848f5

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

Packit 0848f5
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit 0848f5
Packit 0848f5
MPI_ERR_COMM
Invalid communicator. A common error is to use a null
Packit 0848f5
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
Packit 0848f5
Packit 0848f5

Packit 0848f5
<H0>See Also</H0>
Packit 0848f5
 MPI_Comm_dup, MPI_Comm_free, MPI_Keyval_create,
Packit 0848f5

MPI_Attr_put, MPI_Attr_delete, MPI_Comm_create_keyval,
Packit 0848f5
MPI_Comm_set_attr, MPI_Comm_delete_attr
Packit 0848f5
</BODY></HTML>