CEPS  24.01
Cardiac ElectroPhysiology Simulator
VariableTimeStepper.hpp
Go to the documentation of this file.
1 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2  This file is part of CEPS.
3 
4  CEPS is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  CEPS is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with CEPS (see file LICENSE at root of project).
16  If not, see <https://www.gnu.org/licenses/>.
17 
18 
19  Copyright 2019-2024 Inria, Universite de Bordeaux
20 
21  Authors, in alphabetical order:
22 
23  Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC,
24  Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*),
25  Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
26  * : currently active authors
27 
28 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
31 #pragma once
32 
34 
37 {
38 
39  public:
40 
43 
46 
49 
52 
59  void
60  setTimes(CepsReal start, CepsReal end, CepsReal step) override;
61 
63  void
64  setTimeStep(CepsReal timeStep) override;
65 
67  CepsReal
68  getTime() override;
69 
71  CepsReal
72  computeNextTimeStep() override;
73 
75  void
76  reset() override;
77 
78 
79  protected:
80 
82 
83 };
float CepsReal
Need single precision floating point.
Definition: CepsTypes.hpp:100
A simple time stepper used in dynamic linear solvers.
Definition: TimeStepper.hpp:40
void reset() override
Reset current time to tStart.
void setTimes(CepsReal start, CepsReal end, CepsReal step) override
Set start, end and time step.
CepsReal computeNextTimeStep() override
Compute next time step (fixed time stepping only)
void setTimeStep(CepsReal timeStep) override
Set time step.
CepsReal m_middle
Start time of last time step update.
CepsReal getTime() override
current simulation time
~VariableTimeStepper()
Destructor.
VariableTimeStepper(const VariableTimeStepper &)=default
Copy constructor.
VariableTimeStepper()
Default constructor.