File: TaoSetTolerances.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (72 lines) | stat: -rw-r--r-- 4,213 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Tao/TaoSetTolerances.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetTolerances</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/Tao/TaoSetTolerances.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetTolerances"><H1>TaoSetTolerances</H1></A>
Sets parameters used in TAO convergence tests 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoSetTolerances.html#TaoSetTolerances">TaoSetTolerances</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> gatol, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> grtol, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> gttol)
</PRE>
Logically collective on <A HREF="../Tao/Tao.html#Tao">Tao</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>tao </B></TD><TD>- the <A HREF="../Tao/Tao.html#Tao">Tao</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gatol </B></TD><TD>- stop if norm of gradient is less than this
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>grtol </B></TD><TD>- stop if relative norm of gradient is less than this
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gttol </B></TD><TD>- stop if norm of gradient is reduced by this factor
</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>-tao_gatol &lt;gatol&gt; </B></TD><TD>- Sets gatol
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_grtol &lt;grtol&gt; </B></TD><TD>- Sets grtol
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_gttol &lt;gttol&gt; </B></TD><TD>- Sets gttol
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Stopping Criteria</FONT></H3>
<pre>
||g(X)||                            &lt;= gatol
</pre>
<pre>
||g(X)|| / |f(X)|                   &lt;= grtol
</pre>
<pre>
||g(X)|| / ||g(X0)||                &lt;= gttol
</pre>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Use <A HREF="../Sys/PETSC_DEFAULT.html#PETSC_DEFAULT">PETSC_DEFAULT</A> to leave one or more tolerances unchanged.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Tao/TaoGetTolerances.html#TaoGetTolerances">TaoGetTolerances</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/interface/taosolver.c.html#TaoSetTolerances">src/tao/interface/taosolver.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/examples/tutorials/ex16opt_p.c.html">src/ts/examples/tutorials/ex16opt_p.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex16opt_ic.c.html">src/ts/examples/tutorials/ex16opt_ic.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/spectraladjointassimilation.c.html">src/tao/unconstrained/examples/tutorials/spectraladjointassimilation.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/maros.c.html">src/tao/constrained/examples/tutorials/maros.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toy.c.html">src/tao/constrained/examples/tutorials/toy.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toyf.F90.html">src/tao/constrained/examples/tutorials/toyf.F90.html</A><BR>
<BR><A HREF="./index.html">Index of all Tao 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>