File: SNESLineSearchPreCheckFunction.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (38 lines) | stat: -rw-r--r-- 3,020 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/SNESLineSearchPreCheckFunction.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchPreCheckFunction</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/SNESLineSearchPreCheckFunction.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchPreCheckFunction"><H1>SNESLineSearchPreCheckFunction</H1></A>
form of function passed to check the search direction before line search is called 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include &lt;petscsnes.h&gt;
<A HREF="../SNES/SNESLineSearchPreCheckFunction.html#SNESLineSearchPreCheckFunction">SNESLineSearchPreCheckFunction</A>(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> snes,<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>
<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>x </B></TD><TD>- solution vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>y </B></TD><TD>- search direction vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>changed </B></TD><TD>- flag to indicate the precheck changed x or y.
</TD></TR></TABLE>
<P>
Note: This is NOTE a PETSc function, rather it documents the calling sequence of functions passed to <A HREF="../SNES/SNESLineSearchSetPreCheck.html#SNESLineSearchSetPreCheck">SNESLineSearchSetPreCheck</A>()
and <A HREF="../SNES/SNESLineSearchGetPreCheck.html#SNESLineSearchGetPreCheck">SNESLineSearchGetPreCheck</A>()
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   <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><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#SNESLineSearchPreCheckFunction">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>