Solver interface: added a reinitialize() method (#1515).

Makes things cleaner for CVODES when we need to reinitialise it (when solving a DAE model; see SimulationWorker::started()).
opencor · Jan 11, 2018 · 716f191 · 716f191
1 parent 0cb02d6
commit 716f191
Show file tree

Hide file tree

Showing 13 changed files with 240 additions and 235 deletions.
diff --git a/src/plugins/solver/CVODESSolver/src/cvodessolver.cpp b/src/plugins/solver/CVODESSolver/src/cvodessolver.cpp
diff --git a/src/plugins/solver/CVODESSolver/src/cvodessolver.h b/src/plugins/solver/CVODESSolver/src/cvodessolver.h
@@ -135,10 +135,11 @@ class CvodesSolver : public OpenCOR::Solver::OdeSolver
     explicit CvodesSolver();
     ~CvodesSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
+    virtual void reinitialize(const double &pVoi);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const;
 

diff --git a/src/plugins/solver/ForwardEulerSolver/src/forwardeulersolver.cpp b/src/plugins/solver/ForwardEulerSolver/src/forwardeulersolver.cpp
@@ -37,7 +37,7 @@ ForwardEulerSolver::ForwardEulerSolver() :
 
 //==============================================================================
 
-void ForwardEulerSolver::initialize(const double &pVoiStart,
+void ForwardEulerSolver::initialize(const double &pVoi,
                                     const int &pRatesStatesCount,
                                     double *pConstants, double *pRates,
                                     double *pStates, double *pAlgebraic,
@@ -61,9 +61,9 @@ void ForwardEulerSolver::initialize(const double &pVoiStart,
 
     // Initialise the ODE solver itself
 
-    OpenCOR::Solver::OdeSolver::initialize(pVoiStart, pRatesStatesCount,
-                                           pConstants, pRates, pStates,
-                                           pAlgebraic, pComputeRates);
+    OpenCOR::Solver::OdeSolver::initialize(pVoi, pRatesStatesCount, pConstants,
+                                           pRates, pStates, pAlgebraic,
+                                           pComputeRates);
 }
 
 //==============================================================================

diff --git a/src/plugins/solver/ForwardEulerSolver/src/forwardeulersolver.h b/src/plugins/solver/ForwardEulerSolver/src/forwardeulersolver.h
@@ -49,9 +49,9 @@ class ForwardEulerSolver : public OpenCOR::Solver::OdeSolver
 public:
     explicit ForwardEulerSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const;

diff --git a/src/plugins/solver/FourthOrderRungeKuttaSolver/src/fourthorderrungekuttasolver.cpp b/src/plugins/solver/FourthOrderRungeKuttaSolver/src/fourthorderrungekuttasolver.cpp
@@ -51,7 +51,7 @@ FourthOrderRungeKuttaSolver::~FourthOrderRungeKuttaSolver()
 
 //==============================================================================
 
-void FourthOrderRungeKuttaSolver::initialize(const double &pVoiStart,
+void FourthOrderRungeKuttaSolver::initialize(const double &pVoi,
                                              const int &pRatesStatesCount,
                                              double *pConstants,
                                              double *pRates, double *pStates,
@@ -76,9 +76,9 @@ void FourthOrderRungeKuttaSolver::initialize(const double &pVoiStart,
 
     // Initialise the ODE solver itself
 
-    OpenCOR::Solver::OdeSolver::initialize(pVoiStart, pRatesStatesCount,
-                                           pConstants, pRates, pStates,
-                                           pAlgebraic, pComputeRates);
+    OpenCOR::Solver::OdeSolver::initialize(pVoi, pRatesStatesCount, pConstants,
+                                           pRates, pStates, pAlgebraic,
+                                           pComputeRates);
 
     // (Re)create our various arrays
 

diff --git a/src/plugins/solver/FourthOrderRungeKuttaSolver/src/fourthorderrungekuttasolver.h b/src/plugins/solver/FourthOrderRungeKuttaSolver/src/fourthorderrungekuttasolver.h
@@ -50,9 +50,9 @@ class FourthOrderRungeKuttaSolver : public OpenCOR::Solver::OdeSolver
     explicit FourthOrderRungeKuttaSolver();
     ~FourthOrderRungeKuttaSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const;

diff --git a/src/plugins/solver/HeunSolver/src/heunsolver.cpp b/src/plugins/solver/HeunSolver/src/heunsolver.cpp
@@ -49,9 +49,9 @@ HeunSolver::~HeunSolver()
 
 //==============================================================================
 
-void HeunSolver::initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+void HeunSolver::initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates)
 {
     // Retrieve the solver's properties
@@ -72,9 +72,9 @@ void HeunSolver::initialize(const double &pVoiStart,
 
     // Initialise the ODE solver itself
 
-    OpenCOR::Solver::OdeSolver::initialize(pVoiStart, pRatesStatesCount,
-                                           pConstants, pRates, pStates,
-                                           pAlgebraic, pComputeRates);
+    OpenCOR::Solver::OdeSolver::initialize(pVoi, pRatesStatesCount, pConstants,
+                                           pRates, pStates, pAlgebraic,
+                                           pComputeRates);
 
     // (Re)create our various arrays
 

diff --git a/src/plugins/solver/HeunSolver/src/heunsolver.h b/src/plugins/solver/HeunSolver/src/heunsolver.h
@@ -50,9 +50,9 @@ class HeunSolver : public OpenCOR::Solver::OdeSolver
     explicit HeunSolver();
     ~HeunSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const;

diff --git a/src/plugins/solver/SecondOrderRungeKuttaSolver/src/secondorderrungekuttasolver.cpp b/src/plugins/solver/SecondOrderRungeKuttaSolver/src/secondorderrungekuttasolver.cpp
@@ -47,7 +47,7 @@ SecondOrderRungeKuttaSolver::~SecondOrderRungeKuttaSolver()
 
 //==============================================================================
 
-void SecondOrderRungeKuttaSolver::initialize(const double &pVoiStart,
+void SecondOrderRungeKuttaSolver::initialize(const double &pVoi,
                                              const int &pRatesStatesCount,
                                              double *pConstants,
                                              double *pRates, double *pStates,
@@ -72,9 +72,9 @@ void SecondOrderRungeKuttaSolver::initialize(const double &pVoiStart,
 
     // Initialise the ODE solver itself
 
-    OpenCOR::Solver::OdeSolver::initialize(pVoiStart, pRatesStatesCount,
-                                           pConstants, pRates, pStates,
-                                           pAlgebraic, pComputeRates);
+    OpenCOR::Solver::OdeSolver::initialize(pVoi, pRatesStatesCount, pConstants,
+                                           pRates, pStates, pAlgebraic,
+                                           pComputeRates);
 
     // (Re)create our mYk1 array
 

diff --git a/src/plugins/solver/SecondOrderRungeKuttaSolver/src/secondorderrungekuttasolver.h b/src/plugins/solver/SecondOrderRungeKuttaSolver/src/secondorderrungekuttasolver.h
@@ -50,9 +50,9 @@ class SecondOrderRungeKuttaSolver : public OpenCOR::Solver::OdeSolver
     explicit SecondOrderRungeKuttaSolver();
     ~SecondOrderRungeKuttaSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const;

diff --git a/src/plugins/solverinterface.cpp b/src/plugins/solverinterface.cpp
@@ -55,7 +55,7 @@ extern "C" Q_DECL_EXPORT int solverInterfaceVersion()
 {
     // Version of the solver interface
 
-    return 1;
+    return 2;
 }
 
 //==============================================================================
@@ -115,12 +115,12 @@ OdeSolver::OdeSolver() :
 
 //==============================================================================
 
-void OdeSolver::initialize(const double &pVoiStart,
-                           const int &pRatesStatesCount, double *pConstants,
-                           double *pRates, double *pStates, double *pAlgebraic,
+void OdeSolver::initialize(const double &pVoi, const int &pRatesStatesCount,
+                           double *pConstants, double *pRates, double *pStates,
+                           double *pAlgebraic,
                            ComputeRatesFunction pComputeRates)
 {
-    Q_UNUSED(pVoiStart);
+    Q_UNUSED(pVoi);
 
     // Initialise the ODE solver
 
@@ -136,6 +136,15 @@ void OdeSolver::initialize(const double &pVoiStart,
 
 //==============================================================================
 
+void OdeSolver::reinitialize(const double &pVoi)
+{
+    Q_UNUSED(pVoi);
+
+    // Nothing to do by default...
+}
+
+//==============================================================================
+
 NlaSolver * nlaSolver(const QString &pRuntimeAddress)
 {
     // Return the runtime's NLA solver

diff --git a/src/plugins/solverinterface.h b/src/plugins/solverinterface.h
@@ -81,10 +81,11 @@ class OdeSolver : public Solver
 
     explicit OdeSolver();
 
-    virtual void initialize(const double &pVoiStart,
-                            const int &pRatesStatesCount, double *pConstants,
-                            double *pRates, double *pStates, double *pAlgebraic,
+    virtual void initialize(const double &pVoi, const int &pRatesStatesCount,
+                            double *pConstants, double *pRates, double *pStates,
+                            double *pAlgebraic,
                             ComputeRatesFunction pComputeRates);
+    virtual void reinitialize(const double &pVoi);
 
     virtual void solve(double &pVoi, const double &pVoiEnd) const = 0;
 

diff --git a/src/plugins/support/SimulationSupport/src/simulationworker.cpp b/src/plugins/support/SimulationSupport/src/simulationworker.cpp
@@ -288,18 +288,12 @@ void SimulationWorker::started()
         QMutex pausedMutex;
 
         forever {
-            // Reinitialise our solver, if have an NLA solver
+            // Reinitialise our solver, if we have an NLA solver
             // Note: indeed, with a solver such as CVODE, to solve an NLA system
             //       requires updating its internals...
 
-            if (nlaSolver) {
-                odeSolver->initialize(mCurrentPoint, mRuntime->statesCount(),
-                                      mSimulation->data()->constants(),
-                                      mSimulation->data()->rates(),
-                                      mSimulation->data()->states(),
-                                      mSimulation->data()->algebraic(),
-                                      mRuntime->computeRates());
-            }
+            if (nlaSolver)
+                odeSolver->reinitialize(mCurrentPoint);
 
             // Determine our next point and compute our model up to it