petsc-3.6.1 2015-08-06
Report Typos and Errors

PetscTraceBackErrorHandler

 Default error handler routine that generates a traceback on error detection.

Synopsis

#include "petscsys.h" 
PetscErrorCode  PetscTraceBackErrorHandler(MPI_Comm comm,int line,const char *fun,const char *file,PetscErrorCode n,PetscErrorType p,const char *mess,void *ctx)
Not Collective

Input Parameters

comm - communicator over which error occurred
line - the line number of the error (indicated by __LINE__)
func - the function where error is detected (indicated by __FUNCT__)
file - the file in which the error was detected (indicated by __FILE__)
mess - an error text string, usually just printed to the screen
n - the generic error number
p - PETSC_ERROR_INITIAL if this is the first call the error handler, otherwise PETSC_ERROR_REPEAT
ctx - error handler context

Notes

Most users need not directly employ this routine and the other error handlers, but can instead use the simplified interface SETERRQ, which has the calling sequence 
    SETERRQ(comm,number,n,mess)

Notes for experienced users

Use PetscPushErrorHandler() to set the desired error handler. The currently available PETSc error handlers include PetscTraceBackErrorHandler(), PetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), and PetscMPIAbortErrorHandler()

See Also

PetscPushErrorHandler(), PetscAttachDebuggerErrorHandler(),
PetscAbortErrorHandler()

Level:developer
Location:src/sys/error/errtrace.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages