Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 1.97 KB

MPI_Comm_disconnect.3.rst

File metadata and controls

84 lines (57 loc) · 1.97 KB
Raw

MPI_Comm_disconnect

:ref:`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

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_COMM_DISCONNECT(COMM, IERROR)
    INTEGER COMM, IERROR

Fortran 2008 Syntax

USE mpi_f08

MPI_Comm_disconnect(comm, ierror)
    TYPE(MPI_Comm), INTENT(INOUT) :: comm
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT/OUTPUT PARAMETER

  • comm : Communicator (handle).

OUTPUT PARAMETER

  • ierror : Fortran only: Error status (integer).

DESCRIPTION

:ref:`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. :ref:`MPI_Comm_disconnect` may be called only if all communication is complete and matched, so that buffered data can be delivered to its destination. This requirement is the same as for :ref:`MPI_Finalize`. :ref:`MPI_Comm_disconnect` has the same action as :ref:`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 :ref:`MPI_Comm_disconnect`, :ref:`MPI_Win_free`, and :ref:`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

.. seealso::
   * :ref:`MPI_Comm_connect`