Teuchos_Time.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 // Kris
00030 // 07.08.03 -- Move into Teuchos package/namespace
00031 
00032 #ifndef _TEUCHOS_TIME_HPP_
00033 #define _TEUCHOS_TIME_HPP_
00034 
00039 #include "Teuchos_ConfigDefs.hpp"
00040 
00041 #include <ctime>
00042 #ifdef HAVE_MPI
00043 #include "mpi.h"
00044 #else
00045 #if ICL || defined(_WIN32)
00046 #include <time.h>
00047 #else
00048 #include <sys/time.h>
00049 #ifndef MINGW
00050 #include <sys/resource.h>
00051 #endif
00052 #endif
00053 #endif
00054 
00055 
00056 namespace Teuchos {
00057 
00058 
00068 /* ADDITIONAL COMMENTS:
00069  * Initial version by Mike Heroux and Kris Kampshoff. 
00070  * Modified as follows by Kevin Long, 9/29/03:
00071  * <ul>
00072  * <li> There is no need to define explicit copy ctor and dtor for this class.
00073  * <li> The wallTime() method returns the same value for every instance of this class, so
00074  * it would be best to make it a static method.
00075  * <li> Removed the communicator data member. Cross-processor comparisons of timings
00076  * can be done by the TimeMonitor.
00077  * </ul>
00078  */ 
00079 
00080 class TEUCHOS_LIB_DLL_EXPORT Time
00081 {
00082 
00083 public:
00085   Time(const std::string& name, bool start = false);
00086   
00088   static double wallTime();
00089   
00091   void start(bool reset = false);
00092 
00094   double stop();
00095 
00099   double totalElapsedTime(bool readCurrentTime = false) const;
00100 
00103   void reset() {totalTime_ = 0; numCalls_ = 0;}
00104 
00110   bool isRunning() const {return isRunning_;}
00111 
00113   const std::string& name() const {return name_;}
00114 
00116   void incrementNumCalls() {numCalls_++;}
00117 
00119   int numCalls() const {return numCalls_;}
00120 
00121 private:
00122 
00123   double startTime_;
00124   double totalTime_;
00125   bool isRunning_;
00126   std::string name_;
00127   int numCalls_;
00128 
00129 };
00130 
00131 
00132 } // namespace Teuchos
00133 
00134 
00135 #endif // TEUCHOS_TIME_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:44 2011 for Teuchos - Trilinos Tools Package by  doxygen 1.6.3