Skip to main content
Ctrl+K
PETSc v3.26.0-2-g3c5cfaeaff0b documentation - Home
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • PetscFunctionBegin

PetscFunctionBegin#

First executable line of each PETSc function, used for error handling. Final line of PETSc functions should be PetscFunctionReturn(PETSC_SUCCESS);

Synopsis#

#include <petscsys.h>
void PetscFunctionBegin;

Not Collective; No Fortran Support

Usage#

     int something;

     PetscFunctionBegin;

Note#

Use PetscFunctionBeginUser for application codes.

See Also#

PetscFunctionReturn(), PetscFunctionBeginHot(), PetscFunctionBeginUser(), PetscStackPushNoCheck()

Level#

developer

Location#

include/petscerror.h

Examples#

src/sys/classes/random/tutorials/ex2.c
src/sys/tutorials/ex6.c
src/sys/tutorials/ex7.c
src/sys/classes/draw/tests/ex6.c
src/sys/classes/random/tests/ex3.c
src/sys/classes/viewer/tests/ex6.c
src/sys/objects/device/tests/ex11.cxx
src/sys/objects/device/tests/ex3.c
src/sys/objects/device/tests/ex4.c
src/sys/objects/device/tests/ex6.c


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

On this page
  • Synopsis
  • Usage
  • Note
  • See Also
  • Level
  • Location
  • Examples
Edit on GitLab
Show Source

© Copyright 1991-2026, UChicago Argonne, LLC and the PETSc Development Team.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.1.

Last updated on 2026-09-28T23:19:25-0500 (v3.26.0-2-g3c5cfaeaff0b).