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

PetscReturnErrorHandler

Error handler that causes a return to the current level.

Synopsis

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

Input Parameters

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

Many br

Notes

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

Notes for experienced users

This routine is good for catching errors such as zero pivots in preconditioners Many bror breakdown of iterative methods. It is not appropriate for memory violations Many brand similar errors. Many br

Use PetscPushErrorHandler() to set the desired error handler. The Many brcurrently available PETSc error handlers include PetscTraceBackErrorHandler(), Many brPetscAttachDebuggerErrorHandler(), PetscAbortErrorHandler(), and PetscAbortErrorHandler() Many br

See Also

PetscPushErrorHandler(), PetscPopErrorHandler().

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