MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_TimeMonitor.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_TIMEMONITOR_HPP
47 #define MUELU_TIMEMONITOR_HPP
48 
49 #include <string>
50 #include <Teuchos_DefaultComm.hpp>
51 #include <Teuchos_Time.hpp>
52 #include <Teuchos_TimeMonitor.hpp>
53 #include "MueLu_ConfigDefs.hpp"
54 #include "MueLu_BaseClass.hpp"
55 #include "MueLu_VerboseObject.hpp"
57 #ifdef HAVE_TEUCHOS_ADD_TIME_MONITOR_TO_STACKED_TIMER
58 #include "Teuchos_StackedTimer.hpp"
59 #include <sstream>
60 #endif
61 
62 namespace MueLu {
63 
68  class TimeMonitor : public BaseClass {
69 
70  public:
71 
72  TimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0);
73 
74  ~TimeMonitor();
75 
76  protected:
77  TimeMonitor();
78 
79  private:
81  }; //class TimeMonitor
82 
83  //TODO: code duplication MutuallyExclusiveTimeMonitor / TimeMonitor
84 
90  template <class TagName>
92 
93  public:
94 
101  MutuallyExclusiveTimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0) {
102  // Inherit props from 'object'
103  SetVerbLevel (object.GetVerbLevel());
105 
106  if (IsPrint(timerLevel) &&
107  /* disable timer if never printed: */ (IsPrint(RuntimeTimings) || (!IsPrint(NoTimeReport)))) {
108 
109  if (!IsPrint(NoTimeReport)) {
110  timer_ = MutuallyExclusiveTime<TagName>::getNewTimer("MueLu: " + msg /*+ " (MutuallyExclusive)" */);
111  } else {
112  timer_ = rcp(new MutuallyExclusiveTime<TagName> ("MueLu: " + msg /*+ " (MutuallyExclusive)" */));
113  }
114 
115  timer_->start();
116  timer_->incrementNumCalls();
117  }
118  }
119 
121  // Stop the timer if present
122  if (timer_ != Teuchos::null)
123  timer_->stop();
124  }
125 
126  protected:
128 
129  private:
130  RCP<MutuallyExclusiveTime<TagName> > timer_; // keep a reference on the timer to print stats if RuntimeTimings=ON //TODO:use base class instead
131  };
132 
133  extern template class MutuallyExclusiveTimeMonitor<FactoryBase>;
134  extern template class MutuallyExclusiveTimeMonitor<Level>;
135 
136 } // namespace MueLu
137 
138 #endif // MUELU_TIMEMONITOR_HPP
139 
140 
High level timing information (use Teuchos::TimeMonitor::summarize() to print)
void SetVerbLevel(const VerbLevel verbLevel)
Set the verbosity level of this object.
RCP< Teuchos::Time > timer_
static RCP< MutuallyExclusiveTime< TagName > > getNewTimer(const std::string &name)
Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summar...
Integrates Teuchos::TimeMonitor with MueLu verbosity system.
MutuallyExclusiveTimeMonitor(const BaseClass &object, const std::string &msg, MsgType timerLevel=Timings0)
Constructor.
int SetProcRankVerbose(int procRank) const
Set proc rank used for printing.
VerbLevel GetVerbLevel() const
Get the verbosity level.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Similar to TimeMonitor, but uses MutuallyExclusiveTime objects.
By default, enabled timers appears in the teuchos time monitor summary. Use this option if you do not...
RCP< MutuallyExclusiveTime< TagName > > timer_
bool IsPrint(MsgType type, int thisProcRankOnly=-1) const
Find out whether we need to print out information for a specific message type.
Timers that are enabled (using Timings0/Timings1) will be printed during the execution.
Base class for MueLu classes.
This class wraps a Teuchos::Time and maintains a mutually exclusive property between wrapped timers...
int GetProcRankVerbose() const
Get proc rank used for printing. Do not use this information for any other purpose.