asl::Timer Class Reference
Utilities

`#include <aslTimer.h>`

## Public Member Functions

| Timer ()
void | start ()
void | stop ()
const double | realTime () const
const double | processorTime () const
const double | processorLoad () const
void | reset ()
const double | estimatedDuration (double completeness)
| Returns estimated duration of the current task based on its current `completeness` [0..1]. More...
const double | estimatedRemainder (double completeness)
| Returns estimated time till finishing current task based on its current `completeness` [0..1]. More...
| Timer ()
void | start ()
void | stop ()
const double | realTime () const
const double | processorTime () const
const double | processorLoad () const
void | reset ()
const double | estimatedDuration (double completeness)
| Returns estimated duration of the current task based on its current `completeness` [0..1]. More...
const double | estimatedRemainder (double completeness)
| Returns estimated time till finishing current task based on its current `completeness` [0..1]. More...

## Detailed Description

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testPrivateVar.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 34 of file aslTimer.h.

## Constructor & Destructor Documentation

## Timer() [1/2]

asl::Timer::Timer | ( |  | ) |

inline

Definition at line 42 of file aslTimer.h.

## Timer() [2/2]

asl::Timer::Timer | ( |  | ) |

inline

Definition at line 42 of file aslTimer.h.

## Member Function Documentation

## estimatedDuration() [1/2]

const double asl::Timer::estimatedDuration | ( | double | completeness | ) |

inline

Returns estimated duration of the current task based on its current `completeness` [0..1].

Definition at line 50 of file aslTimer.h.

## estimatedDuration() [2/2]

const double asl::Timer::estimatedDuration | ( | double | completeness | ) |

inline

Returns estimated duration of the current task based on its current `completeness` [0..1].

Definition at line 50 of file aslTimer.h.

## estimatedRemainder() [1/2]

const double asl::Timer::estimatedRemainder | ( | double | completeness | ) |

inline

Returns estimated time till finishing current task based on its current `completeness` [0..1].

Examples
  acousticWaves.cc, multicomponent_flow.cc, multiphase_flow.cc, and pitot_tube_ice.cc.

Definition at line 52 of file aslTimer.h.

## estimatedRemainder() [2/2]

const double asl::Timer::estimatedRemainder | ( | double | completeness | ) |

inline

Returns estimated time till finishing current task based on its current `completeness` [0..1].

Definition at line 52 of file aslTimer.h.

## processorLoad() [1/2]

const double asl::Timer::processorLoad | ( |  | ) | const

inline

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 47 of file aslTimer.h.

## processorLoad() [2/2]

const double asl::Timer::processorLoad | ( |  | ) | const

inline

Definition at line 47 of file aslTimer.h.

## processorTime() [1/2]

const double asl::Timer::processorTime | ( |  | ) | const

inline

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 46 of file aslTimer.h.

## processorTime() [2/2]

const double asl::Timer::processorTime | ( |  | ) | const

inline

Definition at line 46 of file aslTimer.h.

## realTime() [1/2]

const double asl::Timer::realTime | ( |  | ) | const

inline

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testPrivateVar.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 45 of file aslTimer.h.

## realTime() [2/2]

const double asl::Timer::realTime | ( |  | ) | const

inline

Definition at line 45 of file aslTimer.h.

## reset() [1/2]

void asl::Timer::reset | ( |  | ) |

inline

Examples
  bus_wind.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, and flowKDPGrowth.cc.

Definition at line 48 of file aslTimer.h.

## reset() [2/2]

void asl::Timer::reset | ( |  | ) |

inline

Definition at line 48 of file aslTimer.h.

## start() [1/2]

void asl::Timer::start | ( |  | ) |

inline

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testPrivateVar.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 43 of file aslTimer.h.

## start() [2/2]

void asl::Timer::start | ( |  | ) |

inline

Definition at line 43 of file aslTimer.h.

## stop() [1/2]

void asl::Timer::stop | ( |  | ) |

inline

Examples
  acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testPrivateVar.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 44 of file aslTimer.h.

## stop() [2/2]

void asl::Timer::stop | ( |  | ) |

inline

Definition at line 44 of file aslTimer.h.

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

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/utilities/aslTimer.h