MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::SubFactoryMonitor Class Reference

Timer to be used in factories. Similar to SubMonitor but adds a timer level by level. More...

#include <MueLu_Monitor.hpp>

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

Public Member Functions

 SubFactoryMonitor (const BaseClass &object, const std::string &msg, int levelID, MsgType msgLevel=Runtime1, MsgType timerLevel=Timings1)
 Constructor.
 
 SubFactoryMonitor (const BaseClass &object, const std::string &msg, const Level &level, MsgType msgLevel=Runtime1, MsgType timerLevel=Timings1)
 Constructor.
 
- Public Member Functions inherited from MueLu::SubMonitor
 SubMonitor (const BaseClass &object, const std::string &msg, MsgType msgLevel=Runtime1, MsgType timerLevel=Timings1)
 Constructor.
 
 SubMonitor (const BaseClass &object, const std::string &msg, const std::string &label, MsgType msgLevel=Runtime1, MsgType timerLevel=Timings1)
 Constructor.
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 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
 
- Public Member Functions inherited from MueLu::Describable
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.
 

Private Attributes

RCP< TimeMonitorlevelTimeMonitor_
 Total time spent on this level in this object and all children.
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
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 ()
 

Detailed Description

Timer to be used in factories. Similar to SubMonitor but adds a timer level by level.

Times an object and all its children on a level-by-level basis.

This timer is useful for timing just a part of a factory; the keyword sub denotes that this is output from a SubFactoryMonitor. The timer yields output such as

   MueLu: SaPFactory: Eigenvalue estimate (sub, total, level=4)    0.01999 (1)      0.02103 (1)      0.02121 (1)      0.02103 (1)

Note that the keyword total denotes timing of the object and its children.

Definition at line 261 of file MueLu_Monitor.hpp.

Constructor & Destructor Documentation

◆ SubFactoryMonitor() [1/2]

MueLu::SubFactoryMonitor::SubFactoryMonitor ( const BaseClass & object,
const std::string & msg,
int levelID,
MsgType msgLevel = Runtime1,
MsgType timerLevel = Timings1 )

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]levelIDThe Level number.
[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 64 of file MueLu_Monitor.cpp.

◆ SubFactoryMonitor() [2/2]

MueLu::SubFactoryMonitor::SubFactoryMonitor ( const BaseClass & object,
const std::string & msg,
const Level & level,
MsgType msgLevel = Runtime1,
MsgType timerLevel = Timings1 )

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]levelThe MueLu Level object.
[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 72 of file MueLu_Monitor.cpp.

Member Data Documentation

◆ levelTimeMonitor_

RCP<TimeMonitor> MueLu::SubFactoryMonitor::levelTimeMonitor_
private

Total time spent on this level in this object and all children.

Definition at line 286 of file MueLu_Monitor.hpp.


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