vtkRungeKutta4 Class Reference

#include <vtkRungeKutta4.h>

Inheritance diagram for vtkRungeKutta4:

Inheritance graph
[legend]
Collaboration diagram for vtkRungeKutta4:

Collaboration graph
[legend]

List of all members.


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


Public Types

typedef
vtkInitialValueProblemSolver 
Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkRungeKutta4SafeDownCast (vtkObject *o)
static vtkRungeKutta4New ()

Protected Member Functions

 vtkRungeKutta4 ()
 ~vtkRungeKutta4 ()
virtual void Initialize ()

Protected Attributes

double * NextDerivs [3]

Member Typedef Documentation

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 42 of file vtkRungeKutta4.h.


Constructor & Destructor Documentation

vtkRungeKutta4::vtkRungeKutta4 (  )  [protected]

vtkRungeKutta4::~vtkRungeKutta4 (  )  [protected]


Member Function Documentation

virtual const char* vtkRungeKutta4::GetClassName (  )  [virtual]

Reimplemented from vtkInitialValueProblemSolver.

static int vtkRungeKutta4::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 vtkInitialValueProblemSolver.

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 ( vtkObject o  )  [static]

Reimplemented from vtkInitialValueProblemSolver.

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.

Reimplemented from vtkObject.

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

virtual int vtkRungeKutta4::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+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 65 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 
) [inline, 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

Reimplemented from vtkInitialValueProblemSolver.

Definition at line 75 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 (  )  [protected, virtual]

Reimplemented from vtkInitialValueProblemSolver.


Member Data Documentation

double* vtkRungeKutta4::NextDerivs[3] [protected]

Definition at line 95 of file vtkRungeKutta4.h.


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

Generated on Wed Aug 24 12:04:35 2011 for VTK by  doxygen 1.5.6