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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRungeKutta45 * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double maxError, double &error)
 
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)
 
- Public Member Functions inherited from vtkInitialValueProblemSolver
vtkInitialValueProblemSolver * NewInstance () const
 
virtual int IsAdaptive ()
 
virtual void SetFunctionSet (vtkFunctionSet *functionset)
 
virtual vtkFunctionSet * GetFunctionSet ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkRungeKutta45 * SafeDownCast (vtkObjectBase *o)
 
static vtkRungeKutta45 * New ()
 
- Static Public Member Functions inherited from vtkInitialValueProblemSolver
static int IsTypeOf (const char *type)
 
static vtkInitialValueProblemSolver * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkRungeKutta45 ()
 
 ~vtkRungeKutta45 ()
 
virtual void Initialize ()
 
int ComputeAStep (double *xprev, double *dxprev, double *xnext, double t, double &delT, double &error)
 
- Protected Member Functions inherited from vtkInitialValueProblemSolver
 vtkInitialValueProblemSolver ()
 
 ~vtkInitialValueProblemSolver ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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

double * NextDerivs [6]
 
- Protected Attributes inherited from vtkInitialValueProblemSolver
vtkFunctionSet * FunctionSet
 
double * Vals
 
double * Derivs
 
int Initialized
 
int Adaptive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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 43 of file vtkRungeKutta45.h.

Member Typedef Documentation

typedef vtkInitialValueProblemSolver vtkRungeKutta45::Superclass

Definition at line 46 of file vtkRungeKutta45.h.

Constructor & Destructor Documentation

vtkRungeKutta45::vtkRungeKutta45 ( )
protected
vtkRungeKutta45::~vtkRungeKutta45 ( )
protected

Member Function Documentation

static int vtkRungeKutta45::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkRungeKutta45* vtkRungeKutta45::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRungeKutta45::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

vtkRungeKutta45* vtkRungeKutta45::NewInstance ( ) const
void vtkRungeKutta45::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

static vtkRungeKutta45* vtkRungeKutta45::New ( )
static

Construct a vtkRungeKutta45 with no initial FunctionSet.

virtual int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  xnext,
double  t,
double &  delT,
double  maxError,
double &  error 
)
inlinevirtual

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

virtual int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  dxprev,
double *  xnext,
double  t,
double &  delT,
double  maxError,
double &  error 
)
inlinevirtual

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

virtual int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  xnext,
double  t,
double &  delT,
double &  delTActual,
double  minStep,
double  maxStep,
double  maxError,
double &  error 
)
inlinevirtual

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

virtual int vtkRungeKutta45::ComputeNextStep ( double *  xprev,
double *  dxprev,
double *  xnext,
double  t,
double &  delT,
double &  delTActual,
double  minStep,
double  maxStep,
double  maxError,
double &  error 
)
virtual

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

Implements vtkInitialValueProblemSolver.

virtual void vtkRungeKutta45::Initialize ( )
protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

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

Member Data Documentation

double vtkRungeKutta45::A[5]
staticprotected

Definition at line 108 of file vtkRungeKutta45.h.

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

Definition at line 109 of file vtkRungeKutta45.h.

double vtkRungeKutta45::C[6]
staticprotected

Definition at line 110 of file vtkRungeKutta45.h.

double vtkRungeKutta45::DC[6]
staticprotected

Definition at line 111 of file vtkRungeKutta45.h.

double* vtkRungeKutta45::NextDerivs[6]
protected

Definition at line 113 of file vtkRungeKutta45.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1