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

clockTimeImpl.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::clockTimeImpl
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     This is the platform specific opaque implementation for class clockTime.
00032 
00033 SourceFiles
00034     clockTimeImpl.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef clockTimeImpl_H
00039 #define clockTimeImpl_H
00040 
00041 #include <sys/types.h>
00042 #ifdef darwin
00043 #include <sys/time.h>
00044 #endif
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace Foam
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class clockTime Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class clockTimeImpl
00056 {
00057     // Private data
00058 
00059         struct timeval startTime_;
00060         mutable struct timeval lastTime_;
00061         mutable struct timeval newTime_;
00062 
00063         static void getTime(struct timeval& t);
00064 
00065         static double timeDifference
00066         (
00067             const struct timeval& start,
00068             const struct timeval& end
00069         );
00070 
00071 
00072 public:
00073 
00074     // Constructors
00075 
00076         //- Construct from components
00077         clockTimeImpl();
00078 
00079 
00080     // Member Functions
00081 
00082         // Access
00083 
00084             //- Returns CPU time from start of run
00085             double elapsedTime() const;
00086 
00087             //- Returns CPU time from last call of clockTimeIncrement()
00088             double timeIncrement() const;
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace Foam
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 #endif
00099 
00100 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines