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
vtkRungeKutta4 Class Reference

Integrate an initial value problem using 4th order Runge-Kutta method. More...

#include <vtkRungeKutta4.h>

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

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 int IsA (const char *type)
 
vtkRungeKutta4NewInstance () const
 
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)
 
- Public Member Functions inherited from vtkInitialValueProblemSolver
vtkInitialValueProblemSolverNewInstance () const
 
virtual int IsAdaptive ()
 
virtual void SetFunctionSet (vtkFunctionSet *functionset)
 
virtual vtkFunctionSetGetFunctionSet ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkRungeKutta4SafeDownCast (vtkObjectBase *o)
 
static vtkRungeKutta4New ()
 
- Static Public Member Functions inherited from vtkInitialValueProblemSolver
static int IsTypeOf (const char *type)
 
static
vtkInitialValueProblemSolver
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkRungeKutta4 ()
 
 ~vtkRungeKutta4 ()
 
virtual void Initialize ()
 
- Protected Member Functions inherited from vtkInitialValueProblemSolver
 vtkInitialValueProblemSolver ()
 
 ~vtkInitialValueProblemSolver ()
 

Protected Attributes

double * NextDerivs [3]
 
- Protected Attributes inherited from vtkInitialValueProblemSolver
vtkFunctionSetFunctionSet
 
double * Vals
 
double * Derivs
 
int Initialized
 
int Adaptive
 

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

Member Typedef Documentation

Definition at line 43 of file vtkRungeKutta4.h.

Constructor & Destructor Documentation

vtkRungeKutta4::vtkRungeKutta4 ( )
protected
vtkRungeKutta4::~vtkRungeKutta4 ( )
protected

Member Function Documentation

static int vtkRungeKutta4::IsTypeOf ( const char *  type)
static
virtual int vtkRungeKutta4::IsA ( const char *  type)
virtual

Reimplemented from vtkInitialValueProblemSolver.

static vtkRungeKutta4* vtkRungeKutta4::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRungeKutta4::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

vtkRungeKutta4* vtkRungeKutta4::NewInstance ( ) const
virtual void vtkRungeKutta4::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkInitialValueProblemSolver.

static vtkRungeKutta4* vtkRungeKutta4::New ( )
static

Construct a vtkRungeKutta4 with no initial FunctionSet.

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

virtual int vtkRungeKutta4::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+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 66 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 
)
inlinevirtual

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 76 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 ( )
protectedvirtual

Reimplemented from vtkInitialValueProblemSolver.

Member Data Documentation

double* vtkRungeKutta4::NextDerivs[3]
protected

Definition at line 96 of file vtkRungeKutta4.h.


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