TimeStepper.cpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#include "common/toolbox/TimeStepper.hpp"
#include "common/core/Precision.hpp"
#include "common/core/CepsIoMacros.hpp"
 
TimeStepper::TimeStepper() :
    m_start(0.),
    m_end(0.),
    m_step(0.),
    m_stepsTaken(0U)
{}
 
TimeStepper::TimeStepper(CepsReal start, CepsReal end, CepsReal step):
    m_start(start),
    m_end(end),
    m_step(step),
    m_stepsTaken(0U)
{
}
 
TimeStepper::~TimeStepper()
{}
 
void
TimeStepper::setTimes(CepsReal start, CepsReal end, CepsReal step)
{
  setStartTime(start);
  setEndTime(end);
  setTimeStep(step);
  return;
}
 
void
TimeStepper::setStartTime(CepsReal startTime)
{
  m_start = startTime;
  return;
}
 
void
TimeStepper::setEndTime(CepsReal endTime)
{
  m_end = endTime;
  return;
}
 
void
TimeStepper::setTimeStep(CepsReal timeStep)
{
  m_step = timeStep;
  return;
}
 
CepsReal
TimeStepper::getStartTime() const
{
  return m_start;
}
 
CepsReal
TimeStepper::getEndTime() const
{
  return m_end;
}
 
CepsReal
TimeStepper::getTimeStep() const
{
  return m_step;
}
 
CepsReal
TimeStepper::getTime()
{
  return m_start + (m_stepsTaken * m_step);
}
 
CepsReal
TimeStepper::computeNextTimeStep()
{
  // Computed this way to avoid accumulating precision error
  CepsReal nextTimeStep = m_start + ((m_stepsTaken + 1) * m_step);
  return nextTimeStep;
}
 
void
TimeStepper::takeOneStep()
{
  m_stepsTaken++;
  return;
}
 
CepsBool
TimeStepper::atEnd()
{
  return m_end <= getTime();
}
 
CepsBool
TimeStepper::isProperlySet() const
{
  return (ceps::lesserThan(m_start, m_end) && (m_step > 0.0));
}
 
CepsUInt
TimeStepper::getNbTakenTimeSteps() const
{
  return m_stepsTaken;
}
 
void
TimeStepper::reset()
{
  m_stepsTaken = 0U;
  return;
}