Edit

Share via


MPI_Finalize function

Terminates the calling MPI process’s execution environment.

Syntax

int MPIAPI MPI_Finalize(void);

Parameters

This function has no parameters.

Return value

MPI_SUCCESS if the function returns successfully. Other error codes if the call failed for other reasons (such as invalid arguments). In Fortran the return value is stored in the IERROR parameter.

Fortran

    MPI_FINALIZE(IERROR)
        INTEGER IERROR

Remarks

All MPI Processes must call this routine before exiting on the thread that called MPI_Init or MPI_Init_thread.

The MPI_Finalize function cleans up all state related to MPI. Once it is called, no other MPI functions may be called, including MPI_Init and MPI_Init_thread. The application must ensure that all pending communications are completed or canceled before calling MPI_Finalize.

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

Mpi.h; Mpif.h

Library

Msmpi.lib

DLL

Msmpi.dll

See also

MPI Management Functions

MPI_Init

MPI_Init_thread