src/OSspecific/POSIX/cpuTime/cpuTime.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 #include <time.h>
  42 #include <sys/times.h>
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class cpuTime Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class cpuTime
  54 {
  55     // Private data
  56
  57         static long Hz_;
  58
  59         struct tms startTime_;
  60         mutable struct tms lastTime_;
  61         mutable struct tms newTime_;
  62
  63         static void getTime(struct tms& t);
  64
  65         static double timeDifference
  66         (
  67             const struct tms& start,
  68             const struct tms& end
  69         );
  70
  71
  72 public:
  73
  74     // Constructors
  75
  76         //- Construct from components
  77         cpuTime();
  78
  79
  80     // Member Functions
  81
  82         // Access
  83
  84             //- Returns CPU time from start of run
  85             double elapsedCpuTime() const;
  86
  87             //- Returns CPU time from last call of cpuTimeIncrement()
  88             double cpuTimeIncrement() const;
  89 };
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //