Open MPI logo

MPI_Free_mem(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Free_memR] - Frees memory that has been allocated using C]MPI_Alloc_memR].

Syntax

C Syntax



C]#include <mpi.h>int MPI_Free_mem(void *base)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_FREE_MEM(BASE, IERROR) <type> BASE(*) INTEGER IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Free_mem(base, ierror) TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: base INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameter

[bu]
C]baseR] : Initial address of memory segment allocated by C]MPI_Alloc_memR] (choice).

Output Parameter

[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Free_memR] frees memory that has been allocated by C]MPI_Alloc_memR].

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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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

C]MPI_Alloc_memR](3)


Table of Contents

« Return to documentation listing