OpenFOAM logo
Open Source CFD Toolkit

cpuTime.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     cpuTime
00027 
00028 Description
00029     Starts timing CPU usage and return elapsed time from start.
00030 
00031 SourceFiles
00032     cpuTime.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef cpuTime_H
00037 #define cpuTime_H
00038 
00039 #include <time.h>
00040 #include <sys/times.h>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class cpuTime Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class cpuTime
00052 {
00053     // Private data
00054 
00055         static long Hz_;
00056 
00057         struct tms startTime_;
00058         mutable struct tms lastTime_;
00059         mutable struct tms newTime_;
00060 
00061         static void getTime(struct tms& t);
00062 
00063         static double timeDifference
00064         (
00065             const struct tms& start,
00066             const struct tms& end
00067         );
00068 
00069 
00070 public:
00071 
00072     // Constructors
00073 
00074         //- Construct from components
00075         cpuTime();
00076 
00077 
00078     // Member Functions
00079 
00080         // Access
00081 
00082             //- Returns CPU time from start of run
00083             double elapsedCpuTime() const;
00084 
00085             //- Returns CPU time from last call of cpuTimeIncrement()
00086             double cpuTimeIncrement() const;
00087 };
00088 
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 } // End namespace Foam
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 #endif
00097 
00098 // ************************************************************************* //
For further information go to www.openfoam.org