HDSim3D::ProgressTracker Class Reference

Tracks the progress of a simulation. More...

#include <hdsim_3d.hpp>

Public Member Functions
	ProgressTracker (void)
	Class constructor.
void	update (double dt)
	Update the progress tracker. More...
double	getTime (void) const
	Returns the current time of the simulation. More...
double	getCycle (void) const
	Returns the number of times time advance was called. More...

Detailed Description

Tracks the progress of a simulation.

Definition at line 19 of file hdsim_3d.hpp.

Member Function Documentation

getCycle()

double HDSim3D::ProgressTracker::getCycle

(

void

)

const

Returns the number of times time advance was called.

Returns

Cycle number

Definition at line 19 of file hdsim_3d.cpp.

getTime()

double HDSim3D::ProgressTracker::getTime

(

void

)

const

Returns the current time of the simulation.

Returns

Time of the simulation

Definition at line 14 of file hdsim_3d.cpp.

update()

void HDSim3D::ProgressTracker::update

(

double

dt

)

Update the progress tracker.

Parameters

dt

Time step

Definition at line 8 of file hdsim_3d.cpp.

---

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

• source/newtonian/three_dimensional/hdsim_3d.hpp
• source/newtonian/three_dimensional/hdsim_3d.cpp