MueLu
Version of the Day
|
Timer to be used in non-factories. More...
#include <MueLu_Monitor.hpp>
Public Member Functions | |
Monitor (const BaseClass &object, const std::string &msg, MsgType msgLevel=Runtime0, MsgType timerLevel=Timings0) | |
Constructor. More... | |
Monitor (const BaseClass &object, const std::string &msg, const std::string &label, MsgType msgLevel=Runtime0, MsgType timerLevel=Timings0) | |
Constructor. More... | |
![]() | |
virtual | ~BaseClass () |
Destructor. More... | |
![]() | |
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... | |
![]() | |
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_ |
Manages printing. More... | |
TimeMonitor | timerMonitor_ |
Records total time spent in this object and all its children, over all levels. More... | |
Additional Inherited Members | |
![]() | |
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... | |
Timer to be used in non-factories.
A timer is created only if 'timerLevel' (Timings0 by default) is enabled. This class manages verbosity, as well as times this object and all its children over all levels.
The timer yields output such as
MueLu: SaPFactory: Prolongator smoothing (total) 6.508 (6) 6.551 (6) 6.557 (6) 1.092 (6)
Note that the keyword total denotes timing of the object and its children.
Definition at line 116 of file MueLu_Monitor.hpp.
|
inline |
Constructor.
[in] | object | Reference to the class instance that is creating this Monitor. |
[in] | msg | String that indicates what the Monitor is monitoring, e.g., "Build" |
[in] | msgLevel | Governs whether information should be printed. |
[in] | timerLevel | Governs whether timing information should be gathered. Setting this to NoTimeReport prevents the creation of timers. |
Definition at line 125 of file MueLu_Monitor.hpp.
|
inline |
Constructor.
[in] | object | Reference to the class instance that is creating this Monitor. |
[in] | msg | String that indicates what the Monitor is monitoring, e.g., "Build" |
[in] | msgLevel | Governs whether information should be printed. |
[in] | timerLevel | Governs whether timing information should be gathered. Setting this to NoTimeReport prevents the creation of timers. |
[in] | label | An optional prefix label. |
Definition at line 138 of file MueLu_Monitor.hpp.
|
private |
Manages printing.
Definition at line 145 of file MueLu_Monitor.hpp.
|
private |
Records total time spent in this object and all its children, over all levels.
Definition at line 147 of file MueLu_Monitor.hpp.