LifeV
LifeChronoManager< TimerType > Class Template Reference

#include <LifeChronoManager.hpp>

+ Collaboration diagram for LifeChronoManager< TimerType >:

Public Types

typedef TimerType timer_Type
 
typedef std::map< std::string const, timer_Type * > timerList_Type
 
typedef std::shared_ptr< Epetra_Comm const > commPtr_Type
 

Public Member Functions

 LifeChronoManager (commPtr_Type comm)
 Constructor. More...
 

Protected Attributes

timerList_Type M_timerList
 
UInt M_stringMaxSize
 
commPtr_Type M_comm
 

Static Protected Attributes

static UInt const S_printSize = 80
 
static UInt const S_columnSize = 16
 

LifeChronoManager - chronometer manager class

void add (std::string const &name, timer_Type *timer)
 Register a timer. More...
 
void print (std::ostream &out=std::cout)
 Print out strings and time diffs for the registered timers. More...
 

Detailed Description

template<typename TimerType = LifeChrono>
class LifeV::LifeChronoManager< TimerType >

This class is used for managing multiple chronometers

Definition at line 56 of file LifeChronoManager.hpp.

Member Typedef Documentation

◆ timer_Type

typedef TimerType timer_Type

Definition at line 59 of file LifeChronoManager.hpp.

◆ timerList_Type

typedef std::map<std::string const, timer_Type*> timerList_Type

Definition at line 60 of file LifeChronoManager.hpp.

◆ commPtr_Type

typedef std::shared_ptr<Epetra_Comm const> commPtr_Type

Definition at line 61 of file LifeChronoManager.hpp.

Constructor & Destructor Documentation

◆ LifeChronoManager()

LifeChronoManager ( commPtr_Type  comm)
inline

Constructor.

Parameters
commCommunicator

Definition at line 67 of file LifeChronoManager.hpp.

Member Function Documentation

◆ add()

void add ( std::string const &  name,
timer_Type timer 
)
inline

Register a timer.

Parameters
nameString to be displayed when printing data relative to the timer
timerA pointer to the timer to be registered

Definition at line 95 of file LifeChronoManager.hpp.

◆ print()

void print ( std::ostream &  out = std::cout)
inline

Print out strings and time diffs for the registered timers.

Parameters
outOutput stream

Definition at line 106 of file LifeChronoManager.hpp.

Field Documentation

◆ M_timerList

timerList_Type M_timerList
protected

Definition at line 86 of file LifeChronoManager.hpp.

◆ M_stringMaxSize

UInt M_stringMaxSize
protected

Definition at line 87 of file LifeChronoManager.hpp.

◆ M_comm

commPtr_Type M_comm
protected

Definition at line 88 of file LifeChronoManager.hpp.

◆ S_printSize

UInt const S_printSize = 80
staticprotected

Definition at line 90 of file LifeChronoManager.hpp.

◆ S_columnSize

UInt const S_columnSize = 16
staticprotected

Definition at line 91 of file LifeChronoManager.hpp.


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