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
|
<!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/SNESLineSearchApply.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchApply</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/SNESLineSearchApply.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchApply"><H1>SNESLineSearchApply</H1></A>
Computes the line-search update.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESLineSearchApply.html#SNESLineSearchApply">SNESLineSearchApply</A>(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> linesearch, <A HREF="../Vec/Vec.html#Vec">Vec</A> X, <A HREF="../Vec/Vec.html#Vec">Vec</A> F, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> * fnorm, <A HREF="../Vec/Vec.html#Vec">Vec</A> Y)
</PRE>
Collective on <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</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>linesearch </B></TD><TD>- The linesearch context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD>- The current solution
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>F </B></TD><TD>- The current function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fnorm </B></TD><TD>- The current norm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Y </B></TD><TD>- The search direction
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD>- The new solution
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>F </B></TD><TD>- The new function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fnorm </B></TD><TD>- The new function norm
</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>-snes_linesearch_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_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_damping </B></TD><TD>- The linesearch damping parameter, default is 1.0 (no damping)
</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 computation (<A HREF="../SNES/SNESLineSearchSetComputeNorms.html#SNESLineSearchSetComputeNorms">SNESLineSearchSetComputeNorms</A>())
</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_max_it </B></TD><TD>- The number of iterations for iterative line searches
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This is typically called from within a <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>() implementation in order to
help with convergence of the nonlinear method. Various <A HREF="../SNES/SNES.html#SNES">SNES</A> types use line searches
in different ways, but the overarching theme is that a line search is used to determine
an optimal damping parameter of a step at each iteration of the method. Each
application of the line search may invoke <A HREF="../SNES/SNESComputeFunction.html#SNESComputeFunction">SNESComputeFunction</A>() several times, and
therefore may be fairly expensive.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>, Create
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESGetLineSearch.html#SNESGetLineSearch">SNESGetLineSearch</A>(), <A HREF="../SNES/SNESLineSearchCreate.html#SNESLineSearchCreate">SNESLineSearchCreate</A>(), <A HREF="../SNES/SNESLineSearchPreCheck.html#SNESLineSearchPreCheck">SNESLineSearchPreCheck</A>(), <A HREF="../SNES/SNESLineSearchPostCheck.html#SNESLineSearchPostCheck">SNESLineSearchPostCheck</A>(), <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>(), <A HREF="../SNES/SNESComputeFunction.html#SNESComputeFunction">SNESComputeFunction</A>(), <A HREF="../SNES/SNESLineSearchSetComputeNorms.html#SNESLineSearchSetComputeNorms">SNESLineSearchSetComputeNorms</A>(),
<BR><A HREF="../SNES/SNESLineSearchType.html#SNESLineSearchType">SNESLineSearchType</A>, <A HREF="../SNES/SNESLineSearchSetType.html#SNESLineSearchSetType">SNESLineSearchSetType</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#SNESLineSearchApply">src/snes/linesearch/interface/linesearch.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/ncg/snesncg.c.html#SNESLineSearchApply_NCGLinear">SNESLineSearchApply_NCGLinear in src/snes/impls/ncg/snesncg.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/basic/linesearchbasic.c.html#SNESLineSearchApply_Basic">SNESLineSearchApply_Basic in src/snes/linesearch/impls/basic/linesearchbasic.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/bt/linesearchbt.c.html#SNESLineSearchApply_BT">SNESLineSearchApply_BT in src/snes/linesearch/impls/bt/linesearchbt.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/cp/linesearchcp.c.html#SNESLineSearchApply_CP">SNESLineSearchApply_CP in src/snes/linesearch/impls/cp/linesearchcp.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/l2/linesearchl2.c.html#SNESLineSearchApply_L2">SNESLineSearchApply_L2 in src/snes/linesearch/impls/l2/linesearchl2.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/nleqerr/linesearchnleqerr.c.html#SNESLineSearchApply_NLEQERR">SNESLineSearchApply_NLEQERR in src/snes/linesearch/impls/nleqerr/linesearchnleqerr.c</A><BR>
<A HREF="../../../src/snes/linesearch/impls/shell/linesearchshell.c.html#SNESLineSearchApply_Shell">SNESLineSearchApply_Shell in src/snes/linesearch/impls/shell/linesearchshell.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>
|
