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

Public Member Functions
virtual int	IsA (const char *type)

vtkRungeKutta4 *	NewInstance () const

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

static vtkRungeKutta4 *	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

	vtkRungeKutta4 ()

	~vtkRungeKutta4 ()

virtual void	Initialize ()

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 [3]

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

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

Examples:: vtkRungeKutta4 (Examples)

Tests:: vtkRungeKutta4 (Tests)

Definition at line 40 of file vtkRungeKutta4.h.

Member Typedef Documentation

typedef vtkInitialValueProblemSolver vtkRungeKutta4::Superclass

Definition at line 43 of file vtkRungeKutta4.h.

Constructor & Destructor Documentation

vtkRungeKutta4::vtkRungeKutta4 ( )

protected

vtkRungeKutta4::~vtkRungeKutta4 ( )

protected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkRungeKutta4::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

vtkRungeKutta4* vtkRungeKutta4::NewInstance ( ) const

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

static

Construct a vtkRungeKutta4 with no initial FunctionSet.

virtual int vtkRungeKutta4::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+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 57 of file vtkRungeKutta4.h.

virtual int vtkRungeKutta4::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+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 66 of file vtkRungeKutta4.h.

virtual int vtkRungeKutta4::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+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 76 of file vtkRungeKutta4.h.

virtual int vtkRungeKutta4::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+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

Implements vtkInitialValueProblemSolver.

virtual void vtkRungeKutta4::Initialize ( )

protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

Member Data Documentation

double* vtkRungeKutta4::NextDerivs[3]

protected

Definition at line 96 of file vtkRungeKutta4.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Math/vtkRungeKutta4.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation