Time2Finish Class Reference

Estimates the total time, in seconds, left to reach the end of any simulation. First, the class needs to be initialized by calling set. After the class is initialized, an estimate of the total remaining time of the simulation can be found by calling getTime2Finish. The estimate is based on rate at which the simulation time progressed since initialization. More...

#include <MercuryTime.h>

Public Member Functions
void	set (Mdouble t, Mdouble tMax)
	Initialises the variable start with the current value of clock ticks, the current time and the final time of the simulation. More...
Mdouble	getTime2Finish (Mdouble t)
	Estimates the total time, in seconds, left to reach the end of any simulation. After the class is initialized, an estimate of the total remaining time of the simulation can be found by calling getTime2Finish. The estimate is based on rate at which the simulation time progressed since initialization. More...
std::string	getFinishTime (Mdouble t)
	Returns the estimated finish time based on the amount of time left to finish. More...

Private Attributes
clock_t	startTime_
	Stores the current number of clock ticks at the start. More...
Mdouble	time_
	Stores the simulation time (DPM units) More...
Mdouble	timeMax_
	Stores the total simulation time (DPM units) More...

Detailed Description

Estimates the total time, in seconds, left to reach the end of any simulation. First, the class needs to be initialized by calling set. After the class is initialized, an estimate of the total remaining time of the simulation can be found by calling getTime2Finish. The estimate is based on rate at which the simulation time progressed since initialization.

E.g., assume that the class has been initialized at simulation time 0, with final time 10. Then, getTime2Finish is called after 1 hour at simulation time 2. Since the code required 0.5 hours per simulation time unit and there are 8 simulation time units left, it is likely to finish in 4 hours.

Definition at line 88 of file MercuryTime.h.

Member Function Documentation

std::string Time2Finish::getFinishTime ( Mdouble  t )

inline

Returns the estimated finish time based on the amount of time left to finish.

Parameters

[in]

t

current simulation time

Returns

time of the day, in hours, at which the simulation is predicted to end

Definition at line 142 of file MercuryTime.h.

References getTime2Finish().

    {
        // gets the estimated time left to finish.
        Mdouble time2Finish = getTime2Finish(t);

        // adds to the estimated time to current time and also type-casting Mdouble to time_t.
        time_t finish = time(nullptr) + time2Finish;

        std::stringstream ss;

        //write estimated end time
        ss << ctime(&finish);

        //decrement put pointer by one to avoid line break
        ss.seekp((long) ss.tellp() - 1);

        //write time to finish
        ss << " (" << time2Finish / 3600 << "h)";
        return ss.str();
    }

Mdouble Time2Finish::getTime2Finish ( Mdouble  t )

inline

Estimates the total time, in seconds, left to reach the end of any simulation. After the class is initialized, an estimate of the total remaining time of the simulation can be found by calling getTime2Finish. The estimate is based on rate at which the simulation time progressed since initialization.

E.g., assume that the class has been initialized at simulation time 0, with final time 10. Then, getTime2Finish is called after 1 hour at simulation time 2. Since the code required 0.5 hours per simulation time unit and there are 8 simulation time units left, it is likely to finish in 4 hours.

Parameters

[in]

t

current simulation time.

Returns

Mdouble time, in seconds, left to reach the end of any simulation

Definition at line 118 of file MercuryTime.h.

References startTime_, time_, and timeMax_.

Referenced by getFinishTime().

    {
        clock_t finish = clock();
        Mdouble elapsedTime = (Mdouble(finish) - Mdouble(startTime_)) / CLOCKS_PER_SEC;

        if (fabs(time_ - t) < 1.e-9)
        {
            std::cout << "Choose an other value for t" << std::endl;
            return 0;
        }
        else
        {
            Mdouble time2Finish = elapsedTime * (timeMax_ - time_) / (t - time_);
            startTime_ = finish;
            time_ = t;
            return time2Finish;
        }
    }

void Time2Finish::set ( Mdouble  t, Mdouble  tMax  )

inline

Initialises the variable start with the current value of clock ticks, the current time and the final time of the simulation.

Parameters

[in]	t	current simulation time.
[in]	tMax	total simulation time for which the simulation is set to run.

Definition at line 98 of file MercuryTime.h.

References startTime_, time_, and timeMax_.

    {
        startTime_ = clock();
        time_ = t;
        timeMax_ = tMax;
    }

Member Data Documentation

clock_t Time2Finish::startTime_

private

Stores the current number of clock ticks at the start.

Definition at line 165 of file MercuryTime.h.

Referenced by getTime2Finish(), and set().

Mdouble Time2Finish::time_

private

Stores the simulation time (DPM units)

Definition at line 168 of file MercuryTime.h.

Referenced by getTime2Finish(), and set().

Mdouble Time2Finish::timeMax_

private

Stores the total simulation time (DPM units)

Definition at line 171 of file MercuryTime.h.

Referenced by getTime2Finish(), and set().

---

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

• MercuryTime.h