PetscCheck#

Check that a particular condition is true

Synopsis#

#include <petscerror.h>
void PetscCheck(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)

Collective; No Fortran Support

Input Parameters#

cond - The boolean condition
comm - The communicator on which the check can be collective on
ierr - A nonzero error code, see include/petscerror.h for the complete list
message - Error message in printf format

Notes#

Enabled in both optimized and debug builds.

Calls SETERRQ() if the assertion fails, so can only be called from functions returning a PetscErrorCode (or equivalent type after conversion).

.seealso: PetscAssert(), SETERRQ(), PetscError(), PetscCall(), PetscCheckAbort()

Level#

beginner

Location#

include/petscerror.h

Examples#

src/dm/field/tutorials/ex1.c
src/dm/impls/plex/tutorials/ex10.c
src/dm/impls/plex/tutorials/ex11.c
src/dm/impls/plex/tutorials/ex5.c
src/dm/impls/plex/tutorials/ex6.c
src/dm/impls/plex/tutorials/ex8.c
src/dm/impls/stag/tutorials/ex3.c
src/dm/impls/stag/tutorials/ex4.c
src/dm/impls/stag/tutorials/ex8.c
src/dm/label/tutorials/ex1.c
src/dm/tutorials/ex10.c

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages