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
|
.. _mpi_free_mem:
MPI_Free_mem
============
.. include_body
:ref:`MPI_Free_mem` |mdash| Frees memory that has been allocated using :ref:`MPI_Alloc_mem`.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Free_mem(void *base)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FREE_MEM(BASE, IERROR)
<type> BASE(*)
INTEGER IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Free_mem(base, ierror)
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: base
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETER
---------------
* ``base`` : Initial address of memory segment allocated by :ref:`MPI_Alloc_mem`
(choice).
OUTPUT PARAMETER
----------------
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Free_mem` frees memory that has been allocated by :ref:`MPI_Alloc_mem`.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso:: :ref:`MPI_Alloc_mem`
|
