src/OSspecific/Unix/clockTime/clockTime.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::clockTime
  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 SourceFiles
  33     clockTime.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef clockTime_H
  38 #define clockTime_H
  39
  40 #include <sys/types.h>
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class clockTime Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class clockTime
  52 {
  53     // Private data
  54
  55         struct timeval startTime_;
  56         mutable struct timeval lastTime_;
  57         mutable struct timeval newTime_;
  58
  59         static void getTime(struct timeval& t);
  60
  61         static double timeDifference
  62         (
  63             const struct timeval& start,
  64             const struct timeval& end
  65         );
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct from components
  73         clockTime();
  74
  75
  76     // Member Functions
  77
  78         // Access
  79
  80             //- Returns CPU time from start of run
  81             double elapsedTime() const;
  82
  83             //- Returns CPU time from last call of clockTimeIncrement()
  84             double timeIncrement() const;
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //