FreeFOAM The Cross-Platform CFD Toolkit
cpuTime.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::cpuTime
26 
27 Description
28  Starts timing CPU usage and return elapsed time from start.
29 
30 SeeAlso
31  clockTime
32 
33 SourceFiles
34  cpuTime.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef cpuTime_H
39 #define cpuTime_H
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cpuTime Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 //- Forward declaration of the OS specific implementation
51 class cpuTimeImpl;
52 
53 
54 class cpuTime
55 {
56  // Private data
57 
58  //- The actual implementation (opaque pointer): PIMPL
59  cpuTimeImpl* impl_;
60 
61 public:
62 
63  // Constructors
64 
65  //- Construct from components
66  cpuTime();
67 
68  // Destructor
69 
70  ~cpuTime();
71 
72 
73  // Member Functions
74 
75  // Access
76 
77  //- Returns CPU time from start of run
78  double elapsedCpuTime() const;
79 
80  //- Returns CPU time from last call of cpuTimeIncrement()
81  double cpuTimeIncrement() const;
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************ vim: set sw=4 sts=4 et: ************************ //