Replace unclear constant with better documentation

The step number is zero before the first timestep has been taken, and
one after. The step number is one before the second timestep has been
taken, and two after. This was not clear from the text.
This commit is contained in:
Roland Kaufmann 2013-11-27 00:23:00 +01:00
parent 2ba7b3329d
commit 73dfe849d6
2 changed files with 5 additions and 5 deletions

View File

@ -30,7 +30,7 @@ namespace Opm
/// Default constructor.
SimulatorTimer::SimulatorTimer()
: current_step_(FIRST_STEP),
: current_step_(0),
current_time_(0.0),
start_date_(2012,1,1) // A really arbitrary default starting value?!
{

View File

@ -50,10 +50,10 @@ namespace Opm
/// Total number of steps.
int numSteps() const;
/// First timestep returned from currentStepNum
static const int FIRST_STEP = 0;
/// Current step number.
/// Current step number. This is the number of timesteps that
/// has been completed from the start of the run. The time
/// after initialization but before the simulation has started
/// is timestep number zero.
int currentStepNum() const;
/// Set current step number.