MueLu  Version of the Day
MueLu::TimeMonitor Class Reference

Integrates Teuchos::TimeMonitor with MueLu verbosity system. More...

#include <MueLu_TimeMonitor.hpp>

Inheritance diagram for MueLu::TimeMonitor:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Public Member Functions

 TimeMonitor (const BaseClass &object, const std::string &msg, MsgType timerLevel=Timings0)
 
 ~TimeMonitor ()
 
- 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::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStream & GetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- 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...
 

Protected Member Functions

 TimeMonitor ()
 

Private Attributes

RCP< Teuchos::Time > timer_
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

Integrates Teuchos::TimeMonitor with MueLu verbosity system.

Definition at line 64 of file MueLu_TimeMonitor.hpp.

Constructor & Destructor Documentation

◆ TimeMonitor() [1/2]

MueLu::TimeMonitor::TimeMonitor ( const BaseClass object,
const std::string &  msg,
MsgType  timerLevel = Timings0 
)
inline

Definition at line 68 of file MueLu_TimeMonitor.hpp.

◆ ~TimeMonitor()

MueLu::TimeMonitor::~TimeMonitor ( )
inline

Definition at line 89 of file MueLu_TimeMonitor.hpp.

◆ TimeMonitor() [2/2]

MueLu::TimeMonitor::TimeMonitor ( )
inlineprotected

Definition at line 96 of file MueLu_TimeMonitor.hpp.

Member Data Documentation

◆ timer_

RCP<Teuchos::Time> MueLu::TimeMonitor::timer_
private

Definition at line 99 of file MueLu_TimeMonitor.hpp.


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