Open MPI logo

MPI_Group_free(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents


C]MPI_Group_freeR] - Frees a group.


C Syntax

C]#include <mpi.h>int MPI_Group_free(MPI_Group *group)R]Fortran Syntax

C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GROUP_FREE(GROUP, IERROR) INTEGER GROUP, IERRORR]Fortran 2008 Syntax

C]USE mpi_f08MPI_Group_free(group, ierror) TYPE(MPI_Group), INTENT(INOUT) :: group INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input/Output Parameter

C]groupR] : Group (handle).

Output Parameter

C]IERRORR] : Fortran only: Error status (integer).


This operation marks a C]groupR] object for deallocation. The handle C]groupR] is set to C]MPI_GROUP_NULLR] by the call. Any ongoing operation using this C]groupR] will complete normally.


On return, C]groupR] is set to C]MPI_GROUP_NULLR].


Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.

Table of Contents

« Return to documentation listing