|
« Return to documentation listing
Table of Contents
MPI_Add_error_code - Creates a new error code associated with
errorclass
#include <mpi.h>
int MPI_Add_error_code(int errorclass, int *errorcode)
USE MPI
! or the older form: INCLUDE ’mpif.h’
MPI_ADD_ERROR_CODE(ERRORCLASS, ERRORCODE, IERROR)
INTEGER ERRORCLASS, ERRORCODE, IERROR
USE mpi_f08
MPI_Add_error_code(errorclass, errorcode, ierror)
INTEGER, INTENT(IN) :: errorclass
INTEGER, INTENT(OUT) :: errorcode
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
- errorclass
- MPI error class (integer).
- errorcode
- Error code returned by an MPI routine or an MPI error class (integer).
- IERROR
- Fortran only: Error status (integer).
Creates a new error code
associated with errorclass and returns its value in errorcode.
No
function is provided to free error codes, as it is not expected that an
application will create them in significant numbers.
The value returned
is always greater than or equal to MPI_ERR_LASTCODE.
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.
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.
MPI_Add_error_class
MPI_Error_class
« Return to documentation listing
|
