MFEM  v4.6.0
Finite element discretization library
Public Member Functions | List of all members
mfem::StopWatch Class Reference

Timing object. More...

#include <tic_toc.hpp>

Public Member Functions

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

Detailed Description

Timing object.

Definition at line 35 of file tic_toc.hpp.

Constructor & Destructor Documentation

◆ StopWatch()

mfem::StopWatch::StopWatch ( )

Creates a new (stopped) StopWatch object.

Definition at line 401 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 403 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 429 of file tic_toc.cpp.

◆ Resolution()

double mfem::StopWatch::Resolution ( )

Return the time resolution available to the stopwatch.

Definition at line 424 of file tic_toc.cpp.

◆ Restart()

void mfem::StopWatch::Restart ( )

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

Definition at line 413 of file tic_toc.cpp.

◆ Start()

void mfem::StopWatch::Start ( )

Start the stopwatch. The elapsed time is not cleared.

Definition at line 408 of file tic_toc.cpp.

◆ Stop()

void mfem::StopWatch::Stop ( )

Stop the stopwatch.

Definition at line 419 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 439 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 434 of file tic_toc.cpp.


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