RK45 (Runge-Kutta-Fehlberg 4(5)) adaptive integrator. More...

#include <rk45.hpp>

Inheritance diagram for diffeq::RK45Integrator< S >:

[legend]

Collaboration diagram for diffeq::RK45Integrator< S >:

[legend]

Public Types
using	base_type = core::AdaptiveIntegrator< S >

using	state_type = typename base_type::state_type

using	time_type = typename base_type::time_type

using	value_type = typename base_type::value_type

using	system_function = typename base_type::system_function

Public Types inherited from diffeq::core::AdaptiveIntegrator< S >
using	base_type = AbstractIntegrator< S >

using	state_type = typename base_type::state_type

using	time_type = typename base_type::time_type

using	value_type = typename base_type::value_type

using	system_function = typename base_type::system_function

Public Types inherited from diffeq::core::AbstractIntegrator< S >
using	state_type = S

using	time_type = typename S::value_type

using	value_type = typename S::value_type

using	system_function = std::function< void(time_type, const state_type &, state_type &)>

Public Member Functions
	RK45Integrator (system_function sys, time_type rtol=static_cast< time_type >(1e-6), time_type atol=static_cast< time_type >(1e-9))

void	step (state_type &state, time_type dt) override

time_type	adaptive_step (state_type &state, time_type dt) override

Public Member Functions inherited from diffeq::core::AdaptiveIntegrator< S >
	AdaptiveIntegrator (system_function sys, time_type rtol=static_cast< time_type >(1e-6), time_type atol=static_cast< time_type >(1e-9))

void	integrate (state_type &state, time_type dt, time_type end_time) override

virtual time_type	adaptive_step (state_type &state, time_type dt)=0

void	set_tolerances (time_type rtol, time_type atol)

void	set_step_limits (time_type dt_min, time_type dt_max)

Public Member Functions inherited from diffeq::core::AbstractIntegrator< S >
	AbstractIntegrator (system_function sys)

virtual void	step (state_type &state, time_type dt)=0

time_type	current_time () const

void	set_time (time_type t)

void	set_system (system_function sys)

Additional Inherited Members
Protected Member Functions inherited from diffeq::core::AdaptiveIntegrator< S >
time_type	calculate_tolerance (value_type y_val) const

time_type	error_norm (const state_type &error, const state_type &y) const

time_type	error_norm_scipy_style (const state_type &error, const state_type &y_old, const state_type &y_new) const

time_type	suggest_step_size (time_type current_dt, time_type error_norm, int order) const

Protected Member Functions inherited from diffeq::core::AbstractIntegrator< S >
void	advance_time (time_type dt)

Protected Attributes inherited from diffeq::core::AdaptiveIntegrator< S >
time_type	rtol_

time_type	atol_

time_type	dt_min_

time_type	dt_max_

time_type	safety_factor_

Protected Attributes inherited from diffeq::core::AbstractIntegrator< S >
system_function	sys_

time_type	current_time_

Detailed Description

template<system_state S>
class diffeq::RK45Integrator< S >

RK45 (Runge-Kutta-Fehlberg 4(5)) adaptive integrator.

Fifth-order method with embedded 4th order error estimation. Popular adaptive ODE solver used in many scientific libraries.

Order: 5 (with 4th order error estimation) Stability: Good for non-stiff problems Usage: General-purpose adaptive ODE integration

Definition at line 20 of file rk45.hpp.

Member Typedef Documentation

◆ base_type

template<system_state S>

using diffeq::RK45Integrator< S >::base_type = core::AdaptiveIntegrator<S>

Definition at line 22 of file rk45.hpp.

◆ state_type

template<system_state S>

using diffeq::RK45Integrator< S >::state_type = typename base_type::state_type

Definition at line 23 of file rk45.hpp.

◆ system_function

template<system_state S>

using diffeq::RK45Integrator< S >::system_function = typename base_type::system_function

Definition at line 26 of file rk45.hpp.

◆ time_type

template<system_state S>

using diffeq::RK45Integrator< S >::time_type = typename base_type::time_type

Definition at line 24 of file rk45.hpp.

◆ value_type

template<system_state S>

using diffeq::RK45Integrator< S >::value_type = typename base_type::value_type

Definition at line 25 of file rk45.hpp.

Constructor & Destructor Documentation

◆ RK45Integrator()

template<system_state S>

diffeq::RK45Integrator< S >::RK45Integrator	(	system_function	sys,
		time_type	rtol = `static_cast<time_type>(1e-6)`,
		time_type	atol = `static_cast<time_type>(1e-9)`
	)

inlineexplicit

Definition at line 28 of file rk45.hpp.

Member Function Documentation

◆ adaptive_step()

template<system_state S>

time_type diffeq::RK45Integrator< S >::adaptive_step	(	state_type &	state,
		time_type	dt
	)

inlineoverride

Definition at line 37 of file rk45.hpp.

◆ step()

template<system_state S>

void diffeq::RK45Integrator< S >::step	(	state_type &	state,
		time_type	dt
	)

inlineoverride

Definition at line 33 of file rk45.hpp.

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

include/integrators/ode/rk45.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

◆ state_type

◆ system_function

◆ time_type

◆ value_type

Constructor & Destructor Documentation

◆ RK45Integrator()

Member Function Documentation

◆ adaptive_step()

◆ step()