Add a UserData parameters to vtkFunctionSet::FunctionValues

This adds a new UserData parameters to FunctionValues
so any type of data can be passed down.

Common/DataModel/vtkGenericInterpolatedVelocityField.h

@@ -63,6 +63,7 @@ public:
    */
   static vtkGenericInterpolatedVelocityField *New();
 
+  using Superclass::FunctionValues;
   /**
    * Evaluate the velocity field, f, at (x, y, z, t).
    * For now, t is ignored.

Common/Math/vtkFunctionSet.h

@@ -43,8 +43,11 @@ public:
    * x and f have to point to valid double arrays of appropriate
    * sizes obtained with GetNumberOfFunctions() and
    * GetNumberOfIndependentVariables.
+   * If you inherit this class, make sure to reimplement at least one of the two
+   * FunctionValues signatures.
    */
-  virtual int FunctionValues(double* x, double* f) = 0;
+  virtual int FunctionValues(double* x, double* f) { return this->FunctionValues(x, f, nullptr); }
+  virtual int FunctionValues(double* x, double* f, void* vtkNotUsed(userData)) { return this->FunctionValues(x, f); }
 
   /**
    * Return the number of functions. Note that this is constant for

Common/Math/vtkRungeKutta2.cxx

@@ -61,7 +61,7 @@ int vtkRungeKutta2::ComputeNextStep(double* xprev, double* dxprev, double* xnext
       this->Derivs[i] = dxprev[i];
     }
   }
-  else if (!this->FunctionSet->FunctionValues(this->Vals, this->Derivs))
+  else if ( !this->FunctionSet->FunctionValues(this->Vals, this->Derivs, userData) )
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     return OUT_OF_DOMAIN;
@@ -75,7 +75,7 @@ int vtkRungeKutta2::ComputeNextStep(double* xprev, double* dxprev, double* xnext
   this->Vals[numVals-1] = t + delT/2.0;
 
   // Obtain the derivatives at x_i + dt/2 * dx_i
-  if (!this->FunctionSet->FunctionValues(this->Vals, this->Derivs))
+  if (!this->FunctionSet->FunctionValues(this->Vals, this->Derivs, userData))
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     delTActual = delT/2.0; // we've only taken half of a time step

Common/Math/vtkRungeKutta4.cxx

@@ -97,7 +97,7 @@ int vtkRungeKutta4::ComputeNextStep(double* xprev, double* dxprev, double* xnext
       this->Derivs[i] = dxprev[i];
     }
   }
-  else if (!this->FunctionSet->FunctionValues(this->Vals, this->Derivs))
+  else if ( !this->FunctionSet->FunctionValues(this->Vals, this->Derivs, userData) )
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     return OUT_OF_DOMAIN;
@@ -110,7 +110,7 @@ int vtkRungeKutta4::ComputeNextStep(double* xprev, double* dxprev, double* xnext
   this->Vals[numVals-1] = t + delT/2.0;
 
   // 2
-  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[0]))
+  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[0], userData))
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     delTActual = delT/2.0; // we've been able to take half a step
@@ -124,7 +124,7 @@ int vtkRungeKutta4::ComputeNextStep(double* xprev, double* dxprev, double* xnext
   this->Vals[numVals-1] = t + delT/2.0;
 
   // 3
-  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[1]))
+  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[1], userData))
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     delTActual = delT/2.0; // we've been able to take half a step
@@ -138,7 +138,7 @@ int vtkRungeKutta4::ComputeNextStep(double* xprev, double* dxprev, double* xnext
   this->Vals[numVals-1] = t + delT;
 
   // 4
-  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[2]))
+  if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[2], userData))
   {
     memcpy(xnext, this->Vals, (numVals-1)*sizeof(double));
     delTActual = delT; // we've been able to take a full step but couldn't finish the algorithm

Common/Math/vtkRungeKutta45.cxx

@@ -239,7 +239,8 @@ int vtkRungeKutta45::ComputeAStep(
       this->NextDerivs[0][i] = dxprev[i];
     }
   }
-  else if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[0]))
+  else if ( !this->FunctionSet->FunctionValues(this->Vals,
+                           this->NextDerivs[0], userData))
   {
     for(i=0; i<numVals-1; i++)
     {
@@ -264,7 +265,8 @@ int vtkRungeKutta45::ComputeAStep(
     }
     this->Vals[numVals-1] = t + delT*A[i-1];
 
-    if (!this->FunctionSet->FunctionValues(this->Vals, this->NextDerivs[i]))
+    if ( !this->FunctionSet->FunctionValues(this->Vals,
+                                            this->NextDerivs[i], userData))
     {
       for(int l = 0; l < numVals - 1; l++)
       {

Filters/FlowPaths/vtkAMRInterpolatedVelocityField.h

@@ -55,6 +55,7 @@ public:
   void SetLastCellId( vtkIdType c ) override
     { this->Superclass::SetLastCellId( c ); }
 
+  using Superclass::FunctionValues;
   /**
    * Evaluate the velocity field f at point p.
    * If it succeeds, then both the last data set (this->LastDataSet) and

Filters/FlowPaths/vtkAbstractInterpolatedVelocityField.h

@@ -185,6 +185,7 @@ public:
     { this->Caching = from->Caching; }
 
 
+  using Superclass::FunctionValues;
   /**
    * Evaluate the velocity field f at point (x, y, z).
    */

Filters/FlowPaths/vtkCachingInterpolatedVelocityField.h

@@ -74,6 +74,7 @@ public:
    */
   static vtkCachingInterpolatedVelocityField *New();
 
+  using Superclass::FunctionValues;
   //@{
   /**
    * Evaluate the velocity field, f={u,v,w}, at {x, y, z}.

Filters/FlowPaths/vtkCellLocatorInterpolatedVelocityField.h

@@ -102,6 +102,7 @@ public:
    */
   void AddDataSet( vtkDataSet * dataset ) override;
 
+  using Superclass::FunctionValues;
   /**
    * Evaluate the velocity field f at point (x, y, z).
    */

Filters/FlowPaths/vtkInterpolatedVelocityField.h

@@ -79,6 +79,7 @@ public:
    */
   void AddDataSet( vtkDataSet * dataset ) override;
 
+  using Superclass::FunctionValues;
   /**
    * Evaluate the velocity field f at point (x, y, z).
    */

Filters/FlowPaths/vtkTemporalInterpolatedVelocityField.h

@@ -77,6 +77,7 @@ public:
    */
   static vtkTemporalInterpolatedVelocityField *New();
 
+  using Superclass::FunctionValues;
   //@{
   /**
    * Evaluate the velocity field, f, at (x, y, z, t).