VTK
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
 
int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error, void *userData) override
 
int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error, void *userData) override
 
- Public Member Functions inherited from vtkInitialValueProblemSolver
vtkInitialValueProblemSolverNewInstance () const
 
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)
 
virtual int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error)
 
virtual int ComputeNextStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error)
 
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))
 
virtual void SetFunctionSet (vtkFunctionSet *functionset)
 Set / get the dataset used for the implicit function evaluation. More...
 
virtual vtkFunctionSetGetFunctionSet ()
 
virtual vtkTypeBool IsAdaptive ()
 Returns 1 if the solver uses adaptive stepsize control, 0 otherwise. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 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
 vtkInitialValueProblemSolver ()
 
 ~vtkInitialValueProblemSolver () override
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

doubleNextDerivs [6]
 
- Protected Attributes inherited from vtkInitialValueProblemSolver
vtkFunctionSetFunctionSet
 
doubleVals
 
doubleDerivs
 
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]
 

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
Tests:
vtkRungeKutta45 (Tests)

Definition at line 44 of file vtkRungeKutta45.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 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 79 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

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 89 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

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 99 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 error,
void *  userData 
)
override

◆ 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 120 of file vtkRungeKutta45.h.

◆ B

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

Definition at line 121 of file vtkRungeKutta45.h.

◆ C

double vtkRungeKutta45::C[6]
staticprotected

Definition at line 122 of file vtkRungeKutta45.h.

◆ DC

double vtkRungeKutta45::DC[6]
staticprotected

Definition at line 123 of file vtkRungeKutta45.h.

◆ NextDerivs

double* vtkRungeKutta45::NextDerivs[6]
protected

Definition at line 125 of file vtkRungeKutta45.h.


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