Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 1.06 KB

MPI_Group_free.3.rst

File metadata and controls

69 lines (43 loc) · 1.06 KB
Raw

MPI_Group_free

:ref:`MPI_Group_free` |mdash| 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