petsc-3.4.4 2014-03-13

PetscError

Routine that is called when an error has been detected, usually called through the macro SETERRQ(PETSC_COMM_SELF,).

Synopsis

#include "petscsys.h" 
PetscErrorCode  PetscError(MPI_Comm comm,int line,const char *func,const char *file,const char *dir,PetscErrorCode n,PetscErrorType p,const char *mess,...)
Not Collective

Input Parameters

comm - communicator over which error occurred. ALL ranks of this communicator MUST call this routine
line - the line number of the error (indicated by __LINE__)
func - the function where the error occured (indicated by __FUNCT__)
dir - the directory of file (indicated by __SDIR__)
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 indicates the error was initially detected, PETSC_ERROR_REPEAT indicates this is a traceback from a previously detected error
mess - formatted message string - aka printf

Notes

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

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

Developer Note: Since this is called after an error condition it should not be calling any error handlers (currently it ignores any error codes) BUT this routine does call regular PETSc functions that may call error handlers, this is problematic and could be fixed by never calling other PETSc routines but this annoying.

See Also

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

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