File: PetscLogEventBarrierEnd.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 (57 lines) | stat: -rw-r--r-- 3,550 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<!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/PetscLogEventBarrierEnd.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscLogEventBarrierEnd</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/Profiling/PetscLogEventBarrierEnd.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscLogEventBarrierEnd"><H1>PetscLogEventBarrierEnd</H1></A>
Logs the time in a barrier before an event. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include &lt;petsclog.h&gt;
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Profiling/PetscLogEventBarrierEnd.html#PetscLogEventBarrierEnd">PetscLogEventBarrierEnd</A>(int e,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> o1,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> o2,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> o3,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> o4,<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm)
</PRE>
Logically Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>e </B> -integer associated with the event obtained from <A HREF="../Profiling/PetscLogEventRegister.html#PetscLogEventRegister">PetscLogEventRegister</A>()
<br>
<DT><B>o1,o2,o3,o4 </B> -objects associated with the event, or 0
<br>
<DT><B>comm </B> -communicator the barrier takes place over
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Usage</FONT></H3>
<PRE>
     <A HREF="../Profiling/PetscLogEventBarrierBegin.html#PetscLogEventBarrierBegin">PetscLogEventBarrierBegin</A>(VEC_NormBarrier,0,0,0,0,comm);
       MPIU_Allreduce()
     <A HREF="../Profiling/PetscLogEventBarrierEnd.html#PetscLogEventBarrierEnd">PetscLogEventBarrierEnd</A>(VEC_NormBarrier,0,0,0,0,comm);
</PRE>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This is for logging the amount of time spent in a barrier for an event
that requires synchronization.
<P>
<H3><FONT COLOR="#CC3333">Additional Notes</FONT></H3>
Synchronization events always come in pairs; for example, VEC_NormBarrier and
VEC_NormComm = VEC_NormBarrier + 1
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Profiling/PetscLogEventRegister.html#PetscLogEventRegister">PetscLogEventRegister</A>(), <A HREF="../Profiling/PetscLogEventEnd.html#PetscLogEventEnd">PetscLogEventEnd</A>(), <A HREF="../Profiling/PetscLogFlops.html#PetscLogFlops">PetscLogFlops</A>(), <A HREF="../Profiling/PetscLogEventBegin.html#PetscLogEventBegin">PetscLogEventBegin</A>(),
<BR><A HREF="../Profiling/PetscLogEventBarrierBegin.html#PetscLogEventBarrierBegin">PetscLogEventBarrierBegin</A>()
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 log, event, begin, barrier
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/logging/plog.c.html#PetscLogEventBarrierEnd">src/sys/logging/plog.c</A>
<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>