File: TaoLineSearchSetFromOptions.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 (48 lines) | stat: -rw-r--r-- 2,906 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
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TaoLineSearch/TaoLineSearchSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchSetFromOptions</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/TaoLineSearch/TaoLineSearchSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchSetFromOptions"><H1>TaoLineSearchSetFromOptions</H1></A>
Sets various TaoLineSearch parameters from user options. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h" 
PetscErrorCode TaoLineSearchSetFromOptions(TaoLineSearch ls)
</PRE>
Collective on TaoLineSearch
<P>
<H3><FONT COLOR="#CC3333">Input Paremeter</FONT></H3>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ls </B></TD><TD>- the TaoLineSearch context
</TD></TR>
<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_ls_type &lt;type&gt; </B></TD><TD>- The algorithm that TAO uses (more-thuente, gpcg, unit)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_ftol &lt;tol&gt; </B></TD><TD>- tolerance for sufficient decrease
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_gtol &lt;tol&gt; </B></TD><TD>- tolerance for curvature condition
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_rtol &lt;tol&gt; </B></TD><TD>- relative tolerance for acceptable step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_stepmin &lt;step&gt; </B></TD><TD>- minimum steplength allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_stepmax &lt;step&gt; </B></TD><TD>- maximum steplength allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_max_funcs &lt;n&gt; </B></TD><TD>- maximum number of function evaluations allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_view </B></TD><TD>- display line-search results to standard output
</TD></TR></TABLE>
<P>

<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/linesearch/interface/taolinesearch.c.html#TaoLineSearchSetFromOptions">src/tao/linesearch/interface/taolinesearch.c</A>
<BR><A HREF="./index.html">Index of all TaoLineSearch 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>