Teuchos - Trilinos Tools Package Version of the Day
Teuchos_TimeMonitor.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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_TIMEMONITOR_HPP
00043 #define TEUCHOS_TIMEMONITOR_HPP
00044 
00045 
00063 #include "Teuchos_ConfigDefs.hpp"
00064 #include "Teuchos_Comm.hpp"
00065 #include "Teuchos_PerformanceMonitorBase.hpp"
00066 #include "Teuchos_Time.hpp"
00067 
00069 #define TEUCHOS_TIMER(funcName, strName) \
00070   static Teuchos::Time& funcName() \
00071   {static Teuchos::RCP<Time> rtn = \
00072       Teuchos::TimeMonitor::getNewCounter(strName); return *rtn;}
00073 
00074 
00080 #define TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, DIFF ) \
00081   static Teuchos::RCP<Teuchos::Time> DIFF ## blabla_localTimer; \
00082   if(!DIFF ## blabla_localTimer.get()) { \
00083     std::ostringstream oss; \
00084     oss << FUNCNAME; \
00085     DIFF ## blabla_localTimer = Teuchos::TimeMonitor::getNewCounter(oss.str()); \
00086   } \
00087   Teuchos::TimeMonitor DIFF ## blabla_localTimeMonitor(*DIFF ## blabla_localTimer)
00088 
00089 
00117 #define TEUCHOS_FUNC_TIME_MONITOR( FUNCNAME ) \
00118   TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, main )
00119 
00120 
00121 namespace Teuchos {
00122 
00134 typedef std::map<std::string, std::vector<std::pair<double, double> > > stat_map_type;
00135 
00159 class TEUCHOS_LIB_DLL_EXPORT TimeMonitor : public PerformanceMonitorBase<Time>
00160 {
00161 public:
00162 
00165  
00174   TimeMonitor (Time& timer, bool reset=false);
00175   
00177   ~TimeMonitor();
00179 
00182 
00187   static RCP<Time> getNewTimer (const std::string& name) {
00188     return getNewCounter (name);
00189   }
00190 
00199   static void zeroOutTimers();
00200 
00298   static void
00299   computeGlobalTimerStatistics (stat_map_type& statData,
00300         std::vector<std::string>& statNames,
00301         Ptr<const Comm<int> > comm,
00302         const ECounterSetOp setOp=Intersection);
00303 
00332   static void
00333   computeGlobalTimerStatistics (stat_map_type& statData,
00334         std::vector<std::string>& statNames,
00335         const ECounterSetOp setOp=Intersection);
00336 
00395   static void 
00396   summarize (Ptr<const Comm<int> > comm,
00397              std::ostream &out=std::cout, 
00398        const bool alwaysWriteLocal=false,
00399        const bool writeGlobalStats=true,
00400        const bool writeZeroTimers=true,
00401        const ECounterSetOp setOp=Intersection);
00402 
00419   static void 
00420   summarize (std::ostream& out=std::cout, 
00421        const bool alwaysWriteLocal=false,
00422        const bool writeGlobalStats=true,
00423        const bool writeZeroTimers=true,
00424        const ECounterSetOp setOp=Intersection);
00426 
00427 };
00428 
00429 
00430 } // namespace Teuchos
00431 
00432 
00433 #endif // TEUCHOS_TIMEMONITOR_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines