src/OSspecific/Unix/cpuTime/cpuTimeImpl.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::cpuTimeImpl
  27
  28 Description
  29     Starts timing CPU usage and return elapsed time from start.
  30
  31     This is the platform specific opaque implementation for class cpuTime.
  32
  33 SeeAlso
  34     clockTime
  35
  36 SourceFiles
  37     cpuTimeImpl.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef cpuTimeImpl_H
  42 #define cpuTimeImpl_H
  43
  44 #include <time.h>
  45 #include <sys/times.h>
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class cpuTimeImpl Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class cpuTimeImpl
  57 {
  58     // Private data
  59
  60         static long Hz_;
  61
  62         struct tms startTime_;
  63         mutable struct tms lastTime_;
  64         mutable struct tms newTime_;
  65
  66         static void getTime(struct tms& t);
  67
  68         static double timeDifference
  69         (
  70             const struct tms& start,
  71             const struct tms& end
  72         );
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         cpuTimeImpl();
  81
  82
  83     // Member Functions
  84
  85         // Access
  86
  87             //- Returns CPU time from start of run
  88             double elapsedCpuTime() const;
  89
  90             //- Returns CPU time from last call of cpuTimeIncrement()
  91             double cpuTimeIncrement() const;
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //