Amesos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
Amesos_Time Class Reference

Amesos_Time: Container for timing information. More...

#include <Amesos_Time.h>

Inheritance diagram for Amesos_Time:
Inheritance graph
[legend]

Public Member Functions

 Amesos_Time ()
 Default constructor to create size timers. More...
 
virtual ~Amesos_Time ()
 Default destructor. More...
 
void CreateTimer (const Epetra_Comm &Comm, int size=1)
 Initializes the Time object. More...
 
void ResetTimer (const int timerID=0)
 Resets the internally stored time object. More...
 
int AddTime (const std::string what, int dataID, const int timerID=0)
 Adds to field what the time elapsed since last call to ResetTimer(). More...
 
double GetTime (const std::string what) const
 Gets the cumulative time using the string. More...
 
double GetTime (const int dataID) const
 Gets the cumulative time using the dataID. More...
 
void GetTiming (Teuchos::ParameterList &list) const
 Load up the current timing information into the parameter list. More...
 

Private Attributes

int size_
 Number of Epetra_Time objects allocated in this object. More...
 
Array< RCP< Epetra_Time > > time_
 Time object. More...
 
Array< Amesos_Time_Datadata_
 Fast accessable container for timing data. More...
 

Detailed Description

Amesos_Time: Container for timing information.

Author
Marzio Sala, SNL 9214
Date
Last updated on 26-March-07 by Heidi Thornquist

Definition at line 56 of file Amesos_Time.h.

Constructor & Destructor Documentation

Amesos_Time::Amesos_Time ( )
inline

Default constructor to create size timers.

Definition at line 61 of file Amesos_Time.h.

virtual Amesos_Time::~Amesos_Time ( )
inlinevirtual

Default destructor.

Definition at line 66 of file Amesos_Time.h.

Member Function Documentation

void Amesos_Time::CreateTimer ( const Epetra_Comm Comm,
int  size = 1 
)
inline

Initializes the Time object.

Definition at line 70 of file Amesos_Time.h.

void Amesos_Time::ResetTimer ( const int  timerID = 0)
inline

Resets the internally stored time object.

Definition at line 80 of file Amesos_Time.h.

int Amesos_Time::AddTime ( const std::string  what,
int  dataID,
const int  timerID = 0 
)
inline

Adds to field what the time elapsed since last call to ResetTimer().

Definition at line 86 of file Amesos_Time.h.

double Amesos_Time::GetTime ( const std::string  what) const
inline

Gets the cumulative time using the string.

Definition at line 108 of file Amesos_Time.h.

double Amesos_Time::GetTime ( const int  dataID) const
inline

Gets the cumulative time using the dataID.

Definition at line 120 of file Amesos_Time.h.

void Amesos_Time::GetTiming ( Teuchos::ParameterList list) const
inline

Load up the current timing information into the parameter list.

Definition at line 130 of file Amesos_Time.h.

Member Data Documentation

int Amesos_Time::size_
private

Number of Epetra_Time objects allocated in this object.

Definition at line 141 of file Amesos_Time.h.

Array<RCP<Epetra_Time> > Amesos_Time::time_
private

Time object.

Definition at line 144 of file Amesos_Time.h.

Array< Amesos_Time_Data > Amesos_Time::data_
private

Fast accessable container for timing data.

Definition at line 147 of file Amesos_Time.h.


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