Ode.h

Go to the documentation of this file.

/*****************************************************************************
 $RCSfile: Ode.h,v $ --- $Date: 2006/07/18 01:45:34 $ --- $Revision: 1.2 $
 *****************************************************************************
 PREPROCESSOR DIRECTIVES
 *****************************************************************************/

 #ifndef CALC_ODE_H
 #define CALC_ODE_H

/*****************************************************************************
 INCLUDE FILES
 *****************************************************************************/

 #include "Base.h"

/*****************************************************************************
 NAMESPACE IDENTIFICATIONS
 *****************************************************************************/

 namespace calc {

/*****************************************************************************
 OdeErr CLASS
 *****************************************************************************/


 class OdeErr:public Err {

 public:

 // Enumerations

    enum ERR_ENUM {
       INIT=0,    
       MEMORY,    
       LOOP,      
       STEP,      
       ERR_CNT    
    };

 // Constructors

    OdeErr(enum OdeErr::ERR_ENUM indErr):
    Err() {
       const char* const CLASS_NAME="Ode";
       const char* const ERR_STR[ERR_CNT]={
          "object initialization error",                 // text for index INIT
          "memory allocation error",                     // text for index MEMORY
          "maximum loop count exceeded",                 // text for index LOOP
          "complete underflow of integration step size", // text for index STEP
       };
       setError(indErr,CLASS_NAME,ERR_STR[indErr]);
    }
 };

/*****************************************************************************
 Ode CLASS TEMPLATE
 *****************************************************************************/


 template <typename xType, typename yType>
 class Ode:public Base {

 public:

 // Member Enumerations

    enum VTYPE {
       CURRENT=0   ,   
       MAXIMUM     ,   
       VARIABLE    ,   
       VTYPE_CNT   ,   
    };


 // Constructors

    Ode(void (&pFn)(yType*,yType*,xType), xType dEps, int nVar);
    Ode(const Ode &od);
   ~Ode(void);

 // Member Functions

    yType  *eval       (yType *y, xType x1, xType x2, xType dx) throw (OdeErr);
    bool    setEpsilon (xType dEps);
    bool    setCount   (int nMaximum);

    void getDerivative(yType *dy, yType *y, xType x) const {(*pFn)(dy,y,x);}
    xType getError(void) const {return yEps;}
    int getCount(enum Ode<xType,yType>::VTYPE vType) const
       {return ((!nogo)&&(vType>=0)&&(vType<VTYPE_CNT)?nCount[vType]:-1);}

    static const int DEF_LOOP_MAX=10000;
    static const int STEP_CNT=6;

 private:

 // Member Functions

    virtual void varInit   (void);

    bool    varAlloc  (int nVar);
    bool    checkIt   (void);
    void    advanceIt (void);

 // Data Members

    void    (*pFn)(yType*,yType*,xType);
    xType   yEps;     
    xType   xCur;     
    xType   dxCur;    
    xType   dxOld;    
    xType   dxNew;    
    xType  *yScl;     
    yType  *yMid;     
    yType  *yCur;     
    yType  *yErr;     
    yType  *yEst;     
    yType  *dyInc[STEP_CNT]; 
    int    nCount[VTYPE_CNT];  
    static const xType  SCALE_MIN;
    static const xType  ADJUST_LO;
    static const xType  ADJUST_HI;
    static const xType  SCALE_LO;
    static const xType  SCALE_HI;

    static const double ADJUST_MIN;
    static const double ADJUST_MAX;
    static const double PADDING;
 };}

/*****************************************************************************/

 template <typename xType, typename yType>
 const xType calc::Ode<xType,yType>::SCALE_MIN=1.0e-20;
 template <typename xType, typename yType>
 const xType calc::Ode<xType,yType>::ADJUST_LO=7000.0;
 template <typename xType, typename yType>
 const xType calc::Ode<xType,yType>::ADJUST_HI=1.0e-04;
 template <typename xType, typename yType>
 const xType calc::Ode<xType,yType>::SCALE_LO=(-0.25);
 template <typename xType, typename yType>
 const xType calc::Ode<xType,yType>::SCALE_HI=(-0.20);

 template <typename xType, typename yType>
 const double calc::Ode<xType,yType>::ADJUST_MIN=0.1;
 template <typename xType, typename yType>
 const double calc::Ode<xType,yType>::ADJUST_MAX=5.0;
 template <typename xType, typename yType>
 const double calc::Ode<xType,yType>::PADDING=0.9;

/*
 * Ref:     Press, William H., et al, NUMERICAL RECIPES IN C,
 *          2nd Edition, Cambridge University Press, Cambridge,
 *          England, 1992.
 */

/*****************************************************************************
 PREPROCESSOR DIRECTIVES
 *****************************************************************************/

 #endif

/*****************************************************************************
 CLASS TEMPLATE SOURCE
 *****************************************************************************/

 #include "Ode.cpp"

/*****************************************************************************/

---