FreeFOAM The Cross-Platform CFD Toolkit
clockTimeImpl.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::clockTimeImpl
26 
27 Description
28  Starts timing (using rtc) and returns elapsed time from start.
29  Better resolution (2uSec instead of ~20mSec) than cpuTime.
30 
31  This is the platform specific opaque implementation for class clockTime.
32 
33 SourceFiles
34  clockTimeImpl.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef clockTimeImpl_H
39 #define clockTimeImpl_H
40 
41 #include <sys/types.h>
42 #ifdef darwin
43 #include <sys/time.h>
44 #endif
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class clockTime Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57  // Private data
58 
59  struct timeval startTime_;
60  mutable struct timeval lastTime_;
61  mutable struct timeval newTime_;
62 
63  static void getTime(struct timeval& t);
64 
65  static double timeDifference
66  (
67  const struct timeval& start,
68  const struct timeval& end
69  );
70 
71 
72 public:
73 
74  // Constructors
75 
76  //- Construct from components
77  clockTimeImpl();
78 
79 
80  // Member Functions
81 
82  // Access
83 
84  //- Returns CPU time from start of run
85  double elapsedTime() const;
86 
87  //- Returns CPU time from last call of clockTimeIncrement()
88  double timeIncrement() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************ vim: set sw=4 sts=4 et: ************************ //