File: PetscTimeSubtract.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (49 lines) | stat: -rw-r--r-- 3,381 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscTimeSubtract.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscTimeSubtract</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/Sys/PetscTimeSubtract.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscTimeSubtract"><H1>PetscTimeSubtract</H1></A>
Subtracts the current time of day (in seconds) from the value v. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include &lt;petsctime.h&gt;
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscTimeSubtract.html#PetscTimeSubtract">PetscTimeSubtract</A>(<A HREF="../Sys/PetscLogDouble.html#PetscLogDouble">PetscLogDouble</A> *v)
</PRE>
Not Collective
<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>v </B></TD><TD>- time counter
</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>v </B></TD><TD>- time counter (v = v - current time)
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Since the PETSc libraries incorporate timing of phases and operations,
we do not every recommend using <A HREF="../Sys/PetscTimeSubtract.html#PetscTimeSubtract">PetscTimeSubtract</A>()
The options database command  -log_view activates
PETSc library timing.  See Users-Manual: ch_profiling for more details, also
see <A HREF="../Profiling/PetscLogStageRegister.html#PetscLogStageRegister">PetscLogStageRegister</A>(), <A HREF="../Profiling/PetscLogEventRegister.html#PetscLogEventRegister">PetscLogEventRegister</A>(), <A HREF="../Profiling/PetscLogEventBegin.html#PetscLogEventBegin">PetscLogEventBegin</A>(), <A HREF="../Profiling/PetscLogEventEnd.html#PetscLogEventEnd">PetscLogEventEnd</A>() for how to register
stages and events in application codes.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
  <A HREF="../Sys/PetscTime.html#PetscTime">PetscTime</A>(), <A HREF="../Sys/PetscTimeAdd.html#PetscTimeAdd">PetscTimeAdd</A>(), <A HREF="../Profiling/PetscLogStageRegister.html#PetscLogStageRegister">PetscLogStageRegister</A>(), <A HREF="../Profiling/PetscLogEventRegister.html#PetscLogEventRegister">PetscLogEventRegister</A>(), <A HREF="../Profiling/PetscLogEventBegin.html#PetscLogEventBegin">PetscLogEventBegin</A>(), <A HREF="../Profiling/PetscLogEventEnd.html#PetscLogEventEnd">PetscLogEventEnd</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/time/../../../include/petsctime.h.html#PetscTimeSubtract">src/sys/time/../../../include/petsctime.h</A>
<BR><A HREF="./index.html">Index of all Sys 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>