SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Types | Public Member Functions | List of all members
smile::COdeSystem Class Referenceabstract

basic class of ODE system used in the orbit integrator. More...

#include <common.h>

Inheritance diagram for smile::COdeSystem:
Inheritance graph
[legend]

Public Types

enum  STEPRESULT { SR_CONTINUE, SR_TERMINATE, SR_REINIT }
 result of processing of a timestep More...
 

Public Member Functions

virtual void initState (OdeStateType *state)=0
 
virtual void odeFnc (double t, const OdeStateType &x, OdeStateType *dx)=0
 
virtual bool isStdHamiltonian ()
 
virtual double getRelErrorToleranceFactor (const OdeStateType &) const
 
virtual STEPRESULT processStep (double timePrev, double timeCurr, OdeStateType *state)=0
 

Detailed Description

basic class of ODE system used in the orbit integrator.

It provides a function for computing the right-hand side of the system of differential equations, and a number of auxiliary functions (for initializing the system and providing some operations). The COrbit class is descending from this one.

Member Enumeration Documentation

result of processing of a timestep

Enumerator
SR_CONTINUE 

need to continue integration

SR_TERMINATE 

may terminate integration if necessary

SR_REINIT 

variables have changed, need to re-initialize integrator


The documentation for this class was generated from the following file: