MueLu  Version of the Day
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 
58 namespace MueLu {
59 
64  class TimeMonitor : public BaseClass {
65 
66  public:
67 
68  TimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0) {
69  // Inherit props from 'object'
70  SetVerbLevel (object.GetVerbLevel());
72 
73  if (IsPrint(timerLevel) &&
74  /* disable timer if never printed: */ (IsPrint(RuntimeTimings) || (!IsPrint(NoTimeReport)))) {
75 
76  if (!IsPrint(NoTimeReport)) {
77  // TODO: there is no function to register a timer in Teuchos::TimeMonitor after the creation of the timer. But would be useful...
78  timer_ = Teuchos::TimeMonitor::getNewTimer("MueLu: " + msg);
79  } else {
80  timer_ = rcp(new Teuchos::Time("MueLu: " + msg));
81  }
82 
83  // Start the timer (this is what is done by Teuchos::TimeMonitor)
84  timer_->start();
85  timer_->incrementNumCalls();
86  }
87  }
88 
90  // Stop the timer if present
91  if (timer_ != Teuchos::null)
92  timer_->stop();
93  }
94 
95  protected:
97 
98  private:
99  RCP<Teuchos::Time> timer_;
100  };
101 
102  //TODO: code duplication MutuallyExclusiveTimeMonitor / TimeMonitor
103 
109  template <class TagName>
111 
112  public:
113 
120  MutuallyExclusiveTimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0) {
121  // Inherit props from 'object'
122  SetVerbLevel (object.GetVerbLevel());
124 
125  if (IsPrint(timerLevel) &&
126  /* disable timer if never printed: */ (IsPrint(RuntimeTimings) || (!IsPrint(NoTimeReport)))) {
127 
128  if (!IsPrint(NoTimeReport)) {
129  timer_ = MutuallyExclusiveTime<TagName>::getNewTimer("MueLu: " + msg /*+ " (MutuallyExclusive)" */);
130  } else {
131  timer_ = rcp(new MutuallyExclusiveTime<TagName> ("MueLu: " + msg /*+ " (MutuallyExclusive)" */));
132  }
133 
134  timer_->start();
135  timer_->incrementNumCalls();
136  }
137  }
138 
140  // Stop the timer if present
141  if (timer_ != Teuchos::null)
142  timer_->stop();
143  }
144 
145  protected:
147 
148  private:
149  RCP<MutuallyExclusiveTime<TagName> > timer_; // keep a reference on the timer to print stats if RuntimeTimings=ON //TODO:use base class instead
150  };
151 
152 } // namespace MueLu
153 
154 #endif // MUELU_TIMEMONITOR_HPP
155 
156 
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_
TimeMonitor(const BaseClass &object, const std::string &msg, MsgType timerLevel=Timings0)
Namespace for MueLu classes and methods.
bool IsPrint(MsgType type, int thisProcRankOnly=-1) const
Find out whether we need to print out information for a specific message type.
Integrates Teuchos::TimeMonitor with MueLu verbosity system.
int SetProcRankVerbose(int procRank) const
Set proc rank used for printing.
MutuallyExclusiveTimeMonitor(const BaseClass &object, const std::string &msg, MsgType timerLevel=Timings0)
Constructor.
int GetProcRankVerbose() const
Get proc rank used for printing. Do not use this information for any other purpose.
static RCP< MutuallyExclusiveTime< TagName > > getNewTimer(const std::string &name)
Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summar...
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_
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...
VerbLevel GetVerbLevel() const
Get the verbosity level.