VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkRungeKutta45 Class Reference

Integrate an initial value problem using 5th order Runge-Kutta method with adaptive stepsize control. More...

#include <vtkRungeKutta45.h>

Inheritance diagram for vtkRungeKutta45:
[legend]
Collaboration diagram for vtkRungeKutta45:
[legend]

Public Types

typedef vtkInitialValueProblemSolver Superclass
 
- Public Types inherited from vtkInitialValueProblemSolver
enum  ErrorCodes { OUT_OF_DOMAIN = 1 , NOT_INITIALIZED = 2 , UNEXPECTED_VALUE = 3 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRungeKutta45NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double maxError, double &error, void *userData) override
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double maxError, double &error, void *userData) override
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error, void *userData) override
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &estErr, void *userData) override
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
- Public Member Functions inherited from vtkInitialValueProblemSolver
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkInitialValueProblemSolverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkTypeBool IsAdaptive ()
 Returns 1 if the solver uses adaptive stepsize control, 0 otherwise. More...
 
virtual int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double maxError, double &error)
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
virtual int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double maxError, double &error)
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
virtual int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error)
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
virtual int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error)
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
virtual int ComputeNextStep (double *vtkNotUsed(xprev), double *vtkNotUsed(dxprev), double *vtkNotUsed(xnext), double vtkNotUsed(t), double &vtkNotUsed(delT), double &vtkNotUsed(delTActual), double vtkNotUsed(minStep), double vtkNotUsed(maxStep), double vtkNotUsed(maxError), double &vtkNotUsed(error), void *vtkNotUsed(userData))
 Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext). More...
 
virtual void SetFunctionSet (vtkFunctionSet *fset)
 Set / get the dataset used for the implicit function evaluation. More...
 
virtual vtkFunctionSetGetFunctionSet ()
 Set / get the dataset used for the implicit function evaluation. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRungeKutta45SafeDownCast (vtkObjectBase *o)
 
static vtkRungeKutta45New ()
 Construct a vtkRungeKutta45 with no initial FunctionSet. More...
 
- Static Public Member Functions inherited from vtkInitialValueProblemSolver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInitialValueProblemSolverSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRungeKutta45 ()
 
 ~vtkRungeKutta45 () override
 
void Initialize () override
 
int ComputeAStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &delTActual, double &error, void *userData)
 
- Protected Member Functions inherited from vtkInitialValueProblemSolver
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInitialValueProblemSolver ()
 
 ~vtkInitialValueProblemSolver () override
 
virtual void Initialize ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double * NextDerivs [6]
 
- Protected Attributes inherited from vtkInitialValueProblemSolver
vtkFunctionSetFunctionSet
 
double * Vals
 
double * Derivs
 
int Initialized
 
vtkTypeBool Adaptive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static double A [5]
 
static double B [5][5]
 
static double C [6]
 
static double DC [6]
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Integrate an initial value problem using 5th order Runge-Kutta method with adaptive stepsize control.

This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 5th order Runge-Kutta method with stepsize control to obtain the values of a set of functions at the next time step. The stepsize is adjusted by calculating an estimated error using an embedded 4th order Runge-Kutta formula: Press, W. H. et al., 1992, Numerical Recipes in Fortran, Second Edition, Cambridge University Press Cash, J.R. and Karp, A.H. 1990, ACM Transactions on Mathematical Software, vol 16, pp 201-222

See also
vtkInitialValueProblemSolver vtkRungeKutta4 vtkRungeKutta2 vtkFunctionSet

Definition at line 41 of file vtkRungeKutta45.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkRungeKutta45.h.

Constructor & Destructor Documentation

◆ vtkRungeKutta45()

vtkRungeKutta45::vtkRungeKutta45 ( )
protected

◆ ~vtkRungeKutta45()

vtkRungeKutta45::~vtkRungeKutta45 ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkRungeKutta45::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkRungeKutta45::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInitialValueProblemSolver.

◆ SafeDownCast()

static vtkRungeKutta45 * vtkRungeKutta45::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRungeKutta45::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

◆ NewInstance()

vtkRungeKutta45 * vtkRungeKutta45::NewInstance ( ) const

◆ PrintSelf()

void vtkRungeKutta45::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkInitialValueProblemSolver.

◆ New()

static vtkRungeKutta45 * vtkRungeKutta45::New ( )
static

Construct a vtkRungeKutta45 with no initial FunctionSet.

◆ ComputeNextStep() [1/4]

int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  xnext,
double  t,
double &  delT,
double  maxError,
double &  error,
void *  userData 
)
inlineoverridevirtual

Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext).

Possibly delTActual != delT. This may occur because this solver supports adaptive stepsize control. It tries to change to stepsize such that the (estimated) error of the integration is less than maxError. The solver will not set the stepsize smaller than minStep or larger than maxStep (note that maxStep and minStep should both be positive, whereas delT can be negative). Also note that delT is an in/out argument. vtkRungeKutta45 will modify delT to reflect the best (estimated) size for the next integration step. An estimated value for the error is returned (by reference) in error. This is the norm of the error vector if there are more than one function to be integrated. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 76 of file vtkRungeKutta45.h.

◆ ComputeNextStep() [2/4]

int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  dxprev,
double *  xnext,
double  t,
double &  delT,
double  maxError,
double &  error,
void *  userData 
)
inlineoverridevirtual

Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext).

Possibly delTActual != delT. This may occur because this solver supports adaptive stepsize control. It tries to change to stepsize such that the (estimated) error of the integration is less than maxError. The solver will not set the stepsize smaller than minStep or larger than maxStep (note that maxStep and minStep should both be positive, whereas delT can be negative). Also note that delT is an in/out argument. vtkRungeKutta45 will modify delT to reflect the best (estimated) size for the next integration step. An estimated value for the error is returned (by reference) in error. This is the norm of the error vector if there are more than one function to be integrated. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 85 of file vtkRungeKutta45.h.

◆ ComputeNextStep() [3/4]

int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  xnext,
double  t,
double &  delT,
double &  delTActual,
double  minStep,
double  maxStep,
double  maxError,
double &  error,
void *  userData 
)
inlineoverridevirtual

Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext).

Possibly delTActual != delT. This may occur because this solver supports adaptive stepsize control. It tries to change to stepsize such that the (estimated) error of the integration is less than maxError. The solver will not set the stepsize smaller than minStep or larger than maxStep (note that maxStep and minStep should both be positive, whereas delT can be negative). Also note that delT is an in/out argument. vtkRungeKutta45 will modify delT to reflect the best (estimated) size for the next integration step. An estimated value for the error is returned (by reference) in error. This is the norm of the error vector if there are more than one function to be integrated. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 94 of file vtkRungeKutta45.h.

◆ ComputeNextStep() [4/4]

int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  dxprev,
double *  xnext,
double  t,
double &  delT,
double &  delTActual,
double  minStep,
double  maxStep,
double  maxError,
double &  estErr,
void *  userData 
)
override

Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delTActual (xnext).

Possibly delTActual != delT. This may occur because this solver supports adaptive stepsize control. It tries to change to stepsize such that the (estimated) error of the integration is less than maxError. The solver will not set the stepsize smaller than minStep or larger than maxStep (note that maxStep and minStep should both be positive, whereas delT can be negative). Also note that delT is an in/out argument. vtkRungeKutta45 will modify delT to reflect the best (estimated) size for the next integration step. An estimated value for the error is returned (by reference) in error. This is the norm of the error vector if there are more than one function to be integrated. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

◆ Initialize()

void vtkRungeKutta45::Initialize ( )
overrideprotectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

◆ ComputeAStep()

int vtkRungeKutta45::ComputeAStep ( double *  xprev,
double *  dxprev,
double *  xnext,
double  t,
double &  delT,
double &  delTActual,
double &  error,
void *  userData 
)
protected

Member Data Documentation

◆ A

double vtkRungeKutta45::A[5]
staticprotected

Definition at line 112 of file vtkRungeKutta45.h.

◆ B

double vtkRungeKutta45::B[5][5]
staticprotected

Definition at line 113 of file vtkRungeKutta45.h.

◆ C

double vtkRungeKutta45::C[6]
staticprotected

Definition at line 114 of file vtkRungeKutta45.h.

◆ DC

double vtkRungeKutta45::DC[6]
staticprotected

Definition at line 115 of file vtkRungeKutta45.h.

◆ NextDerivs

double* vtkRungeKutta45::NextDerivs[6]
protected

Definition at line 117 of file vtkRungeKutta45.h.


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