File: SNESLINESEARCHCP.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (38 lines) | stat: -rw-r--r-- 2,851 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
<!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/SNESLINESEARCHCP.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLINESEARCHCP</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/SNES/SNESLINESEARCHCP.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLINESEARCHCP"><H1>SNESLINESEARCHCP</H1></A>
Critical point line search. This line search assumes that there exists some artificial G(x) for which the <A HREF="../SNES/SNESFunction.html#SNESFunction">SNESFunction</A> F(x) = grad G(x).  Therefore, this line search seeks to find roots of dot(F, Y) via a secant method. 
<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_minlambda &lt;minlambda&gt; </B></TD><TD>- the minimum acceptable lambda
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_maxstep &lt;length&gt; </B></TD><TD>- the algorithm insures that a step length is never longer than this value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_damping &lt;damping&gt; </B></TD><TD>- initial trial step length is scaled by this factor, default is 1.0
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_max_it &lt;max_it&gt; </B></TD><TD>- the maximum number of secant steps performed.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This method does NOT use the objective function if it is provided with <A HREF="../SNES/SNESSetObjective.html#SNESSetObjective">SNESSetObjective</A>().
<P>
This method is the preferred line search for <A HREF="../SNES/SNESQN.html#SNESQN">SNESQN</A> and <A HREF="../SNES/SNESNCG.html#SNESNCG">SNESNCG</A>.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../SNES/SNESLineSearchCreate.html#SNESLineSearchCreate">SNESLineSearchCreate</A>(), <A HREF="../SNES/SNESLineSearchSetType.html#SNESLineSearchSetType">SNESLineSearchSetType</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/linesearch/impls/cp/linesearchcp.c.html#SNESLINESEARCHCP">src/snes/linesearch/impls/cp/linesearchcp.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>