VTK  9.3.1
vtkRungeKutta4.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
20 #ifndef vtkRungeKutta4_h
21 #define vtkRungeKutta4_h
22 
23 #include "vtkCommonMathModule.h" // For export macro
25 
26 VTK_ABI_NAMESPACE_BEGIN
27 class VTKCOMMONMATH_EXPORT vtkRungeKutta4 : public vtkInitialValueProblemSolver
28 {
29 public:
31  void PrintSelf(ostream& os, vtkIndent indent) override;
32 
36  static vtkRungeKutta4* New();
37 
38  using Superclass::ComputeNextStep;
40 
53  int ComputeNextStep(double* xprev, double* xnext, double t, double& delT, double maxError,
54  double& error, void* userData) override
55  {
56  double minStep = delT;
57  double maxStep = delT;
58  double delTActual;
59  return this->ComputeNextStep(
60  xprev, nullptr, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
61  }
62  int ComputeNextStep(double* xprev, double* dxprev, double* xnext, double t, double& delT,
63  double maxError, double& error, void* userData) override
64  {
65  double minStep = delT;
66  double maxStep = delT;
67  double delTActual;
68  return this->ComputeNextStep(
69  xprev, dxprev, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
70  }
71  int ComputeNextStep(double* xprev, double* xnext, double t, double& delT, double& delTActual,
72  double minStep, double maxStep, double maxError, double& error, void* userData) override
73  {
74  return this->ComputeNextStep(
75  xprev, nullptr, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
76  }
77  int ComputeNextStep(double* xprev, double* dxprev, double* xnext, double t, double& delT,
78  double& delTActual, double minStep, double maxStep, double maxError, double& error,
79  void* userData) override;
81 
82 protected:
84  ~vtkRungeKutta4() override;
85 
86  void Initialize() override;
87 
88  double* NextDerivs[3];
89 
90 private:
91  vtkRungeKutta4(const vtkRungeKutta4&) = delete;
92  void operator=(const vtkRungeKutta4&) = delete;
93 };
94 
95 VTK_ABI_NAMESPACE_END
96 #endif
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...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int ComputeNextStep(double *xprev, double *xnext, double t, double &delT, double maxError, double &error, void *userData) override
Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of...
int ComputeNextStep(double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double maxError, double &error, void *userData) override
Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of...
a simple class to control print indentation
Definition: vtkIndent.h:28
Integrate an initial value problem using 4th order Runge-Kutta method.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
int ComputeNextStep(double *xprev, double *dxprev, double *xnext, double t, double &delT, double maxError, double &error, void *userData) override
Given initial values, xprev , initial time, t and a requested time interval, delT calculate values of...
Integrate a set of ordinary differential equations (initial value problem) in time.