rtc-tools 2.8.0a1__py3-none-any.whl → 2.8.0a2__py3-none-any.whl

{rtc_tools-2.8.0a1.dist-info → rtc_tools-2.8.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rtc-tools
-Version: 2.8.0a1
+Version: 2.8.0a2
 Summary: Toolbox for control and optimization of water systems.
 Project-URL: Homepage, https://oss.deltares.nl/web/rtc-tools/home
 Project-URL: Download, http://github.com/deltares/rtc-tools/
@@ -191,10 +191,10 @@ Requires-Python: >=3.9
 Requires-Dist: casadi!=3.6.6,<3.8,>=3.6.3
 Requires-Dist: defusedxml>=0.7.0
 Requires-Dist: importlib-metadata>=5.0.0; python_version < '3.10'
-Requires-Dist: numpy>=1.16.0
+Requires-Dist: numpy>=1.20.0
 Requires-Dist: pymoca==0.9.*,>=0.9.1
 Requires-Dist: rtc-tools-channel-flow>=1.2.0
-Requires-Dist: scipy>=1.0.0
+Requires-Dist: scipy>=1.6.0
 Provides-Extra: all
 Requires-Dist: netcdf4; extra == 'all'
 Provides-Extra: netcdf
@@ -219,13 +219,11 @@ RTC-Tools offers the following functionalities:
 
 - **Model building using extensible libraries**: Build complex system models using extensible libraries of model components. Modelers can also implement their custom modeling components, for instance, using the [Modelica language](https://modelica.org/language/) or Python script.
 
-    RTC-Tools can be used with the following libraries and packages for specific applications:
+    RTC-Tools can be used with the following libraries and packages for specific applications. Please note that this list is not exhaustive. Users can also create libraries for other types of applications.
     - [rtc-tools-channel-flow](https://gitlab.com/deltares/rtc-tools-channel-flow): water system models
     - [rtc-tools-hydraulic-structures](https://gitlab.com/deltares/rtc-tools-channel-flow): hydraulic assets, such as weirs and pumps
     - [rtc-tools-heat-network](https://github.com/Nieuwe-Warmte-Nu/rtc-tools-heat-network): heat networks
-
-Please note that this list is not exhaustive. Users can also create libraries for other types of applications.
-
+            
 - **Running simulations**: Simulate a given model.
 
 - **Specifying and solving optimization problems**: Define optimization goals, constraints and decision variables to specify the optimization problem for a given model. RTC-Tools supports both open-source solvers (CBC, HiGHS, Ipopt) and commercial solvers (Gurobi, CPLEX) for solving several types of optimization problems:

{rtc_tools-2.8.0a1.dist-info → rtc_tools-2.8.0a2.dist-info}/RECORD

@@ -5,7 +5,7 @@ rtctools/version.py,sha256=xvbTWTq6B21t4hw5bi2hdOVaIBeDBQtqEEHe0kxYZsc,1995
 rtctools/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rtctools/_internal/alias_tools.py,sha256=XuQSAhhFuVtwn0yrAObZWIKPsSF4j2axXRtEmitIFPs,5310
 rtctools/_internal/caching.py,sha256=p4gqSL7kCI7Hff-KjMEP7mhJCQSiU_lYm2MR7E18gBM,905
-rtctools/_internal/casadi_helpers.py,sha256=UcVSBsOs9f8gAGk4s3CQRS7TSE1CIvKt0uhrD4gLwu4,1727
+rtctools/_internal/casadi_helpers.py,sha256=vN1H7D_6otY6stVD0Dw2b2UapCJ6T2r8QuscNT8OJOw,2309
 rtctools/_internal/debug_check_helpers.py,sha256=UgQTEPw4PyR7MbYLewSSWQqTwQj7xr5yUBk820O9Kk4,1084
 rtctools/_internal/ensemble_bounds_decorator.py,sha256=-eMSvkgKQ0Ew3EBDzsikQjIOlEP_iZOpbGGuX8R0F_A,2917
 rtctools/data/__init__.py,sha256=EllgSmCdrlvQZSd1VilvjPaeYJGhY9ErPiQtedmuFoA,157
@@ -19,7 +19,7 @@ rtctools/data/interpolation/bspline.py,sha256=qevB842XWCH3fWlWMBqKMy1mw37ust-0Yt
 rtctools/data/interpolation/bspline1d.py,sha256=HAh7m5xLBuiFKzMzuYEqZX_GmCPChKjV7ynTS6iRZOc,6166
 rtctools/data/interpolation/bspline2d.py,sha256=ScmX0fPDxbUVtj3pbUE0L7UJocqroD_6fUT-4cvdRMc,1693
 rtctools/optimization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=cmcjcrv5EdVcZfAZNB8V-BwPC7M1IJYnalvPaP8BhYo,133037
+rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=eiBh9kxbD7W-KgG44rwOhygKD6yJqAFvCisZIJRK7No,135509
 rtctools/optimization/control_tree_mixin.py,sha256=6OMvjT5rFvvXU3_O6Uwz8xvBQpRH9d5z4mMOtOQ4-a4,9036
 rtctools/optimization/csv_lookup_table_mixin.py,sha256=TUYAT-u-mzH6HLP0iJHnLBVqV5tWnhYAqDC4Aj17MJg,17399
 rtctools/optimization/csv_mixin.py,sha256=_6iPVK_EJ8PxnukepzkhFtidceucsozRML_DDEycYik,12453
@@ -43,10 +43,10 @@ rtctools/simulation/csv_mixin.py,sha256=rGDUFPsqGHmF0_dWdXeWzWzMpkPmwCNweTBVrwSh
 rtctools/simulation/io_mixin.py,sha256=WIKOQxr3fS-aNbgjet9iWoUayuD22zLIYmqlWEqxXHo,6215
 rtctools/simulation/pi_mixin.py,sha256=_TU2DrK2MQqVsyrHBD9W4SDEuot9dYmgTDNiXkDAJfk,9833
 rtctools/simulation/simulation_problem.py,sha256=v5Lk2x-yuVb5s7ne5fFgxONxGniLHTyTR0XRzYRl1fw,50005
-rtc_tools-2.8.0a1.dist-info/METADATA,sha256=HXC5wG6m5tOfAZQ2xdllrW2S17p4Ni3puH2vddtxe08,15024
-rtc_tools-2.8.0a1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-rtc_tools-2.8.0a1.dist-info/entry_points.txt,sha256=DVS8sWf3b9ph9h8srEr6zmQ7ZKGwblwgZgGPZg-jRNQ,150
-rtc_tools-2.8.0a1.dist-info/licenses/AUTHORS,sha256=PlDXG1ipmYrbNMR93XVp4_bcvcz30__pEi7mxvl9TWk,155
-rtc_tools-2.8.0a1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-rtc_tools-2.8.0a1.dist-info/licenses/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rtc_tools-2.8.0a1.dist-info/RECORD,,
+rtc_tools-2.8.0a2.dist-info/METADATA,sha256=nKu420Qtu40T8fhGyBihzZD3UEx_ZZmL9ewiN6B468c,15035
+rtc_tools-2.8.0a2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+rtc_tools-2.8.0a2.dist-info/entry_points.txt,sha256=DVS8sWf3b9ph9h8srEr6zmQ7ZKGwblwgZgGPZg-jRNQ,150
+rtc_tools-2.8.0a2.dist-info/licenses/AUTHORS,sha256=al_VX-S8aXSvAt0PNBikE_KWq0ovofK54qTW_JLr9TA,201
+rtc_tools-2.8.0a2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+rtc_tools-2.8.0a2.dist-info/licenses/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+rtc_tools-2.8.0a2.dist-info/RECORD,,

{rtc_tools-2.8.0a1.dist-info → rtc_tools-2.8.0a2.dist-info}/licenses/AUTHORS

@@ -1,10 +1,13 @@
+Farid Alavi
 Jorn Baayen
 Joris Bentvelsen
 Olav van Duin
 Sjoerd Geevers
+Joris Gillis
 Klaudia Horváth
 Ailbhe Mitchell
 Teresa Piovesan
+Jesús A. Rodríguez
 Matthijs den Toom
 Jesse VanderWees
 Tjerk Vreeken

rtctools/_internal/casadi_helpers.py

@@ -1,9 +1,15 @@
 import logging
+from typing import Union
 
 import casadi as ca
 
 logger = logging.getLogger("rtctools")
 
+# Limit the number of times we try to substitute in external functions, e.g. in
+# case of infinite recursion. Generally unlikely that we will hit this limit for
+# any reasonable use case.
+MAX_SUBSTITUTE_DEPTH = 10
+
 
 def is_affine(expr, symbols):
     try:
@@ -37,12 +43,24 @@ def reduce_matvec(e, v):
     return ca.reshape(ca.mtimes(A, v), e.shape)
 
 
-def substitute_in_external(expr, symbols, values):
-    if len(symbols) == 0 or all(isinstance(x, ca.DM) for x in expr):
+def substitute_in_external(
+    expr: list[ca.MX], symbols: list[ca.MX], values: list[Union[ca.MX, ca.DM, float]]
+):
+    # We expect expr to be a list of (at most) length 1
+    assert len(expr) <= 1
+
+    if not expr or len(symbols) == 0 or all(isinstance(x, ca.DM) for x in expr):
         return expr
+    elif not expr:
+        return []
     else:
-        f = ca.Function("f", symbols, expr)
-        return f.call(values, True, False)
+        for _ in range(MAX_SUBSTITUTE_DEPTH):
+            f = ca.Function("f", symbols, expr).expand()
+            expr = f.call(values, True, False)
+            if expr[0].is_constant():
+                break
+
+        return expr
 
 
 def interpolate(ts, xs, t, equidistant, mode=0):

rtctools/optimization/collocated_integrated_optimization_problem.py

@@ -45,11 +45,17 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
 
     :cvar check_collocation_linearity:
         If ``True``, check whether collocation constraints are linear. Default is ``True``.
+    :cvar inline_delay_expressions:
+        If ``True``, delay expressions are inlined into constraints and objectives instead of
+        being added as separate equality constraints. Default is ``False``.
     """
 
     #: Check whether the collocation constraints are linear
     check_collocation_linearity = True
 
+    #: Inline delay expressions instead of adding them as separate equality constraints
+    inline_delay_expressions = False
+
     #: Whether or not the collocation constraints are linear (affine)
     linear_collocation = None
 
@@ -386,7 +392,9 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
             ):
                 parameter_values = nullvertcat(*parameter_values)
                 [parameter_values] = substitute_in_external(
-                    [parameter_values], self.dae_variables["parameters"], parameter_values
+                    [parameter_values],
+                    self.dae_variables["parameters"],
+                    ca.vertsplit(parameter_values),
                 )
             else:
                 parameter_values = nullvertcat(*parameter_values)
@@ -1789,6 +1797,12 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                     + [constant_inputs[v.name()] for v in self.dae_variables["constant_inputs"]]
                 )
 
+                # If inlining delay expressions, prepare for the single call to ca.substitute()
+                # at the end
+                if self.inline_delay_expressions:
+                    delayed_feedback_variable_replacement = ca.MX.zeros(X.numel())
+                    delayed_feedback_variable_replacement[:] = X
+
                 for i in range(len(delayed_feedback_expressions)):
                     in_variable_name = delayed_feedback_states[i]
                     expression = delayed_feedback_expressions[i]
@@ -1855,10 +1869,38 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
 
                     nominal = nominal_delayed_feedback[i]
 
-                    g.append((x_in - x_out_delayed) / nominal)
-                    zeros = np.zeros(n_collocation_times)
-                    lbg.extend(zeros)
-                    ubg.extend(zeros)
+                    if self.inline_delay_expressions:
+                        # Get the indices for the delayed feedback variable in the optimization
+                        # vector
+                        indices = self.__indices[ensemble_member][in_canonical]
+
+                        # Insert replacement values into appropriate slot
+                        delayed_feedback_variable_replacement[indices] = (
+                            x_out_delayed / in_nominal / in_sign
+                        )
+
+                        # Equate delayed feedback variable to zero so that the numerical solver can
+                        # remove it from the problem.
+                        #
+                        # Note: The alternative approach would be to shrink self.solver_input=X,
+                        # self.__indices, and any other variables that directly or indirectly
+                        # depend on the size and order of 'X'.  This would be a complex operation,
+                        # which would however be redundant for solvers that (like Ipopt) already
+                        # automatically detect and remove variables where lbx==ubx.
+                        lbx[indices] = 0.0
+                        ubx[indices] = 0.0
+                    else:
+                        # Default behavior: add delay expressions as equality constraints
+                        g.append((x_in - x_out_delayed) / nominal)
+                        zeros = np.zeros(n_collocation_times)
+                        lbg.extend(zeros)
+                        ubg.extend(zeros)
+
+            # If inlining delay expressions, carry out the single call to ca.substitute()
+            # A single call is more efficient as it constructs a single ca.Function internally,
+            # rather than one for each element of the list.
+            if self.inline_delay_expressions:
+                g = [ca.substitute(ca.vertcat(*g), X, delayed_feedback_variable_replacement)]
 
             # Objective
             f_member = self.objective(ensemble_member)