TimeStepping Namespace Reference

Classes
class	EmbeddedExplicitRungeKutta
class	ExplicitRungeKutta
class	ImplicitRungeKutta
class	RungeKutta
class	TimeStepping

Enumerations
enum	runge_kutta_method {   FORWARD_EULER, RK_THIRD_ORDER, RK_CLASSIC_FOURTH_ORDER, BACKWARD_EULER,   IMPLICIT_MIDPOINT, CRANK_NICOLSON, SDIRK_TWO_STAGES, HEUN_EULER,   BOGACKI_SHAMPINE, DOPRI, FEHLBERG, CASH_KARP,   invalid }
enum	embedded_runge_kutta_time_step { DELTA_T, MIN_DELTA_T, MAX_DELTA_T }

Detailed Description

Namespace containing the time stepping methods.

Author

Bruno Turcksin

Date

2014

Enumeration Type Documentation

runge_kutta_method

enum TimeStepping::runge_kutta_method

The following Runge-Kutta methods are available:

• Explicit methods (see ExplicitRungeKutta::initialize):
  • FORWARD_EULER (first order)
  • RK_THIRD_ORDER (third order Runge-Kutta)
  • RK_CLASSIC_FOURTH_ORDER (classical fourth order Runge-Kutta)
• Implicit methods (see ImplicitRungeKutta::initialize):
  • BACKWARD_EULER (first order)
  • IMPLICIT_MIDPOINT (second order)
  • CRANK_NICOLSON (second order)
  • SDIRK_TWO_STAGES (second order)
• Embedded explicit methods (see EmbeddedExplicitRungeKutta::initialize):
  • HEUN_EULER (second order)
  • BOGACKI_SHAMPINE (third order)
  • DOPRI: Dormand-Prince (fifth order; this is the method used by ode45 in MATLAB)
  • FEHLBERG (fifth order)
  • CASH_KARP (firth order)

Enumerator
FORWARD_EULER
RK_THIRD_ORDER
RK_CLASSIC_FOURTH_ORDER
BACKWARD_EULER
IMPLICIT_MIDPOINT
CRANK_NICOLSON
SDIRK_TWO_STAGES
HEUN_EULER
BOGACKI_SHAMPINE
DOPRI
FEHLBERG
CASH_KARP
invalid

Definition at line 57 of file time_stepping.h.

embedded_runge_kutta_time_step

enum TimeStepping::embedded_runge_kutta_time_step

Reason for exiting evolve_one_time_step when using an embedded method: DELTA_T (the time step is in the valid range), MIN_DELTA_T (the time step was increased to the minimum acceptable time step), MAX_DELTA_T (the time step was reduced to the maximum acceptable time step).

Enumerator
DELTA_T
MIN_DELTA_T
MAX_DELTA_T

Definition at line 82 of file time_stepping.h.