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
44
45
46
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPSetErrorIfNotConverged.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPSetErrorIfNotConverged</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/KSP/KSPSetErrorIfNotConverged.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPSetErrorIfNotConverged"><H1>KSPSetErrorIfNotConverged</H1></A>
Causes <A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>() to generate an error if the solver has not converged.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
PetscErrorCode KSPSetErrorIfNotConverged(KSP ksp,PetscBool flg)
</PRE>
Logically Collective on <A HREF="../KSP/KSP.html#KSP">KSP</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ksp </B></TD><TD>- iterative context obtained from <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>flg </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> indicates you want the error generated
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options database keys</FONT></H3>
<DT><B>-ksp_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false)</B> -
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Normally PETSc continues if a linear solver fails to converge, you can call <A HREF="../KSP/KSPGetConvergedReason.html#KSPGetConvergedReason">KSPGetConvergedReason</A>() after a <A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>()
to determine if it has converged.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../KSP/KSP.html#KSP">KSP</A>, set, initial guess, nonzero
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../KSP/KSPGetInitialGuessNonzero.html#KSPGetInitialGuessNonzero">KSPGetInitialGuessNonzero</A>(), <A HREF="../KSP/KSPSetInitialGuessKnoll.html#KSPSetInitialGuessKnoll">KSPSetInitialGuessKnoll</A>(), <A HREF="../KSP/KSPGetInitialGuessKnoll.html#KSPGetInitialGuessKnoll">KSPGetInitialGuessKnoll</A>(), <A HREF="../KSP/KSPGetErrorIfNotConverged.html#KSPGetErrorIfNotConverged">KSPGetErrorIfNotConverged</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/ksp/interface/itfunc.c.html#KSPSetErrorIfNotConverged">src/ksp/ksp/interface/itfunc.c</A>
<BR><A HREF="./index.html">Index of all KSP 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>
|
