VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInitialValueProblemSolver Class Reference

Integrate a set of ordinary differential equations (initial value problem) in time. More...

#include <vtkInitialValueProblemSolver.h>

Inheritance diagram for vtkInitialValueProblemSolver:
[legend]
Collaboration diagram for vtkInitialValueProblemSolver:
[legend]

Public Types

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...
 
vtkInitialValueProblemSolverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 *xnext, double t, double &delT, double maxError, double &error, void *userData)
 
virtual int ComputeNextStep (double *xprev, double *dxprev, 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, void *userData)
 
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 *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error, void *userData)
 
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 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
 
 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 ()
 
- 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

vtkFunctionSetFunctionSet
 
double * Vals
 
double * Derivs
 
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
 

Detailed Description

Integrate a set of ordinary differential equations (initial value problem) in time.

Given a vtkFunctionSet which returns dF_i(x_j, t)/dt given x_j and t, vtkInitialValueProblemSolver computes the value of F_i at t+deltat.

Warning
vtkInitialValueProblemSolver and it's subclasses are not thread-safe. You should create a new integrator for each thread.
See also
vtkRungeKutta2 vtkRungeKutta4

Definition at line 40 of file vtkInitialValueProblemSolver.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkInitialValueProblemSolver.h.

Member Enumeration Documentation

◆ ErrorCodes

Enumerator
OUT_OF_DOMAIN 
NOT_INITIALIZED 
UNEXPECTED_VALUE 

Definition at line 144 of file vtkInitialValueProblemSolver.h.

Constructor & Destructor Documentation

◆ vtkInitialValueProblemSolver()

vtkInitialValueProblemSolver::vtkInitialValueProblemSolver ( )
protected

◆ ~vtkInitialValueProblemSolver()

vtkInitialValueProblemSolver::~vtkInitialValueProblemSolver ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkInitialValueProblemSolver::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 vtkObjectBase.

Reimplemented in vtkRungeKutta45, vtkRungeKutta2, and vtkRungeKutta4.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInitialValueProblemSolver::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkInitialValueProblemSolver* vtkInitialValueProblemSolver::NewInstance ( ) const

◆ PrintSelf()

void vtkInitialValueProblemSolver::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 vtkObject.

Reimplemented in vtkRungeKutta45, and vtkRungeKutta4.

◆ ComputeNextStep() [1/8]

virtual int vtkInitialValueProblemSolver::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).

For certain concrete sub-classes delTActual != delT. This occurs when the solver supports adaptive stepsize control. If this is the case, the solver 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. Also note that delT is an in/out argument. Adaptive solvers 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. Note that only some concrete sub-classes support this. Otherwise, the error is set to 0. This method returns an error code representing the nature of the failure: OutOfDomain = 1, NotInitialized = 2, UnexpectedValue = 3

Definition at line 68 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [2/8]

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 74 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [3/8]

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

Definition at line 84 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [4/8]

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 90 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [5/8]

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

Definition at line 99 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [6/8]

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 106 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [7/8]

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

Definition at line 114 of file vtkInitialValueProblemSolver.h.

◆ ComputeNextStep() [8/8]

virtual int vtkInitialValueProblemSolver::ComputeNextStep ( double *  vtkNotUsedxprev,
double *  vtkNotUseddxprev,
double *  vtkNotUsedxnext,
double   vtkNotUsedt,
double &  vtkNotUseddelT,
double &  vtkNotUseddelTActual,
double   vtkNotUsedminStep,
double   vtkNotUsedmaxStep,
double   vtkNotUsedmaxError,
double &  vtkNotUsederror,
void *  vtkNotUseduserData 
)
inlinevirtual

Definition at line 121 of file vtkInitialValueProblemSolver.h.

◆ SetFunctionSet()

virtual void vtkInitialValueProblemSolver::SetFunctionSet ( vtkFunctionSet functionset)
virtual

Set / get the dataset used for the implicit function evaluation.

◆ GetFunctionSet()

virtual vtkFunctionSet* vtkInitialValueProblemSolver::GetFunctionSet ( )
virtual

◆ IsAdaptive()

virtual vtkTypeBool vtkInitialValueProblemSolver::IsAdaptive ( )
inlinevirtual

Returns 1 if the solver uses adaptive stepsize control, 0 otherwise.

Definition at line 142 of file vtkInitialValueProblemSolver.h.

◆ Initialize()

virtual void vtkInitialValueProblemSolver::Initialize ( )
protectedvirtual

Reimplemented in vtkRungeKutta45, and vtkRungeKutta4.

Member Data Documentation

◆ FunctionSet

vtkFunctionSet* vtkInitialValueProblemSolver::FunctionSet
protected

Definition at line 157 of file vtkInitialValueProblemSolver.h.

◆ Vals

double* vtkInitialValueProblemSolver::Vals
protected

Definition at line 159 of file vtkInitialValueProblemSolver.h.

◆ Derivs

double* vtkInitialValueProblemSolver::Derivs
protected

Definition at line 160 of file vtkInitialValueProblemSolver.h.

◆ Initialized

int vtkInitialValueProblemSolver::Initialized
protected

Definition at line 161 of file vtkInitialValueProblemSolver.h.

◆ Adaptive

vtkTypeBool vtkInitialValueProblemSolver::Adaptive
protected

Definition at line 162 of file vtkInitialValueProblemSolver.h.


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