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 <time.h>
00042 #ifdef HAVE_MPI
00043 #include "mpi.h"
00044 #else
00045 #ifndef ICL
00046 #include <sys/time.h>
00047 #ifndef MINGW
00048 #include <sys/resource.h>
00049 #endif
00050 #endif
00051 #endif
00052 
00053 namespace Teuchos 
00054 {
00055 
00065   /* ADDITIONAL COMMENTS:
00066    * Initial version by Mike Heroux and Kris Kampshoff. 
00067    * Modified as follows by Kevin Long, 9/29/03:
00068    * <ul>
00069    * <li> There is no need to define explicit copy ctor and dtor for this class.
00070    * <li> The wallTime() method returns the same value for every instance of this class, so
00071    * it would be best to make it a static method.
00072    * <li> Removed the communicator data member. Cross-processor comparisons of timings
00073    * can be done by the TimeMonitor.
00074    * </ul>
00075    */ 
00076 
00077   class Time
00078   {
00079 
00080   public:
00082     Time(const string& name, bool start = false);
00083   
00085     static double wallTime();
00086   
00088     void start(bool reset = false);
00089 
00091     double stop();
00092 
00095     double totalElapsedTime() const {return totalTime_;}
00096 
00100     void reset() {totalTime_ = 0;}
00101 
00107     bool isRunning() const {return isRunning_;}
00108 
00110     const string& name() const {return name_;}
00111     
00112   private:
00113     double startTime_;
00114 
00115     double totalTime_;
00116 
00117     bool isRunning_;
00118 
00119     string name_;
00120   };
00121 
00122 } // namespace Teuchos
00123 
00124 // #include "Teuchos_Time.cpp"
00125 
00126 #endif // TEUCHOS_TIME_HPP_

Generated on Thu Sep 18 12:39:10 2008 for Teuchos - Trilinos Tools Package by doxygen 1.3.9.1