MPI_GROUP_FREE, MPI_Group_free

Purpose

Marks a group for deallocation.

C synopsis

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

C++ synopsis

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

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_FREE(INTEGER GROUP,INTEGER IERROR)

Parameters

group
     is the group (handle) (INOUT)

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

Description

MPI_GROUP_FREE sets the handle group to MPI_GROUP_NULL and marks the group
object for deallocation. Actual deallocation occurs only after all
operations involving group are completed. Any active operation using group
completes normally but no new calls with meaningful references to the freed
group are possible.

Errors

Invalid group

MPI not initialized