Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_comm_disconnect(3openmpi) [osx man page]

MPI_Comm_disconnect(3OpenMPI)											     MPI_Comm_disconnect(3OpenMPI)

NAME
MPI_Comm_disconnect - Deallocates communicator object and sets handle to MPI_COMM_NULL. SYNTAX
C Syntax #include <mpi.h> int MPI_Comm_disconnect(MPI_Comm *comm) Fortran Syntax INCLUDE 'mpif.h' MPI_COMM_DISCONNECT(COMM, IERROR) INTEGER COMM, IERROR C++ Syntax #include <mpi.h> void MPI::Comm::Disconnect() INPUT
/OUTPUT PARAMETER comm Communicator (handle). OUTPUT PARAMETER
IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Comm_disconnect waits for all pending communication on comm to complete internally, deallocates the communicator object, and sets the handle to MPI_COMM_NULL. It is a collective operation. It may not be called with the communicator MPI_COMM_WORLD or MPI_COMM_SELF. MPI_Comm_disconnect may be called only if all communication is complete and matched, so that buffered data can be delivered to its destina- tion. This requirement is the same as for MPI_Finalize. MPI_Comm_disconnect has the same action as MPI_Comm_free, except that it waits for pending communication to finish internally and enables the guarantee about the behavior of disconnected processes. NOTES
To disconnect two processes you may need to call MPI_Comm_disconnect, MPI_Win_free, and MPI_File_close to remove all communication paths between the two processes. Note that it may be necessary to disconnect several communicators (or to free several windows or files) before two processes are completely independent. ERRORS
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func- tions 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. 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 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. SEE ALSO
MPI_Comm_connect MPI_Comm_accept Open MPI 1.2 September 2006 MPI_Comm_disconnect(3OpenMPI)

Check Out this Related Man Page

MPI_Comm_disconnect(3)							MPI						    MPI_Comm_disconnect(3)

NAME
MPI_Comm_disconnect - Disconnect from a communicator SYNOPSIS
int MPI_Comm_disconnect(MPI_Comm * comm) INPUT PARAMETER
comm - communicator (handle) NOTES
This routine waits for all pending communication to complete, then frees the communicator and sets comm to MPI_COMM_NULL . It may not be called with MPI_COMM_WORLD or MPI_COMM_SELF . 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 malloc or other non-MPICH runtime routines that are themselves not interrupt-safe. NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. 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 call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
All MPI routines (except MPI_Wtime and 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 MPI_Comm_set_errhandler (for communicators), MPI_File_set_errhandler (for files), and MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarentee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible. MPI_SUCCESS - No error; MPI routine completed successfully. SEE ALSO
MPI_Comm_connect, MPI_Comm_join LOCATION
comm_disconnect.c 5/20/2010 MPI_Comm_disconnect(3)
Man Page