Integrate an initial value problem using 2nd order Runge-Kutta method. More...
#include <vtkRungeKutta2.h>
Inheritance diagram for vtkRungeKutta2:
Collaboration diagram for vtkRungeKutta2:
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... | |
| vtkRungeKutta2 * | NewInstance () const |
| int | ComputeNextStep (double *xprev, double *xnext, double t, double &delT, double maxError, double &error) 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) 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) 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) 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 |
| 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 void | SetFunctionSet (vtkFunctionSet *functionset) |
| 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) |
| 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... | |
| 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... | |
| 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 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... | |
| void | PrintRevisions (ostream &) |
| Legacy. 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 vtkRungeKutta2 * | SafeDownCast (vtkObjectBase *o) |
| static vtkRungeKutta2 * | New () |
| Construct a vtkRungeKutta2 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 (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 vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkRungeKutta2 () | |
| ~vtkRungeKutta2 () override | |
| Protected Member Functions inherited from vtkInitialValueProblemSolver | |
| 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 | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
| 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 |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
Integrate an initial value problem using 2nd order Runge-Kutta method.
This is a concrete sub-class of vtkInitialValueProblemSolver. It uses a 2nd order Runge-Kutta method to obtain the values of a set of functions at the next time step.
- Tests:
- vtkRungeKutta2 (Tests)
Definition at line 38 of file vtkRungeKutta2.h.
Member Typedef Documentation
Definition at line 41 of file vtkRungeKutta2.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkInitialValueProblemSolver.
| vtkRungeKutta2* vtkRungeKutta2::NewInstance | ( | ) | const |
|
static |
Construct a vtkRungeKutta2 with no initial FunctionSet.
|
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 62 of file vtkRungeKutta2.h.
|
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 72 of file vtkRungeKutta2.h.
|
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 vtkRungeKutta2.h.
|
overridevirtual |
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.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Math/vtkRungeKutta2.h
