1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCGetFailedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCGetFailedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<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.14.5 v3.14.5 docs/manualpages/PC/PCGetFailedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCGetFailedReason"><H1>PCGetFailedReason</H1></A>
Gets the reason a <A HREF="../PC/PCSetUp.html#PCSetUp">PCSetUp</A>() failed or <A HREF="../PC/PCFailedReason.html#PCFailedReason">PC_NOERROR</A> if it did not fail
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PC/PCGetFailedReason.html#PCGetFailedReason">PCGetFailedReason</A>(<A HREF="../PC/PC.html#PC">PC</A> pc,<A HREF="../PC/PCFailedReason.html#PCFailedReason">PCFailedReason</A> *reason)
</PRE>
Logically Collective on <A HREF="../PC/PC.html#PC">PC</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pc </B></TD><TD>- the preconditioner context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD>- the reason it failed
</TD></TR></TABLE>
<P>
<P>
Notes: This is the maximum over reason over all ranks in the <A HREF="../PC/PC.html#PC">PC</A> communicator. It is only valid after
a call <A HREF="../Sys/KSPCheckDot.html#KSPCheckDot">KSPCheckDot</A>() or <A HREF="../Sys/KSPCheckNorm.html#KSPCheckNorm">KSPCheckNorm</A>() inside a <A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>(). It is not valid immediately after a <A HREF="../PC/PCSetUp.html#PCSetUp">PCSetUp</A>()
or <A HREF="../PC/PCApply.html#PCApply">PCApply</A>(), then use <A HREF="../PC/PCGetFailedReasonRank.html#PCGetFailedReasonRank">PCGetFailedReasonRank</A>()
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PC/PCCreate.html#PCCreate">PCCreate</A>(), <A HREF="../PC/PCApply.html#PCApply">PCApply</A>(), <A HREF="../PC/PCDestroy.html#PCDestroy">PCDestroy</A>(), <A HREF="../PC/PCGetFailedReasonRank.html#PCGetFailedReasonRank">PCGetFailedReasonRank</A>(), <A HREF="../PC/PCSetFailedReason.html#PCSetFailedReason">PCSetFailedReason</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/pc/interface/precon.c.html#PCGetFailedReason">src/ksp/pc/interface/precon.c</A>
<BR><A HREF="./index.html">Index of all PC routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|