src/OSspecific/OSspecific/clockTime.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::clockTime
  26
  27 Description
  28     Starts timing (using rtc) and returns elapsed time from start.
  29     Better resolution (2uSec instead of ~20mSec) than cpuTime.
  30
  31 SourceFiles
  32     clockTime.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef clockTime_H
  37 #define clockTime_H
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                            Class clockTime Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 //- Forward declaration of the OS specific implementation
  49 class cpuTimeImpl;
  50
  51
  52 class clockTime
  53 {
  54     // Private data
  55
  56         //- The actual implementation (opaque pointer): PIMPL
  57         clockTime* impl_;
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         clockTime();
  65
  66
  67     // Member Functions
  68
  69         // Access
  70
  71             //- Returns CPU time from start of run
  72             double elapsedTime() const;
  73
  74             //- Returns CPU time from last call of clockTimeIncrement()
  75             double timeIncrement() const;
  76 };
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************ vim: set sw=4 sts=4 et: ************************ //