Epetra_Time: The Epetra Timing Class. More...
#include <Epetra_Time.h>
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_Time & | operator= (const Epetra_Time &src) |
| Public Member Functions inherited from Epetra_Object | |
| Epetra_Object (int TracebackModeIn=-1, bool set_label=true) | |
| Epetra_Object Constructor. | |
| Epetra_Object (const char *const Label, int TracebackModeIn=-1) | |
| Epetra_Object Constructor. | |
| Epetra_Object (const Epetra_Object &Object) | |
| Epetra_Object Copy Constructor. | |
| virtual | ~Epetra_Object () |
| Epetra_Object Destructor. | |
| virtual void | Print (std::ostream &os) const |
| virtual int | ReportError (const std::string Message, int ErrorCode) const |
| Error reporting method. | |
| virtual void | SetLabel (const char *const Label) |
| Epetra_Object Label definition using char *. | |
| virtual const char * | Label () const |
| Epetra_Object Label access funtion. | |
Additional Inherited Members | |
| static void | SetTracebackMode (int TracebackModeValue) |
| Set the value of the Epetra_Object error traceback report mode. | |
| static int | GetTracebackMode () |
| Get the value of the Epetra_Object error report mode. | |
| static std::ostream & | GetTracebackStream () |
| Get the output stream for error reporting. | |
| static int | TracebackMode |
| std::string | toString (const int &x) const |
| std::string | toString (const long long &x) const |
| std::string | toString (const double &x) const |
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() [1/2]
| 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.
Referenced by Epetra_Time(), and ~Epetra_Time().
◆ Epetra_Time() [2/2]
| Epetra_Time::Epetra_Time | ( | const Epetra_Time & | Time | ) |
Epetra_Time Copy Constructor.
Makes an exact copy of an existing Epetra_Time instance.
References Epetra_Time().
◆ ~Epetra_Time()
|
virtual |
Member Function Documentation
◆ ElapsedTime()
| 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.
◆ ResetStartTime()
| 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.
◆ WallTime()
| 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:
- Epetra_Time.h
Generated on for Epetra by
1.15.0