VariableTimeStepper Class Reference

Detailed Description

FIXME Variable ?

A variable time stepper used in dynamic linear solvers.

Definition at line 36 of file VariableTimeStepper.hpp.

#include <VariableTimeStepper.hpp>

Inheritance diagram for VariableTimeStepper:

Public Member Functions
	VariableTimeStepper ()
	Default constructor. More...
	VariableTimeStepper (CepsReal start, CepsReal end, CepsReal step)
	Constructor with times. More...
	VariableTimeStepper (const VariableTimeStepper &)=default
	Copy constructor. More...
	~VariableTimeStepper ()
	Destructor. More...
void	setTimes (CepsReal start, CepsReal end, CepsReal step) override
	Set start, end and time step. More...
void	setTimeStep (CepsReal timeStep) override
	Set time step. More...
CepsReal	getTime () override
	current simulation time More...
CepsReal	computeNextTimeStep () override
	Compute next time step (fixed time stepping only) More...
void	reset () override
	Reset current time to tStart. More...
Public Member Functions inherited from TimeStepper
	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...
void	setStartTime (CepsReal startTime)
	startTime start time of simulation More...
void	setEndTime (CepsReal endTime)
	End time of simulation. More...
CepsReal	getStartTime () const
	startTime start time of simulation More...
CepsReal	getEndTime () const
	End time of simulation. More...
CepsReal	getTimeStep () const
	Time step. 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...

Protected Attributes
CepsReal	m_middle
	Start time of last time step update. More...
Protected Attributes inherited from TimeStepper
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

VariableTimeStepper() [1/3]

VariableTimeStepper::VariableTimeStepper

(

)

Default constructor.

Definition at line 36 of file VariableTimeStepper.cpp.

VariableTimeStepper() [2/3]

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

Constructor with times.

Definition at line 41 of file VariableTimeStepper.cpp.

VariableTimeStepper() [3/3]

VariableTimeStepper::VariableTimeStepper ( const VariableTimeStepper &  )

default

Copy constructor.

~VariableTimeStepper()

VariableTimeStepper::~VariableTimeStepper

(

)

Destructor.

Definition at line 46 of file VariableTimeStepper.cpp.

Member Function Documentation

computeNextTimeStep()

CepsReal VariableTimeStepper::computeNextTimeStep ( )

overridevirtual

Compute next time step (fixed time stepping only)

Reimplemented from TimeStepper.

Definition at line 72 of file VariableTimeStepper.cpp.

getTime()

CepsReal VariableTimeStepper::getTime ( )

overridevirtual

current simulation time

Reimplemented from TimeStepper.

Definition at line 66 of file VariableTimeStepper.cpp.

reset()

void VariableTimeStepper::reset ( )

overridevirtual

Reset current time to tStart.

Reimplemented from TimeStepper.

Definition at line 79 of file VariableTimeStepper.cpp.

setTimes()

void VariableTimeStepper::setTimes ( CepsReal  start, CepsReal  end, CepsReal  step  )

overridevirtual

Set start, end and time step.

Parameters

[in]	start	simulation start time
[in]	end	simulation end time
[in]	step	time step to use

Reimplemented from TimeStepper.

Definition at line 50 of file VariableTimeStepper.cpp.

setTimeStep()

void VariableTimeStepper::setTimeStep ( CepsReal  timeStep )

overridevirtual

Set time step.

Reimplemented from TimeStepper.

Definition at line 57 of file VariableTimeStepper.cpp.

Field Documentation

m_middle

CepsReal VariableTimeStepper::m_middle

protected

Start time of last time step update.

Definition at line 81 of file VariableTimeStepper.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/common/toolbox/VariableTimeStepper.hpp
• /builds/xxjFYZX3/0/carmen/ceps/src/common/toolbox/VariableTimeStepper.cpp