288 water to water heat pump bypass mode by samvanderzwan · Pull Request #344 · Project-OMOTES/simulator-core

samvanderzwan · 2026-03-12T07:36:18Z

Unit test are not yet working but code seems to be working

… in heattransfer solver asset.

Copilot

Pull request overview

This PR introduces a bypass mode for the water-to-water heat pump / heat transfer asset and propagates related sign/setpoint and controller-path/factor changes through the controller layer, solver asset equations, and unit/integration tests.

Changes:

Add bypass_mode support to the solver HeatTransferAsset, with separate “normal” vs “bypass” equation generation.
Extend heat pump/controller setpoints to support bypass and primary-side mass-flow/pressure control, and adjust network factor/path handling.
Update a broad set of unit/integration tests to reflect new sign conventions, setpoint keys, and solver behavior.

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
unit_test/solver/network/assets/test_heat_transfer_asset.py	Updates expectations for equation selection/call counts and mass-flow setup in solver-level tests.
unit_test/integration/test_heat_transfer_asset.py	Adjusts integration scenarios for updated mass-flow initialization and new prescribe flags.
unit_test/entities/test_production_cluster.py	Adapts convergence test to new sign convention behavior.
unit_test/entities/test_heat_pump.py	Updates heat pump tests for new sign conventions and additional solver state; currently misaligned with new required setpoint keys.
unit_test/entities/test_heat_exchanger.py	Updates mass-flow setup and expected output sign.
unit_test/entities/test_ates_cluster.py	Adjusts expected well temperatures due to changed ATES behavior.
unit_test/entities/controller/test_controller_new_class.py	Updates expectations for `factor_to_first_network` now being a list of factors.
unit_test/entities/controller/test_controller_network.py	Updates factor representation and storage setpoint expectations; adapts pressure-setting behavior.
src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py	Implements bypass mode and refactors equation generation; changes flow-direction handling and electric power computation.
src/omotes_simulator_core/infrastructure/app.py	Changes default simulation window/timestep and hardcodes a bypass test run + CSV export in `__main__`.
src/omotes_simulator_core/entities/network_controller.py	Refactors factor/path application, storage charge/discharge logic, heat-transfer setpoints, and pressure-setting key selection.
src/omotes_simulator_core/entities/assets/utils.py	Changes heat-demand↔mass-flow conversion to use internal energy difference instead of heat capacity approximation.
src/omotes_simulator_core/entities/assets/production_cluster.py	Adjusts mass-flow calculation sign and convergence criterion.
src/omotes_simulator_core/entities/assets/heat_pump.py	Adds bypass setpoint support, primary-side control flag, and updates setpoint parsing/sign conventions.
src/omotes_simulator_core/entities/assets/heat_exchanger.py	Adjusts heat-loss sign convention in outputs.
src/omotes_simulator_core/entities/assets/demand_cluster.py	Updates convergence check sign usage (now sensitive to negative allocations).
src/omotes_simulator_core/entities/assets/controller/controller_network.py	Changes factor tracking to list-of-factors and uses a product; extends storage setpoints; updates pressure-setting API.
src/omotes_simulator_core/entities/assets/controller/controller_heat_transfer.py	Adds bypass option and updates how primary/secondary heat demand is set (factor vs bypass behavior).
src/omotes_simulator_core/entities/assets/ates_cluster.py	Updates temperature assignment and convergence logic; tweaks ROSIM initialization/run cadence; adds heat supplied computation.
src/omotes_simulator_core/entities/assets/asset_defaults.py	Adds `PROPERTY_BYPASS` constant.
src/omotes_simulator_core/entities/assets/asset_abstract.py	Removes `solver_asset` type annotation from the base abstract asset.
src/omotes_simulator_core/adapter/transforms/controller_mapper.py	Changes “root network” selection for path computation and updates how paths are generated.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-12T07:44:08Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

        self.pre_scribe_mass_flow_secondary = pre_scribe_mass_flow_secondary
+        # Define the flag that indicates whether the mass flow rate or the pressure is prescribed
+        # at the hot side of the heat pump
+        self.pre_scribe_mass_flow_primary = pre_scribe_mass_flow_secondary
        # Define the mass flow rate set point for the asset on the secondary side


pre_scribe_mass_flow_primary is initialized from pre_scribe_mass_flow_secondary, so the primary-side control flag will always mirror the secondary-side flag. This prevents independently controlling primary mass-flow vs pressure (and is likely a copy/paste bug). Add a dedicated constructor parameter (or default) for pre_scribe_mass_flow_primary and assign it here.

Copilot · 2026-03-12T07:44:09Z

src/omotes_simulator_core/entities/assets/heat_pump.py

        # Assign setpoints to the HeatPump asset
-        self.temperature_in_primary = setpoints_primary[PRIMARY + PROPERTY_TEMPERATURE_IN]
+        if self.first_time_step or self.solver_asset.prev_sol[0] == 0.0:
+            self.temperature_in_primary = setpoints_primary[SECONDARY + PROPERTY_TEMPERATURE_IN]


_set_setpoints_primary() reads setpoints_primary[SECONDARY + PROPERTY_TEMPERATURE_IN], but the required keys are defined with the PRIMARY prefix. This will raise KeyError (or use the wrong temperature) whenever primary and secondary temperatures differ. Use PRIMARY + PROPERTY_TEMPERATURE_IN here.

Suggested change

self.temperature_in_primary = setpoints_primary[SECONDARY + PROPERTY_TEMPERATURE_IN]

self.temperature_in_primary = setpoints_primary[PRIMARY + PROPERTY_TEMPERATURE_IN]

Copilot · 2026-03-12T07:44:09Z

unit_test/entities/test_heat_pump.py

        setpoints = {
            PRIMARY + PROPERTY_TEMPERATURE_IN: 273.15 + 10.0,
            PRIMARY + PROPERTY_TEMPERATURE_OUT: 273.15 + 20.0,
            PRIMARY + PROPERTY_HEAT_DEMAND: 300,
+            PROPERTY_SET_PRESSURE: False,


This test passes PROPERTY_SET_PRESSURE, but _set_setpoints_primary() now requires PRIMARY + PROPERTY_SET_PRESSURE. Align the test setpoints dict with the required key to avoid a missing-key ValueError.

src/omotes_simulator_core/adapter/transforms/controller_mapper.py

Copilot · 2026-03-12T07:44:10Z

src/omotes_simulator_core/entities/assets/demand_cluster.py

-        return abs(self.get_heat_supplied() - (-self.thermal_power_allocation)) < (
-            (-self.thermal_power_allocation) * 0.001
+        return abs(self.get_heat_supplied() - self.thermal_power_allocation) < (
+            self.thermal_power_allocation * 0.001


The convergence tolerance should be non-negative. Since consumer profiles can yield negative demands, self.thermal_power_allocation * 0.001 can become negative and make this check always fail. Use abs(self.thermal_power_allocation) * 0.001 for the tolerance.

Suggested change

self.thermal_power_allocation * 0.001

abs(self.thermal_power_allocation) * 0.001

Zou hier inderdaad niet nog een extra abs ergens omheen moeten?

Copilot · 2026-03-12T07:44:10Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

+        else:
+            if self.iteration_flow_direction_secondary == FlowDirection.ZERO:
+                pset_out = self.pressure_set_point_secondary
+                pset_in = self.pressure_set_point_secondary
+            else:
+                if self.iteration_flow_direction_secondary == FlowDirection.POSITIVE:
+                    pset_out = self.pressure_set_point_secondary / 2
+                    pset_in = self.pressure_set_point_secondary
+                else:
+                    pset_out = self.pressure_set_point_secondary
+                    pset_in = self.pressure_set_point_secondary / 2
+            equations.append(


In bypass mode, pressure splitting depends on iteration_flow_direction_secondary, but that value is never recomputed inside get_equations_bypass(). This can become stale across timesteps/setpoint changes and lead to incorrect pset_in/pset_out selection. Recompute the iteration flow direction(s) at the start of bypass equation generation, similar to get_equations_normal().

Copilot · 2026-03-12T07:44:10Z

unit_test/entities/test_heat_pump.py

            SECONDARY + PROPERTY_TEMPERATURE_IN: 273.15 + 15.0,
            SECONDARY + PROPERTY_TEMPERATURE_OUT: 273.15 + 25.0,
-            SECONDARY + PROPERTY_HEAT_DEMAND: 310,
+            SECONDARY + PROPERTY_HEAT_DEMAND: -310,
            PROPERTY_SET_PRESSURE: True,  # Boolean value
        }


These secondary-setpoint tests no longer match the HeatPump API: _set_setpoints_secondary() now requires SECONDARY + PROPERTY_SET_PRESSURE and PROPERTY_BYPASS, but the test still passes PROPERTY_SET_PRESSURE and omits PROPERTY_BYPASS. Update the test inputs/expectations accordingly (including the sign convention changes in the implementation).

Copilot · 2026-03-12T07:44:11Z

src/omotes_simulator_core/infrastructure/app.py

+    result = run(r".\testdata\heat_pump_bypass.esdl")
    t2 = datetime.now()

    logger.info(f"Results dataframe shape=({result.shape})")
+    result.to_csv(r".\testdata\heat_pump_bypass_results.csv", index=False)


The __main__ block is hardcoded to run heat_pump_bypass.esdl and write a CSV into ./testdata, which is a surprising side effect and can break when run from other working directories. Consider removing these hardcoded paths or gating them behind explicit CLI args/flags.

Copilot · 2026-03-12T07:44:11Z

src/omotes_simulator_core/entities/assets/controller/controller_network.py

 import datetime

+from numpy.ma.core import product
+
 from omotes_simulator_core.entities.assets.asset_defaults import (


Importing product from numpy.ma.core relies on NumPy’s internal/private module structure. Prefer numpy.prod(...) or math.prod(...) (and import from the public namespace) to avoid breakage across NumPy versions.

Just import numpy or import math.prod.

Copilot · 2026-03-12T07:44:11Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

+            \dot{m}_{0} + \dot{m}_{1} = 0
+
+        If the mass flow at the inflow node of the primary and secondary side is not zero, we
+         prescribe the follwoing energy balance equation for the heat transfer asset:


Typo in docstring: "follwoing" → "following".

Suggested change

prescribe the follwoing energy balance equation for the heat transfer asset:

prescribe the following energy balance equation for the heat transfer asset:

vanmeerkerk

Er is erg veel gewijzgd waarvan sommige onderdelen naar mijn mening een apart issue hadden moeten worden. Over het algemeen ziet het er oké uit nog wat docstring opmerkingen.

Ik vermoed wel dat er nu een fout wordt gemaakt in het heat_transfer asset met de huidige implementatie.

vanmeerkerk · 2026-03-12T08:58:00Z

src/omotes_simulator_core/entities/assets/controller/controller_heat_transfer.py

-                SECONDARY + PROPERTY_TEMPERATURE_OUT: 273.15 + 80,
-                SECONDARY + PROPERTY_TEMPERATURE_IN: 273.15 + 50,
-                PROPERTY_SET_PRESSURE: False,
+        if bypass:


Ik heb hier wel een vraag over. Zetten we nu standaard temperaturen in dit asset met set_asset of is dit alleen een initialisatie stap?

Klopt de volgorder van de temperaturen; ik zou verwachtten dat PRIM_OUT gleijk moet zijn aan SEC_IN. Dit lijkt nu niet het geval?

vanmeerkerk · 2026-03-12T08:59:57Z

src/omotes_simulator_core/entities/assets/controller/controller_network.py

 import datetime

+from numpy.ma.core import product
+
 from omotes_simulator_core.entities.assets.asset_defaults import (


Just import numpy or import math.prod.

vanmeerkerk · 2026-03-12T09:01:53Z

src/omotes_simulator_core/entities/assets/controller/controller_network.py

        for storage in self.storages:
            storage_settings[storage.id] = {
                PROPERTY_HEAT_DEMAND: +1 * storage.effective_max_charge_power * factor,
+                PROPERTY_TEMPERATURE_OUT: storage.temperature_out,


Waarom heb je de temperatuur nodig voor een storage? Deze wordt toch niet geset maar gebasseerd op de internal state?

vanmeerkerk · 2026-03-12T09:03:14Z

src/omotes_simulator_core/entities/assets/asset_abstract.py

@@ -45,8 +45,6 @@ class AssetAbstract(ABC):

    connected_ports: list[str]
    """List of ids of the connected ports."""


Je verwijdert solver_asset: Waarom? Alles refereert intern nog steeds naar solver_asset...

vanmeerkerk · 2026-03-12T09:05:19Z

src/omotes_simulator_core/entities/assets/ates_cluster.py

@@ -171,23 +169,30 @@ def set_setpoints(self, setpoints: dict) -> None:
        setpoints_set = set(setpoints.keys())
        # Check if all setpoints are in the setpoints
        if necessary_setpoints.issubset(setpoints_set):


Persoonlijk vind ik de -1 * explicieter, waardoor het direct zichtbaar is dat er nog iets met de waarde gebeurt. De - is te missen.

vanmeerkerk · 2026-03-12T09:26:47Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

-        self.flow_direction_secondary = self.flow_direction(
-            self.mass_flow_rate_rate_set_point_secondary
-        )
+        self.flow_direction_primary = self.flow_direction(self.prev_sol[0])


Hiermee bypass je wel je initiele setpoints; is dat handig?

vanmeerkerk · 2026-03-12T09:28:56Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

@@ -270,7 +281,7 @@ def get_equations(self) -> list[EquationObject]:
        ) = self.get_ordered_connection_point_list()

        if np.all(np.abs(self.prev_sol[0:-1:3]) < MASSFLOW_ZERO_LIMIT):


Klopt het nu dat we alleen de richting zetten op basis van de vorige oplossing als de stroming 0 was (< MASSFLOW_ZERO_LIMIT); ik vraag mij af of dit goed gaat.

vanmeerkerk · 2026-03-12T09:29:40Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

-            if iteration_flow_direction_secondary == FlowDirection.ZERO:
-                mset = 0.0
+            if self.iteration_flow_direction_secondary == FlowDirection.ZERO:
+                mset = self.mass_flow_rate_rate_set_point_secondary


Dus als 0 forceren we niet langer 0 maar gaan we terug naar het setpoint; dit kan niet juist zijn?

Als je dit doet kan je net zo goed deze if loop weghalen en altijd het setpoint zetten. Ik denk dat je hier een fout maakt om het te laten werken. Ik herinner mij dat het zetten van mset=0.0 resulteerde in een matrix fout maar dat zit eerder in hoe je je setpoints zet op basis van een vorige oplossing.

vanmeerkerk · 2026-03-12T09:32:47Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

+            if (self.iteration_flow_direction_primary != FlowDirection.ZERO) or (
+                self.iteration_flow_direction_secondary != FlowDirection.ZERO
+            ):
+                equations.append(


Hier gaat echt iets fout met het zetten vvan m=0.0

vanmeerkerk · 2026-03-12T09:34:15Z

src/omotes_simulator_core/solver/network/assets/heat_transfer_asset.py

+            )
+        return equations
+
+    def set_internal_energy_equations_bypass(self, equations):


samvanderzwan added 10 commits February 12, 2026 13:10

Added possibility in controller to set the heatpump to bypass mode

ae3a6a0

Fixed two small errors which occured due to rebasing

085e6db

Small fixes in the controller to get the correct output

30065d2

Added bypass mode to heatpump

0d2ff22

Rewrote equations setting of heatpump.

23d3025

Corrected flow direction setting

d6167d0

Fixed unit test and made bug fixes based ont he test

4300c03

Fxiing typing and linting issues

86feca1

Added bypass option to controller output. Added bypass mode equations…

1341a82

… in heattransfer solver asset.

Fixed issues, now have mode for normal and bypass operation

4c11a17

samvanderzwan requested review from Copilot and vanmeerkerk March 12, 2026 07:36

samvanderzwan linked an issue Mar 12, 2026 that may be closed by this pull request

Water to water heat pump bypass mode #288

Open

Copilot started reviewing on behalf of samvanderzwan March 12, 2026 07:36 View session

Copilot AI reviewed Mar 12, 2026

View reviewed changes

vanmeerkerk requested changes Mar 12, 2026

View reviewed changes

	self.temperature_in_primary = setpoints_primary[SECONDARY + PROPERTY_TEMPERATURE_IN]
	self.temperature_in_primary = setpoints_primary[PRIMARY + PROPERTY_TEMPERATURE_IN]

	self.thermal_power_allocation * 0.001
	abs(self.thermal_power_allocation) * 0.001

	prescribe the follwoing energy balance equation for the heat transfer asset:
	prescribe the following energy balance equation for the heat transfer asset:

		@@ -45,8 +45,6 @@ class AssetAbstract(ABC):

		connected_ports: list[str]
		"""List of ids of the connected ports."""

		@@ -270,7 +281,7 @@ def get_equations(self) -> list[EquationObject]:
		) = self.get_ordered_connection_point_list()

		if np.all(np.abs(self.prev_sol[0:-1:3]) < MASSFLOW_ZERO_LIMIT):

Conversation

samvanderzwan commented Mar 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

vanmeerkerk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants