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

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-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::cpuTime
00026 
00027 Description
00028     Starts timing CPU usage and return elapsed time from start.
00029 
00030 SeeAlso
00031     clockTime
00032 
00033 SourceFiles
00034     cpuTime.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef cpuTime_H
00039 #define cpuTime_H
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class cpuTime Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 //- Forward declaration of the OS specific implementation
00051 class cpuTimeImpl;
00052 
00053 
00054 class cpuTime
00055 {
00056     // Private data
00057 
00058         //- The actual implementation (opaque pointer): PIMPL
00059         cpuTimeImpl* impl_;
00060 
00061 public:
00062 
00063     // Constructors
00064 
00065         //- Construct from components
00066         cpuTime();
00067 
00068     // Destructor
00069 
00070         ~cpuTime();
00071 
00072 
00073     // Member Functions
00074 
00075         // Access
00076 
00077             //- Returns CPU time from start of run
00078             double elapsedCpuTime() const;
00079 
00080             //- Returns CPU time from last call of cpuTimeIncrement()
00081             double cpuTimeIncrement() const;
00082 };
00083 
00084 
00085 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00086 
00087 } // End namespace Foam
00088 
00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00090 
00091 #endif
00092 
00093 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines