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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
<!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/TaoSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetFromOptions</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/TaoSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetFromOptions"><H1>TaoSetFromOptions</H1></A>
Sets various <A HREF="../Tao/Tao.html#Tao">Tao</A> parameters from user options.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoSetFromOptions.html#TaoSetFromOptions">TaoSetFromOptions</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao)
</PRE>
Collective on <A HREF="../Tao/Tao.html#Tao">Tao</A>
<P>
<H3><FONT COLOR="#CC3333">Input Paremeter</FONT></H3>
<DT><B>tao </B> -the <A HREF="../Tao/Tao.html#Tao">Tao</A> solver context
<br>
<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_type <type> </B></TD><TD>- The algorithm that TAO uses (lmvm, nls, etc.)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_gatol <gatol> </B></TD><TD>- absolute error tolerance for ||gradient||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_grtol <grtol> </B></TD><TD>- relative error tolerance for ||gradient||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_gttol <gttol> </B></TD><TD>- reduction of ||gradient|| relative to initial gradient
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_max_it <max> </B></TD><TD>- sets maximum number of iterations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_max_funcs <max> </B></TD><TD>- sets maximum number of function evaluations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_fmin <fmin> </B></TD><TD>- stop if function value reaches fmin
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_steptol <tol> </B></TD><TD>- stop if trust region radius less than <tol>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_trust0 <t> </B></TD><TD>- initial trust region radius
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_monitor </B></TD><TD>- prints function value and residual at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_smonitor </B></TD><TD>- same as tao_monitor, but truncates very small values
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_cmonitor </B></TD><TD>- prints function value, residual, and constraint norm at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_solution </B></TD><TD>- prints solution vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_separableobjective </B></TD><TD>- prints separable objective vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_step </B></TD><TD>- prints step direction vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_gradient </B></TD><TD>- prints gradient vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_draw_solution </B></TD><TD>- graphically view solution vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_draw_step </B></TD><TD>- graphically view step vector at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_draw_gradient </B></TD><TD>- graphically view gradient at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_fd_gradient </B></TD><TD>- use gradient computed with finite differences
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_fd_hessian </B></TD><TD>- use hessian computed with finite differences
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_mf_hessian </B></TD><TD>- use matrix-free hessian computed with finite differences
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_cancelmonitors </B></TD><TD>- cancels all monitors (except those set with command line)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view </B></TD><TD>- prints information about the <A HREF="../Tao/Tao.html#Tao">Tao</A> after solving
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_converged_reason </B></TD><TD>- prints the reason TAO stopped iterating
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
To see all options, run your program with the -help option or consult the
user's manual. Should be called after <A HREF="../Tao/TaoCreate.html#TaoCreate">TaoCreate</A>() but before <A HREF="../Tao/TaoSolve.html#TaoSolve">TaoSolve</A>()
<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#TaoSetFromOptions">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/ts/examples/tutorials/ex20opt_p.c.html">src/ts/examples/tutorials/ex20opt_p.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex20opt_ic.c.html">src/ts/examples/tutorials/ex20opt_ic.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion1.c.html">src/tao/unconstrained/examples/tutorials/eptorsion1.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion2.c.html">src/tao/unconstrained/examples/tutorials/eptorsion2.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/minsurf2.c.html">src/tao/unconstrained/examples/tutorials/minsurf2.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/rosenbrock1.c.html">src/tao/unconstrained/examples/tutorials/rosenbrock1.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/unconstrained/examples/tutorials/eptorsion2f.F.html">src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/rosenbrock1f.F90.html">src/tao/unconstrained/examples/tutorials/rosenbrock1f.F90.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/tao/bound/impls/blmvm/blmvm.c.html#TaoSetFromOptions_BLMVM">TaoSetFromOptions_BLMVM in src/tao/bound/impls/blmvm/blmvm.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bncg/bncg.c.html#TaoSetFromOptions_BNCG">TaoSetFromOptions_BNCG in src/tao/bound/impls/bncg/bncg.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bnk/bnk.c.html#TaoSetFromOptions_BNK">TaoSetFromOptions_BNK in src/tao/bound/impls/bnk/bnk.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bnk/bntl.c.html#TaoSetFromOptions_BNTL">TaoSetFromOptions_BNTL in src/tao/bound/impls/bnk/bntl.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bnk/bntr.c.html#TaoSetFromOptions_BNTR">TaoSetFromOptions_BNTR in src/tao/bound/impls/bnk/bntr.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bqnk/bqnk.c.html#TaoSetFromOptions_BQNK">TaoSetFromOptions_BQNK in src/tao/bound/impls/bqnk/bqnk.c</A><BR>
<A HREF="../../../src/tao/bound/impls/bqnls/bqnls.c.html#TaoSetFromOptions_BQNLS">TaoSetFromOptions_BQNLS in src/tao/bound/impls/bqnls/bqnls.c</A><BR>
<A HREF="../../../src/tao/bound/impls/tron/tron.c.html#TaoSetFromOptions_TRON">TaoSetFromOptions_TRON in src/tao/bound/impls/tron/tron.c</A><BR>
<A HREF="../../../src/tao/complementarity/impls/ssls/ssls.c.html#TaoSetFromOptions_SSLS">TaoSetFromOptions_SSLS in src/tao/complementarity/impls/ssls/ssls.c</A><BR>
<A HREF="../../../src/tao/constrained/impls/ipm/ipm.c.html#TaoSetFromOptions_IPM">TaoSetFromOptions_IPM in src/tao/constrained/impls/ipm/ipm.c</A><BR>
<A HREF="../../../src/tao/leastsquares/impls/pounders/pounders.c.html#TaoSetFromOptions_POUNDERS">TaoSetFromOptions_POUNDERS in src/tao/leastsquares/impls/pounders/pounders.c</A><BR>
<A HREF="../../../src/tao/pde_constrained/impls/lcl/lcl.c.html#TaoSetFromOptions_LCL">TaoSetFromOptions_LCL in src/tao/pde_constrained/impls/lcl/lcl.c</A><BR>
<A HREF="../../../src/tao/quadratic/impls/bqpip/bqpip.c.html#TaoSetFromOptions_BQPIP">TaoSetFromOptions_BQPIP in src/tao/quadratic/impls/bqpip/bqpip.c</A><BR>
<A HREF="../../../src/tao/quadratic/impls/gpcg/gpcg.c.html#TaoSetFromOptions_GPCG">TaoSetFromOptions_GPCG in src/tao/quadratic/impls/gpcg/gpcg.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/bmrm/bmrm.c.html#TaoSetFromOptions_BMRM">TaoSetFromOptions_BMRM in src/tao/unconstrained/impls/bmrm/bmrm.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/cg/taocg.c.html#TaoSetFromOptions_CG">TaoSetFromOptions_CG in src/tao/unconstrained/impls/cg/taocg.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/lmvm/lmvm.c.html#TaoSetFromOptions_LMVM">TaoSetFromOptions_LMVM in src/tao/unconstrained/impls/lmvm/lmvm.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/neldermead/neldermead.c.html#TaoSetFromOptions_NM">TaoSetFromOptions_NM in src/tao/unconstrained/impls/neldermead/neldermead.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/nls/nls.c.html#TaoSetFromOptions_NLS">TaoSetFromOptions_NLS in src/tao/unconstrained/impls/nls/nls.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/ntl/ntl.c.html#TaoSetFromOptions_NTL">TaoSetFromOptions_NTL in src/tao/unconstrained/impls/ntl/ntl.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/ntr/ntr.c.html#TaoSetFromOptions_NTR">TaoSetFromOptions_NTR in src/tao/unconstrained/impls/ntr/ntr.c</A><BR>
<A HREF="../../../src/tao/unconstrained/impls/owlqn/owlqn.c.html#TaoSetFromOptions_OWLQN">TaoSetFromOptions_OWLQN in src/tao/unconstrained/impls/owlqn/owlqn.c</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>
|
