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

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