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
|
<!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/SNESLineSearchSetLambda.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetLambda</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="SNESLineSearchSetLambda"><H1>SNESLineSearchSetLambda</H1></A>
Sets the linesearch steplength.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESLineSearchSetLambda(SNESLineSearch linesearch, PetscReal lambda)
</PRE>
<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>- linesearch context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lambda </B></TD><TD>- The last steplength.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This routine is typically used within implementations of <A HREF="../SNES/SNESLineSearchApply.html#SNESLineSearchApply">SNESLineSearchApply</A>
to set the final steplength. This routine (and <A HREF="../SNES/SNESLineSearchGetLambda.html#SNESLineSearchGetLambda">SNESLineSearchGetLambda</A>()) were
added in order to facilitate Quasi-Newton methods that use the previous steplength
as an inner scaling parameter.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESLineSearchGetLambda.html#SNESLineSearchGetLambda">SNESLineSearchGetLambda</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/linesearch/interface/linesearch.c.html#SNESLineSearchSetLambda">src/snes/linesearch/interface/linesearch.c</A>
<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>
|
