OpenFOAM: API Guide
v1912
The open source CFD toolbox
clockTime.C
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2018 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
#include "
clockTime.H
"
29
30
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31
32
Foam::clockTime::clockTime
()
33
:
34
start_(true),
35
last_(start_)
36
{}
37
38
39
Foam::clockTime::clockTime
(
const
clockValue
& clockval)
40
:
41
start_(clockval),
42
last_(start_)
43
{}
44
45
46
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
47
48
void
Foam::clockTime::resetTime
()
49
{
50
last_.update();
51
start_ = last_;
52
}
53
54
55
double
Foam::clockTime::elapsedTime
()
const
56
{
57
last_.update();
58
return
(last_ - start_);
59
}
60
61
62
double
Foam::clockTime::timeIncrement
()
const
63
{
64
const
value_type
prev(last_);
65
last_.update();
66
return
(last_ - prev);
67
}
68
69
70
// ************************************************************************* //
Foam::clockTime::timeIncrement
double timeIncrement() const
Return time (in seconds) since last call to timeIncrement()
Definition:
clockTime.C:62
Foam::clockTime::elapsedTime
double elapsedTime() const
Return time (in seconds) from the start.
Definition:
clockTime.C:55
Foam::clockValue
Access to high-resolution clock value with some basic operations.
Definition:
clockValue.H:51
Foam::clockTime::resetTime
void resetTime()
Reset to use the current time for the start time.
Definition:
clockTime.C:48
Foam::clockTime::clockTime
clockTime()
Construct with the current clock time for the starting value.
Definition:
clockTime.C:32
clockTime.H
src
OpenFOAM
global
clockTime
clockTime.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.