File: TaoSetFromOptions.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
links: PTS, VCS
area: main
in suites: stretch
size: 163,864 kB
ctags: 618,438
sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (94 lines) | stat: -rw-r--r-- 6,784 bytes
<!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.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/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" 
PetscErrorCode TaoSetFromOptions(Tao 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 &lt;type&gt; </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 &lt;gatol&gt; </B></TD><TD>- absolute error tolerance for ||gradient||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_grtol &lt;grtol&gt; </B></TD><TD>- relative error tolerance for ||gradient||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_gttol &lt;gttol&gt; </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 &lt;max&gt; </B></TD><TD>- sets maximum number of iterations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_max_funcs &lt;max&gt; </B></TD><TD>- sets maximum number of function evaluations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_fmin &lt;fmin&gt; </B></TD><TD>- stop if function value reaches fmin
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_steptol &lt;tol&gt; </B></TD><TD>- stop if trust region radius less than &lt;tol&gt;
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_trust0 &lt;t&gt; </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_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><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/interface/taosolver.c.html#TaoSetFromOptions">src/tao/interface/taosolver.c</A>
<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>
<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/eptorsion2f.F.html">src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/rosenbrock1f.F.html">src/tao/unconstrained/examples/tutorials/rosenbrock1f.F.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/maros.c.html">src/tao/constrained/examples/tutorials/maros.c.html</A><BR>
</BODY></HTML>