Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::SyncTimeMonitor Class Reference

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

#include <Teuchos_TimeMonitor.hpp>

Inheritance diagram for Teuchos::SyncTimeMonitor:
Teuchos::TimeMonitor Teuchos::PerformanceMonitorBase< Time >

Public Member Functions

Constructor/Destructor
 SyncTimeMonitor (Time &timer, Ptr< const Comm< int > > comm, bool reset=false)
 Constructor: starts the timer. More...
 
 SyncTimeMonitor ()=delete
 Default constructor is deleted, since it would be unsafe. More...
 
 ~SyncTimeMonitor () override
 Destructor: stops the timer. More...
 
- Public Member Functions inherited from Teuchos::TimeMonitor
 TimeMonitor (Time &timer, bool reset=false)
 Constructor: starts the timer. More...
 
 TimeMonitor ()=delete
 Default constructor is deleted, since it would be unsafe. More...
 
 ~TimeMonitor () override
 Destructor: stops the timer. More...
 
- Public Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
 PerformanceMonitorBase (Time &counter_in, bool reset=false)
 Construct with a counter. More...
 
 PerformanceMonitorBase ()=delete
 Default constructor is deleted, since it would be unsafe. More...
 
virtual ~PerformanceMonitorBase ()=default
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::TimeMonitor
static RCP< TimegetNewTimer (const std::string &name)
 Return a new timer with the given name (class method). More...
 
static void disableTimer (const std::string &name)
 Disable the timer with the given name. More...
 
static void enableTimer (const std::string &name)
 Enable the timer with the given name. More...
 
static void zeroOutTimers ()
 Reset all global timers to zero. More...
 
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. More...
 
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). More...
 
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. More...
 
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). More...
 
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. More...
 
static void report (Ptr< const Comm< int > > comm, std::ostream &out, const RCP< ParameterList > &params=null)
 Report timer statistics to the given output stream. More...
 
static void report (std::ostream &out, const std::string &filter, const RCP< ParameterList > &params=null)
 Report timer statistics to the given output stream. More...
 
static void report (std::ostream &out, const RCP< ParameterList > &params=null)
 Report timer statistics to the given output stream. More...
 
static RCP< const ParameterListgetValidReportParameters ()
 Default parameters (with validators) for report(). More...
 
static void setStackedTimer (const Teuchos::RCP< Teuchos::StackedTimer > &t)
 Sets the StackedTimer into which the TimeMonitor will insert timings. More...
 
static Teuchos::RCP
< Teuchos::StackedTimer
getStackedTimer ()
 The StackedTimer used by the TimeMonitor. More...
 
- Static Public Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
static RCP< TimegetNewCounter (const std::string &name)
 Create a new counter with the specified name and add it to a global set of counters of this type. More...
 
static TableFormatformat ()
 Table format that will be used to print a summary of timer results. More...
 
static RCP< TimelookupCounter (const std::string &name)
 Return the first counter with the given name, or null if none. More...
 
static void clearCounters ()
 "Forget" about all counters created with getNewCounter(). More...
 
static void clearCounter (const std::string &name)
 "Forget" about any counters with the given name. More...
 
- Protected Member Functions inherited from Teuchos::PerformanceMonitorBase< Time >
const Timecounter () const
 Constant access to the instance's counter reference. More...
 
Timecounter ()
 Nonconstant access to the instance's counter reference. More...
 
bool isRecursiveCall () const
 Whether we are currently in a recursive call of the counter. More...
 
- 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. More...
 
- Static Protected Attributes inherited from Teuchos::TimeMonitor
static Teuchos::RCP
< Teuchos::StackedTimer
stackedTimer_ = Teuchos::rcp(new Teuchos::StackedTimer("Teuchos::StackedTimer"))
 Stacked timer for optional injection of timing from TimeMonitor-enabled objects. More...
 

Detailed Description

A TimeMonitor that waits at a MPI barrier before destruction.

Definition at line 769 of file Teuchos_TimeMonitor.hpp.

Constructor & Destructor Documentation

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 1116 of file Teuchos_TimeMonitor.cpp.

Teuchos::SyncTimeMonitor::SyncTimeMonitor ( )
delete

Default constructor is deleted, since it would be unsafe.

Teuchos::SyncTimeMonitor::~SyncTimeMonitor ( )
override

Destructor: stops the timer.

Definition at line 1120 of file Teuchos_TimeMonitor.cpp.


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