NAME

MPI_Finalized - Test if the MPI library has shut down

SYNOPSIS

#include <mpi.h> 
int MPI_Finalized(int *flag ); 
#include <pmpi.h> 
int PMPI_Finalized(int *flag ); 
#include <mpi.h> 
bool MPI::Is_finalized(void) 
INCLUDE 'mpif.h' 
MPI_FINALIZED(flag ,  ierr ); 
INTEGER  flag ,  ierr 

OUTPUT PARAMETER

flag - was the MPI library ever shut down (boolean)

DESCRIPTION

The MPI_Finalized() function is used to determine if MPI was ever shut down. If so, flag is set to one. Otherwise, it will be set to zero. This is the only function that may be called after MPI is finalized with MPI_Finalize().

The C++ version of this function passes the flag as the return value.

PMPI_Finalized() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Init (3) MPI_Initialized (3) MPI_Finalize (3) MPI_Abort (3)

• Lockless
• MPI Documentation
• MPI_Finalized