@abi-software/simulationvuer 1.0.0 → 2.0.0

package/src/components/SimulationVuerInput.vue

@@ -13,7 +13,7 @@
 
 <script>
 import { ElInputNumber, ElOption, ElSelect, ElSlider } from "element-plus";
-import { updateUi } from "./ui.js";
+import { updateUi } from "./common.js";
 
 export default {
   name: "SimulationVuerInput",

package/src/components/common.js

@@ -1,31 +1,70 @@
-export const OPENCOR_SOLVER_NAME = "simcore/services/comp/opencor";
-
-function doEvaluateValue(value, from, to) {
-  if (from !== undefined) {
-    let re = new RegExp(`\\b${ from }\\b`, 'g');
+import { create, all } from "mathjs";
 
-    value = value.replace(re, to);
-  }
+const math = create(all, {});
 
-  return value;
-}
+export const OPENCOR_SOLVER_NAME = "simcore/services/comp/opencor";
 
 export function evaluateValue(parent, value) {
   let index = -1;
+  const parser = new math.parser();
 
   parent.simulationUiInfo.input.forEach((input) => {
     ++index;
 
-    value = doEvaluateValue(value, input.id, parent.$refs.simInput[index].vModel);
+    parser.set(input.id, parent.$refs.simInput[index].vModel);
   });
 
-  return Function("return " + value + ";")();
+  return parser.evaluate(value);
 }
 
-export function evaluateSimulationValue(parent, results, value, i) {
-  parent.simulationUiInfo.output.data.forEach((data) => {
-    value = doEvaluateValue(value, data.id, results[parent.simulationDataId[data.id]][i]);
+export function updateUi(parent) {
+  // Show/hide and enable/disable all the elements.
+
+  parent.$nextTick(() => {
+    let index = -1;
+
+    parent.simulationUiInfo.input.forEach((input) => {
+      ++index;
+
+      parent.$refs.simInput[index].visible = (input.visible === undefined) ? true : evaluateValue(parent, input.visible);
+    });
+
+    if (parent.libopencor !== undefined) {
+      parent.userMessage = "Rerunning the model...";
+      parent.showUserMessage = true;
+
+      parent.$nextTick(() => {
+        parent.runSimulation();
+      });
+    }
   });
+}
+
+export function finaliseUi(parent) {
+  // Finalise our UI, but only if we haven't already done so, we are mounted,
+  // and we have some valid simulation UI information.
+
+  if (!parent.hasFinalisedUi && parent.isMounted && parent.hasValidSimulationUiInfo) {
+    // Configure the PlotVuer's.
+
+    parent.$refs.output.classList.add("x" + parent.simulationUiInfo.output.plots.length);
+
+    // Initialise the simulation results.
 
-  return Function("return " + value + ";")();
+    let index = -1;
+
+    parent.simulationUiInfo.output.plots.forEach(() => {
+      parent.simulationResults[++index] = [{
+        x: [],
+        y: [],
+        type: "scatter",
+      }];
+    });
+
+    // Make sure that our UI is up to date.
+
+    updateUi(parent);
+
+    parent.hasFinalisedUi = true;
+  }
 }

package/src/components/json.js

@@ -1,11 +1,11 @@
 import { Validator } from "jsonschema";
 import { OPENCOR_SOLVER_NAME } from "./common.js";
 
-export function validJson(json) {
+export function validJson(json, simulationInfoNeeded) {
   // Check the JSON against our schema.
 
-  let validator = new Validator();
-  let schema = {
+  const validator = new Validator();
+  const schema = {
     additionalProperties: false,
     properties: {
       input: {
@@ -214,14 +214,14 @@ export function validJson(json) {
             type: "array",
           },
         },
-        required: true,
+        required: simulationInfoNeeded,
         type: "object",
       },
     },
     type: "object",
   };
 
-  let result = validator.validate(json, schema, { nestedErrors: true });
+  const result = validator.validate(json, schema, { nestedErrors: true });
 
   if (!result.valid) {
     console.warn(result.toString());
@@ -231,8 +231,8 @@ export function validJson(json) {
 
   // Make sure that the input information makes sense.
 
-  let inputIdUsed = [];
-  let inputValid = json.input.every((input) => {
+  const inputIdUsed = {};
+  const inputValid = json.input.every((input) => {
     if (input.id !== undefined) {
       if (input.id === "") {
         console.warn("JSON: the input id must not be empty.");
@@ -240,7 +240,7 @@ export function validJson(json) {
         return false;
       }
 
-      if (inputIdUsed[input.id]) {
+      if (inputIdUsed[input.id] !== undefined) {
         console.warn("JSON: the input id must be unique (" + input.id + " is used more than once).");
 
         return false;
@@ -268,13 +268,13 @@ export function validJson(json) {
         return false;
       }
 
-      let values = input.possibleValues.map((value) => {
+      const values = input.possibleValues.map((value) => {
         return value.value;
       });
-      let valueUsed = [];
+      const valueUsed = {};
 
       if (!values.every((value) => {
-        if (valueUsed[value]) {
+        if (valueUsed[value] !== undefined) {
           console.warn("JSON: an input possible value must have a unique value (" + value + " is used more than once).");
 
           return false;
@@ -307,7 +307,7 @@ export function validJson(json) {
         return false;
       }
 
-      let range = input.maximumValue - input.minimumValue;
+      const range = input.maximumValue - input.minimumValue;
 
       if (input.stepValue !== undefined) {
         if ((input.stepValue <= 0) || (input.stepValue > range)) {
@@ -347,8 +347,8 @@ export function validJson(json) {
 
   // Make sure that the output information makes sense.
 
-  let outputIdUsed = [];
-  let outputDataValid = json.output.data.every((outputData) => {
+  const outputIdUsed = {};
+  const outputDataValid = json.output.data.every((outputData) => {
     if (outputData.id !== undefined) {
       if (outputData.id === "") {
         console.warn("JSON: the output data id must not be empty.");
@@ -356,7 +356,7 @@ export function validJson(json) {
         return false;
       }
 
-      if (outputIdUsed[outputData.id]) {
+      if (outputIdUsed[outputData.id] !== undefined) {
         console.warn("JSON: the output data id must be unique (" + outputData.id + " is used more than once).");
 
         return false;
@@ -378,7 +378,7 @@ export function validJson(json) {
     return false;
   }
 
-  let outputPlotsValid = json.output.plots.every((outputPlot) => {
+  const outputPlotsValid = json.output.plots.every((outputPlot) => {
     if (outputPlot.xAxisTitle === "") {
       console.warn("JSON: the output plot X axis title must not be empty.");
 
@@ -413,7 +413,7 @@ export function validJson(json) {
   // Make sure that the parameters information makes sense.
 
   if (json.parameters !== undefined) {
-    let parametersValid = json.parameters.every((parameter) => {
+    const parametersValid = json.parameters.every((parameter) => {
       if (parameter.name === "") {
         console.warn("JSON: the parameter name must not be empty.");
 
@@ -436,85 +436,87 @@ export function validJson(json) {
 
   // Make sure that the simulation information makes sense.
 
-  let needOpencorSettings = false;
+  if (simulationInfoNeeded) {
+    let needOpencorSettings = false;
 
-  if (!json.simulation.solvers.every((solver) => {
-    if (solver.if !== undefined) {
-      if (solver.if === "") {
-        console.warn("JSON: a simulation solver if must not be empty.");
+    if (!json.simulation.solvers.every((solver) => {
+      if (solver.if !== undefined) {
+        if (solver.if === "") {
+          console.warn("JSON: a simulation solver if must not be empty.");
 
-        return false;
+          return false;
+        }
       }
-    }
 
-    if (solver.input !== undefined) {
-      if (solver.input.name === "") {
-        console.warn("JSON: a simulation solver input name must not be empty.");
+      if (solver.input !== undefined) {
+        if (solver.input.name === "") {
+          console.warn("JSON: a simulation solver input name must not be empty.");
 
-        return false;
+          return false;
+        }
+
+        if (solver.input.value === "") {
+          console.warn("JSON: a simulation solver input value must not be empty.");
+
+          return false;
+        }
       }
 
-      if (solver.input.value === "") {
-        console.warn("JSON: a simulation solver input value must not be empty.");
+      if (solver.name === "") {
+        console.warn("JSON: a simulation solver name must not be empty.");
 
         return false;
       }
-    }
 
-    if (solver.name === "") {
-      console.warn("JSON: a simulation solver name must not be empty.");
+      needOpencorSettings = needOpencorSettings || (solver.name === OPENCOR_SOLVER_NAME);
 
-      return false;
-    }
-
-    needOpencorSettings = needOpencorSettings || (solver.name === OPENCOR_SOLVER_NAME);
+      if (solver.version === "") {
+        console.warn("JSON: a simulation solver version must not be empty.");
 
-    if (solver.version === "") {
-      console.warn("JSON: a simulation solver version must not be empty.");
+        return false;
+      }
 
+      return true;
+    })) {
       return false;
     }
 
-    return true;
-  })) {
-    return false;
-  }
+    if (needOpencorSettings && (json.simulation.opencor === undefined)) {
+      console.warn("JSON: the simulation solver for OpenCOR is specified so simulation OpenCOR settings must also be specified.");
 
-  if (needOpencorSettings && (json.simulation.opencor === undefined)) {
-    console.warn("JSON: the simulation solver for OpenCOR is specified so simulation OpenCOR settings must also be specified.");
+      return false;
+    }
 
-    return false;
-  }
+    if (json.simulation.opencor !== undefined) {
+      if (json.simulation.opencor.resource === "") {
+        console.warn("JSON: the simulation OpenCOR resource must not be empty.");
 
-  if (json.simulation.opencor !== undefined) {
-    if (json.simulation.opencor.resource === "") {
-      console.warn("JSON: the simulation OpenCOR resource must not be empty.");
+        return false;
+      }
 
-      return false;
-    }
+      if (json.simulation.opencor.endingPoint !== undefined) {
+        if (json.simulation.opencor.pointInterval !== undefined) {
+          if (json.simulation.opencor.endingPoint <= 0.0) {
+            console.warn("JSON: the simulation OpenCOR ending point (" + json.simulation.opencor.endingPoint + ") must be greater than zero.");
 
-    if (json.simulation.opencor.endingPoint !== undefined) {
-      if (json.simulation.opencor.pointInterval !== undefined) {
-        if (json.simulation.opencor.endingPoint <= 0.0) {
-          console.warn("JSON: the simulation OpenCOR ending point (" + json.simulation.opencor.endingPoint + ") must be greater than zero.");
+            return false;
+          }
 
-          return false;
-        }
+          if (json.simulation.opencor.pointInterval <= 0.0) {
+            console.warn("JSON: the simulation OpenCOR point interval (" + json.simulation.opencor.pointInterval + ") must be greater than zero.");
 
-        if (json.simulation.opencor.pointInterval <= 0.0) {
-          console.warn("JSON: the simulation OpenCOR point interval (" + json.simulation.opencor.pointInterval + ") must be greater than zero.");
+            return false;
+          }
+        } else {
+          console.warn("JSON: a simulation OpenCOR ending point is specified so a simulation OpenCOR point interval must also be specified.");
 
           return false;
         }
-      } else {
-        console.warn("JSON: a simulation OpenCOR ending point is specified so a simulation OpenCOR point interval must also be specified.");
+      } else if (json.simulation.opencor.pointInterval !== undefined) {
+        console.warn("JSON: a simulation OpenCOR point interval is specified so a simulation OpenCOR ending point must also be specified.");
 
         return false;
       }
-    } else if (json.simulation.opencor.pointInterval !== undefined) {
-      console.warn("JSON: a simulation OpenCOR point interval is specified so a simulation OpenCOR ending point must also be specified.");
-
-      return false;
     }
   }