/usr/include/trilinos/MueLu_TimeMonitor.hpp is in libtrilinos-muelu-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | // @HEADER
//
// ***********************************************************************
//
// MueLu: A package for multigrid based preconditioning
// Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
// Jonathan Hu (jhu@sandia.gov)
// Andrey Prokopenko (aprokop@sandia.gov)
// Ray Tuminaro (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef MUELU_TIMEMONITOR_HPP
#define MUELU_TIMEMONITOR_HPP
#include <string>
#include <Teuchos_DefaultComm.hpp>
#include <Teuchos_Time.hpp>
#include <Teuchos_TimeMonitor.hpp>
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_BaseClass.hpp"
#include "MueLu_VerboseObject.hpp"
#include "MueLu_MutuallyExclusiveTime.hpp"
namespace MueLu {
/*! @class TimeMonitor
@brief Integrates Teuchos::TimeMonitor with MueLu verbosity system.
*/
class TimeMonitor : public BaseClass {
public:
TimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0) {
// Inherit props from 'object'
SetVerbLevel (object.GetVerbLevel());
SetProcRankVerbose(object.GetProcRankVerbose());
if (IsPrint(timerLevel) &&
/* disable timer if never printed: */ (IsPrint(RuntimeTimings) || (!IsPrint(NoTimeReport)))) {
if (!IsPrint(NoTimeReport)) {
// TODO: there is no function to register a timer in Teuchos::TimeMonitor after the creation of the timer. But would be useful...
timer_ = Teuchos::TimeMonitor::getNewTimer("MueLu: " + msg);
} else {
timer_ = rcp(new Teuchos::Time("MueLu: " + msg));
}
// Start the timer (this is what is done by Teuchos::TimeMonitor)
timer_->start();
timer_->incrementNumCalls();
}
}
~TimeMonitor() {
// Stop the timer if present
if (timer_ != Teuchos::null)
timer_->stop();
}
protected:
TimeMonitor() { }
private:
RCP<Teuchos::Time> timer_;
};
//TODO: code duplication MutuallyExclusiveTimeMonitor / TimeMonitor
/*! @class MutuallyExclusiveTimeMonitor
@brief Similar to TimeMonitor, but uses MutuallyExclusiveTime objects.
*/
template <class TagName>
class MutuallyExclusiveTimeMonitor : public BaseClass {
public:
/*! @brief Constructor
@param[in] object Reference to the class instance that is creating this MutuallyExclusiveTimeMonitor.
@param[in] msg String that indicates what the Monitor is monitoring, e.g., "Build"
@param[in] timerLevel Governs whether timing information should be *gathered*. Setting this to NoTimeReport prevents the creation of timers.
*/
MutuallyExclusiveTimeMonitor(const BaseClass& object, const std::string& msg, MsgType timerLevel = Timings0) {
// Inherit props from 'object'
SetVerbLevel (object.GetVerbLevel());
SetProcRankVerbose(object.GetProcRankVerbose());
if (IsPrint(timerLevel) &&
/* disable timer if never printed: */ (IsPrint(RuntimeTimings) || (!IsPrint(NoTimeReport)))) {
if (!IsPrint(NoTimeReport)) {
timer_ = MutuallyExclusiveTime<TagName>::getNewTimer("MueLu: " + msg /*+ " (MutuallyExclusive)" */);
} else {
timer_ = rcp(new MutuallyExclusiveTime<TagName> ("MueLu: " + msg /*+ " (MutuallyExclusive)" */));
}
timer_->start();
timer_->incrementNumCalls();
}
}
~MutuallyExclusiveTimeMonitor() {
// Stop the timer if present
if (timer_ != Teuchos::null)
timer_->stop();
}
protected:
MutuallyExclusiveTimeMonitor() { }
private:
RCP<MutuallyExclusiveTime<TagName> > timer_; // keep a reference on the timer to print stats if RuntimeTimings=ON //TODO:use base class instead
};
} // namespace MueLu
#endif // MUELU_TIMEMONITOR_HPP
|