MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::MutuallyExclusiveTime< TagName > Class Template Reference

This class wraps a Teuchos::Time and maintains a mutually exclusive property between wrapped timers. More...

#include <MueLu_MutuallyExclusiveTime.hpp>

Inheritance diagram for MueLu::MutuallyExclusiveTime< TagName >:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

void start (bool reset=false)
 Starts the timer. If a MutuallyExclusiveTime timer is running, it will be stopped. More...
 
void incrementNumCalls ()
 Increment the number of times this timer has been called. More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
VerbLevel GetVerbLevel () const
 Get the verbosity level. More...
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object. More...
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose. More...
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing. More...
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type. More...
 
Teuchos::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Static Public Member Functions

static RCP
< MutuallyExclusiveTime
< TagName > > 
getNewTimer (const std::string &name)
 Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summary). More...
 
static void PrintParentChildPairs ()
 Print std::map of (child,parent) pairs for post-run analysis. More...
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static Teuchos::RCP
< Teuchos::FancyOStream
GetMueLuOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 

Public Attributes

std::string name_
 Name of this mutually exclusive timer. More...
 

Private Member Functions

 MutuallyExclusiveTime (RCP< Teuchos::Time > timer)
 
void TopOfTheStack ()
 Check if 'this' is the head of the stack. More...
 

Private Attributes

RCP< Teuchos::Timetimer_
 Using an RCP allows to use Teuchos::TimeMonitor to keep track of the timer. More...
 
bool isPaused_
 

Static Private Attributes

static std::stack
< MutuallyExclusiveTime
< TagName > * > 
timerStack_
 Stack of created timers (active or paused timers). More...
 

Constructor/Destructor

 MutuallyExclusiveTime (const std::string &name, bool startFlag=false)
 Constructor. More...
 
 ~MutuallyExclusiveTime ()
 Destructor. More...
 

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. More...
 
void pause ()
 Pause running timer. Used internally by start(). More...
 
void resume ()
 Resume paused timer. Used internally by stop(). Timer is not reset. More...
 

Query methods.

bool isRunning ()
 
bool isPaused ()
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

template<class TagName>
class MueLu::MutuallyExclusiveTime< TagName >

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'.

Todo:
inheritence from PerformanceMonitorBase<Time> ?

Definition at line 75 of file MueLu_MutuallyExclusiveTime.hpp.

Constructor & Destructor Documentation

template<class TagName >
MueLu::MutuallyExclusiveTime< TagName >::MutuallyExclusiveTime ( const std::string &  name,
bool  startFlag = false 
)

Constructor.

Definition at line 68 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
MueLu::MutuallyExclusiveTime< TagName >::~MutuallyExclusiveTime ( )

Destructor.

Definition at line 78 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
MueLu::MutuallyExclusiveTime< TagName >::MutuallyExclusiveTime ( RCP< Teuchos::Time timer)
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.

Member Function Documentation

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::start ( bool  reset = false)

Starts the timer. If a MutuallyExclusiveTime timer is running, it will be stopped.

Precondition
Timer is not already paused.
Postcondition
Timer is running. Other MutuallyExclusiveTime timers are paused or stopped.

Definition at line 90 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
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.

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::pause ( )

Pause running timer. Used internally by start().

Definition at line 134 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::resume ( )

Resume paused timer. Used internally by stop(). Timer is not reset.

Precondition
Timer is at the top of the stack.

Definition at line 145 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
bool MueLu::MutuallyExclusiveTime< TagName >::isRunning ( )

Definition at line 157 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
bool MueLu::MutuallyExclusiveTime< TagName >::isPaused ( )

Definition at line 166 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
RCP< MutuallyExclusiveTime< TagName > > MueLu::MutuallyExclusiveTime< TagName >::getNewTimer ( const std::string &  name)
static

Return a new MutuallyExclusiveTime that is registered with the Teuchos::TimeMonitor (for timer summary).

Definition at line 172 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::incrementNumCalls ( )

Increment the number of times this timer has been called.

Definition at line 179 of file MueLu_MutuallyExclusiveTime.cpp.

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::PrintParentChildPairs ( )
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.

template<class TagName >
void MueLu::MutuallyExclusiveTime< TagName >::TopOfTheStack ( )
private

Check if 'this' is the head of the stack.

Definition at line 198 of file MueLu_MutuallyExclusiveTime.cpp.

Member Data Documentation

template<class TagName >
std::string MueLu::MutuallyExclusiveTime< TagName >::name_

Name of this mutually exclusive timer.

Definition at line 130 of file MueLu_MutuallyExclusiveTime.hpp.

template<class TagName >
RCP<Teuchos::Time> MueLu::MutuallyExclusiveTime< TagName >::timer_
private

Using an RCP allows to use Teuchos::TimeMonitor to keep track of the timer.

Definition at line 149 of file MueLu_MutuallyExclusiveTime.hpp.

template<class TagName >
bool MueLu::MutuallyExclusiveTime< TagName >::isPaused_
private

Definition at line 150 of file MueLu_MutuallyExclusiveTime.hpp.

template<class TagName >
std::stack< MutuallyExclusiveTime< TagName > * > MueLu::MutuallyExclusiveTime< TagName >::timerStack_
staticprivate

Stack of created timers (active or paused timers).

Definition at line 156 of file MueLu_MutuallyExclusiveTime.hpp.


The documentation for this class was generated from the following files: