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
|
<!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/SNESLineSearchSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetFromOptions</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/SNES/SNESLineSearchSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchSetFromOptions"><H1>SNESLineSearchSetFromOptions</H1></A>
Sets options for the line search
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESLineSearchSetFromOptions.html#SNESLineSearchSetFromOptions">SNESLineSearchSetFromOptions</A>(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> linesearch)
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>linesearch </B> -linesearch 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>-snes_linesearch_type <type> </B></TD><TD>- basic, bt, l2, cp, nleqerr, shell
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_order <order> </B></TD><TD>- 1, 2, 3. Most types only support certain orders (bt supports 2 or 3)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_norms </B></TD><TD>- Turn on/off the linesearch norms for the basic linesearch typem (<A HREF="../SNES/SNESLineSearchSetComputeNorms.html#SNESLineSearchSetComputeNorms">SNESLineSearchSetComputeNorms</A>())
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_minlambda </B></TD><TD>- The minimum step length
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_maxstep </B></TD><TD>- The maximum step size
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_rtol </B></TD><TD>- Relative tolerance for iterative line searches
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_atol </B></TD><TD>- Absolute tolerance for iterative line searches
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_ltol </B></TD><TD>- Change in lambda tolerance for iterative line searches
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_max_it </B></TD><TD>- The number of iterations for iterative line searches
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_monitor [:filename] </B></TD><TD>- Print progress of line searches
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_monitor_solution_update [viewer:filename:format] </B></TD><TD>- view each update tried by line search routine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_damping </B></TD><TD>- The linesearch damping parameter
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_keeplambda </B></TD><TD>- Keep the previous search length as the initial guess.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_precheck_picard </B></TD><TD>- Use precheck that speeds up convergence of picard method
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_precheck_picard_angle </B></TD><TD>- Angle used in picard precheck method
</TD></TR></TABLE>
<P>
Logically Collective on <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESLineSearchCreate.html#SNESLineSearchCreate">SNESLineSearchCreate</A>(), <A HREF="../SNES/SNESLineSearchSetOrder.html#SNESLineSearchSetOrder">SNESLineSearchSetOrder</A>(), <A HREF="../SNES/SNESLineSearchSetType.html#SNESLineSearchSetType">SNESLineSearchSetType</A>(), <A HREF="../SNES/SNESLineSearchSetTolerances.html#SNESLineSearchSetTolerances">SNESLineSearchSetTolerances</A>(), <A HREF="../SNES/SNESLineSearchSetDamping.html#SNESLineSearchSetDamping">SNESLineSearchSetDamping</A>(), <A HREF="../SNES/SNESLineSearchPreCheckPicard.html#SNESLineSearchPreCheckPicard">SNESLineSearchPreCheckPicard</A>(),
<BR><A HREF="../SNES/SNESLineSearchType.html#SNESLineSearchType">SNESLineSearchType</A>, <A HREF="../SNES/SNESLineSearchSetComputeNorms.html#SNESLineSearchSetComputeNorms">SNESLineSearchSetComputeNorms</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/linesearch/interface/linesearch.c.html#SNESLineSearchSetFromOptions">src/snes/linesearch/interface/linesearch.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/linesearch/impls/bt/linesearchbt.c.html#SNESLineSearchSetFromOptions_BT">SNESLineSearchSetFromOptions_BT in src/snes/linesearch/impls/bt/linesearchbt.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>
|
