src/OSspecific/POSIX/cpuTime/cpuTime.C

   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 Description
  26     Starts timing CPU usage and return elapsed time from start.
  27
  28 \*---------------------------------------------------------------------------*/
  29
  30 #include "cpuTime.H"
  31
  32 #include <unistd.h>
  33
  34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  35
  36 namespace Foam
  37 {
  38
  39 // * * * * * * * * * * * * * * * Static Members  * * * * * * * * * * * * * * //
  40
  41 long cpuTime::Hz_(sysconf(_SC_CLK_TCK));
  42
  43
  44 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  45
  46 void cpuTime::getTime(struct tms& t)
  47 {
  48     times(&t);
  49 }
  50
  51
  52 double cpuTime::timeDifference
  53 (
  54     const struct tms& start,
  55     const struct tms& end
  56 )
  57 {
  58     return
  59     (
  60         double
  61         (
  62             (end.tms_utime + end.tms_stime)
  63           - (start.tms_utime + start.tms_stime)
  64         )/Hz_
  65     );
  66 }
  67
  68
  69 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  70
  71 cpuTime::cpuTime()
  72 {
  73     getTime(startTime_);
  74     lastTime_ = startTime_;
  75     newTime_ = startTime_;
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  80
  81 double cpuTime::elapsedCpuTime() const
  82 {
  83     getTime(newTime_);
  84     return timeDifference(startTime_, newTime_);
  85 }
  86
  87
  88 double cpuTime::cpuTimeIncrement() const
  89 {
  90     lastTime_ = newTime_;
  91     getTime(newTime_);
  92     return timeDifference(lastTime_, newTime_);
  93 }
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // ************************************************************************* //