clockTimeI.H
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-2020 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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
31 :
32  start_(true), // == clockValue::now()
33  last_(start_)
34 {}
35 
36 
37 inline Foam::clockTime::clockTime(const clockValue& clockval)
38 :
39  start_(clockval),
40  last_(start_)
41 {}
42 
43 
44 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
45 
47 {
48  last_.update();
49  start_ = last_;
50 }
51 
52 
53 inline double Foam::clockTime::elapsedTime() const
54 {
55  last_.update();
56  return static_cast<double>(last_ - start_);
57 }
58 
59 
60 inline double Foam::clockTime::timeIncrement() const
61 {
62  const auto prev(last_);
63  last_.update();
64  return static_cast<double>(last_ - prev);
65 }
66 
67 
68 // ************************************************************************* //
Foam::clockTime::timeIncrement
double timeIncrement() const
The time [seconds] since the last call to timeIncrement()
Definition: clockTimeI.H:60
Foam::clockTime::elapsedTime
double elapsedTime() const
The time [seconds] since the start point.
Definition: clockTimeI.H:53
Foam::clockValue
Access to high-resolution clock value with some basic operations. Used to calculate time durations,...
Definition: clockValue.H:53
Foam::clockTime::resetTime
void resetTime()
Reset to use the current clock value for the start point.
Definition: clockTimeI.H:46
Foam::clockTime::clockTime
clockTime()
Construct with the current clock value for the start point.
Definition: clockTimeI.H:30