File: petsctime.h.html

package info (click to toggle)
petsc 3.23.1%2Bdfsg1-1exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 515,576 kB
  • sloc: ansic: 751,607; cpp: 51,542; python: 38,598; f90: 17,352; javascript: 3,493; makefile: 3,157; sh: 1,502; xml: 619; objc: 445; java: 13; csh: 1
file content (113 lines) | stat: -rw-r--r-- 10,019 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petsctime.h">Actual source code: petsctime.h</a></center><br>

<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-04-30T18:14:50+00:00">
</head>

<body bgcolor="#FFFFFF">
<pre width=80>
<a name="line1">  1: </a><font color="#B22222">/*</font>
<a name="line2">  2: </a><font color="#B22222">       Low cost access to a system time. This, in general, should not be included in user programs.</font>
<a name="line3">  3: </a><font color="#B22222">*/</font>
<a name="line4">  4: </a><font color="#A020F0">#pragma once</font>

<a name="line6">  6: </a>#include <A href="../include/petscsys.h.html">&lt;petscsys.h&gt;</A>

<a name="line8">  8: </a><font color="#B22222">/* SUBMANSEC = Sys */</font>

<a name="line10"> 10: </a><strong><font color="#4169E1">PETSC_EXTERN <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscGetCPUTime.html">PetscGetCPUTime</a>(<a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> *)</font></strong>;

<a name="line12"> 12: </a><font color="#B22222">/* Global counters */</font>
<a name="line13"> 13: </a>PETSC_EXTERN <a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> petsc_BaseTime;

<a name="line15"> 15: </a><font color="#B22222">/*@</font>
<a name="line16"> 16: </a><font color="#B22222">   <a href="../manualpages/Sys/PetscTime.html">PetscTime</a> - Returns the current time from some base time in the past in seconds.</font>

<a name="line18"> 18: </a><font color="#B22222">   Not Collective</font>

<a name="line20"> 20: </a><font color="#B22222">   Output Parameter:</font>
<a name="line21"> 21: </a><font color="#B22222">.  v - time counter</font>

<a name="line23"> 23: </a><font color="#B22222">   Usage:</font>
<a name="line24"> 24: </a><font color="#B22222">.vb</font>
<a name="line25"> 25: </a><font color="#B22222">     <a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> v;</font>
<a name="line26"> 26: </a><font color="#B22222">     <a href="../manualpages/Sys/PetscTime.html">PetscTime</a>(&amp;v);</font>
<a name="line27"> 27: </a><font color="#B22222">     .... perform some calculation ...</font>
<a name="line28"> 28: </a><font color="#B22222">     printf("Time for operation %g\n",v);</font>
<a name="line29"> 29: </a><font color="#B22222">.ve</font>

<a name="line31"> 31: </a><font color="#B22222">   Level: developer</font>

<a name="line33"> 33: </a><font color="#B22222">   Note:</font>
<a name="line34"> 34: </a><font color="#B22222">   Since the PETSc libraries incorporate timing of phases and operations, we do not recommend ever using `<a href="../manualpages/Sys/PetscTime.html">PetscTime</a>()`.</font>
<a name="line35"> 35: </a><font color="#B22222">   The options database command  `-log_view` activates PETSc library timing.</font>
<a name="line36"> 36: </a><font color="#B22222">   See `<a href="../manualpages/Log/PetscLogStageRegister.html">PetscLogStageRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventRegister.html">PetscLogEventRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventBegin.html">PetscLogEventBegin</a>()`, `<a href="../manualpages/Log/PetscLogEventEnd.html">PetscLogEventEnd</a>()` for how to register</font>
<a name="line37"> 37: </a><font color="#B22222">   stages and events in application codes.</font>

<a name="line39"> 39: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscTimeSubtract.html">PetscTimeSubtract</a>()`, `<a href="../manualpages/Sys/PetscTimeAdd.html">PetscTimeAdd</a>()`, `<a href="../manualpages/Log/PetscLogStageRegister.html">PetscLogStageRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventRegister.html">PetscLogEventRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventBegin.html">PetscLogEventBegin</a>()`, `<a href="../manualpages/Log/PetscLogEventEnd.html">PetscLogEventEnd</a>()`</font>
<a name="line40"> 40: </a><font color="#B22222">@*/</font>
<a name="line41"> 41: </a><strong><font color="#4169E1"><a name="PetscTime"></a>static inline <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscTime.html">PetscTime</a>(<a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> *v)</font></strong>
<a name="line42"> 42: </a>{
<a name="line43"> 43: </a>  *v = <a href="http://www.mpich.org/static/docs/latest/www3/MPI_Wtime.html#MPI_Wtime">MPI_Wtime</a>();
<a name="line44"> 44: </a>  <font color="#4169E1">return</font> <a href="../manualpages/Sys/PetscErrorCode.html">PETSC_SUCCESS</a>;
<a name="line45"> 45: </a>}

<a name="line47"> 47: </a><font color="#B22222">/*@</font>
<a name="line48"> 48: </a><font color="#B22222">   <a href="../manualpages/Sys/PetscTimeSubtract.html">PetscTimeSubtract</a> - Subtracts the current time (in seconds) from the value `v`.</font>

<a name="line50"> 50: </a><font color="#B22222">   Not Collective</font>

<a name="line52"> 52: </a><font color="#B22222">   Input Parameter:</font>
<a name="line53"> 53: </a><font color="#B22222">.  v - time counter</font>

<a name="line55"> 55: </a><font color="#B22222">   Output Parameter:</font>
<a name="line56"> 56: </a><font color="#B22222">.  v - time counter (`v` = `v` - current time)</font>

<a name="line58"> 58: </a><font color="#B22222">   Level: developer</font>

<a name="line60"> 60: </a><font color="#B22222">   Note:</font>
<a name="line61"> 61: </a><font color="#B22222">   Since the PETSc libraries incorporate timing of phases and operations, we do not always recommend using `<a href="../manualpages/Sys/PetscTimeSubtract.html">PetscTimeSubtract</a>()`.</font>
<a name="line62"> 62: </a><font color="#B22222">   The options database command  `-log_view` activates PETSc library timing.</font>
<a name="line63"> 63: </a><font color="#B22222">   See `<a href="../manualpages/Log/PetscLogStageRegister.html">PetscLogStageRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventRegister.html">PetscLogEventRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventBegin.html">PetscLogEventBegin</a>()`, `<a href="../manualpages/Log/PetscLogEventEnd.html">PetscLogEventEnd</a>()` for how to register</font>
<a name="line64"> 64: </a><font color="#B22222">   stages and events in application codes.</font>

<a name="line66"> 66: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscTime.html">PetscTime</a>()`, `<a href="../manualpages/Sys/PetscTimeAdd.html">PetscTimeAdd</a>()`, `<a href="../manualpages/Log/PetscLogStageRegister.html">PetscLogStageRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventRegister.html">PetscLogEventRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventBegin.html">PetscLogEventBegin</a>()`, `<a href="../manualpages/Log/PetscLogEventEnd.html">PetscLogEventEnd</a>()`</font>
<a name="line67"> 67: </a><font color="#B22222">@*/</font>
<a name="line68"> 68: </a><strong><font color="#4169E1"><a name="PetscTimeSubtract"></a>static inline <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscTimeSubtract.html">PetscTimeSubtract</a>(<a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> *v)</font></strong>
<a name="line69"> 69: </a>{
<a name="line70"> 70: </a>  *v -= <a href="http://www.mpich.org/static/docs/latest/www3/MPI_Wtime.html#MPI_Wtime">MPI_Wtime</a>();
<a name="line71"> 71: </a>  <font color="#4169E1">return</font> <a href="../manualpages/Sys/PetscErrorCode.html">PETSC_SUCCESS</a>;
<a name="line72"> 72: </a>}

<a name="line74"> 74: </a><font color="#B22222">/*@</font>
<a name="line75"> 75: </a><font color="#B22222">   <a href="../manualpages/Sys/PetscTimeAdd.html">PetscTimeAdd</a> - Adds the current time (in seconds) to the value `v`.</font>

<a name="line77"> 77: </a><font color="#B22222">   Not Collective</font>

<a name="line79"> 79: </a><font color="#B22222">   Input Parameter:</font>
<a name="line80"> 80: </a><font color="#B22222">.  v - time counter</font>

<a name="line82"> 82: </a><font color="#B22222">   Output Parameter:</font>
<a name="line83"> 83: </a><font color="#B22222">.  v - time counter (`v` = `v` + current time)</font>

<a name="line85"> 85: </a><font color="#B22222">   Level: developer</font>

<a name="line87"> 87: </a><font color="#B22222">   Note:</font>
<a name="line88"> 88: </a><font color="#B22222">   Since the PETSc libraries incorporate timing of phases and operations,  we do not ever recommend using `<a href="../manualpages/Sys/PetscTimeAdd.html">PetscTimeAdd</a>()`.</font>
<a name="line89"> 89: </a><font color="#B22222">   The options database command `-log_view` activates PETSc library timing.</font>

<a name="line91"> 91: </a><font color="#B22222">.seealso: `<a href="../manualpages/Sys/PetscTime.html">PetscTime</a>()`, `<a href="../manualpages/Sys/PetscTimeSubtract.html">PetscTimeSubtract</a>()`, `<a href="../manualpages/Log/PetscLogStageRegister.html">PetscLogStageRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventRegister.html">PetscLogEventRegister</a>()`, `<a href="../manualpages/Log/PetscLogEventBegin.html">PetscLogEventBegin</a>()`, `<a href="../manualpages/Log/PetscLogEventEnd.html">PetscLogEventEnd</a>()`</font>
<a name="line92"> 92: </a><font color="#B22222">@*/</font>
<a name="line93"> 93: </a><strong><font color="#4169E1"><a name="PetscTimeAdd"></a>static inline <a href="../manualpages/Sys/PetscErrorCode.html">PetscErrorCode</a> <a href="../manualpages/Sys/PetscTimeAdd.html">PetscTimeAdd</a>(<a href="../manualpages/Sys/PetscLogDouble.html">PetscLogDouble</a> *v)</font></strong>
<a name="line94"> 94: </a>{
<a name="line95"> 95: </a>  *v += <a href="http://www.mpich.org/static/docs/latest/www3/MPI_Wtime.html#MPI_Wtime">MPI_Wtime</a>();
<a name="line96"> 96: </a>  <font color="#4169E1">return</font> <a href="../manualpages/Sys/PetscErrorCode.html">PETSC_SUCCESS</a>;
<a name="line97"> 97: </a>}
</pre>
</body>

</html>