MPI_Finalize(3)

1MPI_Finalize(3)                     LAM/MPI                    MPI_Finalize(3)
2
3
4

NAME

6       MPI_Finalize -  Terminates MPI execution environment
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Finalize(void)
12

NOTES

14       All  processes  must  call  this routine before exiting.  The number of
15       processes running after this routine is called is undefined; it is best
16       not to perform much more than a return rc after calling MPI_Finalize .
17
18
19       MPI mandates that the same thread invoke MPI_Init (or MPI_Init_thread )
20       and MPI_Finalize  ;  if  a  different  thread  invokes  MPI_Finalize  ,
21       MPI_ERR_OTHER will be returned, and MPI will not be finalized.
22
23

NOTES FOR FORTRAN

25       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
26       an additional argument ierr at the end of the argument list.   ierr  is
27       an  integer and has the same meaning as the return value of the routine
28       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
29       the call statement.
30
31       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
32       Fortran.
33
34

ERRORS

36       If an error occurs in an MPI function, the current MPI error handler is
37       called  to  handle  it.   By default, this error handler aborts the MPI
38       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
39       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
40       values to be returned (in C and Fortran; this  error  handler  is  less
41       useful  in  with  the  C++  MPI bindings.  The predefined error handler
42       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
43       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
44       program can continue past an error.
45
46       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
47       value;  C routines as the value of the function and Fortran routines in
48       the last argument.  The C++ bindings for MPI do not return  error  val‐
49       ues;  instead,  error values are communicated by throwing exceptions of
50       type MPI::Exception (but not by default).  Exceptions are  only  thrown
51       if the error value is not MPI::SUCCESS .
52
53
54       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
55       functions will return upon an error, there will be no  way  to  recover
56       what the actual error value was.
57       MPI_ERR_INTERN
58              -  An  internal error has been detected.  This is fatal.  Please
59              send a bug report to the LAM mailing list  (see  http://www.lam-
60              mpi.org/contact.php ).
61       MPI_ERR_OTHER
62              -  Returned  if a different thread attempts to finalize MPI than
63              the thread that initialized MPI.
64
65

MORE INFORMATION

71       For more information, please see the official MPI Forum web site, which
72       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
73       ments contain detailed information about each  MPI  function  (most  of
74       which is not duplicated in these man pages).
75
76       http://www.mpi-forum.org/
77
78
79

ACKNOWLEDGEMENTS

81       The  LAM Team would like the thank the MPICH Team for the handy program
82       to generate man pages  ("doctext"  from  ftp://ftp.mcs.anl.gov/pub/sow‐
83       ing/sowing.tar.gz  ), the initial formatting, and some initial text for
84       most of the MPI-1 man pages.
85

LOCATION

87       finalize.c
88
89
90
91LAM/MPI 7.1.2                      2/23/2006                   MPI_Finalize(3)