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 47 48
|
<!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/SNESLineSearchMonitorCancel.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESLineSearchMonitorCancel</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/SNESLineSearchMonitorCancel.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESLineSearchMonitorCancel"><H1>SNESLineSearchMonitorCancel</H1></A>
Clears all the monitor functions for a <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> object.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESLineSearchMonitorCancel(SNESLineSearch ls)
</PRE>
Logically Collective on <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>ls </B> -the <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> context
<br>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<DT><B>-snes_linesearch_monitor_cancel </B> -cancels all monitors that have been hardwired
into a code by calls to <A HREF="../SNES/SNESLineSearchMonitorSet.html#SNESLineSearchMonitorSet">SNESLineSearchMonitorSet</A>(), but does not cancel those
set via the options database
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
There is no way to clear one specific monitor from a <A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A> object.
<P>
This does not clear the monitor set with <A HREF="../SNES/SNESLineSearchSetDefaultMonitor.html#SNESLineSearchSetDefaultMonitor">SNESLineSearchSetDefaultMonitor</A>() use <A HREF="../SNES/SNESLineSearchSetDefaultMonitor.html#SNESLineSearchSetDefaultMonitor">SNESLineSearchSetDefaultMonitor</A>(ls,NULL) to cancel
that one.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNESLineSearch.html#SNESLineSearch">SNESLineSearch</A>, nonlinear, set, monitor
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
SNESLineSearchMonitorDefault(), <A HREF="../SNES/SNESLineSearchMonitorSet.html#SNESLineSearchMonitorSet">SNESLineSearchMonitorSet</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#SNESLineSearchMonitorCancel">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>
|