---

rdIntegRKF.h

// rdIntegRKF.h
//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Copyright 2000-2003 Realistic Dynamics, Inc.
// All rights reserved.
//
// Please do not read, copy, distribute, or use without permission.
// Contact: Frank C. Anderson, fca@RealisticDynamics.com
//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#ifndef __rdIntegRKF_h__
#define __rdIntegRKF_h__

// INCLUDES
#include "rdIntegrator.h"
#include <rdTools.h>
#include <rdArray.h>
#include <rdStorage.h>
#include <rdMath.h>
#include "rdModel.h"
#include "rdControlSet.h"
#include "rdController.h"
#include "rdRKF.h"


// DLL SPECIFICATIONS FOR TEMPLATES
template class RDSIMULATION_API rdArray<double>;


//=============================================================================
//=============================================================================
class RDSIMULATION_API rdIntegRKF
   : public rdRKF
{

//=============================================================================
// DATA
//=============================================================================
private:
   rdController *_controller;
   int _status;
   int _steps;
   int _trys;
   int _maxSteps;
   bool _halt;
   double _dtMin;
   double _dtMax;
   double *_x;
   double *_xPrev;
   double *_yPrev;
   double *_yp;
   bool _specifiedDT;
   bool _constantDT;
   double _dt;
   rdArray<double> _tArray;
   rdArray<double> _dtArray;
   rdStorage *_controlStorage;
   rdStorage *_stateStorage;
   rdStorage *_pseudoStorage;

//=============================================================================
// METHODS
//=============================================================================
public:
   rdIntegRKF(rdModel *aModel=NULL,
      double aTol=1.0e-4,double aTolFine=-1.0);
   virtual ~rdIntegRKF();
private:
   void setNull();

public:
   //--------------------------------------------------------------------------
   // GET AND SET
   //--------------------------------------------------------------------------
   // MIN DT
   void setMinDT(double aMin);
   double getMinDT();
   // MIN DT
   void setMaxDT(double aMax);
   double getMaxDT();
   // MAX STEPS
   void setMaximumNumberOfSteps(int aMaxSteps);
   int getMaximumNumberOfSteps();
   // STATUS
   int getStatus();
   // SEPECIFIED TIME STEP
   void setUseSpecifiedDT(bool aTrueFalse);
   bool getUseSpecifiedDT() const;
   // CONSTANT TIME STEP
   void setUseConstantDT(bool aTrueFalse);
   bool getUseConstantDT() const;
   // DT
   void setDT(double aDT);
   double getDT() const;
   // DT VECTOR
   const rdArray<double>& getDTArray();
   void setDTArray(int aN,const double aDT[],double aTI=0.0);
   double getDTArrayDT(int aStep);
   void printDTArray(const char *aFileName=NULL);
   // TIME VECTOR
   const rdArray<double>& getTimeArray();
   double getTimeArrayTime(int aStep);
   int getTimeArrayStep(double aTime);
   void printTimeArray(const char *aFileName=NULL);
   void resetTimeAndDTArrays(double aTime);
   // CONTROL STORAGE
   void setControlStorage(rdStorage *aStorage);
   rdStorage* getControlStorage();
   // STATE STORAGE
   void setStateStorage(rdStorage *aStorage);
   rdStorage* getStateStorage();
   // PSEUDO-STATE STORAGE
   void setPseudoStateStorage(rdStorage *aStorage);
   rdStorage* getPseudoStateStorage();
   // CONTROLLER
   void setController(rdController *aController);
   rdController* getController();

   //--------------------------------------------------------------------------
   // INTEGRATION
   //--------------------------------------------------------------------------
   bool integrate(double ti,double tf,rdControlSet &x,double *y,
            double dtFirst=1.0e-3);

   //--------------------------------------------------------------------------
   // INTERRUPT
   //--------------------------------------------------------------------------
   void halt();
   void clearHalt();
   bool checkHalt();

//=============================================================================
}; // END class rdIntegRKF
//=============================================================================
//=============================================================================


#endif // __rdIntegRKF_h__

---