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
49
50
51
52
53
54
55
56
57
58
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Profiling/PetscLogSetThreshold.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscLogSetThreshold</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/Profiling/PetscLogSetThreshold.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscLogSetThreshold"><H1>PetscLogSetThreshold</H1></A>
Set the threshold time for logging the events; this is a percentage out of 100, so 1. means any event that takes 1 or more percent of the time.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsclog.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Profiling/PetscLogSetThreshold.html#PetscLogSetThreshold">PetscLogSetThreshold</A>(<A HREF="../Sys/PetscLogDouble.html#PetscLogDouble">PetscLogDouble</A> newThresh, <A HREF="../Sys/PetscLogDouble.html#PetscLogDouble">PetscLogDouble</A> *oldThresh)
</PRE>
Logically Collective over <A HREF="../Sys/PETSC_COMM_WORLD.html#PETSC_COMM_WORLD">PETSC_COMM_WORLD</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>newThresh </B></TD><TD>- the threshold to use
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>oldThresh </B></TD><TD>- the previously set threshold value
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-log_view :filename.xml:ascii_xml </B></TD><TD>- Prints an XML summary of flop and timing information to the file
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Usage</FONT></H3>
<PRE>
<A HREF="../Sys/PetscInitialize.html#PetscInitialize">PetscInitialize</A>(...);
<A HREF="../Profiling/PetscLogNestedBegin.html#PetscLogNestedBegin">PetscLogNestedBegin</A>();
<A HREF="../Profiling/PetscLogSetThreshold.html#PetscLogSetThreshold">PetscLogSetThreshold</A>(0.1,&oldthresh);
... code ...
<A HREF="../Profiling/PetscLogView.html#PetscLogView">PetscLogView</A>(viewer);
<A HREF="../Sys/PetscFinalize.html#PetscFinalize">PetscFinalize</A>();
</PRE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Profiling/PetscLogDump.html#PetscLogDump">PetscLogDump</A>(), <A HREF="../Profiling/PetscLogAllBegin.html#PetscLogAllBegin">PetscLogAllBegin</A>(), <A HREF="../Profiling/PetscLogView.html#PetscLogView">PetscLogView</A>(), <A HREF="../Profiling/PetscLogTraceBegin.html#PetscLogTraceBegin">PetscLogTraceBegin</A>(), <A HREF="../Profiling/PetscLogDefaultBegin.html#PetscLogDefaultBegin">PetscLogDefaultBegin</A>(),
<BR><A HREF="../Profiling/PetscLogNestedBegin.html#PetscLogNestedBegin">PetscLogNestedBegin</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/logging/xmllogevent.c.html#PetscLogSetThreshold">src/sys/logging/xmllogevent.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex1f.F90.html">src/snes/tutorials/ex1f.F90.html</A><BR>
<BR><A HREF="./index.html">Index of all Profiling 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>
|
