VariableTimeStepper.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/VariableTimeStepper.hpp"
 
#include "common/core/CepsIoMacros.hpp"
#include "common/core/Precision.hpp"
 
VariableTimeStepper::VariableTimeStepper() :
    TimeStepper(),
    m_middle(m_start)
{}
 
VariableTimeStepper::VariableTimeStepper(CepsReal start, CepsReal end, CepsReal step) :
    TimeStepper(start, end, step),
    m_middle(m_start)
{}
 
VariableTimeStepper::~VariableTimeStepper()
{}
 
void
VariableTimeStepper::setTimes(CepsReal start, CepsReal end, CepsReal step)
{
  TimeStepper::setTimes(start, end, step);
  m_middle = start;
}
 
void
VariableTimeStepper::setTimeStep(CepsReal timeStep)
{
  m_middle = getTime();
  m_stepsTaken = 0;
  m_step = timeStep;
  return;
}
 
CepsReal
VariableTimeStepper::getTime()
{
  return m_middle + (m_stepsTaken * m_step);
}
 
CepsReal
VariableTimeStepper::computeNextTimeStep()
{
  // Computed this way to avoid accumulating precision error
  return m_middle + ((m_stepsTaken + 1) * m_step);
}
 
void
VariableTimeStepper::reset()
{
  TimeStepper::reset();
  m_middle = TimeStepper::getTime();
  return;
}