#include <vtkInitialValueProblemSolver.h>
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.
Definition at line 38 of file vtkInitialValueProblemSolver.h.
Public Types | |
enum | ErrorCodes { OUT_OF_DOMAIN = 1, NOT_INITIALIZED = 2, UNEXPECTED_VALUE = 3 } |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
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 vtkFunctionSet * | GetFunctionSet () |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkInitialValueProblemSolver * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkInitialValueProblemSolver () | |
~vtkInitialValueProblemSolver () | |
virtual void | Initialize () |
Protected Attributes | |
vtkFunctionSet * | FunctionSet |
double * | Vals |
double * | Derivs |
int | Initialized |
int | Adaptive |
Reimplemented from vtkObject.
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
Definition at line 41 of file vtkInitialValueProblemSolver.h.
Definition at line 103 of file vtkInitialValueProblemSolver.h.
vtkInitialValueProblemSolver::vtkInitialValueProblemSolver | ( | ) | [protected] |
vtkInitialValueProblemSolver::~vtkInitialValueProblemSolver | ( | ) | [protected] |
virtual const char* vtkInitialValueProblemSolver::GetClassName | ( | ) | [virtual] |
static int vtkInitialValueProblemSolver::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkObject.
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
virtual int 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 vtkObject.
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
static vtkInitialValueProblemSolver* vtkInitialValueProblemSolver::SafeDownCast | ( | vtkObject * | o | ) | [static] |
virtual void vtkInitialValueProblemSolver::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 vtkObject.
Reimplemented in vtkRungeKutta4, and vtkRungeKutta45.
virtual int vtkInitialValueProblemSolver::ComputeNextStep | ( | double * | xprev, | |
double * | xnext, | |||
double | t, | |||
double & | delT, | |||
double | maxError, | |||
double & | error | |||
) | [inline, 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
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
Definition at line 59 of file vtkInitialValueProblemSolver.h.
virtual int vtkInitialValueProblemSolver::ComputeNextStep | ( | double * | xprev, | |
double * | dxprev, | |||
double * | xnext, | |||
double | t, | |||
double & | delT, | |||
double | maxError, | |||
double & | error | |||
) | [inline, 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
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
Definition at line 69 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 | |||
) | [inline, 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
Reimplemented in vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
Definition at line 79 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 vtkRungeKutta2, vtkRungeKutta4, and vtkRungeKutta45.
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 | ( | ) | [inline, virtual] |
Returns 1 if the solver uses adaptive stepsize control, 0 otherwise
Definition at line 100 of file vtkInitialValueProblemSolver.h.
virtual void vtkInitialValueProblemSolver::Initialize | ( | ) | [protected, virtual] |
Reimplemented in vtkRungeKutta4, and vtkRungeKutta45.
vtkFunctionSet* vtkInitialValueProblemSolver::FunctionSet [protected] |
Definition at line 117 of file vtkInitialValueProblemSolver.h.
double* vtkInitialValueProblemSolver::Vals [protected] |
Definition at line 119 of file vtkInitialValueProblemSolver.h.
double* vtkInitialValueProblemSolver::Derivs [protected] |
Definition at line 120 of file vtkInitialValueProblemSolver.h.
int vtkInitialValueProblemSolver::Initialized [protected] |
Definition at line 121 of file vtkInitialValueProblemSolver.h.
int vtkInitialValueProblemSolver::Adaptive [protected] |
Definition at line 122 of file vtkInitialValueProblemSolver.h.