Integrate an initial value problem using 4th order Runge-Kutta method. More...

#include <vtkRungeKutta4.h>

Inheritance diagram for vtkRungeKutta4:

Collaboration diagram for vtkRungeKutta4:

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...

vtkRungeKutta4 *	NewInstance () 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+delT (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+delT (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+delT (xnext). More...

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
	Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of x at t+delT (xnext). More...

Public Member Functions inherited from vtkInitialValueProblemSolver
vtkInitialValueProblemSolver *	NewInstance () const

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 vtkFunctionSet *	GetFunctionSet ()
	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	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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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...

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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRungeKutta4 *	SafeDownCast (vtkObjectBase *o)

static vtkRungeKutta4 *	New ()
	Construct a vtkRungeKutta4 with no initial FunctionSet. More...

Static Public Member Functions inherited from vtkInitialValueProblemSolver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInitialValueProblemSolver *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (vtkTypeBool 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 vtkTypeBool	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkRungeKutta4 ()

	~vtkRungeKutta4 () override

void	Initialize () override

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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double *	NextDerivs [3]

Protected Attributes inherited from vtkInitialValueProblemSolver
vtkFunctionSet *	FunctionSet

double *	Vals

double *	Derivs

int	Initialized

vtkTypeBool	Adaptive

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 4th order Runge-Kutta method.

This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 4th order Runge-Kutta method to obtain the values of a set of functions at the next time step.

See also: vtkInitialValueProblemSolver vtkRungeKutta45 vtkRungeKutta2 vtkFunctionSet

Online Examples:

OfficeTube

StreamlinesWithLineWidget

Tests:: vtkRungeKutta4 (Tests)

Definition at line 56 of file vtkRungeKutta4.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInitialValueProblemSolver vtkRungeKutta4::Superclass

Definition at line 59 of file vtkRungeKutta4.h.

Constructor & Destructor Documentation

◆ vtkRungeKutta4()

vtkRungeKutta4::vtkRungeKutta4 ( )

protected

◆ ~vtkRungeKutta4()

vtkRungeKutta4::~vtkRungeKutta4 ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkRungeKutta4::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 vtkRungeKutta4* vtkRungeKutta4::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRungeKutta4::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

◆ NewInstance()

vtkRungeKutta4* vtkRungeKutta4::NewInstance ( ) const

◆ PrintSelf()

void vtkRungeKutta4::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 vtkRungeKutta4* vtkRungeKutta4::New ( )

static

Construct a vtkRungeKutta4 with no initial FunctionSet.

◆ ComputeNextStep() [1/4]

int vtkRungeKutta4::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+delT (xnext).

delTActual is always equal to delT. Since this class can not provide an estimate for the error error is set to 0. maxStep, minStep and maxError are unused. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 82 of file vtkRungeKutta4.h.

◆ ComputeNextStep() [2/4]

int vtkRungeKutta4::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+delT (xnext).

delTActual is always equal to delT. Since this class can not provide an estimate for the error error is set to 0. maxStep, minStep and maxError are unused. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 91 of file vtkRungeKutta4.h.

◆ ComputeNextStep() [3/4]

int vtkRungeKutta4::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+delT (xnext).

delTActual is always equal to delT. Since this class can not provide an estimate for the error error is set to 0. maxStep, minStep and maxError are unused. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 100 of file vtkRungeKutta4.h.

◆ ComputeNextStep() [4/4]

int vtkRungeKutta4::ComputeNextStep	(	double *	xprev,
		double *	dxprev,
		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+delT (xnext).

delTActual is always equal to delT. Since this class can not provide an estimate for the error error is set to 0. maxStep, minStep and maxError are unused. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

◆ Initialize()

void vtkRungeKutta4::Initialize ( )

overrideprotectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

Member Data Documentation

◆ NextDerivs

double* vtkRungeKutta4::NextDerivs[3]

protected

Definition at line 117 of file vtkRungeKutta4.h.

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

Common/Math/vtkRungeKutta4.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRungeKutta4()

◆ ~vtkRungeKutta4()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ ComputeNextStep() [1/4]

◆ ComputeNextStep() [2/4]

◆ ComputeNextStep() [3/4]

◆ ComputeNextStep() [4/4]

◆ Initialize()

Member Data Documentation

◆ NextDerivs