MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_Monitor.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_MONITOR_HPP
47#define MUELU_MONITOR_HPP
48
49#include <string>
50#include <algorithm> // for swap
51#include <ostream> // for basic_ostream, operator<<, etc
52#include "Teuchos_FancyOStream.hpp" // for OSTab, FancyOStream
53#include "Teuchos_RCPDecl.hpp" // for RCP
54#include "Teuchos_RCP.hpp" // for RCP::RCP<T>, RCP::operator=, etc
55#include "Teuchos_Utils.hpp" // for Utils
56#include "MueLu_VerbosityLevel.hpp" // for MsgType, MsgType::Runtime0, etc
57#include "MueLu_BaseClass.hpp"
59#include "MueLu_Level.hpp"
60#include "MueLu_TimeMonitor.hpp"
61
62namespace MueLu {
63
66 static std::string getColonLabel(const std::string& label) {
67 if (label != "")
68 return label + ": ";
69 else
70 return "";
71 }
72 };
73
74
78 class PrintMonitor : public BaseClass {
79
80 public:
81
83 PrintMonitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime0);
85
86 private:
88
89 bool tabbed;
91 };
92
107 class Monitor: public BaseClass {
108 public:
116 Monitor(const BaseClass& object, const std::string & msg, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);
117
126 Monitor(const BaseClass& object, const std::string & msg, const std::string & label, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);
127
128 virtual ~Monitor() = default;
129
130 private:
135 };
136
137 //---------------------------------------------------------------------------------------------------
138
155 class SubMonitor: public BaseClass {
156 public:
164 SubMonitor(const BaseClass& object, const std::string & msg, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);
165
174 SubMonitor(const BaseClass& object, const std::string & msg, const std::string & label, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);
175
176 private:
179 };
180
181//convert integer timer number to string
182#ifdef HAVE_MUELU_PROFILING
183#define MUELU_TIMER_AS_STRING static_cast<std::ostringstream*>( &(std::ostringstream() << " " << timerIdentifier_++) )->str()
184#else
185#define MUELU_TIMER_AS_STRING
186#endif
187
188 //---------------------------------------------------------------------------------------------------
189
209 class FactoryMonitor: public Monitor {
210 public:
211
213
222 FactoryMonitor(const BaseClass& object, const std::string & msg, int levelID, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);
223
234 FactoryMonitor(const BaseClass& object, const std::string & msg, const Level & level, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);
235
236 private:
238 RCP<TimeMonitor> levelTimeMonitor_;
242 RCP<MutuallyExclusiveTimeMonitor<Level> > levelTimeMonitorExclusive_;
243 };
244
245 //---------------------------------------------------------------------------------------------------
246
262 public:
263
272 SubFactoryMonitor(const BaseClass& object, const std::string & msg, int levelID, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);
273
282 SubFactoryMonitor(const BaseClass& object, const std::string & msg, const Level & level, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);
283
284 private:
286 RCP<TimeMonitor> levelTimeMonitor_;
287 };
288
289} // namespace MueLu
290
291#endif // MUELU_MONITOR_HPP
Base class for MueLu classes.
Timer to be used in factories. Similar to Monitor but with additional timers.
RCP< TimeMonitor > levelTimeMonitor_
Total time spent on this level in this object and all its children.
RCP< MutuallyExclusiveTimeMonitor< Level > > levelTimeMonitorExclusive_
Total time spent on this level in this object only, excluding all children.
MutuallyExclusiveTimeMonitor< FactoryBase > timerMonitorExclusive_
Total time spent on all levels in this object only, excluding all children.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Timer to be used in non-factories.
TimeMonitor timerMonitor_
Records total time spent in this object and all its children, over all levels.
virtual ~Monitor()=default
PrintMonitor printMonitor_
Manages printing.
Similar to TimeMonitor, but uses MutuallyExclusiveTime objects.
const BaseClass & object_
Timer to be used in factories. Similar to SubMonitor but adds a timer level by level.
RCP< TimeMonitor > levelTimeMonitor_
Total time spent on this level in this object and all children.
Timer to be used in non-factories. Similar to Monitor, but doesn't print object description.
TimeMonitor timerMonitor_
PrintMonitor printMonitor_
Integrates Teuchos::TimeMonitor with MueLu verbosity system.
Namespace for MueLu classes and methods.
@ Timings1
Detailed timing information (use Teuchos::TimeMonitor::summarize() to print)
@ Timings0
High level timing information (use Teuchos::TimeMonitor::summarize() to print)
@ Runtime0
One-liner description of what is happening.
@ Runtime1
Description of what is happening (more verbose)
static std::string getColonLabel(const std::string &label)
Helper function for object label.