petsc-3.7.1 2016-05-15
Report Typos and Errors

SETERRQ5

Macro that is called when an error has been detected,

Synopsis

#include <petscsys.h>
PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
Not Collective Many br

Input Parameters

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

Many br

Notes

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

There are also versions for 4, 5, 6 and 7 arguments. Many br

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

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