MueLu Version of the Day
|
This class wraps a Teuchos::Time and maintains a mutually exclusive property between wrapped timers. More...
#include <MueLu_MutuallyExclusiveTime.hpp>
Query methods. | |
std::string | name_ |
Name of this mutually exclusive timer. | |
RCP< Teuchos::Time > | timer_ |
Using an RCP allows to use Teuchos::TimeMonitor to keep track of the timer. | |
bool | isPaused_ |
static std::stack< MutuallyExclusiveTime< TagName > * > | timerStack_ |
Stack of created timers (active or paused timers). | |
bool | isRunning () |
bool | isPaused () |
void | incrementNumCalls () |
Increment the number of times this timer has been called. | |
static RCP< MutuallyExclusiveTime< TagName > > | getNewTimer (const std::string &name) |
Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summary). | |
static void | PrintParentChildPairs () |
Print std::map of (child,parent) pairs for post-run analysis. | |
MutuallyExclusiveTime (RCP< Teuchos::Time > timer) | |
void | TopOfTheStack () |
Check if 'this' is the head of the stack. | |
Constructor/Destructor | |
MutuallyExclusiveTime (const std::string &name, bool startFlag=false) | |
Constructor. | |
~MutuallyExclusiveTime () | |
Destructor. | |
void | start (bool reset=false) |
Starts the timer. If a MutuallyExclusiveTime timer is running, it will be stopped. | |
Functions that can only be called on the most recent timer (i.e., the running or last paused timer) | |
double | stop () |
Stops the timer. The previous MutuallyExclusiveTime that has been paused when this timer was started will be resumed. This method can be called on an already stopped timer or on the currently running timer. | |
void | pause () |
Pause running timer. Used internally by start(). | |
void | resume () |
Resume paused timer. Used internally by stop(). Timer is not reset. | |
Additional Inherited Members | |
![]() | |
virtual | ~BaseClass () |
Destructor. | |
![]() | |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. | |
VerbLevel | GetVerbLevel () const |
Get the verbosity level. | |
void | SetVerbLevel (const VerbLevel verbLevel) |
Set the verbosity level of this object. | |
int | GetProcRankVerbose () const |
Get proc rank used for printing. Do not use this information for any other purpose. | |
int | SetProcRankVerbose (int procRank) const |
Set proc rank used for printing. | |
bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
Find out whether we need to print out information for a specific message type. | |
Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. | |
Teuchos::FancyOStream & | GetBlackHole () const |
![]() | |
virtual | ~Describable () |
Destructor. | |
virtual void | describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const |
virtual std::string | description () const |
Return a simple one-line description of this object. | |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
Print the object with some verbosity level to an FancyOStream object. | |
virtual std::string | ShortClassName () const |
Return the class name of the object, without template parameters and without namespace. | |
![]() | |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
This class wraps a Teuchos::Time and maintains a mutually exclusive property between wrapped timers.
This class is useful to exclude from a timer the execution time of a subroutine; when a MutuallyExclusiveTime is running, other timers are not running. Timers have three states (running, stopped, paused) to enforce the mutually exclusive property. When the running timer is stopped, the last active timer is restarted. A stack of timers is used internally to support this functionality. The template parameter of this class can be used to define several sets of mutually exclusive timers.
Note: Only one timer can be active at a time but all timers can be inactive at the same time. Timers cannot be destroyed when they are in 'paused'.
Definition at line 75 of file MueLu_MutuallyExclusiveTime.hpp.
MueLu::MutuallyExclusiveTime< TagName >::MutuallyExclusiveTime | ( | const std::string & | name, |
bool | startFlag = false |
||
) |
Constructor.
Definition at line 68 of file MueLu_MutuallyExclusiveTime.cpp.
MueLu::MutuallyExclusiveTime< TagName >::~MutuallyExclusiveTime |
Destructor.
Definition at line 78 of file MueLu_MutuallyExclusiveTime.cpp.
|
private |
This constructor is not public to prevent users from using Teuchos::Time::start()/stop() instead of MutuallyExclusiveTime::start()/stop(), if they have access to the underlying Teuchos::Time object.
Definition at line 193 of file MueLu_MutuallyExclusiveTime.cpp.
void MueLu::MutuallyExclusiveTime< TagName >::start | ( | bool | reset = false | ) |
Starts the timer. If a MutuallyExclusiveTime timer is running, it will be stopped.
Definition at line 90 of file MueLu_MutuallyExclusiveTime.cpp.
double MueLu::MutuallyExclusiveTime< TagName >::stop |
Stops the timer. The previous MutuallyExclusiveTime that has been paused when this timer was started will be resumed. This method can be called on an already stopped timer or on the currently running timer.
Definition at line 113 of file MueLu_MutuallyExclusiveTime.cpp.
void MueLu::MutuallyExclusiveTime< TagName >::pause |
Pause running timer. Used internally by start().
Definition at line 134 of file MueLu_MutuallyExclusiveTime.cpp.
void MueLu::MutuallyExclusiveTime< TagName >::resume |
Resume paused timer. Used internally by stop(). Timer is not reset.
Definition at line 145 of file MueLu_MutuallyExclusiveTime.cpp.
bool MueLu::MutuallyExclusiveTime< TagName >::isRunning |
Definition at line 157 of file MueLu_MutuallyExclusiveTime.cpp.
bool MueLu::MutuallyExclusiveTime< TagName >::isPaused |
Definition at line 166 of file MueLu_MutuallyExclusiveTime.cpp.
|
static |
Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summary).
Definition at line 172 of file MueLu_MutuallyExclusiveTime.cpp.
void MueLu::MutuallyExclusiveTime< TagName >::incrementNumCalls |
Increment the number of times this timer has been called.
Definition at line 179 of file MueLu_MutuallyExclusiveTime.cpp.
|
static |
Print std::map of (child,parent) pairs for post-run analysis.
This method print a std::map. Each key is a child, and the value is its parent. The (child,parent0) pairs can be used by the MueLu script ``mueprof.sh" to print a nice hierarchical tree that shows both runtime flow and time for each section.
Definition at line 182 of file MueLu_MutuallyExclusiveTime.cpp.
|
private |
Check if 'this' is the head of the stack.
Definition at line 198 of file MueLu_MutuallyExclusiveTime.cpp.
std::string MueLu::MutuallyExclusiveTime< TagName >::name_ |
Name of this mutually exclusive timer.
Definition at line 130 of file MueLu_MutuallyExclusiveTime.hpp.
|
private |
Using an RCP allows to use Teuchos::TimeMonitor to keep track of the timer.
Definition at line 149 of file MueLu_MutuallyExclusiveTime.hpp.
|
private |
Definition at line 150 of file MueLu_MutuallyExclusiveTime.hpp.
|
staticprivate |
Stack of created timers (active or paused timers).
Definition at line 156 of file MueLu_MutuallyExclusiveTime.hpp.