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
|
<!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/SNESLineSearchSetOrder.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetOrder</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/SNESLineSearchSetOrder.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchSetOrder"><H1>SNESLineSearchSetOrder</H1></A>
Sets the maximum order of the polynomial fit used in 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/SNESLineSearchSetOrder.html#SNESLineSearchSetOrder">SNESLineSearchSetOrder</A>(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> linesearch,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> order)
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>linesearch </B> -linesearch context
<br>
<DT><B>order </B> -The damping parameter
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Possible Values for order</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>1 or SNES_LINESEARCH_ORDER_LINEAR </B></TD><TD>- linear order
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>2 or SNES_LINESEARCH_ORDER_QUADRATIC </B></TD><TD>- quadratic order
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>3 or SNES_LINESEARCH_ORDER_CUBIC </B></TD><TD>- cubic order
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<H3><FONT COLOR="#CC3333">Variable orders are supported by the following line searches</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bt </B></TD><TD>- cubic and quadratic
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cp </B></TD><TD>- linear and quadratic
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESLineSearchGetOrder.html#SNESLineSearchGetOrder">SNESLineSearchGetOrder</A>(), <A HREF="../SNES/SNESLineSearchSetDamping.html#SNESLineSearchSetDamping">SNESLineSearchSetDamping</A>()
<BR><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#SNESLineSearchSetOrder">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>
|