"Fossies" - the Fresh Open Source Software Archive

Member "petsc-3.12.4/docs/manualpages/Sys/SETERRQ.html" (4 Feb 2020, 4581 Bytes) of package /linux/misc/petsc-3.12.4.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
    2 <HTML>
    3 <HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/SETERRQ.html" />
    4 <META NAME="GENERATOR" CONTENT="DOCTEXT">
    5 <TITLE>SETERRQ</TITLE>
    6 </HEAD>
    7 <BODY BGCOLOR="FFFFFF">
    8    <div id="version" align=right><b>petsc-3.12.4 2020-02-04</b></div>
    9    <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.12.4 v3.12.4 docs/manualpages/Sys/SETERRQ.html "><small>Report Typos and Errors</small></a></div>
   10 <A NAME="SETERRQ"><H1>SETERRQ</H1></A>
   11 Macro to be called when an error has been detected, 
   12 <H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
   13 <PRE>
   14 #include &lt;petscsys.h&gt;
   15 <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/SETERRQ.html#SETERRQ">SETERRQ</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> ierr,char *message)
   16 </PRE>
   17 Collective
   18 <P>
   19 <H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
   20 <TABLE border="0" cellpadding="0" cellspacing="0">
   21 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- A communicator, use <A HREF="../Sys/PETSC_COMM_SELF.html#PETSC_COMM_SELF">PETSC_COMM_SELF</A> unless you know all ranks of another communicator will detect the error
   22 </TD></TR>
   23 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ierr </B></TD><TD>- nonzero error code, see the list of standard error codes in include/petscerror.h
   24 </TD></TR>
   25 <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>message </B></TD><TD>- error message
   26 </TD></TR></TABLE>
   27 <P>
   28 
   29 <P>
   30 <H3><FONT COLOR="#CC3333">Notes</FONT></H3>
   31 Once the error handler is called the calling function is then returned from with the given error code.
   32 <P>
   33 See <A HREF="../Sys/SETERRQ1.html#SETERRQ1">SETERRQ1</A>(), <A HREF="../Sys/SETERRQ2.html#SETERRQ2">SETERRQ2</A>(), <A HREF="../Sys/SETERRQ3.html#SETERRQ3">SETERRQ3</A>() for versions that take arguments
   34 <P>
   35 Experienced users can set the error handler with <A HREF="../Sys/PetscPushErrorHandler.html#PetscPushErrorHandler">PetscPushErrorHandler</A>().
   36 <P>
   37 <H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   38  <A HREF="../Sys/PetscTraceBackErrorHandler.html#PetscTraceBackErrorHandler">PetscTraceBackErrorHandler</A>(), <A HREF="../Sys/PetscPushErrorHandler.html#PetscPushErrorHandler">PetscPushErrorHandler</A>(), <A HREF="../Sys/PetscError.html#PetscError">PetscError</A>(), <A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(), <A HREF="../Sys/CHKMEMQ.html#CHKMEMQ">CHKMEMQ</A>, <A HREF="../Sys/SETERRQ1.html#SETERRQ1">SETERRQ1</A>(), <A HREF="../Sys/SETERRQ2.html#SETERRQ2">SETERRQ2</A>(), <A HREF="../Sys/SETERRQ3.html#SETERRQ3">SETERRQ3</A>()
   39 <BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
   40 <H3><FONT COLOR="#CC3333">Location</FONT></H3>
   41 </B><A HREF="../../../src/sys/error/../../../include/petscerror.h.html#SETERRQ">src/sys/error/../../../include/petscerror.h</A>
   42 <P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
   43 <A HREF="../../../src/sys/classes/random/examples/tutorials/ex1.c.html">src/sys/classes/random/examples/tutorials/ex1.c.html</A><BR>
   44 <A HREF="../../../src/sys/classes/random/examples/tutorials/ex2.c.html">src/sys/classes/random/examples/tutorials/ex2.c.html</A><BR>
   45 <A HREF="../../../src/sys/examples/tutorials/ex3.c.html">src/sys/examples/tutorials/ex3.c.html</A><BR>
   46 <A HREF="../../../src/vec/vec/examples/tutorials/ex6.c.html">src/vec/vec/examples/tutorials/ex6.c.html</A><BR>
   47 <A HREF="../../../src/vec/vec/examples/tutorials/ex9.c.html">src/vec/vec/examples/tutorials/ex9.c.html</A><BR>
   48 <A HREF="../../../src/vec/vec/examples/tutorials/ex10.c.html">src/vec/vec/examples/tutorials/ex10.c.html</A><BR>
   49 <A HREF="../../../src/vec/vec/examples/tutorials/ex19.c.html">src/vec/vec/examples/tutorials/ex19.c.html</A><BR>
   50 <A HREF="../../../src/vec/is/is/examples/tutorials/ex2.c.html">src/vec/is/is/examples/tutorials/ex2.c.html</A><BR>
   51 <A HREF="../../../src/vec/is/is/examples/tutorials/ex3.c.html">src/vec/is/is/examples/tutorials/ex3.c.html</A><BR>
   52 <A HREF="../../../src/vec/is/sf/examples/tutorials/ex2.c.html">src/vec/is/sf/examples/tutorials/ex2.c.html</A><BR>
   53 <A HREF="../../../src/mat/examples/tutorials/ex1.c.html">src/mat/examples/tutorials/ex1.c.html</A><BR>
   54 <BR><A HREF="./index.html">Index of all Sys routines</A>
   55 <BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
   56 <BR><A HREF="../singleindex.html">Index of all manual pages</A>
   57 </BODY></HTML>