WarpTwin
Documentation for WarpTwin models and classes.
Loading...
Searching...
No Matches
warpos::Integrator< N > Class Template Reference

#include <Integrator.hpp>

Inheritance diagram for warpos::Integrator< N >:

Public Member Functions

 Integrator (Rates< N > &rate_calculator)
 Constructor for the integrator.
virtual int16 step (floating_point start_time, floating_point end_time, const std::array< floating_point, N > &start_state, std::array< floating_point, N > &out_state)

Protected Attributes

Rates< N > & _rate_calculator
 Reference to dynamics object that calculates rates.

Detailed Description

template<uint32 N>
class warpos::Integrator< N >

This class is a base implementation of the integrator. It defines the basic functions and components of an integrator.

It cannot function on its own. A derived class for RK4, forward Euler, etc. must be implemented to use the integrator.

Constructor & Destructor Documentation

◆ Integrator()

template<uint32 N>
warpos::Integrator< N >::Integrator ( Rates< N > & rate_calculator)

Constructor for the integrator.

Member Function Documentation

◆ step()

template<uint32 N>
virtual int16 warpos::Integrator< N >::step ( floating_point start_time,
floating_point end_time,
const std::array< floating_point, N > & start_state,
std::array< floating_point, N > & out_state )
inlinevirtual

Function to step the integrator forward from time start to time end

Parameters
start_timeStart time for integration
end_timeEnd time for integration
start_stateState at start of integration
out_stateOutput state via implicit – result of integration
Returns
Error code denoting success/fail
Note
Un-implemented in this base class definition

Reimplemented in warpos::ForwardEulerIntegrator< N >, warpos::ForwardEulerIntegrator< INERTIAL_NAVIGATION_STATE_VECTOR_ELEMENTS+INERTIAL_NAVIGATION_STATE_VECTOR_ELEMENTS *INERTIAL_NAVIGATION_STATE_VECTOR_ELEMENTS >, warpos::ForwardEulerIntegrator< NUM_INTEGRATED_STATES >, warpos::RK4Integrator< N >, and warpos::RK4Integrator< NUM_INTEGRATED_STATES >.

Member Data Documentation

◆ _rate_calculator

template<uint32 N>
Rates<N>& warpos::Integrator< N >::_rate_calculator
protected

Reference to dynamics object that calculates rates.


The documentation for this class was generated from the following file:
  • /Users/mickey/Documents/Projects/warptwin/warpos/src/gncutils/integrator/Integrator.hpp