mfem::StopWatch Class Reference

Timing object. More...

#include <tic_toc.hpp>

Public Member Functions
	StopWatch ()
	Creates a new (stopped) StopWatch object.
	StopWatch (const StopWatch &)
void	Clear ()
	Clear the elapsed time on the stopwatch and restart it if it's running.
void	Start ()
	Start the stopwatch. The elapsed time is not cleared.
void	Stop ()
	Stop the stopwatch.
void	Restart ()
	Clears and restarts the stopwatch. Equivalent to Clear() followed by Start().
double	Resolution ()
	Return the time resolution available to the stopwatch.
double	RealTime ()
	Return the number of real seconds elapsed since the stopwatch was started.
double	UserTime ()
	Return the number of user seconds elapsed since the stopwatch was started.
double	SystTime ()
	Return the number of system seconds elapsed since the stopwatch was started.
	~StopWatch ()
	Default destructor.

Detailed Description

Timing object.

Definition at line 35 of file tic_toc.hpp.

Constructor & Destructor Documentation

StopWatch() [1/2]

mfem::StopWatch::StopWatch

(

)

Creates a new (stopped) StopWatch object.

Definition at line 401 of file tic_toc.cpp.

StopWatch() [2/2]

mfem::StopWatch::StopWatch

(

const StopWatch &

sw

)

Definition at line 403 of file tic_toc.cpp.

~StopWatch()

mfem::StopWatch::~StopWatch ( )

default

Default destructor.

Member Function Documentation

Clear()

void mfem::StopWatch::Clear

(

)

Clear the elapsed time on the stopwatch and restart it if it's running.

Definition at line 406 of file tic_toc.cpp.

RealTime()

double mfem::StopWatch::RealTime

(

)

Return the number of real seconds elapsed since the stopwatch was started.

Definition at line 432 of file tic_toc.cpp.

Resolution()

double mfem::StopWatch::Resolution

(

)

Return the time resolution available to the stopwatch.

Definition at line 427 of file tic_toc.cpp.

Restart()

void mfem::StopWatch::Restart

(

)

Clears and restarts the stopwatch. Equivalent to Clear() followed by Start().

Definition at line 416 of file tic_toc.cpp.

Start()

void mfem::StopWatch::Start

(

)

Start the stopwatch. The elapsed time is not cleared.

Definition at line 411 of file tic_toc.cpp.

Stop()

void mfem::StopWatch::Stop

(

)

Stop the stopwatch.

Definition at line 422 of file tic_toc.cpp.

SystTime()

double mfem::StopWatch::SystTime

(

)

Return the number of system seconds elapsed since the stopwatch was started.

Definition at line 442 of file tic_toc.cpp.

UserTime()

double mfem::StopWatch::UserTime

(

)

Return the number of user seconds elapsed since the stopwatch was started.

Definition at line 437 of file tic_toc.cpp.

---

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

• general/tic_toc.hpp
• general/tic_toc.cpp