VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInitialValueProblemSolver Class Referenceabstract

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 int IsA (const char *type)
 
vtkInitialValueProblemSolverNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsAdaptive ()
 
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)=0
 
virtual void SetFunctionSet (vtkFunctionSet *functionset)
 
virtual vtkFunctionSetGetFunctionSet ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkInitialValueProblemSolver
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkInitialValueProblemSolver ()
 
 ~vtkInitialValueProblemSolver ()
 
virtual void Initialize ()
 

Protected Attributes

vtkFunctionSetFunctionSet
 
double * Vals
 
double * Derivs
 
int Initialized
 
int Adaptive
 

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 39 of file vtkInitialValueProblemSolver.h.

Member Typedef Documentation

Definition at line 42 of file vtkInitialValueProblemSolver.h.

Member Enumeration Documentation

Enumerator
OUT_OF_DOMAIN 
NOT_INITIALIZED 
UNEXPECTED_VALUE 

Definition at line 104 of file vtkInitialValueProblemSolver.h.

Constructor & Destructor Documentation

vtkInitialValueProblemSolver::vtkInitialValueProblemSolver ( )
protected
vtkInitialValueProblemSolver::~vtkInitialValueProblemSolver ( )
protected

Member Function Documentation

static int vtkInitialValueProblemSolver::IsTypeOf ( const char *  type)
static
virtual int vtkInitialValueProblemSolver::IsA ( const char *  type)
virtual
static vtkInitialValueProblemSolver* vtkInitialValueProblemSolver::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkInitialValueProblemSolver::NewInstanceInternal ( ) const
protectedvirtual
vtkInitialValueProblemSolver* vtkInitialValueProblemSolver::NewInstance ( ) const
virtual void vtkInitialValueProblemSolver::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented in vtkRungeKutta45, and vtkRungeKutta4.

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 60 of file vtkInitialValueProblemSolver.h.

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 70 of file vtkInitialValueProblemSolver.h.

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

Reimplemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

Definition at line 80 of file vtkInitialValueProblemSolver.h.

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

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

Implemented in vtkRungeKutta45, vtkRungeKutta4, and vtkRungeKutta2.

virtual void vtkInitialValueProblemSolver::SetFunctionSet ( vtkFunctionSet functionset)
virtual

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

virtual vtkFunctionSet* vtkInitialValueProblemSolver::GetFunctionSet ( )
virtual

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

virtual int vtkInitialValueProblemSolver::IsAdaptive ( )
inlinevirtual

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

Definition at line 101 of file vtkInitialValueProblemSolver.h.

virtual void vtkInitialValueProblemSolver::Initialize ( )
protectedvirtual

Reimplemented in vtkRungeKutta45, and vtkRungeKutta4.

Member Data Documentation

vtkFunctionSet* vtkInitialValueProblemSolver::FunctionSet
protected

Definition at line 118 of file vtkInitialValueProblemSolver.h.

double* vtkInitialValueProblemSolver::Vals
protected

Definition at line 120 of file vtkInitialValueProblemSolver.h.

double* vtkInitialValueProblemSolver::Derivs
protected

Definition at line 121 of file vtkInitialValueProblemSolver.h.

int vtkInitialValueProblemSolver::Initialized
protected

Definition at line 122 of file vtkInitialValueProblemSolver.h.

int vtkInitialValueProblemSolver::Adaptive
protected

Definition at line 123 of file vtkInitialValueProblemSolver.h.


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