Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples
dep / spacecraft / src / utils

dep/spacecraft/src/utils/RungeKutta.h File Reference

#include <Matrix.h>

Include dependency graph for dep/spacecraft/src/utils/RungeKutta.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Typedefs

typedef Vector(* ptr2RKFunc )(const double &_time, const Vector &_states, const Matrix &_params)

Functions

Matrix RungeKuttaSolve (Vector(*odeFunc)(const double &timeInput, const Vector &stateInput, const Matrix &constantsInput), const Vector &_initialConditions, const Matrix &_constants, const double &_timeInitial, const double &_timeFinal, const int &_numSteps)
 Integrate an equation of the form $\dot{y} = f\left(t,x\right)$ using the Runge-Kutta integration method.

Typedef Documentation

typedef Vector(* ptr2RKFunc)(const double &_time, const Vector &_states, const Matrix &_params)
 

defines a pointer to a Runge-Kutta right-hand side (RHS) function

Definition at line 18 of file dep/spacecraft/src/utils/RungeKutta.h.

Function Documentation

Matrix RungeKuttaSolve (  Vector(*)(const double &timeInput, const Vector &stateInput, const Matrix &constantsInput)  odeFunc,
const Vector &  _initialConditions,
const Matrix &  _constants,
const double &  _timeInitial,
const double &  _timeFinal,
const int &  _numSteps
)  [inline]
 

Integrate an equation of the form $\dot{y} = f\left(t,x\right)$ using the Runge-Kutta integration method.

The Runge-Kutta integrator uses a right-hand side equation, $f\left(t,x\right)$ to compute the integration of the function over the specified time interval, given initial conditions, constants of integration, and number of steps desired (since this is a fixed step integrator).

Parameters:
odeFunc Pointer to the right-hand side (RHS) equation
timeInput time of current step to RHS file function
stateInput vector of state inputs at current step to RHS file function
constantsInput vector of constants that are not integrated and passed to the RHS function
_initialConditions vector of initial conditions of the state
_constants matrix of constants that should be passed to the RHS function
_timeInitial initial time of integration
_timeFinal final time of integration
_numSteps number of steps to integrate over (therefore timeStep = _timeFinal - _timeInitial / _numSteps)
Returns:
matrix of integrated state outputs from the initial to final times. Format: /f[ {bmatrix} t_0 & x_{1,0} & x_{2,0} & ...\ t_1 & x_{1,1} & x_{2,1} & ...\ t_2 & x_{1,2} & x_{2,2} & ...\ . & . & . & . \ t_final & x_{1,f} & x_{2,f} & ... {bmatrix} /f] where /f$t_T/f$ is the time at step T, and /f$x_{i,T}/f$ is the state value of element i, at time step T.

Definition at line 44 of file dep/spacecraft/src/utils/RungeKutta.h.

References _, and O_SESSAME::odeFunc.

Generated on Wed Sep 5 12:54:34 2007 for DSACSS Operational Code by  doxygen 1.3.9.1