Merge pull request 'Implemented node configuration and Effluent output' (#2) from experimental into main

Reviewed-on: p.vanderwilt/asm3#2

advanced-reactor.html

@@ -4,12 +4,43 @@
         color: '#c4cce0',
         defaults: {
             name: { value: "" },
+            volume: { value: 0., required: true},
+            S_O_init: { value: 0., required: true },
+            S_I_init: { value: 30., required: true },
+            S_S_init: { value: 100., required: true },
+            S_NH_init: { value: 16., required: true },
+            S_N2_init: { value: 0., required: true },
+            S_NO_init: { value: 0., required: true },
+            S_HCO_init: { value: 5., required: true },
+            X_I_init: { value: 25., required: true },
+            X_S_init: { value: 75., required: true },
+            X_H_init: { value: 30., required: true },
+            X_STO_init: { value: 0., required: true },
+            X_A_init: { value: 0.001, required: true },
+            X_TS_init: { value: 125., required: true }
         },
         inputs: 1,
         outputs: 1,
+        outputLabels: "Effluent",
         icon: "font-awesome/fa-recycle",
         label: function() {
             return this.name || "advanced-reactor";
+        },
+        oneditprepare: function() {
+            $("#node-input-volume").typedInput({
+                type:"num",
+                types:["num"]
+            });
+            $(".concentrations").typedInput({
+                type:"num",
+                types:["num"]
+            });
+        },
+        oneditsave: function() {
+            let volume = parseFloat($("#node-input-volume").typedInput("value"));
+            if (isNaN(volume) || volume <= 0) {
+                RED.notify("Fluid volume not set correctly", {type: "error"});
+            }
         }
     });
 </script>
@@ -19,6 +50,65 @@
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
+    <h2> Reactor properties </h2>
+    <div class="form-row">
+        <label for="node-input-volume"><i class="fa fa-tag"></i> Fluid volume [m3]</label>
+        <input type="text" id="node-input-volume" placeholder="m3">
+    </div>
+    <h2> Dissolved components </h2>
+    <div class="form-row">
+        <label for="node-input-S_O_init"><i class="fa fa-tag"></i> Initial dissolved oxygen [g O2 m-3]</label>
+        <input type="text" id="node-input-S_O_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_I_init"><i class="fa fa-tag"></i> Initial soluble inert  organics [g COD m-3]</label>
+        <input type="text" id="node-input-S_I_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_S_init"><i class="fa fa-tag"></i> Initial readily biodegrable substrates [g COD m-3]</label>
+        <input type="text" id="node-input-S_S_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_NH_init"><i class="fa fa-tag"></i> Initial ammonium / ammonia [g N m-3]</label>
+        <input type="text" id="node-input-S_NH_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_N2_init"><i class="fa fa-tag"></i> Initial dinitrogen, released by denitrification [g N m-3]</label>
+        <input type="text" id="node-input-S_N2_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_NO_init"><i class="fa fa-tag"></i> Initial nitrite + nitrate [g N m-3]</label>
+        <input type="text" id="node-input-S_NO_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-S_HCO_init"><i class="fa fa-tag"></i> Initial alkalinity, bicarbonate [mole HCO3- m-3]</label>
+        <input type="text" id="node-input-S_HCO_init" class="concentrations">
+    </div>
+    <h2> Particulate components </h2>
+    <div class="form-row">
+        <label for="node-input-X_I_init"><i class="fa fa-tag"></i> Initial inert particulate organics [g COD m-3]</label>
+        <input type="text" id="node-input-X_I_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-X_S_init"><i class="fa fa-tag"></i> Initial slowly biodegrable substrates [g COD m-3]</label>
+        <input type="text" id="node-input-X_S_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-X_H_init"><i class="fa fa-tag"></i> Initial heterotrophic biomass [g COD m-3]</label>
+        <input type="text" id="node-input-X_H_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-X_STO_init"><i class="fa fa-tag"></i> Initial Organics stored by heterotrophs [g COD m-3]</label>
+        <input type="text" id="node-input-X_STO_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-X_A_init"><i class="fa fa-tag"></i> Initial autotrophic, nitrifying biomass [g COD m-3]</label>
+        <input type="text" id="node-input-X_A_init" class="concentrations">
+    </div>
+    <div class="form-row">
+        <label for="node-input-X_TS_init"><i class="fa fa-tag"></i> Initial total suspended solids [g TSS m-3]</label>
+        <input type="text" id="node-input-X_TS_init" class="concentrations">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="advanced-reactor">

advanced-reactor.js

@@ -7,13 +7,45 @@ module.exports = function(RED) {
 
         const Reactor = require('./dependencies/reactor_class');
 
-        const reactor = new Reactor(Array(13).fill(0.001));
+        const reactor = new Reactor(
+            config.volume,
+            [
+                parseFloat(config.S_O_init),
+                parseFloat(config.S_I_init),
+                parseFloat(config.S_S_init),
+                parseFloat(config.S_NH_init),
+                parseFloat(config.S_N2_init),
+                parseFloat(config.S_NO_init),
+                parseFloat(config.S_HCO_init),
+                parseFloat(config.X_I_init),
+                parseFloat(config.X_S_init),
+                parseFloat(config.X_H_init),
+                parseFloat(config.X_STO_init),
+                parseFloat(config.X_A_init),
+                parseFloat(config.X_TS_init)
+            ]
+        );
 
         node.on('input', function(msg, send, done) {
-            if (msg.topic == "clock") {
+            switch (msg.topic) {
+                case "clock":
                     reactor.updateState(msg);
+                    break;
+                case "Influent":
+                    reactor.setInflux = msg;
+                    break;
+                case "Effluent":
+                    reactor.setInflux = msg;
+                    break;
+                case "OTR":
+                    reactor.setOTR = msg;
+                    break;
+                default:
+                    console.log("Unknown topic: " + msg.topic);
             }
 
+            send(reactor.getEffluent);
+
             if (done) {
                 done();
             }

dependencies/reactor_class.js

@@ -3,20 +3,33 @@ const math = require('mathjs')
 
 class Reactor_CSTR {
     
-    constructor(initial_state) {
+    constructor(volume, initial_state) {
         this.state = initial_state;
         console.log(this.state);
         this.asm = new ASM3();
 
-        this.Vl = 10.0; // fluid volume reactor [m3]
+        this.Vl = volume; // fluid volume reactor [m3]
-        this.F = 1.0; // fluid debit [m3 d-1]
+        this.F = 0.0; // fluid debit [m3 d-1]
-        this.C_in = [0., 30., 100., 16., 0., 0., 5., 25., 75., 30., 0., 0., 125.]; // composition influent
+        this.C_in = Array(13).fill(0.0); // composition influent
-        this.OTR = 100.0; // oxygen transfer rate [g O2 d-1]
+        this.OTR = 0.0; // oxygen transfer rate [g O2 d-1]
 
         this.currentTime = Date.now(); // milliseconds since epoch [ms]
         this.timeStep = 1/(24*60*15) // time step [d]
     }
 
+    set setInflux(input) { // setter for C_in (WIP)
+        this.F = input.payload.F;
+        this.C_in = input.payload.C_in;
+    }
+
+    set setOTR(input) { // setter for OTR (WIP) [g O2 d-1]
+        this.OTR = input.payload;
+    }
+
+    get getEffluent() {
+        return {topic: "Effluent", payload: {F: this.F, C_in:this.state}};
+    }
+
     // expect update with timestamp
     updateState(input) {
         let newTime = input.payload;