Teuchos::SyncTimeMonitor Class Reference

A TimeMonitor that waits at a MPI barrier before destruction. More...

#include <Teuchos_TimeMonitor.hpp>

Inheritance diagram for Teuchos::SyncTimeMonitor:

Constructor/Destructor
	SyncTimeMonitor (Time &timer, Ptr< const Comm< int > > comm, bool reset=false)
	Constructor: starts the timer.
	SyncTimeMonitor ()=delete
	Default constructor is deleted, since it would be unsafe.
	~SyncTimeMonitor () override
	Destructor: stops the timer.

Additional Inherited Members
	TimeMonitor (Time &timer, bool reset=false)
	Constructor: starts the timer.
	TimeMonitor ()=delete
	Default constructor is deleted, since it would be unsafe.
	~TimeMonitor () override
	Destructor: stops the timer.
Public Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
	PerformanceMonitorBase (Time &counter_in, bool reset=false)
	Construct with a counter.
virtual	~PerformanceMonitorBase ()=default
	Destructor.
static RCP< Time >	getNewTimer (const std::string &name)
	Return a new timer with the given name (class method).
static void	disableTimer (const std::string &name)
	Disable the timer with the given name.
static void	enableTimer (const std::string &name)
	Enable the timer with the given name.
static void	zeroOutTimers ()
	Reset all global timers to zero.
static void	computeGlobalTimerStatistics (stat_map_type &statData, std::vector< std::string > &statNames, Ptr< const Comm< int > > comm, const ECounterSetOp setOp=Intersection, const std::string &filter="")
	Compute global timer statistics for all timers on the given communicator.
static void	computeGlobalTimerStatistics (stat_map_type &statData, std::vector< std::string > &statNames, const ECounterSetOp setOp=Intersection, const std::string &filter="")
	Compute global timer statistics for all timers on all (MPI) processes (in MPI_COMM_WORLD).
static void	summarize (Ptr< const Comm< int > > comm, std::ostream &out=std::cout, const bool alwaysWriteLocal=false, const bool writeGlobalStats=true, const bool writeZeroTimers=true, const ECounterSetOp setOp=Intersection, const std::string &filter="", const bool ignoreZeroTimers=false)
	Print summary statistics for all timers on the given communicator.
static void	summarize (std::ostream &out=std::cout, const bool alwaysWriteLocal=false, const bool writeGlobalStats=true, const bool writeZeroTimers=true, const ECounterSetOp setOp=Intersection, const std::string &filter="", const bool ignoreZeroTimers=false)
	Print summary statistics for all timers on all (MPI) processes (in MPI_COMM_WORLD).
static void	report (Ptr< const Comm< int > > comm, std::ostream &out, const std::string &filter, const RCP< ParameterList > &params=null)
	Report timer statistics to the given output stream.
static void	report (Ptr< const Comm< int > > comm, std::ostream &out, const RCP< ParameterList > &params=null)
	Report timer statistics to the given output stream.
static void	report (std::ostream &out, const std::string &filter, const RCP< ParameterList > &params=null)
	Report timer statistics to the given output stream.
static void	report (std::ostream &out, const RCP< ParameterList > &params=null)
	Report timer statistics to the given output stream.
static RCP< const ParameterList >	getValidReportParameters ()
	Default parameters (with validators) for report().
static void	setStackedTimer (const Teuchos::RCP< Teuchos::StackedTimer > &t)
	Sets the StackedTimer into which the TimeMonitor will insert timings.
static Teuchos::RCP< Teuchos::StackedTimer >	getStackedTimer ()
	The StackedTimer used by the TimeMonitor.
Static Public Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
static RCP< Time >	getNewCounter (const std::string &name)
	Create a new counter with the specified name and add it to a global set of counters of this type.
static TableFormat &	format ()
	Table format that will be used to print a summary of timer results.
static RCP< Time >	lookupCounter (const std::string &name)
	Return the first counter with the given name, or null if none.
static void	clearCounters ()
	"Forget" about all counters created with getNewCounter().
static void	clearCounter (const std::string &name)
	"Forget" about any counters with the given name.
Protected Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
const Time &	counter () const
	Constant access to the instance's counter reference.
bool	isRecursiveCall () const
	Whether we are currently in a recursive call of the counter.
Static Protected Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
static std::map< std::string, RCP< Time > > &	counters ()
	Array of all counters that were created with getNewCounter() on the calling (MPI) process.
static Teuchos::RCP< Teuchos::StackedTimer >	stackedTimer_ = Teuchos::rcp(new Teuchos::StackedTimer("Teuchos::StackedTimer"))
	Stacked timer for optional injection of timing from TimeMonitor-enabled objects.

Detailed Description

A TimeMonitor that waits at a MPI barrier before destruction.

Definition at line 739 of file Teuchos_TimeMonitor.hpp.

Constructor & Destructor Documentation

SyncTimeMonitor() [1/2]

Teuchos::SyncTimeMonitor::SyncTimeMonitor	(	Time &	timer,
		Ptr< const Comm< int > >	comm,
		bool	reset = false )

Constructor: starts the timer.

Parameters

timer	[in/out] Reference to the timer to be wrapped. This constructor starts the timer, and the destructor stops the timer.
reset	[in] If true, reset the timer before starting it. Default behavior is not to reset the timer.

Definition at line 1084 of file Teuchos_TimeMonitor.cpp.

SyncTimeMonitor() [2/2]

Teuchos::SyncTimeMonitor::SyncTimeMonitor ( )

delete

Default constructor is deleted, since it would be unsafe.

~SyncTimeMonitor()

Teuchos::SyncTimeMonitor::~SyncTimeMonitor ( )

override

Destructor: stops the timer.

Definition at line 1088 of file Teuchos_TimeMonitor.cpp.

---

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

• Teuchos_TimeMonitor.hpp
• Teuchos_TimeMonitor.cpp