TAPsODESolver.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsODESolver.hpp
******************************************************************************/
/******************************************************************************
SUKITTI PUNAK   (07/10/2005)
UPDATE          (08/18/2010)
******************************************************************************/
#ifndef TAPs_ODE_SOLVER_HPP
#define TAPs_ODE_SOLVER_HPP

#include "TAPsVectorSet.hpp"

BEGIN_NAMESPACE_TAPs__Simulation
//=============================================================================
//-----------------------------------------------------------------------------
template <typename T, typename T_SET = T>
class ODESolver
{
//-------------------------------------------------------------------
protected:

    // For Array of type VectorSet
    //---------------------------------------------------------------
    // Derivative Function
    //   compute and return d/dt(X(t)) in the array xdot
    typedef bool (*DerivFunc) ( 
        T t,                    // i/p: time step
        VectorSet<T_SET> &x,    // i/p: array  x,   e.g. x    = {position, velocity}
        VectorSet<T_SET> &xdot, // o/p: array xdot, e.g. xdot = {velocity, acceleration}
        void *userData          // o/p: array of user data
    );

    //typedef bool (*DerivFunc_ForPtrData) ( 
    //  T t,                            // i/p: time step
    //  VectorSetPtr<T_SET,T> &x,       // i/p: array  x,   e.g. x    = {position, velocity}
    //  VectorSetPtr<T_SET,T> &xdot,    // o/p: array xdot, e.g. xdot = {velocity, acceleration}
    //  void *userData                  // o/p: array of user data
    //);

//-------------------------------------------------------------------
public:
    
    ODESolver () {}

    virtual ~ODESolver () {}

    // Abstract Member Fns
    virtual void SetSize ( int vectorSize ) = 0;    // set data size

    virtual void Solve ( 
        VectorSet<T_SET> &x0,   // i/p: x(t_0) an initial state vector
        VectorSet<T_SET> &xEnd, // o/p: x(t_1) an end state vector
        T t0, T t1,             // i/p: starting and ending times
        DerivFunc dxdt,         // i/p: a derivative function
        void *userData          // o/p: array of user data
    ) = 0;

    //virtual void Solve_ForPtrData ( 
    //  VectorSetPtr<T_SET,T> &x0,      // i/p: x(t_0) an initial state vector
    //  VectorSetPtr<T_SET,T> &xEnd,    // o/p: x(t_1) an end state vector
    //  T t0, T t1,                     // i/p: starting and ending times
    //  DerivFunc_ForPtrData dxdt,      // i/p: a derivative function
    //  void *userData                  // o/p: array of user data
    //) = 0;
};
//-----------------------------------------------------------------------------
//=============================================================================
END_NAMESPACE_TAPs__Simulation
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
//#if !defined( TAPs_USE_EXPORT )
    #include "TAPsODESolver.cpp"
//#endif
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----