MPI_Group_free(3) man page (version 4.0.7)

« Return to documentation listing

Table of Contents

Name

MPI_Group_free - Frees a group.

Syntax

C Syntax

#include <mpi.h>
int MPI_Group_free(MPI_Group *group)

Fortran Syntax

USE MPI
! or the older form: INCLUDE ’mpif.h’
MPI_GROUP_FREE(GROUP, IERROR)
 INTEGER GROUP, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Group_free(group, ierror)
 TYPE(MPI_Group), INTENT(INOUT) :: group
 INTEGER, OPTIONAL, INTENT(OUT) :: ierror

Input/Output Parameter

group

Group (handle).

Output Parameter

IERROR

Fortran only: Error status (integer).

Description

This operation marks a group object for deallocation. The handle group is set to MPI_GROUP_NULL by the call. Any ongoing operation using this group will complete normally.

Note

On return, group is set to MPI_GROUP_NULL.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions 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.

---

Table of Contents

• Name
• Syntax
• C Syntax
• Fortran Syntax
• Fortran 2008 Syntax
• Input/Output Parameter
• Output Parameter
• Description
• Note
• Errors

« Return to documentation listing

Page last modified: 16-Nov-2021
©2004-2025 The Open MPI Project