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
|
<!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/SNESLineSearchPreCheck.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchPreCheck</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/SNESLineSearchPreCheck.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchPreCheck"><H1>SNESLineSearchPreCheck</H1></A>
Prepares the line search for being applied.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESLineSearchPreCheck.html#SNESLineSearchPreCheck">SNESLineSearchPreCheck</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> Y,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> *changed)
</PRE>
Logically 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 instance.
</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>Y </B></TD><TD>- The step direction
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<DT><B>changed </B> -Indicator that the precheck routine has changed anything
<br>
<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/SNESLineSearchPostCheck.html#SNESLineSearchPostCheck">SNESLineSearchPostCheck</A>(), <A HREF="../SNES/SNESLineSearchSetPreCheck.html#SNESLineSearchSetPreCheck">SNESLineSearchSetPreCheck</A>(), <A HREF="../SNES/SNESLineSearchGetPreCheck.html#SNESLineSearchGetPreCheck">SNESLineSearchGetPreCheck</A>(), <A HREF="../SNES/SNESLineSearchSetPostCheck.html#SNESLineSearchSetPostCheck">SNESLineSearchSetPostCheck</A>(), <A HREF="../SNES/SNESLineSearchGetPostCheck.html#SNESLineSearchGetPostCheck">SNESLineSearchGetPostCheck</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/linesearch/interface/linesearch.c.html#SNESLineSearchPreCheck">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>
|
