MPI_COMM_FREE, MPI_Comm_free

Purpose

Marks a communicator for deallocation.

C synopsis

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

C++ synopsis

#include mpi.h
void MPI::Comm::Free(void);

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_COMM_FREE(INTEGER COMM,INTEGER IERROR)

Parameters

comm
     is the communicator to be freed (handle) (INOUT)

IERROR
     is the FORTRAN return code. It is always the last argument.

Description

This collective operation marks either an intra- or an intercommunicator
object for deallocation. MPI_COMM_FREE sets the handle to MPI_COMM_NULL.
Actual deallocation of the communicator object occurs when active
references to it have completed. The delete callback functions for all
cached attributes are called in arbitrary order. The delete functions are
called immediately and not deferred until deallocation.

Errors

A delete_fn did not return MPI_SUCCESS

Invalid communicator

MPI not initialized

MPI already finalized

Related information

     MPI_KEYVAL_CREATE