Epetra_Time Class Reference

Epetra_Time: The Epetra Timing Class. More...

#include <Epetra_Time.h>

Inheritance diagram for Epetra_Time:

Inheritance graph
[legend]
Collaboration diagram for Epetra_Time:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Epetra_Time (const Epetra_Comm &Comm)
 Epetra_Time Constructor.
 Epetra_Time (const Epetra_Time &Time)
 Epetra_Time Copy Constructor.
double WallTime (void) const
 Epetra_Time wall-clock time function.
void ResetStartTime (void)
 Epetra_Time function to reset the start time for a timer object.
double ElapsedTime (void) const
 Epetra_Time elapsed time function.
virtual ~Epetra_Time (void)
 Epetra_Time Destructor.
Epetra_Timeoperator= (const Epetra_Time &src)

Detailed Description

Epetra_Time: The Epetra Timing Class.

The Epetra_Time class is a wrapper that encapsulates the general information needed getting timing information. Currently it return the elapsed time for each calling processor.. A Epetra_Comm object is required for building all Epetra_Time objects.

Epetra_Time support both serial execution and (via MPI) parallel distributed memory execution. It is meant to insulate the user from the specifics of timing across a variety of platforms.


Constructor & Destructor Documentation

Epetra_Time::Epetra_Time ( const Epetra_Comm Comm  ) 

Epetra_Time Constructor.

Creates a Epetra_Time instance. This instance can be queried for elapsed time on the calling processor. StartTime is also set for use with the ElapsedTime function.

Epetra_Time::Epetra_Time ( const Epetra_Time Time  ) 

Epetra_Time Copy Constructor.

Makes an exact copy of an existing Epetra_Time instance.

virtual Epetra_Time::~Epetra_Time ( void   )  [virtual]

Epetra_Time Destructor.

Completely deletes a Epetra_Time object.


Member Function Documentation

double Epetra_Time::ElapsedTime ( void   )  const

Epetra_Time elapsed time function.

Returns the elapsed time in seconds since the timer object was constructed, or since the ResetStartTime function was called. A code section can be timed by putting it between the Epetra_Time constructor and a call to ElapsedTime, or between a call to ResetStartTime and ElapsedTime.

void Epetra_Time::ResetStartTime ( void   ) 

Epetra_Time function to reset the start time for a timer object.

Resets the start time for the timer object to the current time A code section can be timed by putting it between a call to ResetStartTime and ElapsedTime.

double Epetra_Time::WallTime ( void   )  const

Epetra_Time wall-clock time function.

Returns the wall-clock time in seconds. A code section can be timed by putting it between two calls to WallTime and taking the difference of the times.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:25:14 2010 for Epetra by  doxygen 1.4.7