Login or Register to Ask a Question and Join Our Community

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_get_parent(3OpenMPI)											     MPI_Comm_get_parent(3OpenMPI)

NAME

       MPI_Comm_get_parent - Returns the parent intercommunicator of current spawned process.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Comm_get_parent(MPI_Comm *parent)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_GET_PARENT(PARENT, IERROR)
	    INTEGER   PARENT, IERROR

C++ Syntax
       #include <mpi.h>
       static MPI::Intercomm MPI::Comm::Get_parent()

OUTPUT PARAMETERS

       parent	 The parent communicator (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       If  a process was started with MPI_Comm_spawn or MPI_Comm_spawn_multiple, MPI_Comm_get_parent returns the "parent" intercommunicator of the
       current process. This parent intercommunicator is created implicitly inside of MPI_Init and is the same intercommunicator returned  by  the
       spawn call made in the parents.

       If the process was not spawned, MPI_Comm_get_parent returns MPI_COMM_NULL.

       After the parent communicator is freed or disconnected, MPI_Comm_get_parent returns MPI_COMM_NULL.

NOTES

       MPI_Comm_get_parent  returns a handle to a single intercommunicator. Calling MPI_Comm_get_parent a second time returns a handle to the same
       intercommunicator. Freeing the handle with MPI_Comm_disconnect or MPI_Comm_free will cause other references  to	the  intercommunicator	to
       become invalid (dangling). Note that calling MPI_Comm_free on the parent communicator is not useful.

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_spawn
       MPI_Comm_spawn_multiple

Open MPI 1.2							  September 2006				     MPI_Comm_get_parent(3OpenMPI)
Man Page