Gracefully handle a simulation failure

VERSION.txt

@@ -1 +1 @@
-0.20251017.0
+0.20251022.0

src/sed/sedinstance.cpp

@@ -67,13 +67,23 @@ SedInstance::Impl::Impl(const SedDocumentPtr &pDocument)
                 }
             }
         }
+
+        // Keep track of the issues of all the tasks.
+
+        mTasksIssues = mIssues;
     } else {
         addError("The simulation experiment description does not contain any tasks to run.");
     }
 }
 
 double SedInstance::Impl::run()
 {
+    // Reset iourselves.
+
+    removeAllIssues();
+
+    mIssues = mTasksIssues;
+
     // Run all the tasks associated with this instance unless they have some issues.
 
     auto res = 0.0;
@@ -84,6 +94,10 @@ double SedInstance::Impl::run()
 
             if (task->hasIssues()) {
                 addIssues(task);
+
+                // Reset the issues of the task so that they are not reported again should the instance be run again.
+
+                task->pimpl()->removeAllIssues();
             }
         }
     }

src/sed/sedinstance_p.h

@@ -26,6 +26,7 @@ class SedInstance::Impl: public Logger::Impl
 {
 public:
     SedInstanceTaskPtrs mTasks;
+    IssuePtrs mTasksIssues;
 
     static SedInstancePtr create(const SedDocumentPtr &pDocument);
 

src/sed/sedinstancetask.cpp

@@ -161,9 +161,17 @@ void SedInstanceTask::Impl::initialise()
 #else
         mRuntime->initialiseVariablesForDifferentialModel()(mStates, mRates, mConstants, mComputedConstants, mAlgebraic);
 #endif
+    } else {
+#ifdef __EMSCRIPTEN__
+        mRuntime->initialiseVariablesForAlgebraicModel(mConstants, mComputedConstants, mAlgebraic);
+#else
+        mRuntime->initialiseVariablesForAlgebraicModel()(mConstants, mComputedConstants, mAlgebraic);
+#endif
+    }
 
-        applyChanges();
+    applyChanges();
 
+    if (mSedUniformTimeCourse != nullptr) {
 #ifdef __EMSCRIPTEN__
         mRuntime->computeComputedConstantsForDifferentialModel(mStates, mRates, mConstants, mComputedConstants, mAlgebraic);
         mRuntime->computeRates(mVoi, mStates, mRates, mConstants, mComputedConstants, mAlgebraic);
@@ -174,14 +182,6 @@ void SedInstanceTask::Impl::initialise()
         mRuntime->computeVariablesForDifferentialModel()(mVoi, mStates, mRates, mConstants, mComputedConstants, mAlgebraic);
 #endif
     } else {
-#ifdef __EMSCRIPTEN__
-        mRuntime->initialiseVariablesForAlgebraicModel(mConstants, mComputedConstants, mAlgebraic);
-#else
-        mRuntime->initialiseVariablesForAlgebraicModel()(mConstants, mComputedConstants, mAlgebraic);
-#endif
-
-        applyChanges();
-
 #ifdef __EMSCRIPTEN__
         mRuntime->computeComputedConstantsForAlgebraicModel(mConstants, mComputedConstants, mAlgebraic);
         mRuntime->computeVariablesForAlgebraicModel(mConstants, mComputedConstants, mAlgebraic);
@@ -219,7 +219,7 @@ double SedInstanceTask::Impl::run()
     auto startTime = std::chrono::high_resolution_clock::now();
 
     // (Re)initialise our model.
-    // Note: reinitialise our model in case we are running our model multiple times.
+    // Note: reinitialise our model because we initialised it when we created the instance task.
 
     initialise();
 

tests/CMakeLists.txt

@@ -38,7 +38,7 @@ include(api/sed/tests.cmake)
 include(api/solver/tests.cmake)
 include(api/version/tests.cmake)
 
-include(misc/compiler/tests.cmake)
+include(misc/tests.cmake)
 
 include(support/cellml/tests.cmake)
 include(support/combine/tests.cmake)
@@ -170,7 +170,9 @@ include_directories(${CMAKE_SOURCE_DIR}/src/misc
 
 foreach(TEST ${TESTS})
     if(LIBOPENCOR_UNIT_TESTING)
-        if(NOT "${${TEST}_CATEGORY}" STREQUAL "")
+        if("${${TEST}_CATEGORY}" STREQUAL "")
+            set(TEST_CATEGORY)
+        else()
             set(TEST_CATEGORY "${${TEST}_CATEGORY}_")
         endif()
 

tests/misc/failingsimulationtests.cpp

@@ -0,0 +1,47 @@
+/*
+Copyright libOpenCOR contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+#include "tests/utils.h"
+
+#include <libopencor>
+
+TEST(FailingSimulationTest, basic)
+{
+    // Default simulation.
+
+    auto file = libOpenCOR::File::create(libOpenCOR::resourcePath("../misc/res/tt04.omex"));
+    auto document = libOpenCOR::SedDocument::create(file);
+    auto instance = document->instantiate();
+
+    EXPECT_NE(instance->run(), 0.0);
+    EXPECT_FALSE(instance->hasIssues());
+
+    // Set the value of `membrane.test` to zero and rerun the simulation.
+
+    auto model = document->model(0);
+
+    model->addChange(libOpenCOR::SedChangeAttribute::create("membrane", "test", "0.0"));
+
+    EXPECT_EQ(instance->run(), 0.0);
+    EXPECT_TRUE(instance->hasIssues());
+
+    // Remove all changes and rerun the simulation.
+
+    model->removeAllChanges();
+
+    EXPECT_NE(instance->run(), 0.0);
+    EXPECT_FALSE(instance->hasIssues());
+}

tests/misc/compiler/tests.cmake → tests/misc/tests.cmake

@@ -12,11 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set(TEST compiler)
+set(TEST misc)
 
 list(APPEND TESTS ${TEST})
 
-set(${TEST}_CATEGORY misc)
+set(${TEST}_CATEGORY)
 set(${TEST}_SOURCE_FILES
-    ${CMAKE_CURRENT_LIST_DIR}/tests.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/compilertests.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/failingsimulationtests.cpp
 )