1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
.. _mpi_group_free:
MPI_Group_free
==============
.. include_body
:ref:`MPI_Group_free` |mdash| Frees a group.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Group_free(MPI_Group *group)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GROUP_FREE(GROUP, IERROR)
INTEGER GROUP, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
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
------
.. include:: ./ERRORS.rst
|