src/OSspecific/Unix/clockTime/clockTimeImpl.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::clockTimeImpl
  27
  28 Description
  29     Starts timing (using rtc) and returns elapsed time from start.
  30     Better resolution (2uSec instead of ~20mSec) than cpuTime.
  31
  32     This is the platform specific opaque implementation for class clockTime.
  33
  34 SourceFiles
  35     clockTimeImpl.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef clockTimeImpl_H
  40 #define clockTimeImpl_H
  41
  42 #include <sys/types.h>
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class clockTime Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class clockTimeImpl
  54 {
  55     // Private data
  56
  57         struct timeval startTime_;
  58         mutable struct timeval lastTime_;
  59         mutable struct timeval newTime_;
  60
  61         static void getTime(struct timeval& t);
  62
  63         static double timeDifference
  64         (
  65             const struct timeval& start,
  66             const struct timeval& end
  67         );
  68
  69
  70 public:
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         clockTimeImpl();
  76
  77
  78     // Member Functions
  79
  80         // Access
  81
  82             //- Returns CPU time from start of run
  83             double elapsedTime() const;
  84
  85             //- Returns CPU time from last call of clockTimeIncrement()
  86             double timeIncrement() const;
  87 };
  88
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 } // End namespace Foam
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 #endif
  97
  98 // ************************************************************************* //