Rev | Line | |
---|
[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Finalized 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Finalized \fP \- Checks whether MPI_Finalize has completed. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Finalized(int \fI*flag\fP) |
---|
| 13 | |
---|
| 14 | .SH Fortran Syntax |
---|
| 15 | .nf |
---|
| 16 | INCLUDE 'mpif.h' |
---|
| 17 | MPI_FINALIZED(\fIFLAG\fP, \fIIERROR\fP) |
---|
| 18 | LOGICAL \fIFLAG\fP |
---|
| 19 | INTEGER \fIIERROR\fP |
---|
| 20 | |
---|
| 21 | .SH C++ Syntax |
---|
| 22 | .nf |
---|
| 23 | #include <mpi.h> |
---|
| 24 | bool MPI::Is_finalized() |
---|
| 25 | |
---|
| 26 | .SH OUTPUT PARAMETER |
---|
| 27 | .ft R |
---|
| 28 | .TP 1i |
---|
| 29 | flag |
---|
| 30 | True if MPI was finalized (logical). |
---|
| 31 | .ft R |
---|
| 32 | .TP 1i |
---|
| 33 | IERROR |
---|
| 34 | Fortran only: Error status (integer). |
---|
| 35 | |
---|
| 36 | .SH DESCRIPTION |
---|
| 37 | .ft R |
---|
| 38 | This routine returns "true" if MPI_Finalize has completed. You can call MPI_Finalized before MPI_Init and after MPI_Finalize. |
---|
| 39 | |
---|
| 40 | .SH ERRORS |
---|
| 41 | 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. |
---|
| 42 | .sp |
---|
| 43 | Before the error value is returned, the current MPI error handler is |
---|
| 44 | 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. |
---|
| 45 | |
---|
Note: See
TracBrowser
for help on using the repository browser.