src/OSspecific/POSIX/cpuTime/cpuTime.H

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