Open MPI logo

MPI_Free_mem(3) man page (version 1.8.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Free_mem - Frees memory that has been allocated using MPI_Alloc_mem.

Syntax

C Syntax


#include <mpi.h>
int MPI_Free_mem(void *base)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_FREE_MEM(BASE, IERROR)
    <type> BASE(*)
    INTEGER IERROR

C++ Syntax


#include <mpi.h>
void MPI::Free_mem(void *base)

Input Parameter

base
Initial address of memory segment allocated by MPI_Alloc_mem (choice).

Output Parameter

IERROR
Fortran only: Error status (integer).

Description

MPI_Free_mem frees memory that has been allocated by MPI_Alloc_mem.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.

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

MPI_Alloc_mem


Table of Contents

« Return to documentation listing