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
|
<!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/SNESNewtonTRSetPostCheck.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESNewtonTRSetPostCheck</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/SNESNewtonTRSetPostCheck.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESNewtonTRSetPostCheck"><H1>SNESNewtonTRSetPostCheck</H1></A>
Sets a user function that is called after the search step has been determined but before the next function evaluation. Allows the user a chance to change or override the decision of the line search routine
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESNewtonTRSetPostCheck.html#SNESNewtonTRSetPostCheck">SNESNewtonTRSetPostCheck</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*func)(<A HREF="../SNES/SNES.html#SNES">SNES</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A>*,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A>*,void*),void *ctx)
</PRE>
Logically Collective on snes
<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>snes </B></TD><TD>- the nonlinear solver object
</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/SNESNewtonTRPostCheck.html#SNESNewtonTRPostCheck">SNESNewtonTRPostCheck</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>
Note: This function is called BEFORE the function evaluation within the <A HREF="../SNES/SNESNEWTONTR.html#SNESNEWTONTR">SNESNEWTONTR</A> solver while the function set in
<A HREF="../SNES/SNESLineSearchSetPostCheck.html#SNESLineSearchSetPostCheck">SNESLineSearchSetPostCheck</A>() is called AFTER the function evaluation.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESNewtonTRPostCheck.html#SNESNewtonTRPostCheck">SNESNewtonTRPostCheck</A>(), <A HREF="../SNES/SNESNewtonTRGetPostCheck.html#SNESNewtonTRGetPostCheck">SNESNewtonTRGetPostCheck</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/impls/tr/tr.c.html#SNESNewtonTRSetPostCheck">src/snes/impls/tr/tr.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>
|
