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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<!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/KSPGetConvergenceTest.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPGetConvergenceTest</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/KSP/KSPGetConvergenceTest.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPGetConvergenceTest"><H1>KSPGetConvergenceTest</H1></A>
Gets the function to be used to determine convergence.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../KSP/KSPGetConvergenceTest.html#KSPGetConvergenceTest">KSPGetConvergenceTest</A>(<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (**converge)(<A HREF="../KSP/KSP.html#KSP">KSP</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A>,<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSPConvergedReason</A>*,void*),void **cctx,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (**destroy)(void*))
</PRE>
Logically Collective on ksp
<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>ksp </B></TD><TD>- iterative context obtained from <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>()
</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>converge </B></TD><TD>- pointer to convergence test function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cctx </B></TD><TD>- context for private data for the convergence routine (may be null)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>destroy </B></TD><TD>- a routine for destroying the context (may be null)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of converge</FONT></H3>
<pre>
converge (<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> it, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> rnorm, <A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSPConvergedReason</A> *reason,void *mctx)
</pre>
<P>
<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>it </B></TD><TD>- iteration number
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rnorm </B></TD><TD>- (estimated) 2-norm of (preconditioned) residual
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD>- the reason why it has converged or diverged
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cctx </B></TD><TD>- optional convergence context, as set by <A HREF="../KSP/KSPSetConvergenceTest.html#KSPSetConvergenceTest">KSPSetConvergenceTest</A>()
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../KSP/KSPConvergedDefault.html#KSPConvergedDefault">KSPConvergedDefault</A>(), <A HREF="../KSP/KSPGetConvergenceContext.html#KSPGetConvergenceContext">KSPGetConvergenceContext</A>(), <A HREF="../KSP/KSPSetTolerances.html#KSPSetTolerances">KSPSetTolerances</A>(), <A HREF="../KSP/KSP.html#KSP">KSP</A>, <A HREF="../KSP/KSPSetConvergenceTest.html#KSPSetConvergenceTest">KSPSetConvergenceTest</A>(), <A HREF="../KSP/KSPGetAndClearConvergenceTest.html#KSPGetAndClearConvergenceTest">KSPGetAndClearConvergenceTest</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/ksp/interface/itfunc.c.html#KSPGetConvergenceTest">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>
|
