17.2.160. MPI_Free_mem
MPI_Free_mem - Frees memory that has been allocated using MPI_Alloc_mem.
17.2.160.1. Syntax
17.2.160.1.1. C Syntax
#include <mpi.h>
int MPI_Free_mem(void *base)
17.2.160.1.2. Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FREE_MEM(BASE, IERROR)
<type> BASE(*)
INTEGER IERROR
17.2.160.1.3. Fortran 2008 Syntax
USE mpi_f08
MPI_Free_mem(base, ierror)
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: base
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
17.2.160.2. Input Parameter
base : Initial address of memory segment allocated by MPI_Alloc_mem (choice).
17.2.160.3. Output Parameter
IERROR : Fortran only: Error status (integer).
17.2.160.4. Description
MPI_Free_mem frees memory that has been allocated by MPI_Alloc_mem.
17.2.160.5. 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.
See also