mpi_free_mem.3

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Free_mem 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Free_mem \fP \- Frees memory that has been allocated using MPI_Alloc_mem.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Free_mem(void *\fIbase\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_FREE_MEM(\fIBASE, IERROR\fP) 
	<type> \fIBASE\fP(*) 
	INTEGER \fIIERROR\fP 

.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Free_mem(void *\fIbase\fP)

.SH INPUT PARAMETER
.ft R
.TP 1i
base
Initial address of memory segment allocated by MPI_Alloc_mem (choice). 

.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_Free_mem frees memory that has been allocated by MPI_Alloc_mem. 

.SH 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.
.sp
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.  

.SH SEE ALSO
.ft R
MPI_Alloc_mem

' @(#)MPI_Free_mem.3 1.11 06/03/09