FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

clockTime.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::clockTime
00026 
00027 Description
00028     Starts timing (using rtc) and returns elapsed time from start.
00029     Better resolution (2uSec instead of ~20mSec) than cpuTime.
00030 
00031 SourceFiles
00032     clockTime.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef clockTime_H
00037 #define clockTime_H
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class clockTime Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 //- Forward declaration of the OS specific implementation
00049 class cpuTimeImpl;
00050 
00051 
00052 class clockTime
00053 {
00054     // Private data
00055 
00056         //- The actual implementation (opaque pointer): PIMPL
00057         clockTime* impl_;
00058 
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Construct from components
00064         clockTime();
00065 
00066 
00067     // Member Functions
00068 
00069         // Access
00070 
00071             //- Returns CPU time from start of run
00072             double elapsedTime() const;
00073 
00074             //- Returns CPU time from last call of clockTimeIncrement()
00075             double timeIncrement() const;
00076 };
00077 
00078 
00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00080 
00081 } // End namespace Foam
00082 
00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00084 
00085 #endif
00086 
00087 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines