Compare commits
17 Commits
boundary-c
...
297c6713de
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
297c6713de | ||
|
|
d931bead0a | ||
|
|
7bf464b467 | ||
|
|
c5fc5c1b59 | ||
|
|
556dc39049 | ||
|
|
2e3ba8a9bf | ||
|
|
1da55fc3f5 | ||
|
|
06251988af | ||
|
|
7ff7c6ec1d | ||
|
|
a18c36b2e5 | ||
|
|
aacbc1e99d | ||
|
|
68576a8a36 | ||
|
|
2c69a5a0c1 | ||
|
|
460b872053 | ||
|
|
2b9ad5fd19 | ||
|
|
7c8722b324 | ||
|
|
442ddc60ed |
23
CLAUDE.md
Normal file
23
CLAUDE.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# reactor — Claude Code context
|
||||
|
||||
Biological reactor with ASM kinetics.
|
||||
Part of the [EVOLV](https://gitea.wbd-rd.nl/RnD/EVOLV) wastewater-automation platform.
|
||||
|
||||
## S88 classification
|
||||
|
||||
| Level | Colour | Placement lane |
|
||||
|---|---|---|
|
||||
| **Unit** | `#50a8d9` | L4 |
|
||||
|
||||
## Flow layout rules
|
||||
|
||||
When wiring this node into a multi-node demo or production flow, follow the
|
||||
placement rule set in the **EVOLV superproject**:
|
||||
|
||||
> `.claude/rules/node-red-flow-layout.md` (in the EVOLV repo root)
|
||||
|
||||
Key points for this node:
|
||||
- Place on lane **L4** (x-position per the lane table in the rule).
|
||||
- Stack same-level siblings vertically.
|
||||
- Parent/children sit on adjacent lanes (children one lane left, parent one lane right).
|
||||
- Wrap in a Node-RED group box coloured `#50a8d9` (Unit).
|
||||
51
CONTRACT.md
Normal file
51
CONTRACT.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# reactor — Contract
|
||||
|
||||
Hand-maintained for Phase 6; the `## Inputs` table is generated from
|
||||
`src/commands/index.js` (see Phase 9 generator). Keep ≤ 80 lines.
|
||||
|
||||
## Inputs (msg.topic on Port 0)
|
||||
|
||||
| Canonical | Aliases (deprecated) | Payload | Effect |
|
||||
|---|---|---|---|
|
||||
| `data.clock` | `clock` | `msg.timestamp` (ms since epoch) | Calls `source.updateState(timestamp)` — advances the ASM kinetics integrator by `n_iter` time steps that fit between `currentTime` and the supplied timestamp (scaled by `speedUpFactor`). |
|
||||
| `data.fluent` | `Fluent` | `{ inlet: number, F: number, C: number[13] }` | Writes the per-inlet flow rate (`F`, m³/d) and concentration vector (`C`) into `engine.Fs[inlet]` / `engine.Cs_in[inlet]`. |
|
||||
| `data.otr` | `OTR` | numeric | Sets the externally-supplied oxygen transfer rate (used when `kla` is NaN). |
|
||||
| `data.temperature` | `Temperature` | numeric or `{ value: number }` | Sets `engine.temperature` (°C). Non-numeric payloads are warned and ignored. |
|
||||
| `data.dispersion` | `Dispersion` | numeric | PFR only — sets the axial dispersion coefficient `D` (m²/d). |
|
||||
| `child.register` | `registerChild` | child node id (string) | Looks up the sibling node via `RED.nodes.getNode(id)` and delegates to `source.childRegistrationUtils.registerChild` with `msg.positionVsParent`. |
|
||||
|
||||
Aliases log a one-time deprecation warning the first time they fire.
|
||||
|
||||
## Outputs (msg.topic on Port 0/1/2)
|
||||
|
||||
- **Port 0 (process):** every tick emits the engine's effluent:
|
||||
`{ topic: 'Fluent', payload: { inlet: 0, F, C: number[13] }, timestamp }`.
|
||||
For a PFR an additional `{ topic: 'GridProfile', payload: { grid, n_x, d_x, length, species, timestamp } }`
|
||||
message goes out on the same port before the effluent.
|
||||
- **Port 1 (InfluxDB telemetry):** formatted via `outputUtils.formatMsg(..., 'influxdb')`
|
||||
from `getOutput()` — carries `flow_total`, `temperature`, and one field per ASM3
|
||||
species (`S_O`, `S_I`, `S_S`, `S_NH`, `S_N2`, `S_NO`, `S_HCO`, `X_I`, `X_S`, `X_H`,
|
||||
`X_STO`, `X_A`, `X_TS`).
|
||||
- **Port 2 (registration):** at startup the node sends one
|
||||
`{ topic: 'child.register', payload: <node.id>, positionVsParent, distance }`
|
||||
to its parent.
|
||||
|
||||
## Events emitted by `source.emitter`
|
||||
|
||||
- `stateChange` — fires after every `updateState()` that advances the integrator.
|
||||
Payload is the new `currentTime` (ms since epoch). Downstream reactors register
|
||||
via `child.register` and subscribe to this event to pull the upstream
|
||||
effluent on each advance.
|
||||
- `output-changed` — base notification fired by `updateState()` so the
|
||||
BaseNodeAdapter pipeline pushes outputs (currently used only as a heartbeat;
|
||||
effluent is emitted directly from the periodic tick).
|
||||
|
||||
## Children accepted
|
||||
|
||||
- `measurement` — subscribes to `<type>.measured.<position>` on the child's
|
||||
`measurements.emitter`. Recognised reconciliations: `temperature.measured.atEquipment`
|
||||
writes `engine.temperature`; PFR additionally honours
|
||||
`quantity (oxygen).measured.<distance>` to reconcile dissolved-oxygen
|
||||
concentration into the nearest grid cell.
|
||||
- `reactor` — registers as the upstream reactor; the downstream `updateState`
|
||||
pulls the upstream effluent into `Fs[0]` / `Cs_in[0]` before integrating.
|
||||
@@ -3,13 +3,12 @@ module.exports = function(RED) {
|
||||
RED.nodes.createNode(this, config);
|
||||
var node = this;
|
||||
|
||||
let name = config.name;
|
||||
let F2 = parseFloat(config.F2);
|
||||
const inlet_F2 = parseInt(config.inlet);
|
||||
|
||||
node.on('input', function(msg, send, done) {
|
||||
switch (msg.topic) {
|
||||
case "Fluent":
|
||||
case "Fluent": {
|
||||
// conserve volume flow debit
|
||||
let F_in = msg.payload.F;
|
||||
let F1 = Math.max(F_in - F2, 0);
|
||||
@@ -24,6 +23,7 @@ module.exports = function(RED) {
|
||||
|
||||
send([msg_F1, msg_F2]);
|
||||
break;
|
||||
}
|
||||
case "clock":
|
||||
break;
|
||||
default:
|
||||
|
||||
@@ -3,13 +3,12 @@ module.exports = function(RED) {
|
||||
RED.nodes.createNode(this, config);
|
||||
var node = this;
|
||||
|
||||
let name = config.name;
|
||||
let TS_set = parseFloat(config.TS_set);
|
||||
const inlet_sludge = parseInt(config.inlet);
|
||||
|
||||
node.on('input', function(msg, send, done) {
|
||||
switch (msg.topic) {
|
||||
case "Fluent":
|
||||
case "Fluent": {
|
||||
// conserve volume flow debit
|
||||
let F_in = msg.payload.F;
|
||||
let C_in = msg.payload.C;
|
||||
@@ -41,6 +40,7 @@ module.exports = function(RED) {
|
||||
|
||||
send([msg_F1, msg_F2]);
|
||||
break;
|
||||
}
|
||||
case "clock":
|
||||
break;
|
||||
default:
|
||||
|
||||
8
examples/README.md
Normal file
8
examples/README.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# reactor Example Flows
|
||||
|
||||
Import-ready Node-RED examples for reactor.
|
||||
|
||||
## Files
|
||||
- basic.flow.json
|
||||
- integration.flow.json
|
||||
- edge.flow.json
|
||||
6
examples/basic.flow.json
Normal file
6
examples/basic.flow.json
Normal file
@@ -0,0 +1,6 @@
|
||||
[
|
||||
{"id":"reactor_basic_tab","type":"tab","label":"reactor basic","disabled":false,"info":"reactor basic example"},
|
||||
{"id":"reactor_basic_node","type":"reactor","z":"reactor_basic_tab","name":"reactor basic","x":420,"y":180,"wires":[["reactor_basic_dbg"]]},
|
||||
{"id":"reactor_basic_inj","type":"inject","z":"reactor_basic_tab","name":"basic trigger","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"ping","payload":"1","payloadType":"str","x":160,"y":180,"wires":[["reactor_basic_node"]]},
|
||||
{"id":"reactor_basic_dbg","type":"debug","z":"reactor_basic_tab","name":"reactor basic debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":660,"y":180,"wires":[]}
|
||||
]
|
||||
6
examples/edge.flow.json
Normal file
6
examples/edge.flow.json
Normal file
@@ -0,0 +1,6 @@
|
||||
[
|
||||
{"id":"reactor_edge_tab","type":"tab","label":"reactor edge","disabled":false,"info":"reactor edge example"},
|
||||
{"id":"reactor_edge_node","type":"reactor","z":"reactor_edge_tab","name":"reactor edge","x":420,"y":180,"wires":[["reactor_edge_dbg"]]},
|
||||
{"id":"reactor_edge_inj","type":"inject","z":"reactor_edge_tab","name":"unknown topic","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"doesNotExist","payload":"x","payloadType":"str","x":170,"y":180,"wires":[["reactor_edge_node"]]},
|
||||
{"id":"reactor_edge_dbg","type":"debug","z":"reactor_edge_tab","name":"reactor edge debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":660,"y":180,"wires":[]}
|
||||
]
|
||||
6
examples/integration.flow.json
Normal file
6
examples/integration.flow.json
Normal file
@@ -0,0 +1,6 @@
|
||||
[
|
||||
{"id":"reactor_int_tab","type":"tab","label":"reactor integration","disabled":false,"info":"reactor integration example"},
|
||||
{"id":"reactor_int_node","type":"reactor","z":"reactor_int_tab","name":"reactor integration","x":420,"y":180,"wires":[["reactor_int_dbg"]]},
|
||||
{"id":"reactor_int_inj","type":"inject","z":"reactor_int_tab","name":"registerChild","props":[{"p":"topic","vt":"str"},{"p":"payload","vt":"str"}],"topic":"registerChild","payload":"example-child-id","payloadType":"str","x":170,"y":180,"wires":[["reactor_int_node"]]},
|
||||
{"id":"reactor_int_dbg","type":"debug","z":"reactor_int_tab","name":"reactor integration debug","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":680,"y":180,"wires":[]}
|
||||
]
|
||||
@@ -17,7 +17,10 @@
|
||||
"author": "P.R. van der Wilt",
|
||||
"main": "reactor.js",
|
||||
"scripts": {
|
||||
"test": "node reactor.js"
|
||||
"test": "node --test test/basic/*.test.js test/integration/*.test.js test/edge/*.test.js",
|
||||
"wiki:contract": "node ../generalFunctions/scripts/wikiGen.js contract ./src/commands/index.js --write ./wiki/Home.md",
|
||||
"wiki:datamodel": "node ../generalFunctions/scripts/wikiGen.js datamodel ./src/specificClass.js --write ./wiki/Home.md",
|
||||
"wiki:all": "npm run wiki:contract && npm run wiki:datamodel"
|
||||
},
|
||||
"node-red": {
|
||||
"nodes": {
|
||||
|
||||
48
reactor.html
48
reactor.html
@@ -1,9 +1,19 @@
|
||||
<!--
|
||||
| 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: "WWTP",
|
||||
color: "#c4cce0",
|
||||
category: "EVOLV",
|
||||
color: "#50a8d9",
|
||||
defaults: {
|
||||
name: { value: "" },
|
||||
reactor_type: { value: "CSTR", required: true },
|
||||
@@ -29,6 +39,9 @@
|
||||
X_TS_init: { value: 125.0009, required: true },
|
||||
|
||||
timeStep: { value: 1, required: true },
|
||||
speedUpFactor: { value: 1 },
|
||||
processOutputFormat: { value: "process" },
|
||||
dbaseOutputFormat: { value: "influxdb" },
|
||||
|
||||
enableLog: { value: false },
|
||||
logLevel: { value: "error" },
|
||||
@@ -39,7 +52,7 @@
|
||||
outputs: 3,
|
||||
inputLabels: ["input"],
|
||||
outputLabels: ["process", "dbase", "parent"],
|
||||
icon: "font-awesome/fa-recycle",
|
||||
icon: "font-awesome/fa-flask",
|
||||
label: function() {
|
||||
return this.name || "Reactor";
|
||||
},
|
||||
@@ -105,6 +118,10 @@
|
||||
type:"num",
|
||||
types:["num"]
|
||||
})
|
||||
$("#node-input-speedUpFactor").typedInput({
|
||||
type:"num",
|
||||
types:["num"]
|
||||
})
|
||||
// Set initial visibility on dialog open
|
||||
const initialType = $("#node-input-reactor_type").typedInput("value");
|
||||
if (initialType === "CSTR") {
|
||||
@@ -120,8 +137,8 @@
|
||||
}
|
||||
|
||||
// save position field
|
||||
if (window.EVOLV?.nodes?.measurement?.positionMenu?.saveEditor) {
|
||||
window.EVOLV.nodes.rotatingMachine.positionMenu.saveEditor(this);
|
||||
if (window.EVOLV?.nodes?.reactor?.positionMenu?.saveEditor) {
|
||||
window.EVOLV.nodes.reactor.positionMenu.saveEditor(this);
|
||||
}
|
||||
|
||||
let volume = parseFloat($("#node-input-volume").typedInput("value"));
|
||||
@@ -233,6 +250,27 @@
|
||||
<label for="node-input-timeStep"><i class="fa fa-tag"></i> Time step [s]</label>
|
||||
<input type="text" id="node-input-timeStep" placeholder="s">
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-speedUpFactor"><i class="fa fa-tag"></i> Speed-up factor</label>
|
||||
<input type="text" id="node-input-speedUpFactor" placeholder="1 = real-time">
|
||||
</div>
|
||||
<h3>Output Formats</h3>
|
||||
<div class="form-row">
|
||||
<label for="node-input-processOutputFormat"><i class="fa fa-random"></i> Process Output</label>
|
||||
<select id="node-input-processOutputFormat" style="width:60%;">
|
||||
<option value="process">process</option>
|
||||
<option value="json">json</option>
|
||||
<option value="csv">csv</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-dbaseOutputFormat"><i class="fa fa-database"></i> Database Output</label>
|
||||
<select id="node-input-dbaseOutputFormat" style="width:60%;">
|
||||
<option value="influxdb">influxdb</option>
|
||||
<option value="json">json</option>
|
||||
<option value="csv">csv</option>
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<!-- Logger fields injected here -->
|
||||
<div id="logger-fields-placeholder"></div>
|
||||
|
||||
25
src/commands/handlers.js
Normal file
25
src/commands/handlers.js
Normal file
@@ -0,0 +1,25 @@
|
||||
'use strict';
|
||||
|
||||
// Reactor input handlers. Each receives (source, msg, ctx) where source is
|
||||
// the Reactor domain and ctx is { node, RED, send, logger }. The handlers
|
||||
// either forward to engine setters or drive a synchronous state update.
|
||||
|
||||
exports.dataClock = (source, msg) => {
|
||||
source.updateState(msg.timestamp ?? Date.now());
|
||||
};
|
||||
|
||||
exports.dataFluent = (source, msg) => { source.setInfluent = msg; };
|
||||
exports.dataOTR = (source, msg) => { source.setOTR = msg; };
|
||||
exports.dataTemperature = (source, msg) => { source.setTemperature = msg; };
|
||||
exports.dataDispersion = (source, msg) => { source.setDispersion = msg; };
|
||||
|
||||
exports.childRegister = (source, msg, ctx) => {
|
||||
const childId = msg.payload;
|
||||
const RED = ctx?.RED;
|
||||
const childObj = RED?.nodes?.getNode?.(childId);
|
||||
if (!childObj || !childObj.source) {
|
||||
source?.logger?.warn?.(`registerChild skipped: missing child/source for id=${childId}`);
|
||||
return;
|
||||
}
|
||||
source.childRegistrationUtils.registerChild(childObj.source, msg.positionVsParent);
|
||||
};
|
||||
47
src/commands/index.js
Normal file
47
src/commands/index.js
Normal file
@@ -0,0 +1,47 @@
|
||||
'use strict';
|
||||
|
||||
// reactor command registry. Canonical names follow CONTRACTS.md §1.
|
||||
// Legacy names (clock, Fluent, OTR, Temperature, Dispersion, registerChild)
|
||||
// stay as aliases — they log a one-time deprecation warning on first use
|
||||
// and are removed in Phase 7.
|
||||
|
||||
const handlers = require('./handlers');
|
||||
|
||||
module.exports = [
|
||||
{
|
||||
topic: 'data.clock',
|
||||
aliases: ['clock'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.dataClock,
|
||||
},
|
||||
{
|
||||
topic: 'data.fluent',
|
||||
aliases: ['Fluent'],
|
||||
payloadSchema: { type: 'object' },
|
||||
handler: handlers.dataFluent,
|
||||
},
|
||||
{
|
||||
topic: 'data.otr',
|
||||
aliases: ['OTR'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.dataOTR,
|
||||
},
|
||||
{
|
||||
topic: 'data.temperature',
|
||||
aliases: ['Temperature'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.dataTemperature,
|
||||
},
|
||||
{
|
||||
topic: 'data.dispersion',
|
||||
aliases: ['Dispersion'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.dataDispersion,
|
||||
},
|
||||
{
|
||||
topic: 'child.register',
|
||||
aliases: ['registerChild'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.childRegister,
|
||||
},
|
||||
];
|
||||
139
src/kinetics/baseEngine.js
Normal file
139
src/kinetics/baseEngine.js
Normal file
@@ -0,0 +1,139 @@
|
||||
'use strict';
|
||||
|
||||
const EventEmitter = require('events');
|
||||
const ASM3 = require('../reaction_modules/asm3_class.js');
|
||||
const { create, all } = require('mathjs');
|
||||
const { childRegistrationUtils, logger, MeasurementContainer, POSITIONS } = require('generalFunctions');
|
||||
|
||||
const math = create(all, { matrix: 'Array' });
|
||||
|
||||
const S_O_INDEX = 0;
|
||||
const NUM_SPECIES = 13;
|
||||
|
||||
// Abstract reactor engine. Holds the influent/OTR/temperature state plus
|
||||
// the parent-side child registration that the original Reactor class
|
||||
// exposed. Concrete CSTR / PFR subclasses provide tick().
|
||||
class BaseReactorEngine {
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
this.logger = new logger(
|
||||
this.config.general.logging.enabled,
|
||||
this.config.general.logging.logLevel,
|
||||
config.general.name,
|
||||
);
|
||||
this.emitter = new EventEmitter();
|
||||
this.measurements = new MeasurementContainer();
|
||||
this.upstreamReactor = null;
|
||||
this.childRegistrationUtils = new childRegistrationUtils(this);
|
||||
|
||||
this.asm = new ASM3();
|
||||
this.volume = config.volume;
|
||||
|
||||
this.Fs = Array(config.n_inlets).fill(0);
|
||||
this.Cs_in = Array.from(Array(config.n_inlets), () => new Array(NUM_SPECIES).fill(0));
|
||||
this.OTR = 0.0;
|
||||
this.temperature = 20;
|
||||
|
||||
this.kla = config.kla;
|
||||
this.currentTime = Date.now();
|
||||
// timeStep stored in days (the integrator uses [d] internally).
|
||||
this.timeStep = (1 / (24 * 60 * 60)) * this.config.timeStep;
|
||||
this.speedUpFactor = config.speedUpFactor ?? 1;
|
||||
}
|
||||
|
||||
set setInfluent(input) {
|
||||
const index_in = input.payload.inlet;
|
||||
this.Fs[index_in] = input.payload.F;
|
||||
this.Cs_in[index_in] = input.payload.C;
|
||||
}
|
||||
|
||||
set setOTR(input) { this.OTR = input.payload; }
|
||||
|
||||
set setTemperature(input) {
|
||||
const p = input?.payload;
|
||||
const raw = (p && typeof p === 'object' && p.value !== undefined) ? p.value : p;
|
||||
const v = Number(raw);
|
||||
if (!Number.isFinite(v)) { this.logger.warn(`Invalid temperature input: ${raw}`); return; }
|
||||
this.temperature = v;
|
||||
}
|
||||
|
||||
get getEffluent() {
|
||||
const last = Array.isArray(this.state.at?.(-1)) ? this.state.at(-1) : this.state;
|
||||
return { topic: 'Fluent', payload: { inlet: 0, F: math.sum(this.Fs), C: last }, timestamp: this.currentTime };
|
||||
}
|
||||
|
||||
get getGridProfile() { return null; }
|
||||
|
||||
_calcOTR(S_O, T = 20.0) {
|
||||
const sat = this._calcOxygenSaturation(T);
|
||||
return this.kla * (sat - S_O);
|
||||
}
|
||||
|
||||
_calcOxygenSaturation(T = 20.0) {
|
||||
return 14.652 - 4.1022e-1 * T + 7.9910e-3 * T * T + 7.7774e-5 * T * T * T;
|
||||
}
|
||||
|
||||
_capDissolvedOxygen(state) {
|
||||
const sat = this._calcOxygenSaturation(this.temperature);
|
||||
const capRow = (row) => {
|
||||
if (!Array.isArray(row)) return row;
|
||||
const next = row.slice();
|
||||
if (Number.isFinite(next[S_O_INDEX])) next[S_O_INDEX] = Math.max(0, Math.min(next[S_O_INDEX], sat));
|
||||
return next;
|
||||
};
|
||||
return (Array.isArray(state) && Array.isArray(state[0])) ? state.map(capRow) : capRow(state);
|
||||
}
|
||||
|
||||
_arrayClip2Zero(arr) {
|
||||
if (Array.isArray(arr)) return arr.map((x) => this._arrayClip2Zero(x));
|
||||
return arr < 0 ? 0 : arr;
|
||||
}
|
||||
|
||||
registerChild(child, softwareType) {
|
||||
switch (softwareType) {
|
||||
case 'measurement': this._connectMeasurement(child); break;
|
||||
case 'reactor': this._connectReactor(child); break;
|
||||
default: this.logger.error(`Unrecognized softwareType: ${softwareType}`);
|
||||
}
|
||||
}
|
||||
|
||||
_connectMeasurement(measurement) {
|
||||
if (!measurement) { this.logger.warn('Invalid measurement provided.'); return; }
|
||||
const fn = measurement.config.functionality;
|
||||
const position = fn.distance !== 'undefined' ? fn.distance : fn.positionVsParent;
|
||||
const measurementType = measurement.config.asset.type;
|
||||
const eventName = `${measurementType}.measured.${position}`;
|
||||
measurement.measurements.emitter.on(eventName, (eventData) => {
|
||||
this.measurements
|
||||
.type(measurementType).variant('measured').position(position)
|
||||
.value(eventData.value, eventData.timestamp, eventData.unit);
|
||||
this._updateMeasurement(measurementType, eventData.value, position, eventData);
|
||||
});
|
||||
}
|
||||
|
||||
_connectReactor(reactor) {
|
||||
if (!reactor) { this.logger.warn('Invalid reactor provided.'); return; }
|
||||
this.upstreamReactor = reactor;
|
||||
reactor.emitter.on('stateChange', (data) => this.updateState(data));
|
||||
}
|
||||
|
||||
_updateMeasurement(measurementType, value, position) {
|
||||
if (measurementType === 'temperature' && position === POSITIONS.AT_EQUIPMENT) {
|
||||
this.temperature = value;
|
||||
return;
|
||||
}
|
||||
this.logger.error(`Type '${measurementType}' not recognized for measured update.`);
|
||||
}
|
||||
|
||||
updateState(newTime = Date.now()) {
|
||||
const day2ms = 1000 * 60 * 60 * 24;
|
||||
if (this.upstreamReactor) this.setInfluent = this.upstreamReactor.getEffluent;
|
||||
const n_iter = Math.floor(this.speedUpFactor * (newTime - this.currentTime) / (this.timeStep * day2ms));
|
||||
if (!n_iter) return;
|
||||
for (let n = 0; n < n_iter; n += 1) this.tick(this.timeStep);
|
||||
this.currentTime += (n_iter * this.timeStep * day2ms) / this.speedUpFactor;
|
||||
this.emitter.emit('stateChange', this.currentTime);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { BaseReactorEngine, math, S_O_INDEX, NUM_SPECIES };
|
||||
27
src/kinetics/cstr.js
Normal file
27
src/kinetics/cstr.js
Normal file
@@ -0,0 +1,27 @@
|
||||
'use strict';
|
||||
|
||||
const { BaseReactorEngine, math, S_O_INDEX, NUM_SPECIES } = require('./baseEngine.js');
|
||||
|
||||
class Reactor_CSTR extends BaseReactorEngine {
|
||||
constructor(config) {
|
||||
super(config);
|
||||
this.state = config.initialState;
|
||||
}
|
||||
|
||||
// Forward Euler step over `time_step` days.
|
||||
tick(time_step) {
|
||||
const inflow = math.multiply(math.divide([this.Fs], this.volume), this.Cs_in)[0];
|
||||
const outflow = math.multiply(-1 * math.sum(this.Fs) / this.volume, this.state);
|
||||
const reaction = this.asm.compute_dC(this.state, this.temperature);
|
||||
const transfer = Array(NUM_SPECIES).fill(0.0);
|
||||
transfer[S_O_INDEX] = isNaN(this.kla)
|
||||
? this.OTR
|
||||
: this._calcOTR(this.state[S_O_INDEX], this.temperature);
|
||||
|
||||
const dC_total = math.multiply(math.add(inflow, outflow, reaction, transfer), time_step);
|
||||
this.state = this._capDissolvedOxygen(this._arrayClip2Zero(math.add(this.state, dC_total)));
|
||||
return this.state;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Reactor_CSTR;
|
||||
132
src/kinetics/pfr.js
Normal file
132
src/kinetics/pfr.js
Normal file
@@ -0,0 +1,132 @@
|
||||
'use strict';
|
||||
|
||||
const { assertNoNaN } = require('../utils.js');
|
||||
const { BaseReactorEngine, math, S_O_INDEX, NUM_SPECIES } = require('./baseEngine.js');
|
||||
|
||||
class Reactor_PFR extends BaseReactorEngine {
|
||||
constructor(config) {
|
||||
super(config);
|
||||
|
||||
this.length = config.length;
|
||||
this.n_x = config.resolution_L;
|
||||
this.d_x = this.length / this.n_x;
|
||||
this.A = this.volume / this.length;
|
||||
this.alpha = config.alpha;
|
||||
|
||||
this.state = Array.from(Array(this.n_x), () => config.initialState.slice());
|
||||
this.D = 0.0;
|
||||
|
||||
this.D_op = this._makeDoperator(true, true);
|
||||
this.D2_op = this._makeD2operator();
|
||||
assertNoNaN(this.D_op, 'Derivative operator');
|
||||
assertNoNaN(this.D2_op, 'Second derivative operator');
|
||||
}
|
||||
|
||||
get getGridProfile() {
|
||||
return {
|
||||
grid: this.state.map((row) => row.slice()),
|
||||
n_x: this.n_x,
|
||||
d_x: this.d_x,
|
||||
length: this.length,
|
||||
species: ['S_O','S_I','S_S','S_NH','S_N2','S_NO','S_HCO',
|
||||
'X_I','X_S','X_H','X_STO','X_A','X_TS'],
|
||||
timestamp: this.currentTime,
|
||||
};
|
||||
}
|
||||
|
||||
set setDispersion(input) { this.D = input.payload; }
|
||||
|
||||
updateState(newTime) {
|
||||
super.updateState(newTime);
|
||||
const Pe_local = (this.d_x * math.sum(this.Fs)) / (this.D * this.A);
|
||||
const Co_D = (this.D * this.timeStep) / (this.d_x * this.d_x);
|
||||
if (Pe_local >= 2) this.logger.warn(`Local Peclet number (${Pe_local}) is too high! Increase reactor resolution.`);
|
||||
if (Co_D >= 0.5) this.logger.warn(`Courant number (${Co_D}) is too high! Reduce time step size.`);
|
||||
}
|
||||
|
||||
// Explicit finite-difference step over `time_step` days.
|
||||
tick(time_step) {
|
||||
const dispersion = math.multiply(this.D / (this.d_x * this.d_x), this.D2_op, this.state);
|
||||
const advection = math.multiply(-1 * math.sum(this.Fs) / (this.A * this.d_x), this.D_op, this.state);
|
||||
const reaction = this.state.map((slice) => this.asm.compute_dC(slice, this.temperature));
|
||||
const transfer = Array.from(Array(this.n_x), () => new Array(NUM_SPECIES).fill(0));
|
||||
|
||||
const klaIsNaN = isNaN(this.kla);
|
||||
for (let i = 1; i < this.n_x - 1; i += 1) {
|
||||
const otr = klaIsNaN ? this.OTR : this._calcOTR(this.state[i][S_O_INDEX], this.temperature);
|
||||
transfer[i][S_O_INDEX] = otr * this.n_x / (this.n_x - 2);
|
||||
}
|
||||
|
||||
const dC_total = math.multiply(math.add(dispersion, advection, reaction, transfer), time_step);
|
||||
const stateNew = math.add(this.state, dC_total);
|
||||
this._applyBoundaryConditions(stateNew);
|
||||
this.state = this._capDissolvedOxygen(this._arrayClip2Zero(stateNew));
|
||||
return stateNew;
|
||||
}
|
||||
|
||||
_updateMeasurement(measurementType, value, position, context) {
|
||||
if (measurementType === 'quantity (oxygen)') {
|
||||
if (!Number.isFinite(position) || !Number.isFinite(value) || this.config.length <= 0) {
|
||||
this.logger.warn(`Ignoring oxygen measurement update with invalid data (position=${position}, value=${value}).`);
|
||||
return;
|
||||
}
|
||||
const rawIndex = Math.round((position / this.config.length) * this.n_x);
|
||||
const grid_pos = Math.max(0, Math.min(this.n_x - 1, rawIndex));
|
||||
this.state[grid_pos][S_O_INDEX] = value;
|
||||
return;
|
||||
}
|
||||
super._updateMeasurement(measurementType, value, position, context);
|
||||
}
|
||||
|
||||
// Generalised Danckwerts at inlet when flow > 0; Neumann (no-flux) at outlet
|
||||
// and at inlet when there is no flow.
|
||||
_applyBoundaryConditions(state) {
|
||||
if (math.sum(this.Fs) > 0) {
|
||||
const BC_C_in = math.multiply(1 / math.sum(this.Fs), [this.Fs], this.Cs_in)[0];
|
||||
const BC_disp = ((1 - this.alpha) * this.D * this.A) / (math.sum(this.Fs) * this.d_x);
|
||||
state[0] = math.multiply(1 / (1 + BC_disp), math.add(BC_C_in, math.multiply(BC_disp, state[1])));
|
||||
} else {
|
||||
state[0] = state[1];
|
||||
}
|
||||
state[this.n_x - 1] = state[this.n_x - 2];
|
||||
}
|
||||
|
||||
_makeDoperator(central = false, higher_order = false) {
|
||||
if (higher_order) {
|
||||
if (!central) throw new Error('Upwind higher order method not implemented! Use central scheme instead.');
|
||||
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(this.n_x).fill(-2 / 3), -1), [this.n_x, this.n_x]);
|
||||
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(this.n_x).fill(-1 / 12), 2), [this.n_x, this.n_x]);
|
||||
const D = math.add(I, A, B, C);
|
||||
// Preserve the pre-refactor aliasing: D[1] = NearBoundary; NearBoundary.reverse()
|
||||
// mutates D[1] in place; then D[n_x-2] = -1 * NearBoundary uses the reversed view.
|
||||
const nb = Array(this.n_x).fill(0.0);
|
||||
nb[0] = -1 / 4; nb[1] = -5 / 6; nb[2] = 3 / 2; nb[3] = -1 / 2; nb[4] = 1 / 12;
|
||||
D[1] = nb;
|
||||
nb.reverse();
|
||||
D[this.n_x - 2] = math.multiply(-1, nb);
|
||||
D[0] = Array(this.n_x).fill(0);
|
||||
D[this.n_x - 1] = Array(this.n_x).fill(0);
|
||||
return D;
|
||||
}
|
||||
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);
|
||||
D[this.n_x - 1] = Array(this.n_x).fill(0);
|
||||
return D;
|
||||
}
|
||||
|
||||
_makeD2operator() {
|
||||
const I = math.diag(Array(this.n_x).fill(-2), 0);
|
||||
const A = math.resize(math.diag(Array(this.n_x).fill(1), 1), [this.n_x, this.n_x]);
|
||||
const B = math.resize(math.diag(Array(this.n_x).fill(1), -1), [this.n_x, this.n_x]);
|
||||
const D2 = math.add(I, A, B);
|
||||
D2[0] = Array(this.n_x).fill(0);
|
||||
D2[this.n_x - 1] = Array(this.n_x).fill(0);
|
||||
return D2;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Reactor_PFR;
|
||||
202
src/nodeClass.js
202
src/nodeClass.js
@@ -1,165 +1,53 @@
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('./specificClass.js');
|
||||
'use strict';
|
||||
|
||||
const { BaseNodeAdapter } = require('generalFunctions');
|
||||
const Reactor = require('./specificClass.js');
|
||||
const commands = require('./commands');
|
||||
|
||||
class nodeClass {
|
||||
/**
|
||||
* Node-RED node class for advanced-reactor.
|
||||
* @param {object} uiConfig - Node-RED node configuration
|
||||
* @param {object} RED - Node-RED runtime API
|
||||
* @param {object} nodeInstance - Node-RED node instance
|
||||
* @param {string} nameOfNode - Name of the node
|
||||
*/
|
||||
constructor(uiConfig, RED, nodeInstance, nameOfNode) {
|
||||
// Preserve RED reference for HTTP endpoints if needed
|
||||
this.node = nodeInstance;
|
||||
this.RED = RED;
|
||||
this.name = nameOfNode;
|
||||
this.source = null;
|
||||
const SPECIES = ['S_O','S_I','S_S','S_NH','S_N2','S_NO','S_HCO',
|
||||
'X_I','X_S','X_H','X_STO','X_A','X_TS'];
|
||||
|
||||
this._loadConfig(uiConfig)
|
||||
this._setupClass();
|
||||
class nodeClass extends BaseNodeAdapter {
|
||||
static DomainClass = Reactor;
|
||||
static commands = commands;
|
||||
// Tick-driven: ASM kinetics integrate over wall-clock time. The engine's
|
||||
// updateState computes how many internal Euler/FD steps fit in the elapsed
|
||||
// ms; without a periodic tick the integrator never advances.
|
||||
static tickInterval = 1000;
|
||||
static statusInterval = 1000;
|
||||
|
||||
this._attachInputHandler();
|
||||
this._registerChild();
|
||||
this._startTickLoop();
|
||||
this._attachCloseHandler();
|
||||
}
|
||||
buildDomainConfig(uiConfig) {
|
||||
const initialState = {};
|
||||
for (const k of SPECIES) initialState[k] = parseFloat(uiConfig[`${k}_init`]);
|
||||
return {
|
||||
reactor: {
|
||||
reactor_type: uiConfig.reactor_type,
|
||||
volume: parseFloat(uiConfig.volume),
|
||||
length: parseFloat(uiConfig.length),
|
||||
resolution_L: parseInt(uiConfig.resolution_L, 10),
|
||||
alpha: parseFloat(uiConfig.alpha),
|
||||
n_inlets: parseInt(uiConfig.n_inlets, 10),
|
||||
kla: parseFloat(uiConfig.kla),
|
||||
timeStep: parseFloat(uiConfig.timeStep),
|
||||
speedUpFactor: Number(uiConfig.speedUpFactor) || 1,
|
||||
},
|
||||
initialState,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle node-red input messages
|
||||
*/
|
||||
_attachInputHandler() {
|
||||
this.node.on('input', (msg, send, done) => {
|
||||
|
||||
switch (msg.topic) {
|
||||
case "clock":
|
||||
this.source.updateState(msg.timestamp);
|
||||
send([msg, null, null]);
|
||||
break;
|
||||
case "Fluent":
|
||||
this.source.setInfluent = msg;
|
||||
break;
|
||||
case "OTR":
|
||||
this.source.setOTR = msg;
|
||||
break;
|
||||
case "Temperature":
|
||||
this.source.setTemperature = msg;
|
||||
break;
|
||||
case "Dispersion":
|
||||
this.source.setDispersion = msg;
|
||||
break;
|
||||
case 'registerChild':
|
||||
// Register this node as a parent of the child node
|
||||
const childId = msg.payload;
|
||||
const childObj = this.RED.nodes.getNode(childId);
|
||||
this.source.childRegistrationUtils.registerChild(childObj.source, msg.positionVsParent);
|
||||
break;
|
||||
default:
|
||||
console.log("Unknown topic: " + msg.topic);
|
||||
}
|
||||
|
||||
if (done) {
|
||||
done();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse node configuration
|
||||
* @param {object} uiConfig Config set in UI in node-red
|
||||
*/
|
||||
_loadConfig(uiConfig) {
|
||||
this.config = {
|
||||
general: {
|
||||
name: uiConfig.name || this.name,
|
||||
id: this.node.id,
|
||||
unit: null,
|
||||
logging: {
|
||||
enabled: uiConfig.enableLog,
|
||||
logLevel: uiConfig.logLevel
|
||||
}
|
||||
},
|
||||
functionality: {
|
||||
positionVsParent: uiConfig.positionVsParent || 'atEquipment', // Default to 'atEquipment' if not specified
|
||||
softwareType: "reactor" // should be set in config manager
|
||||
},
|
||||
reactor_type: uiConfig.reactor_type,
|
||||
volume: parseFloat(uiConfig.volume),
|
||||
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),
|
||||
parseFloat(uiConfig.S_I_init),
|
||||
parseFloat(uiConfig.S_S_init),
|
||||
parseFloat(uiConfig.S_NH_init),
|
||||
parseFloat(uiConfig.S_N2_init),
|
||||
parseFloat(uiConfig.S_NO_init),
|
||||
parseFloat(uiConfig.S_HCO_init),
|
||||
parseFloat(uiConfig.X_I_init),
|
||||
parseFloat(uiConfig.X_S_init),
|
||||
parseFloat(uiConfig.X_H_init),
|
||||
parseFloat(uiConfig.X_STO_init),
|
||||
parseFloat(uiConfig.X_A_init),
|
||||
parseFloat(uiConfig.X_TS_init)
|
||||
],
|
||||
timeStep: parseFloat(uiConfig.timeStep)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register this node as a child upstream and downstream.
|
||||
* Delayed to avoid Node-RED startup race conditions.
|
||||
*/
|
||||
_registerChild() {
|
||||
setTimeout(() => {
|
||||
this.node.send([
|
||||
null,
|
||||
null,
|
||||
{ topic: 'registerChild', payload: this.node.id, positionVsParent: this.config?.functionality?.positionVsParent || 'atEquipment' }
|
||||
]);
|
||||
}, 100);
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup reactor class based on config
|
||||
*/
|
||||
_setupClass() {
|
||||
let new_reactor;
|
||||
|
||||
switch (this.config.reactor_type) {
|
||||
case "CSTR":
|
||||
new_reactor = new Reactor_CSTR(this.config);
|
||||
break;
|
||||
case "PFR":
|
||||
new_reactor = new Reactor_PFR(this.config);
|
||||
break;
|
||||
default:
|
||||
console.warn("Unknown reactor type: " + uiConfig.reactor_type);
|
||||
}
|
||||
|
||||
this.source = new_reactor; // protect from reassignment
|
||||
this.node.source = this.source;
|
||||
}
|
||||
|
||||
_startTickLoop() {
|
||||
setTimeout(() => {
|
||||
this._tickInterval = setInterval(() => this._tick(), 1000);
|
||||
}, 1000);
|
||||
}
|
||||
|
||||
_tick(){
|
||||
this.node.send([this.source.getEffluent, null, null]);
|
||||
}
|
||||
|
||||
_attachCloseHandler() {
|
||||
this.node.on('close', (done) => {
|
||||
clearInterval(this._tickInterval);
|
||||
done();
|
||||
});
|
||||
}
|
||||
// The kinetics engine drives Port-0 effluent + grid-profile shapes that
|
||||
// don't fit BaseNodeAdapter's delta-compressed payload. Override the
|
||||
// periodic emission so the Fluent / GridProfile contract is preserved.
|
||||
_emitOutputs() {
|
||||
const src = this.source;
|
||||
if (!src?.engine) return;
|
||||
src.updateState(Date.now());
|
||||
const grid = src.getGridProfile;
|
||||
if (grid) this.node.send([{ topic: 'GridProfile', payload: grid }, null, null]);
|
||||
const raw = src.getOutput();
|
||||
const influx = this._output.formatMsg(raw, src.config || this.config, 'influxdb');
|
||||
this.node.send([src.getEffluent, influx, null]);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = nodeClass;
|
||||
@@ -171,7 +171,7 @@ class ASM3 {
|
||||
compute_rates(state, T = 20) {
|
||||
// state: S_O, S_I, S_S, S_NH, S_N2, S_NO, S_HCO, X_I, X_S, X_H, X_STO, X_A, X_TS
|
||||
const rates = Array(12);
|
||||
const [S_O, S_I, S_S, S_NH, S_N2, S_NO, S_HCO, X_I, X_S, X_H, X_STO, X_A, X_TS] = state;
|
||||
const [S_O, , S_S, S_NH, , S_NO, S_HCO, , X_S, X_H, X_STO, X_A] = state;
|
||||
const { k_H, K_X, k_STO, nu_NO, K_O, K_NO, K_S, K_STO, mu_H_max, K_NH, K_HCO, b_H_O, b_H_NO, b_STO_O, b_STO_NO, mu_A_max, K_A_NH, K_A_O, K_A_HCO, b_A_O, b_A_NO } = this.kin_params;
|
||||
const { theta_H, theta_STO, theta_mu_H, theta_b_H_O, theta_b_H_NO, theta_b_STO_O, theta_b_STO_NO, theta_mu_A, theta_b_A_O, theta_b_A_NO } = this.temp_params;
|
||||
|
||||
|
||||
@@ -171,7 +171,7 @@ class ASM3 {
|
||||
compute_rates(state, T = 20) {
|
||||
// state: S_O, S_I, S_S, S_NH, S_N2, S_NO, S_HCO, X_I, X_S, X_H, X_STO, X_A, X_TS
|
||||
const rates = Array(12);
|
||||
const [S_O, S_I, S_S, S_NH, S_N2, S_NO, S_HCO, X_I, X_S, X_H, X_STO, X_A, X_TS] = state;
|
||||
const [S_O, , S_S, S_NH, , S_NO, S_HCO, , X_S, X_H, X_STO, X_A] = state;
|
||||
const { k_H, K_X, k_STO, nu_NO, K_O, K_NO, K_S, K_STO, mu_H_max, K_NH, K_HCO, b_H_O, b_H_NO, b_STO_O, b_STO_NO, mu_A_max, K_A_NH, K_A_O, K_A_HCO, b_A_O, b_A_NO } = this.kin_params;
|
||||
const { theta_H, theta_STO, theta_mu_H, theta_b_H_O, theta_b_H_NO, theta_b_STO_O, theta_b_STO_NO, theta_mu_A, theta_b_A_O, theta_b_A_NO } = this.temp_params;
|
||||
|
||||
|
||||
@@ -1,419 +1,134 @@
|
||||
const ASM3 = require('./reaction_modules/asm3_class.js');
|
||||
const { create, all, isArray } = require('mathjs');
|
||||
const { assertNoNaN } = require('./utils.js');
|
||||
const { childRegistrationUtils, logger, MeasurementContainer } = require('generalFunctions');
|
||||
const EventEmitter = require('events');
|
||||
'use strict';
|
||||
|
||||
const mathConfig = {
|
||||
matrix: 'Array' // use Array as the matrix type
|
||||
};
|
||||
const { BaseDomain, statusBadge, POSITIONS } = require('generalFunctions');
|
||||
const Reactor_CSTR = require('./kinetics/cstr.js');
|
||||
const Reactor_PFR = require('./kinetics/pfr.js');
|
||||
|
||||
const math = create(all, mathConfig);
|
||||
const SPECIES_KEYS = ['S_O','S_I','S_S','S_NH','S_N2','S_NO','S_HCO',
|
||||
'X_I','X_S','X_H','X_STO','X_A','X_TS'];
|
||||
|
||||
const S_O_INDEX = 0;
|
||||
const NUM_SPECIES = 13;
|
||||
const DEBUG = false;
|
||||
// Reactor — biological reactor orchestrator (Unit-level). Wraps a CSTR or
|
||||
// PFR kinetics engine and exposes the BaseDomain surface to BaseNodeAdapter.
|
||||
// The engines own the ASM3 integration; this class wires child registration
|
||||
// through ChildRouter, holds the validated config, and presents getOutput /
|
||||
// getStatusBadge.
|
||||
class Reactor extends BaseDomain {
|
||||
static name = 'reactor';
|
||||
|
||||
class Reactor {
|
||||
/**
|
||||
* Reactor base class.
|
||||
* @param {object} config - Configuration object containing reactor parameters.
|
||||
*/
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
// EVOLV stuff
|
||||
this.logger = new logger(this.config.general.logging.enabled, this.config.general.logging.logLevel, config.general.name);
|
||||
this.emitter = new EventEmitter();
|
||||
this.measurements = new MeasurementContainer();
|
||||
this.upstreamReactor = null;
|
||||
this.childRegistrationUtils = new childRegistrationUtils(this); // Child registration utility
|
||||
configure() {
|
||||
const flat = this._flattenEngineConfig(this.config);
|
||||
this.engine = this._buildEngine(flat);
|
||||
|
||||
this.asm = new ASM3();
|
||||
// Re-emit upstream-reactor stateChange and engine stateChange events on
|
||||
// the BaseDomain emitter so adapter listeners pick them up uniformly.
|
||||
this.engine.emitter.on('stateChange', (t) => this.emitter.emit('stateChange', t));
|
||||
|
||||
this.volume = config.volume; // fluid volume reactor [m3]
|
||||
// ChildRouter dispatches to engine handlers — keeps the existing
|
||||
// _connectMeasurement / _connectReactor wiring intact, just centralised.
|
||||
this.router.onRegister('measurement', (child) => this.engine._connectMeasurement(child));
|
||||
this.router.onRegister('reactor', (child) => this.engine._connectReactor(child));
|
||||
|
||||
this.Fs = Array(config.n_inlets).fill(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.OTR = 0.0; // oxygen transfer rate [g O2 d-1 m-3]
|
||||
this.temperature = 20; // temperature [C]
|
||||
|
||||
this.kla = config.kla; // if NaN, use externaly provided OTR [d-1]
|
||||
|
||||
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
|
||||
// Bridge engine.measurements into the BaseDomain measurements container
|
||||
// so getFlattenedOutput surfaces temperature / oxygen series.
|
||||
this.measurements = this.engine.measurements;
|
||||
}
|
||||
|
||||
/**
|
||||
* Setter for influent data.
|
||||
* @param {object} input - Input object (msg) containing payload with inlet index, flow rate, and concentrations.
|
||||
*/
|
||||
set setInfluent(input) {
|
||||
let index_in = input.payload.inlet;
|
||||
this.Fs[index_in] = input.payload.F;
|
||||
this.Cs_in[index_in] = input.payload.C;
|
||||
// Translate the nested schema config (reactor.*, initialState.*) into the
|
||||
// flat shape the kinetics engines accept.
|
||||
_flattenEngineConfig(config) {
|
||||
const reactor = config.reactor || {};
|
||||
const init = config.initialState || {};
|
||||
const initialState = SPECIES_KEYS.map((k) => Number(init[k] ?? 0));
|
||||
return {
|
||||
general: config.general,
|
||||
functionality: config.functionality,
|
||||
reactor_type: reactor.reactor_type ?? 'CSTR',
|
||||
volume: Number(reactor.volume),
|
||||
length: Number(reactor.length),
|
||||
resolution_L: Number(reactor.resolution_L),
|
||||
alpha: Number(reactor.alpha),
|
||||
n_inlets: Number(reactor.n_inlets),
|
||||
kla: Number(reactor.kla),
|
||||
timeStep: Number(reactor.timeStep),
|
||||
speedUpFactor: Number(reactor.speedUpFactor) || 1,
|
||||
initialState,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Setter for OTR (Oxygen Transfer Rate).
|
||||
* @param {object} input - Input object (msg) containing payload with OTR value [g O2 d-1 m-3].
|
||||
*/
|
||||
set setOTR(input) {
|
||||
this.OTR = input.payload;
|
||||
}
|
||||
|
||||
/**
|
||||
* Getter for effluent data.
|
||||
* @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))) {
|
||||
return { topic: "Fluent", payload: { inlet: 0, F: math.sum(this.Fs), C: this.state.at(-1) }, timestamp: this.currentTime };
|
||||
}
|
||||
return { topic: "Fluent", payload: { inlet: 0, F: math.sum(this.Fs), C: this.state }, timestamp: this.currentTime };
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the oxygen transfer rate (OTR) based on the dissolved oxygen concentration and temperature.
|
||||
* @param {number} S_O - Dissolved oxygen concentration [g O2 m-3].
|
||||
* @param {number} T - Temperature in Celsius, default to 20 C.
|
||||
* @returns {number} - Calculated OTR [g O2 d-1 m-3].
|
||||
*/
|
||||
_calcOTR(S_O, T = 20.0) { // caculate the OTR using basic correlation, default to temperature: 20 C
|
||||
let S_O_sat = 14.652 - 4.1022e-1 * T + 7.9910e-3 * T*T + 7.7774e-5 * T*T*T;
|
||||
return this.kla * (S_O_sat - S_O);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clip values in an array to zero.
|
||||
* @param {Array} arr - Array of values to clip.
|
||||
* @returns {Array} - New array with values clipped to zero.
|
||||
*/
|
||||
_arrayClip2Zero(arr) {
|
||||
if (Array.isArray(arr)) {
|
||||
return arr.map(x => this._arrayClip2Zero(x));
|
||||
} else {
|
||||
return arr < 0 ? 0 : arr;
|
||||
}
|
||||
}
|
||||
|
||||
registerChild(child, softwareType) {
|
||||
switch (softwareType) {
|
||||
case "measurement":
|
||||
this.logger.debug(`Registering measurement child.`);
|
||||
this._connectMeasurement(child);
|
||||
break;
|
||||
case "reactor":
|
||||
this.logger.debug(`Registering reactor child.`);
|
||||
this._connectReactor(child);
|
||||
break;
|
||||
|
||||
_buildEngine(flat) {
|
||||
// The schema enum validator lowercases the configured value, so accept
|
||||
// either case.
|
||||
switch (String(flat.reactor_type || '').toUpperCase()) {
|
||||
case 'CSTR': return new Reactor_CSTR(flat);
|
||||
case 'PFR': return new Reactor_PFR(flat);
|
||||
default:
|
||||
this.logger.error(`Unrecognized softwareType: ${softwareType}`);
|
||||
this.logger.warn(`Unknown reactor type: ${flat.reactor_type}. Falling back to CSTR.`);
|
||||
return new Reactor_CSTR(flat);
|
||||
}
|
||||
}
|
||||
|
||||
_connectMeasurement(measurement) {
|
||||
if (!measurement) {
|
||||
this.logger.warn("Invalid measurement provided.");
|
||||
return;
|
||||
}
|
||||
// Adapter input setters — forwarded straight to the engine.
|
||||
set setInfluent(msg) { this.engine.setInfluent = msg; }
|
||||
set setOTR(msg) { this.engine.setOTR = msg; }
|
||||
set setTemperature(msg) { this.engine.setTemperature = msg; }
|
||||
set setDispersion(msg) { if (this.engine instanceof Reactor_PFR) this.engine.setDispersion = msg; }
|
||||
|
||||
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}`;
|
||||
updateState(t) { this.engine.updateState(t); this.notifyOutputChanged(); }
|
||||
|
||||
// Register event listener for measurement updates
|
||||
measurement.measurements.emitter.on(eventName, (eventData) => {
|
||||
this.logger.debug(`${position} ${measurementType} from ${eventData.childName}: ${eventData.value} ${eventData.unit}`);
|
||||
|
||||
// Store directly in parent's measurement container
|
||||
this.measurements
|
||||
.type(measurementType)
|
||||
.variant("measured")
|
||||
.position(position)
|
||||
.value(eventData.value, eventData.timestamp, eventData.unit);
|
||||
|
||||
this._updateMeasurement(measurementType, eventData.value, position, eventData);
|
||||
});
|
||||
// Engine pass-through — needed so the BaseNodeAdapter tick loop (and
|
||||
// tests calling reactor.tick(dt) directly) drive the ASM integration.
|
||||
// Without this the Node-RED tick fires `source.tick?.()`, gets undefined,
|
||||
// and the kinetics state never advances.
|
||||
tick(timeStep) {
|
||||
const result = this.engine.tick(timeStep);
|
||||
this.notifyOutputChanged();
|
||||
return result;
|
||||
}
|
||||
|
||||
get getEffluent() { return this.engine.getEffluent; }
|
||||
get getGridProfile() { return this.engine.getGridProfile; }
|
||||
get temperature() { return this.engine.temperature; }
|
||||
|
||||
_connectReactor(reactor) {
|
||||
if (!reactor) {
|
||||
this.logger.warn("Invalid reactor provided.");
|
||||
return;
|
||||
// Per-tick output for Port 0 / Port 1. Carries the effluent vector plus
|
||||
// a flat per-species block keyed by SPECIES_KEYS for InfluxDB telemetry.
|
||||
getOutput() {
|
||||
const eff = this.engine.getEffluent;
|
||||
const C = Array.isArray(eff?.payload?.C) ? eff.payload.C : [];
|
||||
const out = {
|
||||
flow_total: Number(eff?.payload?.F),
|
||||
temperature: Number(this.engine.temperature),
|
||||
};
|
||||
for (let i = 0; i < Math.min(SPECIES_KEYS.length, C.length); i += 1) {
|
||||
const v = Number(C[i]);
|
||||
if (Number.isFinite(v)) out[SPECIES_KEYS[i]] = v;
|
||||
}
|
||||
|
||||
this.upstreamReactor = reactor;
|
||||
|
||||
reactor.emitter.on("stateChange", (data) => {
|
||||
this.logger.debug(`State change of upstream reactor detected.`);
|
||||
this.updateState(data);
|
||||
});
|
||||
return out;
|
||||
}
|
||||
|
||||
|
||||
_updateMeasurement(measurementType, value, position, context) {
|
||||
this.logger.debug(`---------------------- updating ${measurementType} ------------------ `);
|
||||
switch (measurementType) {
|
||||
case "temperature":
|
||||
if (position == "atEquipment") {
|
||||
this.temperature = value;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
this.logger.error(`Type '${measurementType}' not recognized for measured update.`);
|
||||
return;
|
||||
}
|
||||
getStatusBadge() {
|
||||
const eff = this.engine.getEffluent;
|
||||
const F = Number(eff?.payload?.F) || 0;
|
||||
const SO = Array.isArray(eff?.payload?.C) ? Number(eff.payload.C[0]) : NaN;
|
||||
const so = Number.isFinite(SO) ? SO.toFixed(2) : '—';
|
||||
return statusBadge.compose(
|
||||
[`${this.engine.constructor.name.replace('Reactor_', '')}`,
|
||||
`T=${Number(this.engine.temperature).toFixed(1)} C`,
|
||||
`F=${F.toFixed(2)} m³/d`,
|
||||
`S_O=${so} mg/L`],
|
||||
{ fill: 'green', shape: 'dot' },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the reactor state based on the new time.
|
||||
* @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;
|
||||
}
|
||||
|
||||
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.emitter.emit("stateChange", this.currentTime);
|
||||
}
|
||||
close() {
|
||||
this.engine?.emitter?.removeAllListeners?.();
|
||||
super.close();
|
||||
}
|
||||
}
|
||||
|
||||
class Reactor_CSTR extends Reactor {
|
||||
/**
|
||||
* Reactor_CSTR class for Continuous Stirred Tank Reactor.
|
||||
* @param {object} config - Configuration object containing reactor parameters.
|
||||
*/
|
||||
constructor(config) {
|
||||
super(config);
|
||||
this.state = config.initialState;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tick the reactor state using the forward Euler method.
|
||||
* @param {number} time_step - Time step for the simulation [d].
|
||||
* @returns {Array} - New reactor state.
|
||||
*/
|
||||
tick(time_step) { // tick reactor state using forward Euler method
|
||||
const inflow = math.multiply(math.divide([this.Fs], this.volume), this.Cs_in)[0];
|
||||
const outflow = math.multiply(-1 * math.sum(this.Fs) / this.volume, this.state);
|
||||
const reaction = this.asm.compute_dC(this.state, this.temperature);
|
||||
const transfer = Array(NUM_SPECIES).fill(0.0);
|
||||
transfer[S_O_INDEX] = isNaN(this.kla) ? this.OTR : this._calcOTR(this.state[S_O_INDEX], this.temperature); // calculate OTR if kla is not NaN, otherwise use externaly calculated OTR
|
||||
|
||||
const dC_total = math.multiply(math.add(inflow, outflow, reaction, transfer), time_step)
|
||||
this.state = this._arrayClip2Zero(math.add(this.state, dC_total)); // clip value element-wise to avoid negative concentrations
|
||||
if(DEBUG){
|
||||
assertNoNaN(dC_total, "change in state");
|
||||
assertNoNaN(this.state, "new state");
|
||||
}
|
||||
return this.state;
|
||||
}
|
||||
}
|
||||
|
||||
class Reactor_PFR extends Reactor {
|
||||
/**
|
||||
* Reactor_PFR class for Plug Flow Reactor.
|
||||
* @param {object} config - Configuration object containing reactor parameters.
|
||||
*/
|
||||
constructor(config) {
|
||||
super(config);
|
||||
|
||||
this.length = config.length; // reactor length [m]
|
||||
this.n_x = config.resolution_L; // number of slices
|
||||
|
||||
this.d_x = this.length / this.n_x;
|
||||
this.A = this.volume / this.length; // crosssectional area [m2]
|
||||
|
||||
this.alpha = config.alpha;
|
||||
|
||||
this.state = Array.from(Array(this.n_x), () => config.initialState.slice())
|
||||
|
||||
this.D = 0.0; // axial dispersion [m2 d-1]
|
||||
|
||||
this.D_op = this._makeDoperator(true, true);
|
||||
assertNoNaN(this.D_op, "Derivative operator");
|
||||
|
||||
this.D2_op = this._makeD2operator();
|
||||
assertNoNaN(this.D2_op, "Second derivative operator");
|
||||
}
|
||||
|
||||
/**
|
||||
* Setter for axial dispersion.
|
||||
* @param {object} input - Input object (msg) containing payload with dispersion value [m2 d-1].
|
||||
*/
|
||||
set setDispersion(input) {
|
||||
this.D = input.payload;
|
||||
}
|
||||
|
||||
updateState(newTime) {
|
||||
super.updateState(newTime);
|
||||
let Pe_local = this.d_x*math.sum(this.Fs)/(this.D*this.A)
|
||||
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.`);
|
||||
(Co_D >= 0.5) && this.logger.warn(`Courant number (${Co_D}) is too high! Reduce time step size.`);
|
||||
|
||||
if(DEBUG) {
|
||||
console.log("Inlet state max " + math.max(this.state[0]))
|
||||
console.log("Pe total " + this.length*math.sum(this.Fs)/(this.D*this.A));
|
||||
console.log("Pe local " + Pe_local);
|
||||
console.log("Co ad " + math.sum(this.Fs)*this.timeStep/(this.A*this.d_x));
|
||||
console.log("Co D " + Co_D);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tick the reactor state using explicit finite difference method.
|
||||
* @param {number} time_step - Time step for the simulation [d].
|
||||
* @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);
|
||||
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 transfer = Array.from(Array(this.n_x), () => 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++) {
|
||||
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++) {
|
||||
transfer[i][S_O_INDEX] = this._calcOTR(this.state[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 stateNew = math.add(this.state, dC_total);
|
||||
this._applyBoundaryConditions(stateNew);
|
||||
|
||||
if (DEBUG) {
|
||||
assertNoNaN(dispersion, "dispersion");
|
||||
assertNoNaN(advection, "advection");
|
||||
assertNoNaN(reaction, "reaction");
|
||||
assertNoNaN(dC_total, "change in state");
|
||||
assertNoNaN(stateNew, "new state post BC");
|
||||
}
|
||||
|
||||
this.state = this._arrayClip2Zero(stateNew);
|
||||
return stateNew;
|
||||
}
|
||||
|
||||
_updateMeasurement(measurementType, value, position, context) {
|
||||
switch(measurementType) {
|
||||
case "quantity (oxygen)":
|
||||
grid_pos = Math.round(position / this.config.length * this.n_x);
|
||||
this.state[grid_pos][S_O_INDEX] = value; // naive approach for reconciling measurements and simulation
|
||||
break;
|
||||
default:
|
||||
super._updateMeasurement(measurementType, value, position, context);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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) {
|
||||
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);
|
||||
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];
|
||||
}
|
||||
// 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
|
||||
if (higher_order) {
|
||||
if (central) {
|
||||
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(this.n_x).fill(-2/3), -1), [this.n_x, this.n_x]);
|
||||
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(this.n_x).fill(-1/12), 2), [this.n_x, this.n_x]);
|
||||
const D = math.add(I, A, B, C);
|
||||
const NearBoundary = Array(this.n_x).fill(0.0);
|
||||
NearBoundary[0] = -1/4;
|
||||
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;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create central finite difference second derivative operator.
|
||||
* @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 A = math.resize(math.diag(Array(this.n_x).fill(1), 1), [this.n_x, this.n_x]);
|
||||
const B = math.resize(math.diag(Array(this.n_x).fill(1), -1), [this.n_x, this.n_x]);
|
||||
const D2 = math.add(I, A, B);
|
||||
D2[0] = Array(this.n_x).fill(0); // set by BCs elsewhere
|
||||
D2[this.n_x - 1] = Array(this.n_x).fill(0);
|
||||
return D2;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { Reactor_CSTR, Reactor_PFR };
|
||||
|
||||
// DEBUG
|
||||
// state: S_O, S_I, S_S, S_NH, S_N2, S_NO, S_HCO, X_I, X_S, X_H, X_STO, X_A, X_TS
|
||||
// let initial_state = [0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1];
|
||||
// const Reactor = new Reactor_PFR(200, 10, 10, 1, 100, initial_state);
|
||||
// Reactor.Cs_in[0] = [0.0, 30., 100., 16., 0., 0., 5., 25., 75., 30., 0., 0., 125.];
|
||||
// Reactor.Fs[0] = 10;
|
||||
// Reactor.D = 0.01;
|
||||
// let N = 0;
|
||||
// while (N < 5000) {
|
||||
// console.log(Reactor.tick(0.001));
|
||||
// N += 1;
|
||||
// }
|
||||
module.exports = Reactor;
|
||||
module.exports.Reactor = Reactor;
|
||||
module.exports.Reactor_CSTR = Reactor_CSTR;
|
||||
module.exports.Reactor_PFR = Reactor_PFR;
|
||||
// POSITIONS is consumed by older test setups; surface it here so they don't
|
||||
// need to chase down generalFunctions internals.
|
||||
module.exports.POSITIONS = POSITIONS;
|
||||
|
||||
12
test/README.md
Normal file
12
test/README.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# reactor Test Suite Layout
|
||||
|
||||
Required EVOLV layout:
|
||||
- basic/
|
||||
- integration/
|
||||
- edge/
|
||||
- helpers/
|
||||
|
||||
Baseline structure tests:
|
||||
- basic/structure-module-load.basic.test.js
|
||||
- integration/structure-examples.integration.test.js
|
||||
- edge/structure-examples-node-type.edge.test.js
|
||||
0
test/basic/.gitkeep
Normal file
0
test/basic/.gitkeep
Normal file
65
test/basic/constructor.basic.test.js
Normal file
65
test/basic/constructor.basic.test.js
Normal file
@@ -0,0 +1,65 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeUiConfig } = require('../helpers/factories');
|
||||
|
||||
// These tests pinned the old private _loadConfig / _setupClass methods on
|
||||
// the pre-refactor nodeClass. After the BaseNodeAdapter migration the
|
||||
// same logic lives in buildDomainConfig + the Reactor wrapper's engine
|
||||
// selector. We exercise both surfaces directly.
|
||||
|
||||
test('buildDomainConfig coerces numeric fields and builds initial state vector', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
inst.node = { id: 'n-reactor-1' };
|
||||
inst.name = 'reactor';
|
||||
const dc = inst.buildDomainConfig(
|
||||
makeUiConfig({
|
||||
volume: '12.5',
|
||||
length: '9',
|
||||
resolution_L: '7',
|
||||
alpha: '0.5',
|
||||
n_inlets: '3',
|
||||
timeStep: '2',
|
||||
S_O_init: '1.1',
|
||||
}),
|
||||
);
|
||||
|
||||
assert.equal(dc.reactor.volume, 12.5);
|
||||
assert.equal(dc.reactor.length, 9);
|
||||
assert.equal(dc.reactor.resolution_L, 7);
|
||||
assert.equal(dc.reactor.alpha, 0.5);
|
||||
assert.equal(dc.reactor.n_inlets, 3);
|
||||
assert.equal(dc.reactor.timeStep, 2);
|
||||
assert.equal(Object.keys(dc.initialState).length, 13);
|
||||
assert.equal(dc.initialState.S_O, 1.1);
|
||||
});
|
||||
|
||||
test('Reactor wrapper instantiates CSTR engine when configured as CSTR', () => {
|
||||
const Reactor = require('../../src/specificClass');
|
||||
const config = {
|
||||
general: { name: 'reactor', id: 'n', logging: { enabled: false, logLevel: 'error' } },
|
||||
functionality: { softwareType: 'reactor', positionVsParent: 'atEquipment' },
|
||||
reactor: { reactor_type: 'CSTR', volume: 100, length: 10, resolution_L: 5, alpha: 0,
|
||||
n_inlets: 1, kla: NaN, timeStep: 1 },
|
||||
initialState: { S_O: 0, S_I: 30, S_S: 100, S_NH: 16, S_N2: 0, S_NO: 0, S_HCO: 5,
|
||||
X_I: 25, X_S: 75, X_H: 30, X_STO: 0, X_A: 0.001, X_TS: 125 },
|
||||
};
|
||||
const r = new Reactor(config);
|
||||
assert.ok(r.engine instanceof Reactor_CSTR);
|
||||
});
|
||||
|
||||
test('Reactor wrapper instantiates PFR engine when configured as PFR', () => {
|
||||
const Reactor = require('../../src/specificClass');
|
||||
const config = {
|
||||
general: { name: 'reactor', id: 'n', logging: { enabled: false, logLevel: 'error' } },
|
||||
functionality: { softwareType: 'reactor', positionVsParent: 'atEquipment' },
|
||||
reactor: { reactor_type: 'PFR', volume: 100, length: 10, resolution_L: 5, alpha: 0,
|
||||
n_inlets: 1, kla: NaN, timeStep: 1 },
|
||||
initialState: { S_O: 0, S_I: 30, S_S: 100, S_NH: 16, S_N2: 0, S_NO: 0, S_HCO: 5,
|
||||
X_I: 25, X_S: 75, X_H: 30, X_STO: 0, X_A: 0.001, X_TS: 125 },
|
||||
};
|
||||
const r = new Reactor(config);
|
||||
assert.ok(r.engine instanceof Reactor_PFR);
|
||||
});
|
||||
42
test/basic/cstr-tick.basic.test.js
Normal file
42
test/basic/cstr-tick.basic.test.js
Normal file
@@ -0,0 +1,42 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
const NUM_SPECIES = 13;
|
||||
|
||||
test('Reactor_CSTR tick clips negative concentrations to zero', () => {
|
||||
const reactor = new Reactor_CSTR(
|
||||
makeReactorConfig({
|
||||
reactor_type: 'CSTR',
|
||||
volume: 1,
|
||||
n_inlets: 1,
|
||||
kla: NaN,
|
||||
S_O_init: 0.1,
|
||||
S_I_init: 0.1,
|
||||
S_S_init: 0.1,
|
||||
S_NH_init: 0.1,
|
||||
S_N2_init: 0.1,
|
||||
S_NO_init: 0.1,
|
||||
S_HCO_init: 0.1,
|
||||
X_I_init: 0.1,
|
||||
X_S_init: 0.1,
|
||||
X_H_init: 0.1,
|
||||
X_STO_init: 0.1,
|
||||
X_A_init: 0.1,
|
||||
X_TS_init: 0.1,
|
||||
}),
|
||||
);
|
||||
|
||||
reactor.asm = {
|
||||
compute_dC: () => Array(NUM_SPECIES).fill(0),
|
||||
};
|
||||
reactor.Fs[0] = 1;
|
||||
reactor.Cs_in[0] = Array(NUM_SPECIES).fill(0);
|
||||
|
||||
reactor.tick(1);
|
||||
|
||||
assert.equal(reactor.state.every((v) => Number.isFinite(v) && v >= 0), true);
|
||||
assert.equal(reactor.state.every((v) => v === 0), true);
|
||||
});
|
||||
38
test/basic/effluent-shape.basic.test.js
Normal file
38
test/basic/effluent-shape.basic.test.js
Normal file
@@ -0,0 +1,38 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
test('CSTR getEffluent returns flat concentration vector', () => {
|
||||
const reactor = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR', n_inlets: 1 }));
|
||||
reactor.state = Array.from({ length: 13 }, (_, i) => i + 1);
|
||||
reactor.Fs[0] = 5;
|
||||
|
||||
const effluent = reactor.getEffluent;
|
||||
|
||||
assert.equal(effluent.topic, 'Fluent');
|
||||
assert.equal(effluent.payload.inlet, 0);
|
||||
assert.equal(effluent.payload.F, 5);
|
||||
assert.deepEqual(effluent.payload.C, reactor.state);
|
||||
});
|
||||
|
||||
test('PFR getEffluent returns last slice concentration vector', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', n_inlets: 1, length: 10, resolution_L: 4 }),
|
||||
);
|
||||
|
||||
reactor.state = [
|
||||
Array(13).fill(10),
|
||||
Array(13).fill(20),
|
||||
Array(13).fill(30),
|
||||
Array(13).fill(40),
|
||||
];
|
||||
reactor.Fs[0] = 7;
|
||||
|
||||
const effluent = reactor.getEffluent;
|
||||
|
||||
assert.equal(effluent.topic, 'Fluent');
|
||||
assert.equal(effluent.payload.F, 7);
|
||||
assert.deepEqual(effluent.payload.C, Array(13).fill(40));
|
||||
});
|
||||
45
test/basic/grid-profile.basic.test.js
Normal file
45
test/basic/grid-profile.basic.test.js
Normal file
@@ -0,0 +1,45 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
test('CSTR getGridProfile returns null', () => {
|
||||
const reactor = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR' }));
|
||||
assert.equal(reactor.getGridProfile, null);
|
||||
});
|
||||
|
||||
test('PFR getGridProfile returns state matrix with correct dimensions', () => {
|
||||
const n_x = 8;
|
||||
const length = 40;
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', resolution_L: n_x, length }),
|
||||
);
|
||||
|
||||
const profile = reactor.getGridProfile;
|
||||
assert.notEqual(profile, null);
|
||||
assert.equal(profile.n_x, n_x);
|
||||
assert.equal(profile.d_x, length / n_x);
|
||||
assert.equal(profile.length, length);
|
||||
assert.equal(profile.grid.length, n_x, 'grid should have n_x rows');
|
||||
assert.equal(profile.grid[0].length, 13, 'each row should have 13 species');
|
||||
assert.ok(Array.isArray(profile.species), 'species list should be an array');
|
||||
assert.equal(profile.species.length, 13);
|
||||
assert.equal(profile.species[3], 'S_NH');
|
||||
assert.equal(typeof profile.timestamp, 'number');
|
||||
});
|
||||
|
||||
test('PFR getGridProfile is mutation-safe', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', resolution_L: 5, length: 10 }),
|
||||
);
|
||||
|
||||
const profile = reactor.getGridProfile;
|
||||
const originalValue = reactor.state[0][3]; // S_NH at cell 0
|
||||
|
||||
// Mutate the returned grid
|
||||
profile.grid[0][3] = 999;
|
||||
|
||||
// Reactor internal state should be unchanged
|
||||
assert.equal(reactor.state[0][3], originalValue, 'mutating grid copy must not affect reactor state');
|
||||
});
|
||||
56
test/basic/input-routing.basic.test.js
Normal file
56
test/basic/input-routing.basic.test.js
Normal file
@@ -0,0 +1,56 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const commands = require('../../src/commands');
|
||||
const { createRegistry } = require('generalFunctions');
|
||||
const { makeNodeStub, makeREDStub } = require('../helpers/factories');
|
||||
|
||||
// Post-refactor: dispatch goes through the commands registry built by
|
||||
// BaseNodeAdapter (this._commands). We seed the registry on a prototype-
|
||||
// derived instance, then drive _attachInputHandler the same way the live
|
||||
// adapter would.
|
||||
|
||||
test('input handler routes legacy topic aliases to engine setters', async () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
const calls = [];
|
||||
|
||||
const source = {
|
||||
logger: { warn: () => {}, info: () => {}, debug: () => {}, error: () => {} },
|
||||
updateState(t) { calls.push(['clock', t]); },
|
||||
childRegistrationUtils: {
|
||||
registerChild(childSource, position) { calls.push(['registerChild', childSource, position]); },
|
||||
},
|
||||
};
|
||||
|
||||
Object.defineProperty(source, 'setInfluent', { set(v) { calls.push(['Fluent', v]); } });
|
||||
Object.defineProperty(source, 'setOTR', { set(v) { calls.push(['OTR', v]); } });
|
||||
Object.defineProperty(source, 'setTemperature', { set(v) { calls.push(['Temperature', v]); } });
|
||||
Object.defineProperty(source, 'setDispersion', { set(v) { calls.push(['Dispersion', v]); } });
|
||||
|
||||
inst.node = node;
|
||||
inst.RED = makeREDStub({ childA: { source: { id: 'child-source-A' } } });
|
||||
inst.source = source;
|
||||
inst._commands = createRegistry(commands, { logger: source.logger });
|
||||
inst._attachInputHandler();
|
||||
|
||||
const onInput = node._handlers.input;
|
||||
let doneCount = 0;
|
||||
const done = () => { doneCount += 1; };
|
||||
|
||||
await onInput({ topic: 'clock', timestamp: 1000 }, () => {}, done);
|
||||
await onInput({ topic: 'Fluent', payload: { inlet: 0, F: 10, C: [] } }, () => {}, done);
|
||||
await onInput({ topic: 'OTR', payload: 3.5 }, () => {}, done);
|
||||
await onInput({ topic: 'Temperature', payload: 18.2 }, () => {}, done);
|
||||
await onInput({ topic: 'Dispersion', payload: 0.2 }, () => {}, done);
|
||||
await onInput({ topic: 'registerChild', payload: 'childA', positionVsParent: 'upstream' }, () => {}, done);
|
||||
|
||||
assert.equal(doneCount, 6);
|
||||
assert.deepEqual(calls[0], ['clock', 1000]);
|
||||
assert.equal(calls.some((x) => x[0] === 'Fluent'), true);
|
||||
assert.equal(calls.some((x) => x[0] === 'OTR'), true);
|
||||
assert.equal(calls.some((x) => x[0] === 'Temperature'), true);
|
||||
assert.equal(calls.some((x) => x[0] === 'Dispersion'), true);
|
||||
assert.deepEqual(calls.at(-1), ['registerChild', { id: 'child-source-A' }, 'upstream']);
|
||||
});
|
||||
27
test/basic/pfr-operators.basic.test.js
Normal file
27
test/basic/pfr-operators.basic.test.js
Normal file
@@ -0,0 +1,27 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
test('Reactor_PFR derivative operators have expected dimensions and boundary rows', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({
|
||||
reactor_type: 'PFR',
|
||||
length: 12,
|
||||
resolution_L: 6,
|
||||
volume: 60,
|
||||
n_inlets: 1,
|
||||
}),
|
||||
);
|
||||
|
||||
assert.equal(reactor.D_op.length, reactor.n_x);
|
||||
assert.equal(reactor.D2_op.length, reactor.n_x);
|
||||
assert.equal(reactor.D_op.every((row) => row.length === reactor.n_x), true);
|
||||
assert.equal(reactor.D2_op.every((row) => row.length === reactor.n_x), true);
|
||||
|
||||
assert.deepEqual(reactor.D_op[0], Array(reactor.n_x).fill(0));
|
||||
assert.deepEqual(reactor.D_op[reactor.n_x - 1], Array(reactor.n_x).fill(0));
|
||||
assert.deepEqual(reactor.D2_op[0], Array(reactor.n_x).fill(0));
|
||||
assert.deepEqual(reactor.D2_op[reactor.n_x - 1], Array(reactor.n_x).fill(0));
|
||||
});
|
||||
32
test/basic/register-child.basic.test.js
Normal file
32
test/basic/register-child.basic.test.js
Normal file
@@ -0,0 +1,32 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const { makeNodeStub } = require('../helpers/factories');
|
||||
|
||||
// Post-refactor: BaseNodeAdapter handles registration via _scheduleRegistration
|
||||
// (was _registerChild). Topic moved from 'registerChild' to 'child.register'.
|
||||
test('_scheduleRegistration emits delayed child.register message on output 2', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
|
||||
inst.node = node;
|
||||
inst.config = { functionality: { positionVsParent: 'downstream', distance: null } };
|
||||
|
||||
const originalSetTimeout = global.setTimeout;
|
||||
const delays = [];
|
||||
global.setTimeout = (fn, ms) => { delays.push(ms); fn(); return 1; };
|
||||
|
||||
try {
|
||||
inst._scheduleRegistration();
|
||||
} finally {
|
||||
global.setTimeout = originalSetTimeout;
|
||||
}
|
||||
|
||||
assert.deepEqual(delays, [100]);
|
||||
assert.equal(node._sent.length, 1);
|
||||
assert.equal(Array.isArray(node._sent[0]), true);
|
||||
assert.equal(node._sent[0][2].topic, 'child.register');
|
||||
assert.equal(node._sent[0][2].payload, node.id);
|
||||
assert.equal(node._sent[0][2].positionVsParent, 'downstream');
|
||||
});
|
||||
61
test/basic/speedup-factor.basic.test.js
Normal file
61
test/basic/speedup-factor.basic.test.js
Normal file
@@ -0,0 +1,61 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR } = require('../../src/specificClass');
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const { makeReactorConfig, makeUiConfig } = require('../helpers/factories');
|
||||
|
||||
/**
|
||||
* Smoke tests for Fix 3: configurable speedUpFactor on Reactor.
|
||||
*/
|
||||
|
||||
test('specificClass defaults speedUpFactor to 1 when not in config', () => {
|
||||
const config = makeReactorConfig();
|
||||
const reactor = new Reactor_CSTR(config);
|
||||
assert.equal(reactor.speedUpFactor, 1, 'speedUpFactor should default to 1');
|
||||
});
|
||||
|
||||
test('specificClass accepts speedUpFactor from config', () => {
|
||||
const config = makeReactorConfig();
|
||||
config.speedUpFactor = 10;
|
||||
const reactor = new Reactor_CSTR(config);
|
||||
assert.equal(reactor.speedUpFactor, 10, 'speedUpFactor should be read from config');
|
||||
});
|
||||
|
||||
test('specificClass accepts speedUpFactor = 60 for accelerated simulation', () => {
|
||||
const config = makeReactorConfig();
|
||||
config.speedUpFactor = 60;
|
||||
const reactor = new Reactor_CSTR(config);
|
||||
assert.equal(reactor.speedUpFactor, 60, 'speedUpFactor=60 should be accepted');
|
||||
});
|
||||
|
||||
test('buildDomainConfig propagates speedUpFactor from uiConfig', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
inst.node = { id: 'n-reactor' };
|
||||
inst.name = 'reactor';
|
||||
const dc = inst.buildDomainConfig(makeUiConfig({ speedUpFactor: 5 }));
|
||||
assert.equal(dc.reactor.speedUpFactor, 5);
|
||||
});
|
||||
|
||||
test('buildDomainConfig defaults speedUpFactor to 1 when missing from uiConfig', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
inst.node = { id: 'n-reactor' };
|
||||
inst.name = 'reactor';
|
||||
const ui = makeUiConfig();
|
||||
delete ui.speedUpFactor;
|
||||
const dc = inst.buildDomainConfig(ui);
|
||||
assert.equal(dc.reactor.speedUpFactor, 1);
|
||||
});
|
||||
|
||||
test('updateState with speedUpFactor=1 advances roughly real-time', () => {
|
||||
const config = makeReactorConfig();
|
||||
config.speedUpFactor = 1;
|
||||
config.n_inlets = 1;
|
||||
const reactor = new Reactor_CSTR(config);
|
||||
|
||||
const t0 = reactor.currentTime;
|
||||
reactor.updateState(t0 + 2000);
|
||||
|
||||
const elapsed = reactor.currentTime - t0;
|
||||
assert.ok(elapsed < 5000, `Elapsed ${elapsed}ms should be close to 2000ms, not 120000ms (old 60x factor)`);
|
||||
});
|
||||
8
test/basic/structure-module-load.basic.test.js
Normal file
8
test/basic/structure-module-load.basic.test.js
Normal file
@@ -0,0 +1,8 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
test('reactor module load smoke', () => {
|
||||
assert.doesNotThrow(() => {
|
||||
require('../../reactor.js');
|
||||
});
|
||||
});
|
||||
0
test/edge/.gitkeep
Normal file
0
test/edge/.gitkeep
Normal file
21
test/edge/invalid-reactor-type.edge.test.js
Normal file
21
test/edge/invalid-reactor-type.edge.test.js
Normal file
@@ -0,0 +1,21 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const Reactor = require('../../src/specificClass');
|
||||
const { Reactor_CSTR } = require('../../src/specificClass');
|
||||
|
||||
// Post-refactor: an unknown reactor_type falls back to CSTR and warns,
|
||||
// rather than throwing.
|
||||
test('Reactor wrapper falls back to CSTR when reactor_type is unknown', () => {
|
||||
const config = {
|
||||
general: { name: 'reactor', id: 'n', logging: { enabled: false, logLevel: 'error' } },
|
||||
functionality: { softwareType: 'reactor', positionVsParent: 'atEquipment' },
|
||||
reactor: { reactor_type: 'UNKNOWN_TYPE', volume: 100, length: 10, resolution_L: 5,
|
||||
alpha: 0, n_inlets: 1, kla: NaN, timeStep: 1 },
|
||||
initialState: { S_O: 0, S_I: 30, S_S: 100, S_NH: 16, S_N2: 0, S_NO: 0, S_HCO: 5,
|
||||
X_I: 25, X_S: 75, X_H: 30, X_STO: 0, X_A: 0.001, X_TS: 125 },
|
||||
};
|
||||
|
||||
const r = new Reactor(config);
|
||||
assert.ok(r.engine instanceof Reactor_CSTR);
|
||||
});
|
||||
31
test/edge/invalid-topic.edge.test.js
Normal file
31
test/edge/invalid-topic.edge.test.js
Normal file
@@ -0,0 +1,31 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const commands = require('../../src/commands');
|
||||
const { createRegistry } = require('generalFunctions');
|
||||
const { makeNodeStub, makeREDStub } = require('../helpers/factories');
|
||||
|
||||
test('unknown input topic does not throw and still calls done', async () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
|
||||
inst.node = node;
|
||||
inst.RED = makeREDStub();
|
||||
inst.source = {
|
||||
logger: { warn: () => {}, info: () => {}, debug: () => {}, error: () => {} },
|
||||
childRegistrationUtils: { registerChild() {} },
|
||||
updateState() {},
|
||||
};
|
||||
inst._commands = createRegistry(commands, { logger: inst.source.logger });
|
||||
inst._attachInputHandler();
|
||||
|
||||
let doneCalled = 0;
|
||||
await assert.doesNotReject(async () => {
|
||||
await node._handlers.input({ topic: 'somethingUnknown', payload: 1 }, () => {}, () => {
|
||||
doneCalled += 1;
|
||||
});
|
||||
});
|
||||
|
||||
assert.equal(doneCalled, 1);
|
||||
});
|
||||
29
test/edge/missing-child.edge.test.js
Normal file
29
test/edge/missing-child.edge.test.js
Normal file
@@ -0,0 +1,29 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const commands = require('../../src/commands');
|
||||
const { createRegistry } = require('generalFunctions');
|
||||
const { makeNodeStub, makeREDStub } = require('../helpers/factories');
|
||||
|
||||
test('registerChild with unknown node id is ignored without throwing', async () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
|
||||
inst.node = node;
|
||||
inst.RED = makeREDStub();
|
||||
inst.source = {
|
||||
logger: { warn: () => {}, info: () => {}, debug: () => {}, error: () => {} },
|
||||
childRegistrationUtils: { registerChild() {} },
|
||||
};
|
||||
inst._commands = createRegistry(commands, { logger: inst.source.logger });
|
||||
inst._attachInputHandler();
|
||||
|
||||
await assert.doesNotReject(async () => {
|
||||
await node._handlers.input(
|
||||
{ topic: 'registerChild', payload: 'missing-child', positionVsParent: 'upstream' },
|
||||
() => {},
|
||||
() => {},
|
||||
);
|
||||
});
|
||||
});
|
||||
16
test/edge/pfr-measurement-grid.edge.test.js
Normal file
16
test/edge/pfr-measurement-grid.edge.test.js
Normal file
@@ -0,0 +1,16 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
test('oxygen measurement at exact reactor length is clamped to the last PFR grid index', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', length: 10, resolution_L: 5, n_inlets: 1 }),
|
||||
);
|
||||
|
||||
assert.doesNotThrow(() => {
|
||||
reactor._updateMeasurement('quantity (oxygen)', 2.5, 10, {});
|
||||
});
|
||||
assert.equal(reactor.state[reactor.n_x - 1][0], 2.5);
|
||||
});
|
||||
11
test/edge/structure-examples-node-type.edge.test.js
Normal file
11
test/edge/structure-examples-node-type.edge.test.js
Normal file
@@ -0,0 +1,11 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
const fs = require('node:fs');
|
||||
const path = require('node:path');
|
||||
|
||||
const flow = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../../examples/basic.flow.json'), 'utf8'));
|
||||
|
||||
test('basic example includes node type reactor', () => {
|
||||
const count = flow.filter((n) => n && n.type === 'reactor').length;
|
||||
assert.equal(count >= 1, true);
|
||||
});
|
||||
27
test/edge/zero-dispersion.edge.test.js
Normal file
27
test/edge/zero-dispersion.edge.test.js
Normal file
@@ -0,0 +1,27 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
const DAY_MS = 1000 * 60 * 60 * 24;
|
||||
|
||||
test('updateState warns when local Peclet number is too high at zero dispersion', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', length: 10, resolution_L: 5, volume: 50, n_inlets: 1 }),
|
||||
);
|
||||
|
||||
const warnings = [];
|
||||
reactor.logger.warn = (msg) => warnings.push(String(msg));
|
||||
|
||||
reactor.currentTime = 0;
|
||||
reactor.timeStep = 1;
|
||||
reactor.speedUpFactor = 1;
|
||||
reactor.Fs[0] = 2;
|
||||
reactor.D = 0;
|
||||
reactor.tick = () => reactor.state;
|
||||
|
||||
reactor.updateState(DAY_MS);
|
||||
|
||||
assert.equal(warnings.some((w) => w.includes('Péclet number') || w.includes('Peclet number')), true);
|
||||
});
|
||||
0
test/helpers/.gitkeep
Normal file
0
test/helpers/.gitkeep
Normal file
149
test/helpers/factories.js
Normal file
149
test/helpers/factories.js
Normal file
@@ -0,0 +1,149 @@
|
||||
const EventEmitter = require('node:events');
|
||||
|
||||
function makeUiConfig(overrides = {}) {
|
||||
return {
|
||||
name: 'reactor-test',
|
||||
reactor_type: 'CSTR',
|
||||
volume: 100,
|
||||
length: 10,
|
||||
resolution_L: 5,
|
||||
alpha: 0,
|
||||
n_inlets: 1,
|
||||
kla: NaN,
|
||||
S_O_init: 0,
|
||||
S_I_init: 30,
|
||||
S_S_init: 100,
|
||||
S_NH_init: 16,
|
||||
S_N2_init: 0,
|
||||
S_NO_init: 0,
|
||||
S_HCO_init: 5,
|
||||
X_I_init: 25,
|
||||
X_S_init: 75,
|
||||
X_H_init: 30,
|
||||
X_STO_init: 0,
|
||||
X_A_init: 0.001,
|
||||
X_TS_init: 125,
|
||||
timeStep: 1,
|
||||
enableLog: false,
|
||||
logLevel: 'error',
|
||||
positionVsParent: 'atEquipment',
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
function makeReactorConfig(overrides = {}) {
|
||||
const ui = makeUiConfig(overrides);
|
||||
return {
|
||||
general: {
|
||||
id: 'reactor-node-1',
|
||||
name: ui.name,
|
||||
unit: null,
|
||||
logging: {
|
||||
enabled: ui.enableLog,
|
||||
logLevel: ui.logLevel,
|
||||
},
|
||||
},
|
||||
functionality: {
|
||||
positionVsParent: ui.positionVsParent || 'atEquipment',
|
||||
softwareType: 'reactor',
|
||||
},
|
||||
reactor_type: ui.reactor_type,
|
||||
volume: Number(ui.volume),
|
||||
length: Number(ui.length),
|
||||
resolution_L: Number(ui.resolution_L),
|
||||
alpha: Number(ui.alpha),
|
||||
n_inlets: Number(ui.n_inlets),
|
||||
kla: Number(ui.kla),
|
||||
initialState: [
|
||||
Number(ui.S_O_init),
|
||||
Number(ui.S_I_init),
|
||||
Number(ui.S_S_init),
|
||||
Number(ui.S_NH_init),
|
||||
Number(ui.S_N2_init),
|
||||
Number(ui.S_NO_init),
|
||||
Number(ui.S_HCO_init),
|
||||
Number(ui.X_I_init),
|
||||
Number(ui.X_S_init),
|
||||
Number(ui.X_H_init),
|
||||
Number(ui.X_STO_init),
|
||||
Number(ui.X_A_init),
|
||||
Number(ui.X_TS_init),
|
||||
],
|
||||
timeStep: Number(ui.timeStep),
|
||||
};
|
||||
}
|
||||
|
||||
function makeNodeStub() {
|
||||
const handlers = {};
|
||||
const sent = [];
|
||||
const warns = [];
|
||||
const errors = [];
|
||||
const statuses = [];
|
||||
|
||||
return {
|
||||
id: 'reactor-node-1',
|
||||
source: null,
|
||||
on(event, cb) {
|
||||
handlers[event] = cb;
|
||||
},
|
||||
send(msg) {
|
||||
sent.push(msg);
|
||||
},
|
||||
warn(msg) {
|
||||
warns.push(msg);
|
||||
},
|
||||
error(msg) {
|
||||
errors.push(msg);
|
||||
},
|
||||
status(msg) {
|
||||
statuses.push(msg);
|
||||
},
|
||||
_handlers: handlers,
|
||||
_sent: sent,
|
||||
_warns: warns,
|
||||
_errors: errors,
|
||||
_statuses: statuses,
|
||||
};
|
||||
}
|
||||
|
||||
function makeREDStub(nodeMap = {}) {
|
||||
return {
|
||||
nodes: {
|
||||
getNode(id) {
|
||||
return nodeMap[id] || null;
|
||||
},
|
||||
createNode() {},
|
||||
registerType() {},
|
||||
},
|
||||
httpAdmin: {
|
||||
get() {},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function makeMeasurementChild({
|
||||
id = 'measurement-1',
|
||||
name = 'temp-sensor-1',
|
||||
distance = 'atEquipment',
|
||||
positionVsParent = 'atEquipment',
|
||||
type = 'temperature',
|
||||
} = {}) {
|
||||
return {
|
||||
config: {
|
||||
general: { id, name },
|
||||
functionality: { distance, positionVsParent, softwareType: 'measurement' },
|
||||
asset: { type },
|
||||
},
|
||||
measurements: {
|
||||
emitter: new EventEmitter(),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
makeUiConfig,
|
||||
makeReactorConfig,
|
||||
makeNodeStub,
|
||||
makeREDStub,
|
||||
makeMeasurementChild,
|
||||
};
|
||||
0
test/integration/.gitkeep
Normal file
0
test/integration/.gitkeep
Normal file
26
test/integration/measurement-temperature.integration.test.js
Normal file
26
test/integration/measurement-temperature.integration.test.js
Normal file
@@ -0,0 +1,26 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig, makeMeasurementChild } = require('../helpers/factories');
|
||||
|
||||
test('measurement child temperature event updates reactor temperature', () => {
|
||||
const reactor = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR' }));
|
||||
|
||||
const measurement = makeMeasurementChild({
|
||||
type: 'temperature',
|
||||
distance: 'atEquipment',
|
||||
positionVsParent: 'upstream',
|
||||
});
|
||||
|
||||
reactor.registerChild(measurement, 'measurement');
|
||||
|
||||
measurement.measurements.emitter.emit('temperature.measured.atEquipment', {
|
||||
childName: 'T-1',
|
||||
value: 27.5,
|
||||
unit: 'C',
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
|
||||
assert.equal(reactor.temperature, 27.5);
|
||||
});
|
||||
91
test/integration/otr-kla.integration.test.js
Normal file
91
test/integration/otr-kla.integration.test.js
Normal file
@@ -0,0 +1,91 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
const NUM_SPECIES = 13;
|
||||
|
||||
test('CSTR uses external OTR when kla is NaN', () => {
|
||||
const reactor = new Reactor_CSTR(
|
||||
makeReactorConfig({ reactor_type: 'CSTR', kla: NaN, n_inlets: 1 }),
|
||||
);
|
||||
|
||||
reactor.asm = {
|
||||
compute_dC: () => Array(NUM_SPECIES).fill(0),
|
||||
};
|
||||
reactor.Fs[0] = 0;
|
||||
reactor.OTR = 4;
|
||||
reactor.state = Array(NUM_SPECIES).fill(0);
|
||||
|
||||
reactor.tick(1);
|
||||
|
||||
assert.equal(reactor.state[0], 4);
|
||||
});
|
||||
|
||||
test('CSTR uses kla-based oxygen transfer when kla is finite', () => {
|
||||
const reactor = new Reactor_CSTR(
|
||||
makeReactorConfig({ reactor_type: 'CSTR', kla: 2, n_inlets: 1 }),
|
||||
);
|
||||
|
||||
reactor.asm = {
|
||||
compute_dC: () => Array(NUM_SPECIES).fill(0),
|
||||
};
|
||||
reactor.Fs[0] = 0;
|
||||
reactor.OTR = 1;
|
||||
reactor.state = Array(NUM_SPECIES).fill(0);
|
||||
|
||||
const expected = Math.min(
|
||||
reactor._calcOTR(0, reactor.temperature),
|
||||
reactor._calcOxygenSaturation(reactor.temperature),
|
||||
);
|
||||
reactor.tick(1);
|
||||
|
||||
assert.ok(Math.abs(reactor.state[0] - expected) < 1e-9);
|
||||
});
|
||||
|
||||
test('PFR uses external OTR branch when kla is NaN', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', kla: NaN, n_inlets: 1, length: 8, resolution_L: 6, volume: 40 }),
|
||||
);
|
||||
|
||||
reactor.asm = {
|
||||
compute_dC: () => Array(NUM_SPECIES).fill(0),
|
||||
};
|
||||
reactor.Fs[0] = 0;
|
||||
reactor.D = 0;
|
||||
reactor.OTR = 3;
|
||||
reactor.state = Array.from({ length: reactor.n_x }, () => Array(NUM_SPECIES).fill(0));
|
||||
|
||||
reactor.tick(1);
|
||||
|
||||
assert.equal(reactor.state[1][0], 4.5);
|
||||
assert.equal(reactor.state[2][0], 4.5);
|
||||
assert.equal(reactor.state[3][0], 4.5);
|
||||
assert.equal(reactor.state[4][0], 4.5);
|
||||
});
|
||||
|
||||
test('PFR uses kla-based transfer branch when kla is finite', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', kla: 1, n_inlets: 1, length: 8, resolution_L: 6, volume: 40 }),
|
||||
);
|
||||
|
||||
reactor.asm = {
|
||||
compute_dC: () => Array(NUM_SPECIES).fill(0),
|
||||
};
|
||||
reactor.Fs[0] = 0;
|
||||
reactor.D = 0;
|
||||
reactor.OTR = 0;
|
||||
reactor.state = Array.from({ length: reactor.n_x }, () => Array(NUM_SPECIES).fill(0));
|
||||
|
||||
const expected = Math.min(
|
||||
reactor._calcOTR(0, reactor.temperature) * (reactor.n_x / (reactor.n_x - 2)),
|
||||
reactor._calcOxygenSaturation(reactor.temperature),
|
||||
);
|
||||
reactor.tick(1);
|
||||
|
||||
assert.ok(Math.abs(reactor.state[1][0] - expected) < 1e-9);
|
||||
assert.ok(Math.abs(reactor.state[2][0] - expected) < 1e-9);
|
||||
assert.ok(Math.abs(reactor.state[3][0] - expected) < 1e-9);
|
||||
assert.ok(Math.abs(reactor.state[4][0] - expected) < 1e-9);
|
||||
});
|
||||
35
test/integration/pfr-boundary.integration.test.js
Normal file
35
test/integration/pfr-boundary.integration.test.js
Normal file
@@ -0,0 +1,35 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_PFR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
test('_applyBoundaryConditions enforces Danckwerts inlet and Neumann outlet for flowing case', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', n_inlets: 1, length: 10, resolution_L: 5, volume: 50, alpha: 0.2 }),
|
||||
);
|
||||
|
||||
reactor.Fs[0] = 2;
|
||||
reactor.Cs_in[0] = Array(13).fill(9);
|
||||
reactor.D = 1;
|
||||
|
||||
const state = Array.from({ length: reactor.n_x }, (_, i) => Array(13).fill(i));
|
||||
reactor._applyBoundaryConditions(state);
|
||||
|
||||
assert.deepEqual(state[reactor.n_x - 1], state[reactor.n_x - 2]);
|
||||
assert.equal(state[0].every((v) => Number.isFinite(v)), true);
|
||||
});
|
||||
|
||||
test('_applyBoundaryConditions copies first interior slice when no flow is present', () => {
|
||||
const reactor = new Reactor_PFR(
|
||||
makeReactorConfig({ reactor_type: 'PFR', n_inlets: 1, length: 10, resolution_L: 5, volume: 50 }),
|
||||
);
|
||||
|
||||
reactor.Fs[0] = 0;
|
||||
const state = Array.from({ length: reactor.n_x }, (_, i) => Array(13).fill(i + 10));
|
||||
|
||||
reactor._applyBoundaryConditions(state);
|
||||
|
||||
assert.deepEqual(state[0], state[1]);
|
||||
assert.deepEqual(state[reactor.n_x - 1], state[reactor.n_x - 2]);
|
||||
});
|
||||
23
test/integration/structure-examples.integration.test.js
Normal file
23
test/integration/structure-examples.integration.test.js
Normal file
@@ -0,0 +1,23 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
const fs = require('node:fs');
|
||||
const path = require('node:path');
|
||||
|
||||
const dir = path.resolve(__dirname, '../../examples');
|
||||
|
||||
function loadJson(file) {
|
||||
return JSON.parse(fs.readFileSync(path.join(dir, file), 'utf8'));
|
||||
}
|
||||
|
||||
test('examples package exists for reactor', () => {
|
||||
for (const file of ['README.md', 'basic.flow.json', 'integration.flow.json', 'edge.flow.json']) {
|
||||
assert.equal(fs.existsSync(path.join(dir, file)), true, file + ' missing');
|
||||
}
|
||||
});
|
||||
|
||||
test('example flows are parseable arrays for reactor', () => {
|
||||
for (const file of ['basic.flow.json', 'integration.flow.json', 'edge.flow.json']) {
|
||||
const parsed = loadJson(file);
|
||||
assert.equal(Array.isArray(parsed), true);
|
||||
}
|
||||
});
|
||||
103
test/integration/tick-loop.integration.test.js
Normal file
103
test/integration/tick-loop.integration.test.js
Normal file
@@ -0,0 +1,103 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const NodeClass = require('../../src/nodeClass');
|
||||
const { makeNodeStub } = require('../helpers/factories');
|
||||
|
||||
// Post-refactor: BaseNodeAdapter drives tick + status loops. The reactor
|
||||
// nodeClass overrides _emitOutputs to preserve the Fluent / GridProfile
|
||||
// Port-0 contract (delta-compressed payloads can't carry the C-vector).
|
||||
|
||||
test('_emitOutputs emits effluent on process output', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
|
||||
inst.node = node;
|
||||
inst.config = { functionality: { softwareType: 'reactor' }, general: { id: 'r-1' } };
|
||||
inst._output = { formatMsg() { return null; } };
|
||||
inst.source = {
|
||||
engine: { temperature: 18, getEffluent: { topic: 'Fluent', payload: { inlet: 0, F: 1, C: [] }, timestamp: 1 }, get getGridProfile() { return null; } },
|
||||
config: inst.config,
|
||||
updateState() {},
|
||||
get getEffluent() { return this.engine.getEffluent; },
|
||||
get getGridProfile() { return this.engine.getGridProfile; },
|
||||
getOutput() { return {}; },
|
||||
};
|
||||
|
||||
inst._emitOutputs();
|
||||
|
||||
assert.equal(node._sent.length, 1);
|
||||
assert.equal(node._sent[0][0].topic, 'Fluent');
|
||||
assert.equal(node._sent[0][1], null);
|
||||
assert.equal(node._sent[0][2], null);
|
||||
});
|
||||
|
||||
test('_emitOutputs emits reactor telemetry on influx output', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
let captured = null;
|
||||
|
||||
inst.node = node;
|
||||
inst.config = { functionality: { softwareType: 'reactor' }, general: { id: 'reactor-node-1' } };
|
||||
inst._output = {
|
||||
formatMsg(output, _config, format) {
|
||||
captured = { output, format };
|
||||
return { topic: `reactor_${inst.config.general.id}`, payload: { measurement: 'reactor', fields: output } };
|
||||
},
|
||||
};
|
||||
const effluent = { topic: 'Fluent', payload: { inlet: 0, F: 42, C: [2.1, 30, 100, 16, 0, 1, 8, 25, 75, 1500, 0, 15, 2500] }, timestamp: 1 };
|
||||
inst.source = {
|
||||
engine: { temperature: 19.5, getEffluent: effluent, get getGridProfile() { return null; } },
|
||||
config: inst.config,
|
||||
updateState() {},
|
||||
get getEffluent() { return this.engine.getEffluent; },
|
||||
get getGridProfile() { return this.engine.getGridProfile; },
|
||||
getOutput() {
|
||||
const C = effluent.payload.C;
|
||||
const out = { flow_total: effluent.payload.F, temperature: 19.5 };
|
||||
const keys = ['S_O','S_I','S_S','S_NH','S_N2','S_NO','S_HCO','X_I','X_S','X_H','X_STO','X_A','X_TS'];
|
||||
for (let i = 0; i < keys.length; i += 1) out[keys[i]] = C[i];
|
||||
return out;
|
||||
},
|
||||
};
|
||||
|
||||
inst._emitOutputs();
|
||||
|
||||
assert.equal(node._sent.length, 1);
|
||||
assert.equal(node._sent[0][0].topic, 'Fluent');
|
||||
assert.equal(node._sent[0][1].topic, 'reactor_reactor-node-1');
|
||||
assert.equal(captured.format, 'influxdb');
|
||||
assert.equal(captured.output.flow_total, 42);
|
||||
assert.equal(captured.output.temperature, 19.5);
|
||||
assert.equal(captured.output.S_O, 2.1);
|
||||
assert.equal(captured.output.S_NH, 16);
|
||||
assert.equal(captured.output.X_TS, 2500);
|
||||
});
|
||||
|
||||
test('_emitOutputs also emits GridProfile when engine exposes one', () => {
|
||||
const inst = Object.create(NodeClass.prototype);
|
||||
const node = makeNodeStub();
|
||||
|
||||
inst.node = node;
|
||||
inst.config = { functionality: { softwareType: 'reactor' }, general: { id: 'r-1' } };
|
||||
inst._output = { formatMsg() { return null; } };
|
||||
const grid = { grid: [[0]], n_x: 1, d_x: 1, length: 1, species: [], timestamp: 1 };
|
||||
inst.source = {
|
||||
engine: {
|
||||
temperature: 18,
|
||||
getEffluent: { topic: 'Fluent', payload: { inlet: 0, F: 1, C: [] }, timestamp: 1 },
|
||||
get getGridProfile() { return grid; },
|
||||
},
|
||||
config: inst.config,
|
||||
updateState() {},
|
||||
get getEffluent() { return this.engine.getEffluent; },
|
||||
get getGridProfile() { return this.engine.getGridProfile; },
|
||||
getOutput() { return {}; },
|
||||
};
|
||||
|
||||
inst._emitOutputs();
|
||||
|
||||
assert.equal(node._sent.length, 2);
|
||||
assert.equal(node._sent[0][0].topic, 'GridProfile');
|
||||
assert.equal(node._sent[1][0].topic, 'Fluent');
|
||||
});
|
||||
48
test/integration/upstream-reactor.integration.test.js
Normal file
48
test/integration/upstream-reactor.integration.test.js
Normal file
@@ -0,0 +1,48 @@
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const { Reactor_CSTR } = require('../../src/specificClass');
|
||||
const { makeReactorConfig } = require('../helpers/factories');
|
||||
|
||||
const DAY_MS = 1000 * 60 * 60 * 24;
|
||||
|
||||
test('registering upstream reactor subscribes to upstream stateChange events', () => {
|
||||
const downstream = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR' }));
|
||||
const upstream = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR' }));
|
||||
|
||||
let calledWith = null;
|
||||
downstream.updateState = (timestamp) => {
|
||||
calledWith = timestamp;
|
||||
};
|
||||
|
||||
downstream.registerChild(upstream, 'reactor');
|
||||
upstream.emitter.emit('stateChange', 12345);
|
||||
|
||||
assert.equal(downstream.upstreamReactor, upstream);
|
||||
assert.equal(calledWith, 12345);
|
||||
});
|
||||
|
||||
test('updateState pulls influent from upstream reactor effluent when linked', () => {
|
||||
const downstream = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR', n_inlets: 1, timeStep: 1 }));
|
||||
const upstream = new Reactor_CSTR(makeReactorConfig({ reactor_type: 'CSTR', n_inlets: 1 }));
|
||||
|
||||
upstream.Fs[0] = 3;
|
||||
upstream.state = Array(13).fill(11);
|
||||
|
||||
downstream.upstreamReactor = upstream;
|
||||
downstream.currentTime = 0;
|
||||
downstream.timeStep = 1;
|
||||
downstream.speedUpFactor = 1;
|
||||
|
||||
let ticks = 0;
|
||||
downstream.tick = () => {
|
||||
ticks += 1;
|
||||
return downstream.state;
|
||||
};
|
||||
|
||||
downstream.updateState(DAY_MS);
|
||||
|
||||
assert.equal(ticks, 1);
|
||||
assert.equal(downstream.Fs[0], 3);
|
||||
assert.deepEqual(downstream.Cs_in[0], Array(13).fill(11));
|
||||
});
|
||||
346
test/specificClass.test.js
Normal file
346
test/specificClass.test.js
Normal file
@@ -0,0 +1,346 @@
|
||||
/**
|
||||
* Tests for reactor specificClass (domain logic).
|
||||
*
|
||||
* Two reactor classes are exported: Reactor_CSTR and Reactor_PFR.
|
||||
* Both extend a base Reactor class.
|
||||
*
|
||||
* Key methods tested:
|
||||
* - _calcOTR: oxygen transfer rate calculation
|
||||
* - _arrayClip2Zero: clip negative values to zero
|
||||
* - setInfluent / getEffluent: influent/effluent data flow
|
||||
* - setOTR: external OTR override
|
||||
* - tick (CSTR): forward Euler state update
|
||||
* - tick (PFR): finite difference state update
|
||||
* - registerChild: dispatches to measurement / reactor handlers
|
||||
*/
|
||||
|
||||
const { Reactor_CSTR, Reactor_PFR } = require('../src/specificClass');
|
||||
|
||||
// --------------- helpers ---------------
|
||||
|
||||
const NUM_SPECIES = 13;
|
||||
|
||||
function makeCSTRConfig(overrides = {}) {
|
||||
return {
|
||||
general: {
|
||||
name: 'TestCSTR',
|
||||
id: 'cstr-test-1',
|
||||
logging: { enabled: false, logLevel: 'error' },
|
||||
},
|
||||
functionality: {
|
||||
softwareType: 'reactor',
|
||||
positionVsParent: 'atEquipment',
|
||||
},
|
||||
volume: 1000,
|
||||
n_inlets: 1,
|
||||
kla: 240,
|
||||
timeStep: 1, // 1 second
|
||||
initialState: new Array(NUM_SPECIES).fill(1.0),
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
function makePFRConfig(overrides = {}) {
|
||||
return {
|
||||
general: {
|
||||
name: 'TestPFR',
|
||||
id: 'pfr-test-1',
|
||||
logging: { enabled: false, logLevel: 'error' },
|
||||
},
|
||||
functionality: {
|
||||
softwareType: 'reactor',
|
||||
positionVsParent: 'atEquipment',
|
||||
},
|
||||
volume: 200,
|
||||
length: 10,
|
||||
resolution_L: 10,
|
||||
n_inlets: 1,
|
||||
kla: 240,
|
||||
alpha: 0.5,
|
||||
timeStep: 1,
|
||||
initialState: new Array(NUM_SPECIES).fill(0.1),
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// --------------- CSTR tests ---------------
|
||||
|
||||
describe('Reactor_CSTR', () => {
|
||||
|
||||
describe('constructor / initialization', () => {
|
||||
it('should create an instance and set state from initialState', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
expect(r).toBeDefined();
|
||||
expect(r.state).toEqual(new Array(NUM_SPECIES).fill(1.0));
|
||||
});
|
||||
|
||||
it('should initialize Fs and Cs_in arrays based on n_inlets', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig({ n_inlets: 3 }));
|
||||
expect(r.Fs).toHaveLength(3);
|
||||
expect(r.Cs_in).toHaveLength(3);
|
||||
expect(r.Fs.every(v => v === 0)).toBe(true);
|
||||
});
|
||||
|
||||
it('should store volume from config', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig({ volume: 500 }));
|
||||
expect(r.volume).toBe(500);
|
||||
});
|
||||
|
||||
it('should initialize temperature to 20', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
expect(r.temperature).toBe(20);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcOTR()', () => {
|
||||
let r;
|
||||
beforeAll(() => { r = new Reactor_CSTR(makeCSTRConfig({ kla: 240 })); });
|
||||
|
||||
it('should return a positive value when S_O < saturation', () => {
|
||||
const otr = r._calcOTR(0, 20);
|
||||
expect(otr).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it('should return approximately zero when S_O equals saturation', () => {
|
||||
// S_O_sat at T=20: 14.652 - 4.1022e-1*20 + 7.9910e-3*400 + 7.7774e-5*8000
|
||||
const T = 20;
|
||||
const S_O_sat = 14.652 - 4.1022e-1 * T + 7.9910e-3 * T * T + 7.7774e-5 * T * T * T;
|
||||
const otr = r._calcOTR(S_O_sat, T);
|
||||
expect(otr).toBeCloseTo(0, 5);
|
||||
});
|
||||
|
||||
it('should return a negative value when S_O > saturation (supersaturated)', () => {
|
||||
const otr = r._calcOTR(100, 20);
|
||||
expect(otr).toBeLessThan(0);
|
||||
});
|
||||
|
||||
it('should use T=20 as default temperature', () => {
|
||||
const otr1 = r._calcOTR(0);
|
||||
const otr2 = r._calcOTR(0, 20);
|
||||
expect(otr1).toBe(otr2);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_arrayClip2Zero()', () => {
|
||||
let r;
|
||||
beforeAll(() => { r = new Reactor_CSTR(makeCSTRConfig()); });
|
||||
|
||||
it('should clip negative values to zero', () => {
|
||||
expect(r._arrayClip2Zero([-5, 3, -1, 0, 7])).toEqual([0, 3, 0, 0, 7]);
|
||||
});
|
||||
|
||||
it('should leave all-positive arrays unchanged', () => {
|
||||
expect(r._arrayClip2Zero([1, 2, 3])).toEqual([1, 2, 3]);
|
||||
});
|
||||
|
||||
it('should handle nested arrays (2D)', () => {
|
||||
const result = r._arrayClip2Zero([[-1, 2], [3, -4]]);
|
||||
expect(result).toEqual([[0, 2], [3, 0]]);
|
||||
});
|
||||
|
||||
it('should handle a single scalar', () => {
|
||||
expect(r._arrayClip2Zero(-5)).toBe(0);
|
||||
expect(r._arrayClip2Zero(5)).toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('setInfluent / getEffluent', () => {
|
||||
it('should store influent data via setter', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig({ n_inlets: 2 }));
|
||||
const input = {
|
||||
payload: {
|
||||
inlet: 0,
|
||||
F: 100,
|
||||
C: new Array(NUM_SPECIES).fill(5),
|
||||
},
|
||||
};
|
||||
r.setInfluent = input;
|
||||
expect(r.Fs[0]).toBe(100);
|
||||
expect(r.Cs_in[0]).toEqual(new Array(NUM_SPECIES).fill(5));
|
||||
});
|
||||
|
||||
it('should return effluent with the sum of Fs and the current state', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
r.Fs[0] = 50;
|
||||
const eff = r.getEffluent;
|
||||
expect(eff.topic).toBe('Fluent');
|
||||
expect(eff.payload.F).toBe(50);
|
||||
expect(eff.payload.C).toEqual(r.state);
|
||||
});
|
||||
});
|
||||
|
||||
describe('setOTR', () => {
|
||||
it('should set the OTR value', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig({ kla: NaN }));
|
||||
r.setOTR = { payload: 42 };
|
||||
expect(r.OTR).toBe(42);
|
||||
});
|
||||
});
|
||||
|
||||
describe('tick()', () => {
|
||||
it('should return a new state array of correct length', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
const result = r.tick(0.001);
|
||||
expect(result).toHaveLength(NUM_SPECIES);
|
||||
});
|
||||
|
||||
it('should not produce NaN values', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
r.Fs[0] = 10;
|
||||
r.Cs_in[0] = new Array(NUM_SPECIES).fill(5);
|
||||
const result = r.tick(0.001);
|
||||
result.forEach(v => expect(Number.isNaN(v)).toBe(false));
|
||||
});
|
||||
|
||||
it('should not produce negative concentrations', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
// Run multiple ticks
|
||||
for (let i = 0; i < 100; i++) {
|
||||
r.tick(0.001);
|
||||
}
|
||||
r.state.forEach(v => expect(v).toBeGreaterThanOrEqual(0));
|
||||
});
|
||||
|
||||
it('should reach steady state with zero flow (concentrations change only via reaction)', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
// No inflow
|
||||
const initial = [...r.state];
|
||||
r.tick(0.0001);
|
||||
// State should have changed due to reaction/OTR
|
||||
const changed = r.state.some((v, i) => v !== initial[i]);
|
||||
expect(changed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('registerChild()', () => {
|
||||
it('should not throw for "measurement" software type', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
// Passing null child will trigger warn but not crash
|
||||
expect(() => r.registerChild(null, 'measurement')).not.toThrow();
|
||||
});
|
||||
|
||||
it('should not throw for "reactor" software type', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
expect(() => r.registerChild(null, 'reactor')).not.toThrow();
|
||||
});
|
||||
|
||||
it('should not throw for unknown software type', () => {
|
||||
const r = new Reactor_CSTR(makeCSTRConfig());
|
||||
expect(() => r.registerChild(null, 'unknown')).not.toThrow();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// --------------- PFR tests ---------------
|
||||
|
||||
describe('Reactor_PFR', () => {
|
||||
|
||||
describe('constructor / initialization', () => {
|
||||
it('should create an instance with 2D state grid', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
expect(r).toBeDefined();
|
||||
expect(r.state).toHaveLength(10); // resolution_L = 10
|
||||
expect(r.state[0]).toHaveLength(NUM_SPECIES);
|
||||
});
|
||||
|
||||
it('should compute d_x = length / n_x', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ length: 10, resolution_L: 5 }));
|
||||
expect(r.d_x).toBe(2);
|
||||
});
|
||||
|
||||
it('should compute cross-sectional area A = volume / length', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ volume: 200, length: 10 }));
|
||||
expect(r.A).toBe(20);
|
||||
});
|
||||
|
||||
it('should initialize D (dispersion) to 0', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
expect(r.D).toBe(0);
|
||||
});
|
||||
|
||||
it('should create derivative operators of correct size', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ resolution_L: 8 }));
|
||||
expect(r.D_op).toHaveLength(8);
|
||||
expect(r.D_op[0]).toHaveLength(8);
|
||||
expect(r.D2_op).toHaveLength(8);
|
||||
expect(r.D2_op[0]).toHaveLength(8);
|
||||
});
|
||||
});
|
||||
|
||||
describe('setDispersion', () => {
|
||||
it('should set the axial dispersion value', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
r.setDispersion = { payload: 0.5 };
|
||||
expect(r.D).toBe(0.5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('tick()', () => {
|
||||
it('should return a 2D state grid of correct dimensions', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
r.D = 0.01;
|
||||
const result = r.tick(0.0001);
|
||||
expect(result).toHaveLength(10);
|
||||
expect(result[0]).toHaveLength(NUM_SPECIES);
|
||||
});
|
||||
|
||||
it('should not produce NaN values with small time step and dispersion', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
r.D = 0.01;
|
||||
r.Fs[0] = 10;
|
||||
r.Cs_in[0] = new Array(NUM_SPECIES).fill(5);
|
||||
const result = r.tick(0.0001);
|
||||
result.forEach(row => {
|
||||
row.forEach(v => expect(Number.isNaN(v)).toBe(false));
|
||||
});
|
||||
});
|
||||
|
||||
it('should not produce negative concentrations', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
r.D = 0.01;
|
||||
for (let i = 0; i < 10; i++) {
|
||||
r.tick(0.0001);
|
||||
}
|
||||
r.state.forEach(row => {
|
||||
row.forEach(v => expect(v).toBeGreaterThanOrEqual(0));
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('_applyBoundaryConditions()', () => {
|
||||
it('should apply Neumann BC at outlet (last = second to last)', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ resolution_L: 5 }));
|
||||
const state = Array.from({ length: 5 }, () => new Array(NUM_SPECIES).fill(1));
|
||||
state[3] = new Array(NUM_SPECIES).fill(7);
|
||||
r._applyBoundaryConditions(state);
|
||||
// outlet BC: state[4] = state[3]
|
||||
expect(state[4]).toEqual(new Array(NUM_SPECIES).fill(7));
|
||||
});
|
||||
|
||||
it('should apply Neumann BC at inlet when no flow', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ resolution_L: 5 }));
|
||||
r.Fs[0] = 0;
|
||||
const state = Array.from({ length: 5 }, () => new Array(NUM_SPECIES).fill(1));
|
||||
state[1] = new Array(NUM_SPECIES).fill(3);
|
||||
r._applyBoundaryConditions(state);
|
||||
// No flow: state[0] = state[1]
|
||||
expect(state[0]).toEqual(new Array(NUM_SPECIES).fill(3));
|
||||
});
|
||||
});
|
||||
|
||||
describe('_arrayClip2Zero() (inherited)', () => {
|
||||
it('should clip 2D arrays correctly', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig());
|
||||
const result = r._arrayClip2Zero([[-1, 2], [3, -4]]);
|
||||
expect(result).toEqual([[0, 2], [3, 0]]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcOTR() (inherited)', () => {
|
||||
it('should work the same as in CSTR', () => {
|
||||
const r = new Reactor_PFR(makePFRConfig({ kla: 240 }));
|
||||
const otr = r._calcOTR(0, 20);
|
||||
expect(otr).toBeGreaterThan(0);
|
||||
});
|
||||
});
|
||||
});
|
||||
285
wiki/Home.md
Normal file
285
wiki/Home.md
Normal file
@@ -0,0 +1,285 @@
|
||||
# reactor
|
||||
|
||||
> **Reflects code as of `b8247fc` · regenerated `2026-05-11` via `npm run wiki:all`**
|
||||
> If this banner is stale, the page may be out of date. Treat as informative, not authoritative.
|
||||
|
||||
## 1. What this node is
|
||||
|
||||
**reactor** is an S88 Unit that wraps an ASM3 biological-process engine — either a CSTR (fully mixed tank) or a PFR (plug-flow with axial dispersion). It integrates 13 species (S_O, S_NH, X_H, X_TS, …) and emits the effluent vector each tick. Drives a settler downstream and accepts a recirculation pump child.
|
||||
|
||||
## 2. Position in the platform
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
upstream[reactor<br/>upstream<br/>Unit]:::unit
|
||||
reactor[reactor<br/>Unit]:::unit
|
||||
settler[settler<br/>downstream<br/>Unit]:::unit
|
||||
pump[rotatingMachine<br/>downstream<br/>Equipment]:::equip
|
||||
tsens[measurement<br/>temperature<br/>atequipment]:::ctrl
|
||||
osens[measurement<br/>oxygen<br/>position]:::ctrl
|
||||
|
||||
upstream -.stateChange.-> reactor
|
||||
reactor -->|Fluent inlet=0| settler
|
||||
pump -->|child.register downstream| reactor
|
||||
tsens -->|temperature.measured.atequipment| reactor
|
||||
osens -->|quantity (oxygen).measured.<position>| reactor
|
||||
classDef unit fill:#50a8d9,color:#000
|
||||
classDef equip fill:#86bbdd,color:#000
|
||||
classDef ctrl fill:#a9daee,color:#000
|
||||
```
|
||||
|
||||
S88 colours: Unit `#50a8d9`, Equipment `#86bbdd`, Control Module `#a9daee`. Source of truth: `.claude/rules/node-red-flow-layout.md`.
|
||||
|
||||
## 3. Capability matrix
|
||||
|
||||
| Capability | Status | Notes |
|
||||
|---|---|---|
|
||||
| ASM3 13-species ODE integration | ✅ | CSTR + PFR engines under `kinetics/`. |
|
||||
| CSTR (fully mixed) | ✅ | Single concentration vector per tick. |
|
||||
| PFR (axial discretization) | ✅ | `resolution_L` grid cells; emits `GridProfile` alongside `Fluent`. |
|
||||
| Multi-inlet mixing | ✅ | `n_inlets`; each inlet receives its own `data.fluent` with `inlet` index. |
|
||||
| Temperature reconcile from measurement | ✅ | `temperature.measured.atEquipment` writes `engine.temperature`. |
|
||||
| Oxygen reconcile (PFR) | ✅ | `quantity (oxygen).measured.<distance>` maps to nearest grid cell. |
|
||||
| KLa-driven aeration | ✅ | `reactor.kla` > 0 enables internal mass transfer; falls back to `data.otr`. |
|
||||
| Speed-up factor (sim time) | ✅ | `reactor.speedUpFactor` accelerates wall-clock → process time. |
|
||||
| Dispersion override (PFR) | ✅ | `data.dispersion` updates axial `D`. |
|
||||
| Hot-swap engine type | ❌ | `reactor_type` is read once in `configure()`. |
|
||||
|
||||
## 4. Code map
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
subgraph nodeRED["nodeClass.js — adapter (BaseNodeAdapter)"]
|
||||
nc["buildDomainConfig()<br/>static DomainClass = Reactor<br/>static commands"]
|
||||
end
|
||||
subgraph domain["specificClass.js — orchestrator (BaseDomain)"]
|
||||
sc["Reactor.configure()<br/>flatten config → build engine<br/>ChildRouter rules"]
|
||||
end
|
||||
subgraph kinetics["src/kinetics/"]
|
||||
be["baseEngine.js<br/>shared ASM3 rate vector"]
|
||||
cstr["cstr.js<br/>0-D integrator"]
|
||||
pfr["pfr.js<br/>spatial discretization + dispersion"]
|
||||
end
|
||||
subgraph commands["src/commands/"]
|
||||
cmds["index.js + handlers.js<br/>6 input topics"]
|
||||
end
|
||||
sc --> be
|
||||
sc --> cstr
|
||||
sc --> pfr
|
||||
nc --> sc
|
||||
nc --> cmds
|
||||
```
|
||||
|
||||
| Module | Owns | Read first if you're changing… |
|
||||
|---|---|---|
|
||||
| `kinetics/baseEngine.js` | ASM3 stoichiometry + rate vector + species list. | Stoichiometric matrix, kinetic constants. |
|
||||
| `kinetics/cstr.js` | 0-D CSTR integrator + `_connectMeasurement` + `_connectReactor`. | Mixed-tank behaviour, child wiring. |
|
||||
| `kinetics/pfr.js` | Axial discretization, dispersion, grid profile emission. | PFR-specific behaviour, grid math. |
|
||||
| `commands/` | 6 input descriptors + handlers (clock, fluent, OTR, temperature, dispersion, child). | Inbound topic API, alias deprecation. |
|
||||
| `reaction_modules/` | Optional plug-in reaction modules (legacy — not yet refactored). | Adding new bio-process modules. |
|
||||
| `additional_nodes/` | Sibling Node-RED nodes (`recirculation-pump`, `settling-basin`) shipped from this repo. | Cross-node deploy in same package. |
|
||||
|
||||
## 5. Topic contract
|
||||
|
||||
> **Auto-generated** from `src/commands/index.js`. Do NOT hand-edit between the markers. Re-run `npm run wiki:contract`.
|
||||
|
||||
<!-- BEGIN AUTOGEN: topic-contract -->
|
||||
|
||||
| Canonical topic | Aliases | Payload | Effect |
|
||||
|---|---|---|---|
|
||||
| `data.clock` | `clock` | `any` | Pushes a value into the node's measurement stream. |
|
||||
| `data.fluent` | `Fluent` | `object` | Pushes a value into the node's measurement stream. |
|
||||
| `data.otr` | `OTR` | `any` | Pushes a value into the node's measurement stream. |
|
||||
| `data.temperature` | `Temperature` | `any` | Pushes a value into the node's measurement stream. |
|
||||
| `data.dispersion` | `Dispersion` | `any` | Pushes a value into the node's measurement stream. |
|
||||
| `child.register` | `registerChild` | `any` | Parent/child plumbing — registers or unregisters a child node. |
|
||||
|
||||
<!-- END AUTOGEN: topic-contract -->
|
||||
|
||||
## 6. Child registration
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph kids["accepted children (softwareType)"]
|
||||
m_t["measurement<br/>temperature"]:::ctrl
|
||||
m_o["measurement<br/>quantity (oxygen)"]:::ctrl
|
||||
r_up["reactor<br/>upstream"]:::unit
|
||||
end
|
||||
m_t -->|temperature.measured.atEquipment| h_meas[engine._connectMeasurement]
|
||||
m_o -->|quantity (oxygen).measured.<pos>| h_meas
|
||||
r_up -.stateChange.-> h_react[engine._connectReactor]
|
||||
h_meas --> reconcile[reconcile T / O2 into engine state]
|
||||
h_react --> pull[pull upstream effluent → Fs/Cs_in]
|
||||
classDef ctrl fill:#a9daee,color:#000
|
||||
classDef unit fill:#50a8d9,color:#000
|
||||
```
|
||||
|
||||
| softwareType | filter | wired to | side-effect |
|
||||
|---|---|---|---|
|
||||
| `measurement` | any | `engine._connectMeasurement` | `temperature.measured.atEquipment` → `engine.temperature`. PFR additionally honours `quantity (oxygen).measured.<distance>` → nearest grid cell DO. |
|
||||
| `reactor` | upstream | `engine._connectReactor` | Subscribes to upstream reactor's `stateChange`; pulls effluent into `Fs[0]` / `Cs_in[0]` before next integration step. |
|
||||
|
||||
## 7. Lifecycle — what one `data.clock` advance does
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant clock as clock injector
|
||||
participant reactor as reactor
|
||||
participant engine as kinetics engine
|
||||
participant downstream as settler / next reactor
|
||||
participant out as Port-0 output
|
||||
|
||||
clock->>reactor: data.clock { timestamp }
|
||||
reactor->>engine: updateState(timestamp)
|
||||
Note over engine: n_iter steps,<br/>each timeStep × speedUpFactor
|
||||
engine->>engine: integrate ASM3 rates
|
||||
engine->>engine: emit 'stateChange'
|
||||
reactor->>reactor: notifyOutputChanged
|
||||
reactor->>out: Fluent { inlet=0, F, C[13] }
|
||||
alt PFR
|
||||
reactor->>out: GridProfile { grid, n_x, d_x, … }
|
||||
end
|
||||
out->>downstream: Fluent envelope
|
||||
```
|
||||
|
||||
`stateChange` re-emits on `reactor.emitter` (BaseDomain emitter) so downstream reactors / settlers can listen. The effluent emission goes through the BaseNodeAdapter tick pipeline.
|
||||
|
||||
## 8. Data model — `getOutput()`
|
||||
|
||||
Port-0 process payload is the `Fluent` envelope (+ optional `GridProfile` for PFR). Port-1 telemetry is the scalar snapshot below.
|
||||
|
||||
<!-- BEGIN AUTOGEN: data-model -->
|
||||
|
||||
| Key | Type | Unit | Sample |
|
||||
|---|---|---|---|
|
||||
| `S_HCO` | number | — | `5` |
|
||||
| `S_I` | number | — | `30` |
|
||||
| `S_N2` | number | — | `0` |
|
||||
| `S_NH` | number | — | `25` |
|
||||
| `S_NO` | number | — | `0` |
|
||||
| `S_O` | number | — | `0` |
|
||||
| `S_S` | number | — | `70` |
|
||||
| `X_A` | number | — | `200` |
|
||||
| `X_H` | number | — | `2000` |
|
||||
| `X_I` | number | — | `1000` |
|
||||
| `X_S` | number | — | `100` |
|
||||
| `X_STO` | number | — | `0` |
|
||||
| `X_TS` | number | — | `3500` |
|
||||
| `flow_total` | number | — | `0` |
|
||||
| `temperature` | number | — | `20` |
|
||||
|
||||
<!-- END AUTOGEN: data-model -->
|
||||
|
||||
**Concrete sample** (CSTR mid-integration, nitrifying):
|
||||
|
||||
```json
|
||||
{
|
||||
"flow_total": 1000,
|
||||
"temperature": 15.2,
|
||||
"S_O": 2.1,
|
||||
"S_I": 30,
|
||||
"S_S": 12.4,
|
||||
"S_NH": 0.8,
|
||||
"S_N2": 4.3,
|
||||
"S_NO": 18.6,
|
||||
"S_HCO": 4.2,
|
||||
"X_I": 1050,
|
||||
"X_S": 65,
|
||||
"X_H": 2150,
|
||||
"X_STO": 4.5,
|
||||
"X_A": 215,
|
||||
"X_TS": 3680
|
||||
}
|
||||
```
|
||||
|
||||
Species ordering follows ASM3: indices 0–6 are soluble, 7–12 are particulate. `flow_total` is the effluent flow (m³/d); the reactor uses days as the time unit internally.
|
||||
|
||||
## 9. Configuration — editor form ↔ config keys
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
subgraph editor["Node-RED editor form"]
|
||||
f1[Reactor type CSTR / PFR]
|
||||
f2[Volume m3]
|
||||
f3[Length m + resolution]
|
||||
f4[Alpha dispersion]
|
||||
f5[KLa 1/h]
|
||||
f6[Time step + speed-up]
|
||||
f7[Initial state 13 species]
|
||||
end
|
||||
subgraph config["Domain config slice"]
|
||||
c1[reactor.reactor_type]
|
||||
c2[reactor.volume]
|
||||
c3[reactor.length<br/>reactor.resolution_L]
|
||||
c4[reactor.alpha]
|
||||
c5[reactor.kla]
|
||||
c6[reactor.timeStep<br/>reactor.speedUpFactor]
|
||||
c7[initialState.* ASM3 keys]
|
||||
end
|
||||
f1 --> c1
|
||||
f2 --> c2
|
||||
f3 --> c3
|
||||
f4 --> c4
|
||||
f5 --> c5
|
||||
f6 --> c6
|
||||
f7 --> c7
|
||||
```
|
||||
|
||||
| Form field | Config key | Default | Range | Where used |
|
||||
|---|---|---|---|---|
|
||||
| Reactor type | `reactor.reactor_type` | `CSTR` | enum: `CSTR` / `PFR` | engine selection in `_buildEngine` |
|
||||
| Volume (m³) | `reactor.volume` | `1000` | > 0 | residence time, mass balance |
|
||||
| Length (m) | `reactor.length` | `10` | > 0 | PFR only — axial extent |
|
||||
| Resolution L | `reactor.resolution_L` | `10` | ≥ 1 | PFR grid cell count |
|
||||
| Alpha | `reactor.alpha` | `0.5` | 0–1 | dispersion vs plug-flow blend |
|
||||
| Inlets | `reactor.n_inlets` | `1` | ≥ 1 | `Fs[]` / `Cs_in[]` array sizes |
|
||||
| KLa (1/h) | `reactor.kla` | `0` | ≥ 0 | aeration mass transfer (NaN → use `data.otr`) |
|
||||
| Time step (h) | `reactor.timeStep` | `0.001` | ≥ 0.0001 | integrator inner step |
|
||||
| Speed-up factor | `reactor.speedUpFactor` | `1` | ≥ 1 | wall-clock → process-time multiplier |
|
||||
| Initial S_NH | `initialState.S_NH` | `25` | ≥ 0 (mg/L) | starting ammonium |
|
||||
| Initial X_H | `initialState.X_H` | `2000` | ≥ 0 (mg/L) | starting heterotroph biomass |
|
||||
| Initial X_A | `initialState.X_A` | `200` | ≥ 0 (mg/L) | starting autotroph biomass — must be ≥ ~50 for nitrification |
|
||||
| Initial X_TS | `initialState.X_TS` | `3500` | ≥ 0 (mg/L) | starting TSS — drives settler split |
|
||||
|
||||
## 10. State chart
|
||||
|
||||
Skipped — reactor has no FSM. It runs continuous-state ODE integration; the engine's only stateful event is `stateChange`, fired after every successful integration advance. See section 7 for the integration sequence.
|
||||
|
||||
## 11. Examples
|
||||
|
||||
| Tier | File | What it shows | Status |
|
||||
|---|---|---|---|
|
||||
| Basic | `examples/basic.flow.json` | CSTR with one inlet, watch `Fluent` effluent | ✅ in repo |
|
||||
| Integration | `examples/integration.flow.json` | upstream reactor → reactor → settler chain | ✅ in repo |
|
||||
| Edge | `examples/edge.flow.json` | PFR with dispersion + multi-inlet | ✅ in repo |
|
||||
| Companions | `additional_nodes/*` | recirculation-pump + settling-basin Node-RED nodes shipped from this repo | ✅ in repo |
|
||||
|
||||
One screenshot per tier where helpful. PNG ≤ 200 KB under `wiki/_partial-screenshots/reactor/`.
|
||||
|
||||
## 12. Debug recipes
|
||||
|
||||
| Symptom | First thing to check | Where to look |
|
||||
|---|---|---|
|
||||
| Nitrification doesn't proceed (S_NH stays high) | `initialState.X_A` must be ≥ ~50 mg/L. Defaulting to `0.001` (a known footgun) means no autotrophs. | `generalFunctions/src/configs/reactor.json` |
|
||||
| `Fluent` effluent flow zero | No `data.clock` ticks arriving, or `data.fluent` never set `Fs[0] > 0`. | `commands/handlers.js`, engine `setInfluent` |
|
||||
| PFR `GridProfile` not emitted | `reactor_type` set to `CSTR` — only PFR emits grid. | `_buildEngine` switch |
|
||||
| Settler downstream not updating | `stateChange` event listener path: settler must subscribe to `reactor.emitter`, NOT `reactor.measurements.emitter`. | settler `_connectReactor` |
|
||||
| Temperature reconcile silently ignored | Child measurement's `asset.type` not `temperature` exactly, or `positionVsParent` not `atEquipment`. | `engine._connectMeasurement` |
|
||||
| Integrator slow / stalls | `reactor.timeStep` too small for `speedUpFactor`. Internal `n_iter` count blows up. | `engine.updateState` |
|
||||
| `wiki:datamodel` script slow / hangs | `mathjs` cold-start ~13 s; instantiation depends on it transitively. See known-limitations row 1. | `kinetics/baseEngine.js` |
|
||||
|
||||
## 13. When you would NOT use this node
|
||||
|
||||
- Use reactor for **ASM3 biological treatment** modelling (activated sludge, nitrification, denitrification). For aerobic-only or simpler kinetics, the ASM3 species vector is overkill.
|
||||
- Don't use reactor for a passive equalisation tank — the kinetics engines assume reactions are happening.
|
||||
- Skip reactor when you only need a residence-time delay; a simple buffer node is lighter and doesn't require `mathjs`.
|
||||
|
||||
## 14. Known limitations / current issues
|
||||
|
||||
| # | Issue | Tracked in |
|
||||
|---|---|---|
|
||||
| 1 | `mathjs` cold-start adds ~13 s to first `require()` — `wiki:datamodel` auto-gen may time out on the 60 s wrapper. Falls back to the hand-curated `concrete sample` block. | `.claude/refactor/OPEN_QUESTIONS.md` — "mathjs slow load" |
|
||||
| 2 | `initialState.X_A` default of `200` mg/L is correct; older config snapshots used `0.001` which silently disabled nitrification. Verify on every new deploy. | `generalFunctions/src/configs/reactor.json` |
|
||||
| 3 | `getEffluent` shape historically varied (array vs single envelope) — settler's `_connectReactor` tolerates both. Don't break the contract without updating settler. | `nodes/settler/src/specificClass.js → _connectReactor` |
|
||||
| 4 | `additional_nodes/recirculation-pump` and `settling-basin` are legacy companions — not yet refactored to BaseDomain. | P6.5 follow-up |
|
||||
| 5 | `reaction_modules/` is a legacy plug-in directory not consumed by the current engines. Removal pending. | P6.5 follow-up |
|
||||
Reference in New Issue
Block a user