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
|
<!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/SNESLineSearchSetDefaultMonitor.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchSetDefaultMonitor</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/SNESLineSearchSetDefaultMonitor.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchSetDefaultMonitor"><H1>SNESLineSearchSetDefaultMonitor</H1></A>
Turns on/off printing useful information and debugging output about 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/SNESLineSearchSetDefaultMonitor.html#SNESLineSearchSetDefaultMonitor">SNESLineSearchSetDefaultMonitor</A>(<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> linesearch, <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> viewer)
</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>linesearch </B></TD><TD>- the linesearch object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>viewer </B></TD><TD>- an ASCII <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> or NULL to turn off monitor
</TD></TR></TABLE>
<P>
Logically Collective on <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_linesearch_monitor [:filename] </B></TD><TD>- enables the monitor
</TD></TR></TABLE>
<P>
<P>
Developer Note: This monitor is implemented differently than the other SNESLineSearchMonitors that are set with
<A HREF="../SNES/SNESLineSearchMonitorSet.html#SNESLineSearchMonitorSet">SNESLineSearchMonitorSet</A>() since it is called in many locations of the line search routines to display aspects of the
line search that are not visible to the other monitors.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESGetLineSearch.html#SNESGetLineSearch">SNESGetLineSearch</A>(), <A HREF="../SNES/SNESLineSearchGetDefaultMonitor.html#SNESLineSearchGetDefaultMonitor">SNESLineSearchGetDefaultMonitor</A>(), <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A>, SNESLineSearchSetMonitor()
<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#SNESLineSearchSetDefaultMonitor">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>
|
