petsc-master 2019-08-18
Report Typos and Errors

SETERRQ9

Macro that is called when an error has been detected,

Synopsis

#include <petscsys.h>
PetscErrorCode SETERRQ9(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
Collective

Input Parameters

comm - A communicator, so that the error can be collective
ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
message - error message in the printf format
arg1 - argument (for example an integer, string or double)
arg2 - argument (for example an integer, string or double)
arg3 - argument (for example an integer, string or double)
arg4 - argument (for example an integer, string or double)
arg5 - argument (for example an integer, string or double)
arg6 - argument (for example an integer, string or double)
arg7 - argument (for example an integer, string or double)
arg8 - argument (for example an integer, string or double)
arg9 - argument (for example an integer, string or double)

Notes

Once the error handler is called the calling function is then returned from with the given error code.

There are also versions for 0 to 9 arguments.

Experienced users can set the error handler with PetscPushErrorHandler().

See Also

PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()

Level

beginner

Location

src/sys/error/../../../include/petscerror.h
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages