PRISMS-PF Manual
Loading...
Searching...
No Matches
SimulationTimer Class Reference

#include <simulation_timer.h>

Public Member Functions

 SimulationTimer ()=default
 
 SimulationTimer (double step_size)
 
unsigned int get_increment () const
 
double get_time () const
 
double get_timestep () const
 
void increment (double step_size)
 
void increment ()
 
void set_timestep (double step_size)
 
void set_time (double time)
 
void set_increment (unsigned int increment)
 
void reset ()
 

Private Attributes

unsigned int current_increment = 0
 
double current_time = 0.0
 
double time_step_size = 0.0
 

Constructor & Destructor Documentation

◆ SimulationTimer() [1/2]

SimulationTimer::SimulationTimer ( )
default

◆ SimulationTimer() [2/2]

SimulationTimer::SimulationTimer ( double  step_size)
inlineexplicit

Member Function Documentation

◆ get_increment()

unsigned int SimulationTimer::get_increment ( ) const
inline

◆ get_time()

double SimulationTimer::get_time ( ) const
inline

◆ get_timestep()

double SimulationTimer::get_timestep ( ) const
inline

◆ increment() [1/2]

void SimulationTimer::increment ( )
inline

◆ increment() [2/2]

void SimulationTimer::increment ( double  step_size)
inline

◆ reset()

void SimulationTimer::reset ( )
inline

◆ set_increment()

void SimulationTimer::set_increment ( unsigned int  increment)
inline

◆ set_time()

void SimulationTimer::set_time ( double  time)
inline

◆ set_timestep()

void SimulationTimer::set_timestep ( double  step_size)
inline

Member Data Documentation

◆ current_increment

unsigned int SimulationTimer::current_increment = 0
private

◆ current_time

double SimulationTimer::current_time = 0.0
private

◆ time_step_size

double SimulationTimer::time_step_size = 0.0
private

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