NAME

MPI_Comm_free - Frees a communicator

SYNOPSIS

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

INPUT PARAMETER

comm - communicator (handle)

OUTPUT PARAMETER

comm - the communicator is set to MPI_COMM_NULL

DESCRIPTION

The MPI_Comm_free() function is used to free a user-created communicator comm . You may not free MPI_COMM_SELF , MPI_COMM_WORLD or MPI_COMM_NULL

PMPI_Comm_free() is the profiling version of this function.

On success, comm is set to MPI_COMM_NULL

This function will call the delete function for any attributes attached to this communicator via MPI_Attr_put(). If a delete function returns something other than MPI_SUCCESS then that return value will be forwarded here, and the communicator will not be freed.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_COMM - Invalid communicator.

SEE ALSO

MPI_Comm_create (3) MPI_Comm_free (3) MPI_Intercomm_create (3) MPI_Attr_put (3)

• Lockless
• MPI Documentation
• MPI_Comm_free