Query: mpi_free_mem
OS: osx
Section: 3openmpi
Links: osx man pages all man pages
Forums: forum home forum categories
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
MPI_Free_mem(3OpenMPI) MPI_Free_mem(3OpenMPI)NAMEMPI_Free_mem - Frees memory that has been allocated using MPI_Alloc_mem.SYNTAXC 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 PARAMETERbase Initial address of memory segment allocated by MPI_Alloc_mem (choice).OUTPUT PARAMETERIERROR Fortran only: Error status (integer).DESCRIPTIONMPI_Free_mem frees memory that has been allocated by MPI_Alloc_mem.ERRORSAlmost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func- tions 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 ALSOMPI_Alloc_mem Open MPI 1.2 September 2006 MPI_Free_mem(3OpenMPI)