
Signed-off-by: Fangcong Yin <fyin2@nd.edu> Convert MPI_Graph_create.3in - MPI_Group_intersection.3in to md files Update ompi/mpi/man/man3/MPI_Grequest_complete.md Signed-off-by: Fangcong Yin <fyin2@nd.edu> Co-authored-by: Jeff Squyres <jsquyres@users.noreply.github.com> Update ompi/mpi/man/man3/MPI_Group_excl.md Signed-off-by: Fangcong Yin <fyin2@nd.edu> Co-authored-by: Jeff Squyres <jsquyres@users.noreply.github.com>
1.3 KiB
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.
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.