vtkInitialValueProblemSolver.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkInitialValueProblemSolver_h
#define vtkInitialValueProblemSolver_h
 
#include "vtkCommonMathModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkFunctionSet;
 
class VTKCOMMONMATH_EXPORT vtkInitialValueProblemSolver : public vtkObject
{
public:
  vtkTypeMacro(vtkInitialValueProblemSolver, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual int ComputeNextStep(
    double* xprev, double* xnext, double t, double& delT, double maxError, double& error)
  {
    return this->ComputeNextStep(xprev, xnext, t, delT, maxError, error, nullptr);
  }
 
  virtual int ComputeNextStep(double* xprev, double* xnext, double t, double& delT, double maxError,
    double& error, void* userData)
  {
    double minStep = delT;
    double maxStep = delT;
    double delTActual;
    return this->ComputeNextStep(
      xprev, nullptr, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
  }
 
  virtual int ComputeNextStep(double* xprev, double* dxprev, double* xnext, double t, double& delT,
    double maxError, double& error)
  {
    return this->ComputeNextStep(xprev, dxprev, xnext, t, delT, maxError, error, nullptr);
  }
 
  virtual int ComputeNextStep(double* xprev, double* dxprev, double* xnext, double t, double& delT,
    double maxError, double& error, void* userData)
  {
    double minStep = delT;
    double maxStep = delT;
    double delTActual;
    return this->ComputeNextStep(
      xprev, dxprev, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
  }
  virtual int ComputeNextStep(double* xprev, double* xnext, double t, double& delT,
    double& delTActual, double minStep, double maxStep, double maxError, double& error)
  {
    return this->ComputeNextStep(
      xprev, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, nullptr);
  }
 
  virtual int ComputeNextStep(double* xprev, double* xnext, double t, double& delT,
    double& delTActual, double minStep, double maxStep, double maxError, double& error,
    void* userData)
  {
    return this->ComputeNextStep(
      xprev, nullptr, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, userData);
  }
 
  virtual int ComputeNextStep(double* xprev, double* dxprev, double* xnext, double t, double& delT,
    double& delTActual, double minStep, double maxStep, double maxError, double& error)
  {
    return this->ComputeNextStep(
      xprev, dxprev, xnext, t, delT, delTActual, minStep, maxStep, maxError, error, nullptr);
  }
 
  virtual int ComputeNextStep(double* vtkNotUsed(xprev), double* vtkNotUsed(dxprev),
    double* vtkNotUsed(xnext), double vtkNotUsed(t), double& vtkNotUsed(delT),
    double& vtkNotUsed(delTActual), double vtkNotUsed(minStep), double vtkNotUsed(maxStep),
    double vtkNotUsed(maxError), double& vtkNotUsed(error), void* vtkNotUsed(userData))
  {
    return 0;
  }
 
 
  virtual void SetFunctionSet(vtkFunctionSet* fset);
  vtkGetObjectMacro(FunctionSet, vtkFunctionSet);
 
  virtual vtkTypeBool IsAdaptive() { return this->Adaptive; }
 
  enum ErrorCodes
  {
    OUT_OF_DOMAIN = 1,
    NOT_INITIALIZED = 2,
    UNEXPECTED_VALUE = 3
  };
 
protected:
  vtkInitialValueProblemSolver();
  ~vtkInitialValueProblemSolver() override;
 
  virtual void Initialize();
 
  vtkFunctionSet* FunctionSet;
 
  double* Vals;
  double* Derivs;
  int Initialized;
  vtkTypeBool Adaptive;
 
private:
  vtkInitialValueProblemSolver(const vtkInitialValueProblemSolver&) = delete;
  void operator=(const vtkInitialValueProblemSolver&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif