Open MPI logo

MPI_Comm_free(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing


       MPI_Comm_free  - Mark a communicator object for deallocation.


C Syntax

       #include <mpi.h>
       int MPI_Comm_free(MPI_Comm *comm)

Fortran Syntax

       INCLUDE 'mpif.h'
            INTEGER   COMM, IERROR

C++ Syntax

       #include <mpi.h>
       void Comm::Free()


       comm      Communicator to be destroyed (handle).


       IERROR    Fortran only: Error status (integer).


       This operation marks the communicator object for deallocation. The han-
       dle is set to MPI_COMM_NULL. Any pending operations that use this  com-
       municator  will  complete  normally; the object is actually deallocated
       only if there are no other active references to it. This  call  applies
       to intracommunicators and intercommunicators. Upon actual deallocation,
       the delete callback functions for all cached  attributes  (see  Section
       5.7 in the MPI-1 Standard, "Caching") are called in arbitrary order.


       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.

Open MPI 1.2                    September 2006         MPI_Comm_free(3OpenMPI)

« Return to documentation listing