![]() |
KaliVeda
Toolkit for HIC analysis
|
Adaptive step-size 4th order Runge-Kutta ODE integrator from Numerical Recipes.
To use, implement a class which inherits from KVRungeKutta and which has AT LEAST the following methods:
i.e. a constructor which has at least one argument, the number of ODE to be integrated, which is passed to the KVRungeKutta(Int_t, Double_t, Double_t) constructor (this number is stored in the member variable KVRungeKutta::nvar). In this case the default values of precision and minimum step size will be used.
This method must calculate and store the values of the derivatives DYDX[nvar]
given the value of X
and of the Y[nvar]
independent variables. This method will be called many times during each step of the integration. The member variable fInitialDeriv
is set to kTRUE
when the method is called for the first time of each step.
Then, after filling an array ystart[nvar]
with the initial values of the independent variables, perform the integration from x1
to x2
like this:
Definition at line 50 of file KVRungeKutta.h.
#include <KVRungeKutta.h>
Public Member Functions | |
KVRungeKutta () | |
KVRungeKutta (Int_t N, Double_t PREC=1.e-8, Double_t MINSTEP=0.0) | |
virtual | ~KVRungeKutta () |
Destructor. More... | |
virtual void | CalcDerivs (Double_t X, Double_t *Y, Double_t *DYDX)=0 |
Int_t | GetNBadSteps () const |
Int_t | GetNGoodSteps () const |
virtual void | Integrate (Double_t *ystart, Double_t x1, Double_t x2, Double_t h1) |
Bool_t | IsOK () const |
![]() | |
KVBase () | |
Default constructor. More... | |
KVBase (const Char_t *name, const Char_t *title="") | |
Ctor for object with given name and type. More... | |
KVBase (const KVBase &) | |
copy ctor More... | |
virtual | ~ KVBase () |
virtual void | Clear (Option_t *opt="") |
Clear object properties : name, type/title, number, label. More... | |
virtual void | Copy (TObject &) const |
Make a copy of this object. More... | |
const Char_t * | GetLabel () const |
UInt_t | GetNumber () const |
UInt_t | GetNumberOfObjects () const |
virtual TObject * | GetObject () const |
virtual const Char_t * | GetType () const |
Bool_t | HasLabel () const |
virtual Bool_t | IsCalled (const Char_t *name) const |
Bool_t | IsLabelled (const Char_t *l) const |
virtual Bool_t | IsType (const Char_t *typ) const |
virtual void | List () |
KVBase & | operator= (const KVBase &) |
copy assignment operator More... | |
virtual void | Print (Option_t *option="") const |
Double_t | ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const |
void | SetLabel (const Char_t *lab) |
virtual void | SetNumber (UInt_t num) |
virtual void | SetType (const Char_t *str) |
![]() | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TObject * | Clone (const char *newname="") const override |
Int_t | Compare (const TObject *obj) const override |
virtual void | FillBuffer (char *&buffer) |
const char * | GetName () const override |
const char * | GetTitle () const override |
ULong_t | Hash () const override |
TClass * | IsA () const override |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
TNamed & | operator= (const TNamed &rhs) |
virtual void | SetName (const char *name) |
virtual void | SetNameTitle (const char *name, const char *title) |
virtual void | SetTitle (const char *title="") |
virtual Int_t | Sizeof () const |
void | Streamer (TBuffer &) override |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
![]() | |
TObject () | |
TObject (const TObject &object) | |
virtual | ~TObject () |
void | AbstractMethod (const char *method) const |
virtual void | AppendPad (Option_t *option="") |
virtual void | Browse (TBrowser *b) |
ULong_t | CheckedHash () |
virtual const char * | ClassName () const |
virtual void | Delete (Option_t *option="") |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
virtual void | Draw (Option_t *option="") |
virtual void | DrawClass () const |
virtual TObject * | DrawClone (Option_t *option="") const |
virtual void | Dump () const |
virtual void | Error (const char *method, const char *msgfmt,...) const |
virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
virtual TObject * | FindObject (const char *name) const |
virtual TObject * | FindObject (const TObject *obj) const |
virtual Option_t * | GetDrawOption () const |
virtual const char * | GetIconName () const |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
virtual Bool_t | HandleTimer (TTimer *timer) |
Bool_t | HasInconsistentHash () const |
virtual void | Info (const char *method, const char *msgfmt,...) const |
virtual Bool_t | InheritsFrom (const char *classname) const |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
virtual void | Inspect () const |
void | InvertBit (UInt_t f) |
Bool_t | IsDestructed () const |
virtual Bool_t | IsEqual (const TObject *obj) const |
virtual Bool_t | IsFolder () const |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
void | MayNotUse (const char *method) const |
virtual Bool_t | Notify () |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *vp) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, void *vp) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
virtual void | Paint (Option_t *option="") |
virtual void | Pop () |
virtual Int_t | Read (const char *name) |
virtual void | RecursiveRemove (TObject *obj) |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
virtual void | SetDrawOption (Option_t *option="") |
virtual void | SetUniqueID (UInt_t uid) |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Private Member Functions | |
virtual void | rkck (Double_t h) |
virtual void | rkqs (Double_t htry) |
Private Attributes | |
Double_t * | ak2 |
Double_t * | ak3 |
Double_t * | ak4 |
Double_t * | ak5 |
Double_t * | ak6 |
Double_t | dc1 |
Double_t | dc3 |
Double_t | dc4 |
Double_t | dc6 |
Double_t * | dydx |
Double_t | eps |
precision required More... | |
Bool_t | fInitialDeriv |
Bool_t | fOK |
Double_t | hdid |
Double_t | hmin |
minimum allowed step size More... | |
Double_t | hnext |
Int_t | nbad |
number of bad steps taken More... | |
Int_t | nok |
number of good steps taken More... | |
Int_t | nvar |
number of independent variables/equations More... | |
Double_t | x |
Double_t * | y |
Double_t * | yerr |
Double_t * | yout |
Double_t * | yscal |
Double_t * | ytemp |
Static Private Attributes | |
static Double_t | a2 = 0.2 |
static Double_t | a3 = 0.3 |
static Double_t | a4 = 0.6 |
static Double_t | a5 = 1.0 |
static Double_t | a6 = 0.875 |
static Double_t | b21 = 0.2 |
static Double_t | b31 = 3.0 / 40.0 |
static Double_t | b32 = 9.0 / 40.0 |
static Double_t | b41 = 0.3 |
static Double_t | b42 = -0.9 |
static Double_t | b43 = 1.2 |
static Double_t | b51 = -11.0 / 54.0 |
static Double_t | b52 = 2.5 |
static Double_t | b53 = -70.0 / 27.0 |
static Double_t | b54 = 35.0 / 27.0 |
static Double_t | b61 = 1631.0 / 55296.0 |
static Double_t | b62 = 175.0 / 512.0 |
static Double_t | b63 = 575.0 / 13824.0 |
static Double_t | b64 = 44275.0 / 110592.0 |
static Double_t | b65 = 253.0 / 4096.0 |
static Double_t | c1 = 37.0 / 378.0 |
static Double_t | c3 = 250.0 / 621.0 |
static Double_t | c4 = 125.0 / 594.0 |
static Double_t | c6 = 512.0 / 1771.0 |
static Double_t | dc5 = -277.00 / 14336.0 |
Additional Inherited Members | |
![]() | |
enum | EKaliVedaBits { kIsKaliVedaObject = BIT(23) } |
![]() | |
enum | EDeprecatedStatusBits |
enum | EStatusBits |
![]() | |
static Bool_t | AreEqual (Double_t x, Double_t y, Long64_t maxdif=1) |
Comparison between two 64-bit floating-point values. More... | |
static void | BackupFileWithDate (const Char_t *path) |
static void | CombineFiles (const Char_t *file1, const Char_t *file2, const Char_t *newfilename, Bool_t keep=kTRUE) |
static void | Deprecated (const char *method, const char *advice) |
static Bool_t | FindClassSourceFiles (const Char_t *class_name, KVString &imp_file, KVString &dec_file, const Char_t *dir_name=".") |
static Bool_t | FindExecutable (TString &exec, const Char_t *path="$(PATH)") |
static const Char_t * | FindFile (const Char_t *search, TString &wfil) |
static const Char_t * | GetBINDIRFilePath (const Char_t *namefile="") |
static const Char_t * | GetDATABASEFilePath () |
static const Char_t * | GetDATADIRFilePath (const Char_t *namefile="") |
static Bool_t | GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval) |
static const Char_t * | GetDataSetEnv (const Char_t *dataset, const Char_t *type, const Char_t *defval) |
static Double_t | GetDataSetEnv (const Char_t *dataset, const Char_t *type, Double_t defval) |
static const Char_t * | GetETCDIRFilePath (const Char_t *namefile="") |
static const Char_t * | GetExampleFilePath (const Char_t *library, const Char_t *namefile) |
Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More... | |
static const Char_t * | GetINCDIRFilePath (const Char_t *namefile="") |
static const Char_t * | GetKVBuildDate () |
Returns KaliVeda build date. More... | |
static const Char_t * | GetKVBuildDir () |
Returns top-level directory used for build. More... | |
static const Char_t * | GetKVBuildTime () |
Returns KaliVeda build time. More... | |
static const Char_t * | GetKVBuildType () |
Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More... | |
static const Char_t * | GetKVBuildUser () |
Returns username of person who performed build. More... | |
static const Char_t * | GetKVSourceDir () |
Returns top-level directory of source tree used for build. More... | |
static const Char_t * | GetKVVersion () |
Returns KaliVeda version string. More... | |
static const Char_t * | GetLIBDIRFilePath (const Char_t *namefile="") |
static const Char_t * | GetListOfPlugins (const Char_t *base) |
static const Char_t * | GetListOfPluginURIs (const Char_t *base) |
static const Char_t * | GetPluginURI (const Char_t *base, const Char_t *plugin) |
static void | GetTempFileName (TString &base) |
static const Char_t * | GetTEMPLATEDIRFilePath (const Char_t *namefile="") |
static const Char_t * | GetWORKDIRFilePath (const Char_t *namefile="") |
static const Char_t * | gitBranch () |
Returns git branch of sources. More... | |
static const Char_t * | gitCommit () |
Returns last git commit of sources. More... | |
static void | InitEnvironment () |
static bool | is_gnuinstall () |
static Bool_t | IsThisAPlugin (const TString &uri, TString &base) |
static TPluginHandler * | LoadPlugin (const Char_t *base, const Char_t *uri="0") |
static Bool_t | OpenContextMenu (const char *method, TObject *obj, const char *alt_method_name="") |
static void | OpenTempFile (TString &base, std::ofstream &fp) |
static void | PrintSplashScreen () |
Prints welcome message and infos on version etc. More... | |
static Bool_t | SearchAndOpenKVFile (const Char_t *name, KVSQLite::database &dbfile, const Char_t *kvsubdir="") |
static Bool_t | SearchAndOpenKVFile (const Char_t *name, std::ifstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0) |
static Bool_t | SearchAndOpenKVFile (const Char_t *name, std::ofstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0) |
static Bool_t | SearchKVFile (const Char_t *name, TString &fullpath, const Char_t *kvsubdir="") |
static const Char_t * | WorkingDirectory () |
![]() | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
![]() | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_t | GetDtorOnly () |
static Bool_t | GetObjectStat () |
static void | SetDtorOnly (void *obj) |
static void | SetObjectStat (Bool_t stat) |
![]() | |
kBitMask | |
kCanDelete | |
kCannotPick | |
kHasUUID | |
kInconsistent | |
kInvalidObject | |
kIsOnHeap | |
kIsReferenced | |
kMustCleanup | |
kNoContextMenu | |
kNotDeleted | |
kObjInCanvas | |
kOverwrite | |
kSingleKey | |
kWriteDelete | |
kZombie | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
void | MakeZombie () |
![]() | |
TString | fName |
TString | fTitle |
![]() | |
kOnlyPrepStep | |
|
inline |
Definition at line 75 of file KVRungeKutta.h.
Set up integrator for N independent variables PREC = required precision (default: 1.e-8) MINSTEP = minimum allowed stepsize (default: 0)
Definition at line 43 of file KVRungeKutta.cpp.
|
virtual |
Destructor.
Definition at line 76 of file KVRungeKutta.cpp.
This method must be implemented in child classes in order to fill the array DYDX[nvar] with the calculated values of the derivatives given the value of X and the values of Y[nvar]
Implemented in KVCoulombPropagator.
|
inline |
Return number of bad (but retried and fixed) steps taken in integration
Definition at line 91 of file KVRungeKutta.h.
|
inline |
Return number of succesful steps taken in integration
Definition at line 86 of file KVRungeKutta.h.
Runge-Kutta driver with adaptive stepsize control. Integrate nvar starting values ystart[0,...,nvar-1] from x1 to x2 with accuracy eps. h1 should be set as a guessed first stepsize. after call, GetNGoodSteps() and GetNBadSteps() give the number of good and bad (but retried and fixed) steps taken, and ystart values are replaced by values at the end of the integration interval.
Definition at line 102 of file KVRungeKutta.cpp.
|
inline |
Can be used after call to Integrate to check if successful
Definition at line 96 of file KVRungeKutta.h.
Given values for n variables y[1..n] and their derivatives dydx[1..n] known at x, use the fifth-order Cash-Karp Runge-Kutta method to advance the solution over an interval h and return the incremented variables as yout[1..n]. Also return an estimate of the local truncation error in yout using the embedded fourth-order method. The user supplies the routine derivs(x,y,dydx) , which returns derivatives dydx at x.
Definition at line 208 of file KVRungeKutta.cpp.
Fifth-order Runge-Kutta step with monitoring of local truncation error to ensure accuracy and adjust stepsize. Input are the dependent variable vector y[1..n] and its derivative dydx[1..n] at the starting value of the independent variable x. Also input are the stepsize to be attempted htry, the required accuracy eps, and the vector yscal[1..n] against which the error is scaled. On output, y and x are replaced by their new values, hdid is the stepsize that was actually accomplished, and hnext is the estimated next stepsize. derivs is the user-supplied routine that computes the right-hand side derivatives.
Definition at line 165 of file KVRungeKutta.cpp.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
private |
Definition at line 67 of file KVRungeKutta.h.
|
private |
Definition at line 67 of file KVRungeKutta.h.
|
private |
Definition at line 67 of file KVRungeKutta.h.
|
private |
Definition at line 67 of file KVRungeKutta.h.
|
private |
Definition at line 67 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 51 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 52 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 52 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 52 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 52 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 52 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 53 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 53 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 53 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 53 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 54 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 54 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 54 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 55 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 55 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 55 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 56 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 56 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 56 of file KVRungeKutta.h.
|
private |
Definition at line 68 of file KVRungeKutta.h.
|
private |
Definition at line 68 of file KVRungeKutta.h.
|
private |
Definition at line 68 of file KVRungeKutta.h.
|
staticprivate |
Definition at line 57 of file KVRungeKutta.h.
|
private |
Definition at line 68 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.
|
private |
precision required
Definition at line 60 of file KVRungeKutta.h.
|
private |
Definition at line 70 of file KVRungeKutta.h.
|
private |
Definition at line 69 of file KVRungeKutta.h.
|
private |
Definition at line 66 of file KVRungeKutta.h.
|
private |
minimum allowed step size
Definition at line 61 of file KVRungeKutta.h.
|
private |
Definition at line 66 of file KVRungeKutta.h.
|
private |
number of bad steps taken
Definition at line 63 of file KVRungeKutta.h.
|
private |
number of good steps taken
Definition at line 62 of file KVRungeKutta.h.
|
private |
number of independent variables/equations
Definition at line 59 of file KVRungeKutta.h.
|
private |
Definition at line 66 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.
|
private |
Definition at line 65 of file KVRungeKutta.h.