MueLu  Version of the Day
MueLu::SubMonitor Class Reference

Timer to be used in non-factories. Similar to Monitor, but doesn't print object description. More...

#include <MueLu_Monitor.hpp>

Inheritance diagram for MueLu::SubMonitor:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable MueLu::SubFactoryMonitor

Public Member Functions

 SubMonitor (const BaseClass &object, const std::string &msg, MsgType msgLevel=Runtime1, MsgType timerLevel=Timings1)
 Constructor. 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::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...
 

Private Attributes

PrintMonitor printMonitor_
 
TimeMonitor timerMonitor_
 

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

Timer to be used in non-factories. Similar to Monitor, but doesn't print object description.

Should be used in non-factory setting. Times object and all its children over all levels. A timer is created only if 'timerLevel' (Timings1 by default) is enabled.

The timer yields output such as

 MueLu: SaPFactory: Eigenvalue estimate (sub, total)        0.149 (6)        0.1615 (6)       0.1643 (6)       0.02692 (6)

Note that the keyword sub denotes that this is output from a SubFactoryMonitor. Note that the keyword total denotes timing of the object and its children.

Definition at line 144 of file MueLu_Monitor.hpp.

Constructor & Destructor Documentation

◆ SubMonitor()

MueLu::SubMonitor::SubMonitor ( const BaseClass object,
const std::string &  msg,
MsgType  msgLevel = Runtime1,
MsgType  timerLevel = Timings1 
)
inline

Constructor.

Parameters
[in]objectReference to the class instance that is creating this SubMonitor.
[in]msgString that indicates what the SubMonitor is monitoring, e.g., "Build"
[in]msgLevelGoverns whether information should be printed.
[in]timerLevelGoverns whether timing information should be gathered. Setting this to NoTimeReport prevents the creation of timers.

Definition at line 153 of file MueLu_Monitor.hpp.

Member Data Documentation

◆ printMonitor_

PrintMonitor MueLu::SubMonitor::printMonitor_
private

Definition at line 159 of file MueLu_Monitor.hpp.

◆ timerMonitor_

TimeMonitor MueLu::SubMonitor::timerMonitor_
private

Definition at line 160 of file MueLu_Monitor.hpp.


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