File: SNESConvergedDefault.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (105 lines) | stat: -rw-r--r-- 7,238 bytes parent folder | download 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESConvergedDefault.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESConvergedDefault</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/SNES/SNESConvergedDefault.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESConvergedDefault"><H1>SNESConvergedDefault</H1></A>
Default onvergence test of the solvers for systems of nonlinear equations. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsc/private/snesimpl.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../SNES/SNESConvergedDefault.html#SNESConvergedDefault">SNESConvergedDefault</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> it,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> xnorm,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> snorm,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> fnorm,<A HREF="../SNES/SNESConvergedReason.html#SNESConvergedReason">SNESConvergedReason</A> *reason,void *dummy)
</PRE>
Collective on <A HREF="../SNES/SNES.html#SNES">SNES</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>snes </B></TD><TD>- the <A HREF="../SNES/SNES.html#SNES">SNES</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>it </B></TD><TD>- the iteration (0 indicates before any Newton steps)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>xnorm </B></TD><TD>- 2-norm of current iterate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>snorm </B></TD><TD>- 2-norm of current step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fnorm </B></TD><TD>- 2-norm of function at current iterate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dummy </B></TD><TD>- unused 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>- one of
</TD></TR></TABLE>
<pre>
 <A HREF="../SNES/SNES_CONVERGED_FNORM_ABS.html#SNES_CONVERGED_FNORM_ABS">SNES_CONVERGED_FNORM_ABS</A>       - (fnorm &lt; abstol),
</pre>
<pre>
 <A HREF="../SNES/SNES_CONVERGED_SNORM_RELATIVE.html#SNES_CONVERGED_SNORM_RELATIVE">SNES_CONVERGED_SNORM_RELATIVE</A>  - (snorm &lt; stol*xnorm),
</pre>
<pre>
 <A HREF="../SNES/SNES_CONVERGED_FNORM_RELATIVE.html#SNES_CONVERGED_FNORM_RELATIVE">SNES_CONVERGED_FNORM_RELATIVE</A>  - (fnorm &lt; rtol*fnorm0),
</pre>
<pre>
 <A HREF="../SNES/SNES_DIVERGED_FUNCTION_COUNT.html#SNES_DIVERGED_FUNCTION_COUNT">SNES_DIVERGED_FUNCTION_COUNT</A>   - (nfct &gt; maxf),
</pre>
<pre>
 <A HREF="../SNES/SNES_DIVERGED_FNORM_NAN.html#SNES_DIVERGED_FNORM_NAN">SNES_DIVERGED_FNORM_NAN</A>        - (fnorm == NaN),
</pre>
<pre>
 <A HREF="../SNES/SNESConvergedReason.html#SNESConvergedReason">SNES_CONVERGED_ITERATING</A>       - (otherwise),
</pre>
<pre>
 <A HREF="../SNES/SNES_DIVERGED_DTOL.html#SNES_DIVERGED_DTOL">SNES_DIVERGED_DTOL</A>             - (fnorm &gt; divtol*snes-&gt;fnorm0)
</pre>
<P>
where
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>maxf </B></TD><TD>- maximum number of function evaluations,  set with <A HREF="../SNES/SNESSetTolerances.html#SNESSetTolerances">SNESSetTolerances</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nfct </B></TD><TD>- number of function evaluations,
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>abstol </B></TD><TD>- absolute function norm tolerance, set with <A HREF="../SNES/SNESSetTolerances.html#SNESSetTolerances">SNESSetTolerances</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rtol </B></TD><TD>- relative function norm tolerance, set with <A HREF="../SNES/SNESSetTolerances.html#SNESSetTolerances">SNESSetTolerances</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>divtol </B></TD><TD>- divergence tolerance, set with <A HREF="../SNES/SNESSetDivergenceTolerance.html#SNESSetDivergenceTolerance">SNESSetDivergenceTolerance</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fnorm0 </B></TD><TD>- 2-norm of the function at the initial solution (initial guess; zeroth iteration)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_stol </B></TD><TD>- convergence tolerance in terms of the norm  of the change in the solution between steps
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_atol &lt;abstol&gt; </B></TD><TD>- absolute tolerance of residual norm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_rtol &lt;rtol&gt; </B></TD><TD>- relative decrease in tolerance norm from the initial 2-norm of the solution
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_divergence_tolerance &lt;divtol&gt; </B></TD><TD>- if the residual goes above divtol*rnorm0, exit with divergence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_max_funcs &lt;max_funcs&gt; </B></TD><TD>- maximum number of function evaluations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_max_fail &lt;max_fail&gt; </B></TD><TD>- maximum number of line search failures allowed before stopping, default is none
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_max_linear_solve_fail </B></TD><TD>- number of linear solver failures before <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>() stops
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../SNES/SNESSetConvergenceTest.html#SNESSetConvergenceTest">SNESSetConvergenceTest</A>(), <A HREF="../SNES/SNESSetTolerances.html#SNESSetTolerances">SNESSetTolerances</A>(), <A HREF="../SNES/SNESSetDivergenceTolerance.html#SNESSetDivergenceTolerance">SNESSetDivergenceTolerance</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/interface/snesut.c.html#SNESConvergedDefault">src/snes/interface/snesut.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex30.c.html">src/snes/tutorials/ex30.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/vi/vi.c.html#SNESConvergedDefault_VI">SNESConvergedDefault_VI in src/snes/impls/vi/vi.c</A><BR>
<BR><A HREF="./index.html">Index of all SNES 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>