Files
pumpingStation/wiki
znetsixe a2189457f6 Rename basin/control thresholds to wiki naming; trim stale comments
Aligns the code with the 5-threshold convention used throughout the
wiki (basin model + per-mode transfer-function diagrams):

  heightInlet       → inflowLevel
  heightOutlet      → outflowLevel
  heightOverflow    → overflowLevel
  stopLevel         → minLevel
  maxFlowLevel      → maxLevel
  minFlowLevel      → removed (collapsed into startLevel; they were
                      always supposed to hold the same value)
  minVolIn          → minVolAtInflow
  minVolOut         → minVolAtOutflow
  maxVolOverflow    → maxVolAtOverflow
  startLevel        → unchanged

Config schema (generalFunctions/src/configs/pumpingStation.json) is
updated in a parallel commit in that submodule.

Also:
- Stripped the ~150-line ASCII basin diagram from initBasinProperties
  JSDoc; it now points at wiki/functional-description.md#basin-model.
- Trimmed the top-of-class JSDoc — the config-sections breakdown was
  drifting from the schema anyway; wiki is now the source of truth.
- Tidied inline comments in _controlLevelBased, _scaleLevelToFlowPercent.
- Editor order reshuffled to match the bottom→top basin order:
  minLevel, startLevel, maxLevel.

Breaking change for saved flows: existing pumpingStation nodes in
production flows reference the old field names and will need to be
re-entered in the editor. No compat shim — node is RnD/trial.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 16:13:59 +02:00
..

pumpingStation — Documentation

All docs and diagrams for this node live in this folder so they version-lock with the code they describe.

Pages

  • Functional Description — operator-facing reference derived from src/specificClass.js: basin model, net-flow selection, safety interlocks, registration topology.
  • Control modes — one page per control mode (levelbased, flowbased, …) describing how the mode uses the shared basin model to compute demand.

Diagrams

Editable draw.io sources live in diagrams/. See diagrams/README.md for the editing workflow — open .drawio files in draw.io, export to .drawio.svg, commit both.

The basin model is the shared canvas (diagrams/basin-model.drawio.svg); per-mode transfer-function diagrams live under diagrams/modes/.

Part of

This node is a git submodule of EVOLV. The EVOLV superproject has its own wiki/ with platform-level docs (architecture, concepts, shared manuals).