...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Home | Libraries | People | FAQ | More |
boost::numeric::odeint::modified_midpoint
// In header: <boost/numeric/odeint/stepper/modified_midpoint.hpp> template<typename State, typename Value = double, typename Deriv = State, typename Time = Value, typename Algebra = range_algebra, typename Operations = default_operations, typename Resizer = initially_resizer> class modified_midpoint : public boost::numeric::odeint::explicit_stepper_base< Stepper, Order, State, Value, Deriv, Time, Algebra, Operations, Resizer > { public: // types typedef explicit_stepper_base< modified_midpoint< State, Value, Deriv, Time, Algebra, Operations, Resizer >, 2, State, Value, Deriv, Time, Algebra, Operations, Resizer > stepper_base_type; typedef stepper_base_type::state_type state_type; typedef stepper_base_type::wrapped_state_type wrapped_state_type; typedef stepper_base_type::value_type value_type; typedef stepper_base_type::deriv_type deriv_type; typedef stepper_base_type::wrapped_deriv_type wrapped_deriv_type; typedef stepper_base_type::time_type time_type; typedef stepper_base_type::algebra_type algebra_type; typedef stepper_base_type::operations_type operations_type; typedef stepper_base_type::resizer_type resizer_type; typedef stepper_base_type::stepper_type stepper_type; // construct/copy/destruct modified_midpoint(unsigned short = 2, const algebra_type & = algebra_type()); // public member functions template<typename System, typename StateIn, typename DerivIn, typename StateOut> void do_step_impl(System, const StateIn &, const DerivIn &, time_type, StateOut &, time_type); void set_steps(unsigned short); unsigned short steps(void) const; template<typename StateIn> void adjust_size(const StateIn &); order_type order(void) const; template<typename System, typename StateInOut> void do_step(System, StateInOut &, time_type, time_type); template<typename System, typename StateInOut> void do_step(System, const StateInOut &, time_type, time_type); template<typename System, typename StateInOut, typename DerivIn> boost::disable_if< boost::is_same< DerivIn, time_type >, void >::type do_step(System, StateInOut &, const DerivIn &, time_type, time_type); template<typename System, typename StateIn, typename StateOut> void do_step(System, const StateIn &, time_type, StateOut &, time_type); template<typename System, typename StateIn, typename DerivIn, typename StateOut> void do_step(System, const StateIn &, const DerivIn &, time_type, StateOut &, time_type); algebra_type & algebra(); const algebra_type & algebra() const; // private member functions template<typename StateIn> bool resize_impl(const StateIn &); };
Implementation of the modified midpoint method with a configurable number of intermediate steps. This class is used by the Bulirsch-Stoer algorithm and is not meant for direct usage.
modified_midpoint
public member functionstemplate<typename System, typename StateIn, typename DerivIn, typename StateOut> void do_step_impl(System system, const StateIn & in, const DerivIn & dxdt, time_type t, StateOut & out, time_type dt);
void set_steps(unsigned short steps);
unsigned short steps(void) const;
template<typename StateIn> void adjust_size(const StateIn & x);
order_type order(void) const;
Returns: |
Returns the order of the stepper. |
template<typename System, typename StateInOut> void do_step(System system, StateInOut & x, time_type t, time_type dt);This method performs one step. It transforms the result in-place.
Parameters: |
|
template<typename System, typename StateInOut> void do_step(System system, const StateInOut & x, time_type t, time_type dt);Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut.
template<typename System, typename StateInOut, typename DerivIn> boost::disable_if< boost::is_same< DerivIn, time_type >, void >::type do_step(System system, StateInOut & x, const DerivIn & dxdt, time_type t, time_type dt);The method performs one step. Additionally to the other method the derivative of x is also passed to this method. It is supposed to be used in the following way:
sys( x , dxdt , t ); stepper.do_step( sys , x , dxdt , t , dt );
The result is updated in place in x. This method is disabled if Time and Deriv are of the same type. In this case the method could not be distinguished from other do_step
versions.
Note | |
---|---|
This method does not solve the forwarding problem. |
Parameters: |
|
template<typename System, typename StateIn, typename StateOut> void do_step(System system, const StateIn & in, time_type t, StateOut & out, time_type dt);The method performs one step. The state of the ODE is updated out-of-place.
Note | |
---|---|
This method does not solve the forwarding problem. |
Parameters: |
|
template<typename System, typename StateIn, typename DerivIn, typename StateOut> void do_step(System system, const StateIn & in, const DerivIn & dxdt, time_type t, StateOut & out, time_type dt);The method performs one step. The state of the ODE is updated out-of-place. Furthermore, the derivative of x at t is passed to the stepper. It is supposed to be used in the following way:
sys( in , dxdt , t ); stepper.do_step( sys , in , dxdt , t , out , dt );
Note | |
---|---|
This method does not solve the forwarding problem. |
Parameters: |
|
algebra_type & algebra();
Returns: |
A reference to the algebra which is held by this class. |
const algebra_type & algebra() const;
Returns: |
A const reference to the algebra which is held by this class. |