CEPS  24.01
Cardiac ElectroPhysiology Simulator
TimeStepper Class Reference

Detailed Description

A simple time stepper used in dynamic linear solvers.

More complex time steppers (e.g., adaptative time steppers) can use this class through inheritance and reimplement the methods needed.

Definition at line 39 of file TimeStepper.hpp.

#include <TimeStepper.hpp>

Inheritance diagram for TimeStepper:
[legend]

Public Member Functions

 TimeStepper ()
 Default constructor. More...
 
 TimeStepper (CepsReal start, CepsReal end, CepsReal step)
 Constructor with times. More...
 
 TimeStepper (const TimeStepper &)=default
 Copy constructor. More...
 
virtual ~TimeStepper ()
 Destructor. More...
 
virtual void setTimes (CepsReal start, CepsReal end, CepsReal step)
 Set start, end and time step. More...
 
void setStartTime (CepsReal startTime)
 startTime start time of simulation More...
 
void setEndTime (CepsReal endTime)
 End time of simulation. More...
 
virtual void setTimeStep (CepsReal timeStep)
 Set time step. More...
 
CepsReal getStartTime () const
 startTime start time of simulation More...
 
CepsReal getEndTime () const
 End time of simulation. More...
 
CepsReal getTimeStep () const
 Time step. More...
 
virtual CepsReal getTime ()
 current simulation time More...
 
virtual CepsReal computeNextTimeStep ()
 Compute next time step (fixed time stepping only) More...
 
void takeOneStep ()
 Updates the number of steps taken (derived steppers may compute new time and time step here) More...
 
CepsBool atEnd ()
 Whether time stepper has reached the end time or not. More...
 
CepsBool isProperlySet () const
 Check that everything is fine with this time stepper. More...
 
CepsUInt getNbTakenTimeSteps () const
 Number of time steps performed until now. More...
 
virtual void reset ()
 Reset current time to tStart. More...
 

Protected Attributes

CepsReal m_start
 Start time of simulation. More...
 
CepsReal m_end
 End time of simulation. More...
 
CepsReal m_step
 Time step, i.e dt. More...
 
CepsUInt m_stepsTaken
 Number of time steps taken. More...
 

Constructor & Destructor Documentation

◆ TimeStepper() [1/3]

TimeStepper::TimeStepper ( )

Default constructor.

Definition at line 34 of file TimeStepper.cpp.

◆ TimeStepper() [2/3]

TimeStepper::TimeStepper ( CepsReal  start,
CepsReal  end,
CepsReal  step 
)

Constructor with times.

Definition at line 41 of file TimeStepper.cpp.

◆ TimeStepper() [3/3]

TimeStepper::TimeStepper ( const TimeStepper )
default

Copy constructor.

◆ ~TimeStepper()

TimeStepper::~TimeStepper ( )
virtual

Destructor.

Definition at line 49 of file TimeStepper.cpp.

Member Function Documentation

◆ atEnd()

CepsBool TimeStepper::atEnd ( )

Whether time stepper has reached the end time or not.

Definition at line 122 of file TimeStepper.cpp.

◆ computeNextTimeStep()

CepsReal TimeStepper::computeNextTimeStep ( )
virtual

Compute next time step (fixed time stepping only)

Reimplemented in VariableTimeStepper.

Definition at line 107 of file TimeStepper.cpp.

◆ getEndTime()

CepsReal TimeStepper::getEndTime ( ) const

End time of simulation.

Definition at line 89 of file TimeStepper.cpp.

◆ getNbTakenTimeSteps()

CepsUInt TimeStepper::getNbTakenTimeSteps ( ) const

Number of time steps performed until now.

Definition at line 134 of file TimeStepper.cpp.

◆ getStartTime()

CepsReal TimeStepper::getStartTime ( ) const

startTime start time of simulation

Definition at line 83 of file TimeStepper.cpp.

◆ getTime()

CepsReal TimeStepper::getTime ( )
virtual

current simulation time

Reimplemented in VariableTimeStepper.

Definition at line 101 of file TimeStepper.cpp.

◆ getTimeStep()

CepsReal TimeStepper::getTimeStep ( ) const

Time step.

Definition at line 95 of file TimeStepper.cpp.

◆ isProperlySet()

CepsBool TimeStepper::isProperlySet ( ) const

Check that everything is fine with this time stepper.

Definition at line 128 of file TimeStepper.cpp.

◆ reset()

void TimeStepper::reset ( )
virtual

Reset current time to tStart.

Reimplemented in VariableTimeStepper.

Definition at line 140 of file TimeStepper.cpp.

◆ setEndTime()

void TimeStepper::setEndTime ( CepsReal  endTime)

End time of simulation.

Definition at line 69 of file TimeStepper.cpp.

◆ setStartTime()

void TimeStepper::setStartTime ( CepsReal  startTime)

startTime start time of simulation

Definition at line 62 of file TimeStepper.cpp.

◆ setTimes()

void TimeStepper::setTimes ( CepsReal  start,
CepsReal  end,
CepsReal  step 
)
virtual

Set start, end and time step.

Parameters
[in]startsimulation start time
[in]endsimulation end time
[in]steptime step to use

Reimplemented in VariableTimeStepper.

Definition at line 53 of file TimeStepper.cpp.

◆ setTimeStep()

void TimeStepper::setTimeStep ( CepsReal  timeStep)
virtual

Set time step.

Reimplemented in VariableTimeStepper.

Definition at line 76 of file TimeStepper.cpp.

◆ takeOneStep()

void TimeStepper::takeOneStep ( )

Updates the number of steps taken (derived steppers may compute new time and time step here)

Definition at line 115 of file TimeStepper.cpp.

Field Documentation

◆ m_end

CepsReal TimeStepper::m_end
protected

End time of simulation.

Definition at line 118 of file TimeStepper.hpp.

◆ m_start

CepsReal TimeStepper::m_start
protected

Start time of simulation.

Definition at line 117 of file TimeStepper.hpp.

◆ m_step

CepsReal TimeStepper::m_step
protected

Time step, i.e dt.

Definition at line 119 of file TimeStepper.hpp.

◆ m_stepsTaken

CepsUInt TimeStepper::m_stepsTaken
protected

Number of time steps taken.

Definition at line 120 of file TimeStepper.hpp.


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