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
|
<!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/SNESLineSearchSetPreCheck.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetPreCheck</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/SNES/SNESLineSearchSetPreCheck.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchSetPreCheck"><H1>SNESLineSearchSetPreCheck</H1></A>
Sets a user function that is called after the initial search direction has been computed but before the line search routine has been applied. Allows the user to adjust the result of (usually a linear solve) that determined the search direction.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESLineSearchSetPreCheck(SNESLineSearch linesearch, PetscErrorCode (*func)(SNESLineSearch,Vec,Vec,PetscBool*,void*),void *ctx)
</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 <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- [optional] function evaluation routine, see <A HREF="../SNES/SNESLineSearchPreCheckFunction.html#SNESLineSearchPreCheckFunction">SNESLineSearchPreCheckFunction</A> for the calling sequence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- [optional] user-defined context for private data for the function evaluation routine (may be NULL)
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
set, linesearch, pre-check
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESLineSearchSetPostCheck.html#SNESLineSearchSetPostCheck">SNESLineSearchSetPostCheck</A>(), <A HREF="../SNES/SNESLineSearchGetPostCheck.html#SNESLineSearchGetPostCheck">SNESLineSearchGetPostCheck</A>(), <A HREF="../SNES/SNESLineSearchGetPreCheck.html#SNESLineSearchGetPreCheck">SNESLineSearchGetPreCheck</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/linesearch/interface/linesearch.c.html#SNESLineSearchSetPreCheck">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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex3.c.html">src/snes/examples/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex15.c.html">src/snes/examples/tutorials/ex15.c.html</A><BR>
</BODY></HTML>
|
