Merge pull request 'Recirculation Integration' (#4) from recirculation-integration into main

Reviewed-on: #4

reactor.html

@@ -1,19 +1,9 @@
-<!--
-| S88-niveau             | Primair (blokkleur) | Tekstkleur |
-| ---------------------- | ------------------- | ---------- |
-| **Area**               | `#0f52a5`           | wit        |
-| **Process Cell**       | `#0c99d9`           | wit        |
-| **Unit**               | `#50a8d9`           | zwart      |
-| **Equipment (Module)** | `#86bbdd`           | zwart      |
-| **Control Module**     | `#a9daee`           | zwart      |
-
--->
 <script src="/reactor/menu.js"></script>
 
 <script type="text/javascript">
     RED.nodes.registerType("reactor", {
-        category: "EVOLV",
+        category: "WWTP",
-        color: "#50a8d9",
+        color: "#c4cce0",
         defaults: {
             name: { value: "" },
             reactor_type: { value: "CSTR", required: true },
@@ -21,7 +11,6 @@
             length: { value: 0.},
             resolution_L: { value: 0.},
             alpha: {value: 0},
-            n_inlets: { value: 1, required: true},
             kla: { value: null },
             
             S_O_init: { value: 0., required: true },
@@ -49,7 +38,7 @@
         outputs: 3,
         inputLabels: ["input"],
         outputLabels: ["process", "dbase", "parent"],
-        icon: "font-awesome/fa-flask",
+        icon: "font-awesome/fa-recycle",
         label: function() {
             return this.name || "Reactor";
         },
@@ -68,10 +57,6 @@
                 type:"num",
                 types:["num"]
             });
-            $("#node-input-n_inlets").typedInput({
-                type:"num",
-                types:["num"]
-            });
             $("#node-input-length").typedInput({
                 type:"num",
                 types:["num"]
@@ -138,10 +123,6 @@
             if (isNaN(volume) || volume <= 0) {
                 RED.notify("Fluid volume not set correctly", {type: "error"});
             }
-            let n_inlets = parseInt($("#node-input-n_inlets").typedInput("value"));
-            if (isNaN(n_inlets) || n_inlets < 1) {
-                RED.notify("Number of inlets not set correctly", {type: "error"});
-            }
         }
     });
 </script>
@@ -175,10 +156,6 @@
             <input type="text" id="node-input-alpha">
         </div>
     </div>
-    <div class="form-row">
-        <label for="node-input-n_inlets"><i class="fa fa-tag"></i> Number of inlets</label>
-        <input type="text" id="node-input-n_inlets" placeholder="#">
-    </div>
     <h3> Internal mass transfer calculation (optional) </h3>
     <div class="form-row">
         <label for="node-input-kla"><i class="fa fa-tag"></i> kLa [d-1]</label>

src/nodeClass.js

@@ -88,7 +88,6 @@ class nodeClass {
             length: parseFloat(uiConfig.length),
             resolution_L: parseInt(uiConfig.resolution_L),
             alpha: parseFloat(uiConfig.alpha),
-            n_inlets: parseInt(uiConfig.n_inlets),
             kla: parseFloat(uiConfig.kla),
             initialState: [
                 parseFloat(uiConfig.S_O_init),

src/specificClass.js

@@ -1,5 +1,5 @@
 const ASM3 = require('./reaction_modules/asm3_class.js');
-const { create, all, isArray } = require('mathjs');
+const { create, all, isArray, i } = require('mathjs');
 const { assertNoNaN } = require('./utils.js');
 const { childRegistrationUtils, logger, MeasurementContainer } = require('generalFunctions');
 const EventEmitter = require('events');
@@ -12,7 +12,9 @@ const math = create(all, mathConfig);
 
 const S_O_INDEX = 0;
 const NUM_SPECIES = 13;
+const BC_PADDING = 2;
 const DEBUG = false;
+const DAY2MS = 1000 * 60 * 60 * 24;
 
 class Reactor {
   /**
@@ -28,12 +30,16 @@ class Reactor {
     this.upstreamReactor = null;
     this.childRegistrationUtils = new childRegistrationUtils(this); // Child registration utility
 
+    this.upstreamReactor = null;
+    this.downstreamReactor = null;
+    this.returnPump = null;
+
     this.asm = new ASM3();
 
     this.volume = config.volume; // fluid volume reactor [m3]
 
-    this.Fs = Array(config.n_inlets).fill(0); // fluid debits per inlet [m3 d-1]
+    this.Fs = [0]; // fluid debits per inlet [m3 d-1]
-    this.Cs_in = Array.from(Array(config.n_inlets), () => new Array(NUM_SPECIES).fill(0)); // composition influents
+    this.Cs_in = [Array(NUM_SPECIES).fill(0)]; // composition influents
     this.OTR = 0.0; // oxygen transfer rate [g O2 d-1 m-3]
     this.temperature = 20; // temperature [C]
 
@@ -41,7 +47,7 @@ class Reactor {
 
     this.currentTime = Date.now(); // milliseconds since epoch [ms]
     this.timeStep = 1 / (24*60*60) * this.config.timeStep; // time step in seconds, converted to days.
-    this.speedUpFactor = 60; // speed up factor for simulation, 60 means 1 minute per simulated second
+    this.speedUpFactor = 100; // speed up factor for simulation, 60 means 1 minute per simulated second
   }
 
   /**
@@ -49,9 +55,15 @@ class Reactor {
    * @param {object} input - Input object (msg) containing payload with inlet index, flow rate, and concentrations.
   */
   set setInfluent(input) {
-    let index_in = input.payload.inlet;
+    const i_in = input.payload.inlet;
-    this.Fs[index_in] = input.payload.F;
+    if (this.Fs.length <= i_in) {
-    this.Cs_in[index_in] = input.payload.C;
+      this.logger.debug(`Adding new inlet index ${i_in}.`);
+      this.Fs.push(0);
+      this.Cs_in.push(Array(NUM_SPECIES).fill(0));
+      this.setInfluent = input;
+    }
+    this.Fs[i_in] = input.payload.F;
+    this.Cs_in[i_in] = input.payload.C;
   }
 
   /**
@@ -67,10 +79,17 @@ class Reactor {
    * @returns {object} Effluent data object (msg), defaults to inlet 0.
    */
   get getEffluent() { // getter for Effluent, defaults to inlet 0
-    if (isArray(this.state.at(-1))) {
+    const Cs = isArray(this.state.at(-1)) ? this.state.at(-1) : this.state;
-      return { topic: "Fluent", payload: { inlet: 0, F: math.sum(this.Fs), C: this.state.at(-1) }, timestamp: this.currentTime };
+    const effluent = [{ topic: "Fluent", payload: { inlet: 0, F: math.sum(this.Fs), C: Cs }, timestamp: this.currentTime }];
+    if (this.returnPump) {
+      const recirculationFlow = this.returnPump.measurements.type("flow").variant("measured").position("atEquipment").getCurrentValue();
+      // constrain flow to prevent negatives
+      const F_main = Math.max(effluent[0].payload.F - recirculationFlow, 0);
+      const F_sidestream = effluent[0].payload.F < recirculationFlow ? effluent[0].payload.F : recirculationFlow;
+      effluent[0].payload.F = F_main;
+      effluent.push({ topic: "Fluent", payload: { inlet: 1, F: F_sidestream, C: Cs }, timestamp: this.currentTime });
     }
-    return { topic: "Fluent", payload: { inlet: 0, F: math.sum(this.Fs), C: this.state }, timestamp: this.currentTime };
+    return effluent;
   }
 
   /**
@@ -98,39 +117,37 @@ class Reactor {
   }
 
   registerChild(child, softwareType) {
+    if(!child) {
+      this.logger.error(`Invalid ${softwareType} child provided.`);
+      return;
+    }
+
     switch (softwareType) {
       case "measurement":
-        this.logger.debug(`Registering measurement child.`);
+        this.logger.debug(`Registering measurement child...`);
         this._connectMeasurement(child);
         break;
       case "reactor":
-        this.logger.debug(`Registering reactor child.`);
+        this.logger.debug(`Registering reactor child...`);
         this._connectReactor(child);
         break;
+      case "machine":
+        this.logger.debug(`Registering machine child...`);
+        this._connectMachine(child);
+        break;
 
       default:
         this.logger.error(`Unrecognized softwareType: ${softwareType}`);
     }
   }
 
-  _connectMeasurement(measurement) {
+  _connectMeasurement(measurementChild) {
-    if (!measurement) {
+    const position = measurementChild.config.functionality.positionVsParent;
-      this.logger.warn("Invalid measurement provided.");
+    const measurementType = measurementChild.config.asset.type;
-      return;
-    }
-
-    let position;
-    if (measurement.config.functionality.distance !== 'undefined') {
-      position = measurement.config.functionality.distance;
-    } else {
-      position = measurement.config.functionality.positionVsParent;
-    }
-    const measurementType = measurement.config.asset.type;
-    const key = `${measurementType}_${position}`;
     const eventName = `${measurementType}.measured.${position}`;
 
     // Register event listener for measurement updates
-    measurement.measurements.emitter.on(eventName, (eventData) => {
+    measurementChild.measurements.emitter.on(eventName, (eventData) => {
       this.logger.debug(`${position} ${measurementType} from ${eventData.childName}: ${eventData.value} ${eventData.unit}`);
 
       // Store directly in parent's measurement container
@@ -145,20 +162,31 @@ class Reactor {
   }
 
 
-  _connectReactor(reactor) {
+  _connectReactor(reactorChild) {
-    if (!reactor) {
+    if (reactorChild.config.functionality.positionVsParent != "upstream") {
-      this.logger.warn("Invalid reactor provided.");
+      this.logger.warn("Reactor children of reactors should always be upstream.");
-      return;
     }
 
-    this.upstreamReactor = reactor;
+    if (math.abs(reactorChild.d_x - this.d_x) / this.d_x < 0.025) {
+      this.logger.warn("Significant grid sizing discrepancies between adjacent reactors! Change resolutions to match reactors grid step, or implement boundary value interpolation.");
+    }
 
-    reactor.emitter.on("stateChange", (data) => {
+    // set upstream and downstream reactor variable in current and child nodes respectively for easy access
+    this.upstreamReactor = reactorChild;
+    reactorChild.downstreamReactor = this;
+
+    reactorChild.emitter.on("stateChange", (eventData) => {
       this.logger.debug(`State change of upstream reactor detected.`);
-      this.updateState(data);
+      this.updateState(eventData);
     });
   }
 
+  _connectMachine(machineChild) {
+    if (machineChild.config.functionality.positionVsParent == "downstream") {
+      machineChild.upstreamSource = this;
+      this.returnPump = machineChild;
+    }
+  }
   
   _updateMeasurement(measurementType, value, position, context) {
     this.logger.debug(`---------------------- updating ${measurementType} ------------------ `);
@@ -179,20 +207,18 @@ class Reactor {
    * @param {number} newTime - New time to update reactor state to, in milliseconds since epoch.
    */
   updateState(newTime = Date.now()) { // expect update with timestamp
-    const day2ms = 1000 * 60 * 60 * 24;
-
     if (this.upstreamReactor) {
-      this.setInfluent = this.upstreamReactor.getEffluent;
+      this.setInfluent = this.upstreamReactor.getEffluent[0]; // grab main effluent upstream reactor
     }
 
-    let n_iter = Math.floor(this.speedUpFactor * (newTime-this.currentTime) / (this.timeStep*day2ms));
+    let n_iter = Math.floor(this.speedUpFactor * (newTime-this.currentTime) / (this.timeStep*DAY2MS));
     if (n_iter) {
       let n = 0;
       while (n < n_iter) {
         this.tick(this.timeStep);
         n += 1;
       }
-      this.currentTime += n_iter * this.timeStep * day2ms / this.speedUpFactor;
+      this.currentTime += n_iter * this.timeStep * DAY2MS / this.speedUpFactor;
       this.emitter.emit("stateChange", this.currentTime);
     }
   }
@@ -246,11 +272,15 @@ class Reactor_PFR extends Reactor {
 
     this.alpha = config.alpha;
 
-    this.state = Array.from(Array(this.n_x), () => config.initialState.slice())
+    this.state = Array.from(Array(this.n_x), () => config.initialState.slice());
+    this.extendedState = Array.from(Array(this.n_x + 2*BC_PADDING), () => new Array(NUM_SPECIES).fill(0));
+
+    // initialise extended state
+    this.state.forEach((row, i) => this.extendedState[i+BC_PADDING] = row);
 
     this.D = 0.0; // axial dispersion [m2 d-1]
 
-    this.D_op = this._makeDoperator(true, true);
+    this.D_op = this._makeDoperator();
     assertNoNaN(this.D_op, "Derivative operator");
 
     this.D2_op = this._makeD2operator();
@@ -262,15 +292,16 @@ class Reactor_PFR extends Reactor {
    * @param {object} input - Input object (msg) containing payload with dispersion value [m2 d-1].
    */
   set setDispersion(input) {
-    this.D = input.payload;
+    this.D = this._constrainDispersion(input.payload);
   }
 
   updateState(newTime) {
     super.updateState(newTime);
-    let Pe_local = this.d_x*math.sum(this.Fs)/(this.D*this.A)
+    // let Pe_local = this.d_x*math.sum(this.Fs)/(this.D*this.A)
+    this.D = this._constrainDispersion(this.D);
     let Co_D = this.D*this.timeStep/(this.d_x*this.d_x);
 
-    (Pe_local >= 2) && this.logger.warn(`Local Péclet number (${Pe_local}) is too high! Increase reactor resolution.`);
+    // (Pe_local >= 2) && this.logger.warn(`Local Péclet number (${Pe_local}) is too high! Increase reactor resolution.`);
     (Co_D >= 0.5) && this.logger.warn(`Courant number (${Co_D}) is too high! Reduce time step size.`);
 
     if(DEBUG) {
@@ -288,25 +319,26 @@ class Reactor_PFR extends Reactor {
    * @returns {Array} - New reactor state.
    */
   tick(time_step) {
-    const dispersion = math.multiply(this.D / (this.d_x*this.d_x), this.D2_op, this.state);
+    this._applyBoundaryConditions();
-    const advection = math.multiply(-1 * math.sum(this.Fs) / (this.A*this.d_x), this.D_op, this.state);
+
-    const reaction = this.state.map((state_slice) => this.asm.compute_dC(state_slice, this.temperature));
+    const dispersion = math.multiply(this.D / (this.d_x*this.d_x), this.D2_op, this.extendedState);
-    const transfer = Array.from(Array(this.n_x), () => new Array(NUM_SPECIES).fill(0));
+    const advection = math.multiply(-1 * math.sum(this.Fs) / (this.A*this.d_x), this.D_op, this.extendedState);
+    const reaction = this.extendedState.map((state_slice) => this.asm.compute_dC(state_slice, this.temperature));
+    const transfer = Array.from(Array(this.n_x+2*BC_PADDING), () => new Array(NUM_SPECIES).fill(0));
 
     if (isNaN(this.kla)) { // calculate OTR if kla is not NaN, otherwise use externally calculated OTR
-      for (let i = 1; i < this.n_x - 1; i++) {
+      for (let i = BC_PADDING+1; i < BC_PADDING+this.n_x - 1; i++) {
         transfer[i][S_O_INDEX] = this.OTR * this.n_x/(this.n_x-2);
       }
     } else {
-    for (let i = 1; i < this.n_x - 1; i++) {
+    for (let i = BC_PADDING+1; i < BC_PADDING+this.n_x - 1; i++) {
-        transfer[i][S_O_INDEX] = this._calcOTR(this.state[i][S_O_INDEX], this.temperature)  * this.n_x/(this.n_x-2);
+        transfer[i][S_O_INDEX] = this._calcOTR(this.extendedState[i][S_O_INDEX], this.temperature)  * this.n_x/(this.n_x-2);
       }
     }
 
-    const dC_total = math.multiply(math.add(dispersion, advection, reaction, transfer), time_step);
+    const dC_total = math.multiply(math.add(dispersion, advection, reaction, transfer).slice(BC_PADDING, this.n_x+BC_PADDING), time_step);
 
     const stateNew = math.add(this.state, dC_total);
-    this._applyBoundaryConditions(stateNew);
 
     if (DEBUG) {
       assertNoNaN(dispersion, "dispersion");
@@ -317,13 +349,14 @@ class Reactor_PFR extends Reactor {
     }
 
     this.state = this._arrayClip2Zero(stateNew);
+    this.state.forEach((row, i) => this.extendedState[i+BC_PADDING] = row);
     return stateNew;
   }
 
   _updateMeasurement(measurementType, value, position, context) {
     switch(measurementType) {
       case "quantity (oxygen)":
-        let grid_pos = Math.round(position / this.config.length * this.n_x);
+        let grid_pos = Math.round(context.distance / this.config.length * this.n_x);
         this.state[grid_pos][S_O_INDEX] = value; // naive approach for reconciling measurements and simulation
         break;
       default:
@@ -335,57 +368,51 @@ class Reactor_PFR extends Reactor {
    * Apply boundary conditions to the reactor state.
    *  for inlet, apply generalised Danckwerts BC, if there is not flow, apply Neumann BC with no flux
    *  for outlet, apply regular Danckwerts BC (Neumann BC with no flux)
-   * @param {Array} state - Current reactor state without enforced BCs.
    */
-  _applyBoundaryConditions(state) {
+  _applyBoundaryConditions() {
-    if (math.sum(this.Fs) > 0) { // Danckwerts BC
+    if (this.upstreamReactor) {
-      const BC_C_in = math.multiply(1 / math.sum(this.Fs), [this.Fs], this.Cs_in)[0];
+      for (let i = 0; i < BC_PADDING; i++) {
-      const BC_dispersion_term = (1-this.alpha)*this.D*this.A/(math.sum(this.Fs)*this.d_x);
+        this.extendedState[i] = this.upstreamReactor.state.at(i-BC_PADDING);
-      state[0] = math.multiply(1/(1+BC_dispersion_term), math.add(BC_C_in, math.multiply(BC_dispersion_term, state[1])));
+      }
     } else {
-      state[0] = state[1];
+      if (math.sum(this.Fs) > 0) { // Danckwerts BC
+        const BC_C_in = math.multiply(1 / math.sum(this.Fs), [this.Fs], this.Cs_in)[0];
+        const BC_dispersion_term = (1-this.alpha)*this.D*this.A/(math.sum(this.Fs)*this.d_x);
+        this.extendedState[BC_PADDING] = math.multiply(1/(1+BC_dispersion_term), math.add(BC_C_in, math.multiply(BC_dispersion_term, this.extendedState[BC_PADDING+1])));
+        this.extendedState[BC_PADDING-1] = math.add(math.multiply(2, this.extendedState[BC_PADDING]), math.multiply(-2, this.extendedState[BC_PADDING+2]), this.extendedState[BC_PADDING+3]);
+      } else {
+        for (let i = 0; i < BC_PADDING; i++) {
+          this.extendedState[i] = this.extendedState[BC_PADDING];
+        }
+      }
+    }
+
+    if (this.downstreamReactor) {
+      for (let i = 0; i < BC_PADDING; i++) {
+        this.extendedState[this.n_x+BC_PADDING+i] = this.downstreamReactor.state[i];
+      }
+    } else {
+      // Neumann BC (no flux)
+      for (let i = 0; i < BC_PADDING; i++) {
+        this.extendedState[BC_PADDING+this.n_x+i] = this.extendedState.at(-1-BC_PADDING);
+      }
     }
-    // Neumann BC (no flux)
-    state[this.n_x-1] = state[this.n_x-2];
   }
 
   /**
    * Create finite difference first derivative operator.
-   * @param {boolean} central - Use central difference scheme if true, otherwise use upwind scheme.
-   * @param {boolean} higher_order - Use higher order scheme if true, otherwise use first order scheme.
    * @returns {Array} - First derivative operator matrix.
    */
-  _makeDoperator(central = false, higher_order = false) { // create gradient operator
+  _makeDoperator() { // create gradient operator
-    if (higher_order) {
+    const D_size = this.n_x+2*BC_PADDING;
-      if (central) {
+    const I = math.resize(math.diag(Array(D_size).fill(1/12), -2), [D_size, D_size]);
-        const I = math.resize(math.diag(Array(this.n_x).fill(1/12), -2), [this.n_x, this.n_x]);
+    const A = math.resize(math.diag(Array(D_size).fill(-2/3), -1), [D_size, D_size]);
-        const A = math.resize(math.diag(Array(this.n_x).fill(-2/3), -1), [this.n_x, this.n_x]);
+    const B = math.resize(math.diag(Array(D_size).fill(2/3), 1), [D_size, D_size]);
-        const B = math.resize(math.diag(Array(this.n_x).fill(2/3), 1), [this.n_x, this.n_x]);
+    const C = math.resize(math.diag(Array(D_size).fill(-1/12), 2), [D_size, D_size]);
-        const C = math.resize(math.diag(Array(this.n_x).fill(-1/12), 2), [this.n_x, this.n_x]);
+    const D = math.add(I, A, B, C);
-        const D = math.add(I, A, B, C);
+    // set by BCs elsewhere
-        const NearBoundary = Array(this.n_x).fill(0.0);
+    D.forEach((row, i) => i < BC_PADDING || i >= this.n_x+BC_PADDING ? row.fill(0) : row);
-        NearBoundary[0] = -1/4;
+    return D;
-        NearBoundary[1] = -5/6;
-        NearBoundary[2] = 3/2;
-        NearBoundary[3] = -1/2;
-        NearBoundary[4] = 1/12;
-        D[1] = NearBoundary;
-        NearBoundary.reverse();
-        D[this.n_x-2] = math.multiply(-1, NearBoundary);
-        D[0] = Array(this.n_x).fill(0); // set by BCs elsewhere
-        D[this.n_x-1] = Array(this.n_x).fill(0);
-        return D;
-      } else {
-        throw new Error("Upwind higher order method not implemented! Use central scheme instead.");
-      }
-    } else {
-      const I = math.resize(math.diag(Array(this.n_x).fill(1 / (1+central)), central), [this.n_x, this.n_x]);
-      const A = math.resize(math.diag(Array(this.n_x).fill(-1 / (1+central)), -1), [this.n_x, this.n_x]);
-      const D = math.add(I, A);
-      D[0] = Array(this.n_x).fill(0); // set by BCs elsewhere
-      D[this.n_x-1] = Array(this.n_x).fill(0);
-      return D;
-    }
   }
 
   /**
@@ -393,14 +420,24 @@ class Reactor_PFR extends Reactor {
    * @returns {Array} - Second derivative operator matrix.
    */
   _makeD2operator() { // create the central second derivative operator
-    const I = math.diag(Array(this.n_x).fill(-2), 0);
+    const D_size = this.n_x+2*BC_PADDING;
-    const A = math.resize(math.diag(Array(this.n_x).fill(1), 1), [this.n_x, this.n_x]);
+    const I = math.diag(Array(D_size).fill(-2), 0);
-    const B = math.resize(math.diag(Array(this.n_x).fill(1), -1), [this.n_x, this.n_x]);
+    const A = math.resize(math.diag(Array(D_size).fill(1), 1), [D_size, D_size]);
+    const B = math.resize(math.diag(Array(D_size).fill(1), -1), [D_size, D_size]);
     const D2 = math.add(I, A, B);
-    D2[0] = Array(this.n_x).fill(0); // set by BCs elsewhere
+    // set by BCs elsewhere
-    D2[this.n_x - 1] = Array(this.n_x).fill(0);
+    D2.forEach((row, i) => i < BC_PADDING || i >= this.n_x+BC_PADDING ? row.fill(0) : row);
     return D2;
   }
+
+  _constrainDispersion(D) {
+    const Dmin = math.sum(this.Fs) * this.d_x / (1.999 * this.A);
+    if (D < Dmin) {
+      this.logger.warn(`Local Péclet number too high! Constraining given dispersion (${D}) to minimal value (${Dmin}).`);
+      return Dmin;
+    }
+    return D;
+  }
 }
 
 module.exports = { Reactor_CSTR, Reactor_PFR };