flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper > Class Template Reference

Class for integrating a system of first order ODEs. More...

#include <basic_rk_integrator.hpp>

Collaboration diagram for flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >:

Public Member Functions
int	get_max_steps () const
	Returns the maximum number of allowed steps in the integration.
void	operator() (double start, double end, StateType &ystart, Derivs derivs, double tolerance) const
	Integrates the system over an interval.
void	set_max_steps (int s)
	Sets the maximum number of allowed steps in the integration.

Private Attributes
int	max_steps {400}
	Maximum number of steps in integration.
Stepper	stepper {}
	Stepper to provide a Runge-Kutta step.

Detailed Description

template<typename StateType, typename Derivs = std::function<StateType(double, const StateType&)>, typename Stepper = Basic_rk_stepper<StateType,Derivs>>
class flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >

Class for integrating a system of first order ODEs.

Template Parameters

StateType	type of parameters vector
Derivs	type of object returning the values of the derivatives
Stepper	type of object implementing Runge-Kutta step

Definition at line 113 of file basic_rk_integrator.hpp.

Member Function Documentation

get_max_steps()

template<typename StateType , typename Derivs = std::function<StateType(double, const StateType&)>, typename Stepper = Basic_rk_stepper<StateType,Derivs>>

int flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::get_max_steps ( ) const

inline

Returns the maximum number of allowed steps in the integration.

Returns

maximum number of steps to allow

Definition at line 125 of file basic_rk_integrator.hpp.

References flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::max_steps.

operator()()

template<typename StateType , typename Derivs , typename Stepper >

void flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::operator()	(	double	start,
		double	end,
		StateType &	ystart,
		Derivs	derivs,
		double	tolerance
	)		const

Integrates the system over an interval.

The vector of the initial values of the parameters is updated so that after calling this function, this vector contains the updated values of the parameters at the end-point of the integration.

Parameters

[in]	start	initial value of the independent variable
[in]	end	final value of the independent variable
[in,out]	ystart	initial values of the parameters
[in]	derivs	function calculating the derivatives
[in]	tolerance	desired accuracy to use in integration step

Definition at line 145 of file basic_rk_integrator.hpp.

References flexiblesusy::end(), and flexiblesusy::runge_kutta::integrateOdes().

set_max_steps()

template<typename StateType , typename Derivs = std::function<StateType(double, const StateType&)>, typename Stepper = Basic_rk_stepper<StateType,Derivs>>

void flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::set_max_steps ( int  s )

inline

Sets the maximum number of allowed steps in the integration.

Parameters

s	maximum number of steps to allow

Definition at line 121 of file basic_rk_integrator.hpp.

References flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::max_steps.

Member Data Documentation

max_steps

template<typename StateType , typename Derivs = std::function<StateType(double, const StateType&)>, typename Stepper = Basic_rk_stepper<StateType,Derivs>>

int flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::max_steps {400}

private

Maximum number of steps in integration.

Definition at line 128 of file basic_rk_integrator.hpp.

Referenced by flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::get_max_steps(), and flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::set_max_steps().

stepper

template<typename StateType , typename Derivs = std::function<StateType(double, const StateType&)>, typename Stepper = Basic_rk_stepper<StateType,Derivs>>

Stepper flexiblesusy::runge_kutta::Basic_rk_integrator< StateType, Derivs, Stepper >::stepper {}

private

Stepper to provide a Runge-Kutta step.

Definition at line 129 of file basic_rk_integrator.hpp.

---

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

• basic_rk_integrator.hpp