update OWA SWMM to v5.2.3

- add inlet api functions - set release version
pyswmm · Mar 28, 2023 · 384ed3f · 384ed3f
1 parent 1199894
commit 384ed3f
Show file tree

Hide file tree

Showing 10 changed files with 652 additions and 5 deletions.
diff --git a/swmm-toolkit/CMakeLists.txt b/swmm-toolkit/CMakeLists.txt
@@ -15,7 +15,7 @@ cmake_minimum_required (VERSION 3.17)
 
 project(swmm-toolkit
     VERSION
-        0.13.0
+        0.14.0
 )
 
 

diff --git a/swmm-toolkit/setup.py b/swmm-toolkit/setup.py
@@ -88,7 +88,7 @@ def exclude_files(cmake_manifest):
 
 setup(
     name = "swmm-toolkit",
-    version = "0.13.0",
+    version = "0.14.0",
 
     packages = ["swmm_toolkit", "swmm.toolkit"],
     package_dir = package_dir,

diff --git a/swmm-toolkit/src/swmm/toolkit/__init__.py b/swmm-toolkit/src/swmm/toolkit/__init__.py
@@ -19,7 +19,7 @@
 __credits__ = "Colleen Barr, Sam Hatchett"
 __license__ = "CC0 1.0 Universal"
 
-__version__ = "0.13.0"
+__version__ = "0.14.0"
 __date__ = "June 7, 2021"
 
 __maintainer__ = "Michael Tryby"

diff --git a/swmm-toolkit/src/swmm/toolkit/shared_enum.py b/swmm-toolkit/src/swmm/toolkit/shared_enum.py
@@ -739,3 +739,17 @@ class RainResult(Enum):
     TOTAL = 0
     RAINFALL = 1
     SNOWFALL = 2
+
+class InletProperty(Enum):
+    NUM_INLETS = 0
+    CLOG_FACTOR = 1
+    FLOW_LIMIT = 2
+    DEPRESSION_HEIGHT = 3
+    DEPRESSION_WIDTH = 4
+
+
+class InletResult(Enum):
+    FLOW_FACTOR = 0
+    FLOW_CAPTURE = 1
+    BACK_FLOW = 2
+    BLACK_FLOW_RATIO = 3
diff --git a/swmm-toolkit/src/swmm/toolkit/solver.i b/swmm-toolkit/src/swmm/toolkit/solver.i
@@ -158,7 +158,9 @@
     SM_LidLayerProperty,
     SM_LidUProperty,
     SM_LidUOptions,
-    SM_LidResult
+    SM_LidResult,
+    SM_InletProperty,
+    SM_InletResult
 }
 
 

diff --git a/swmm-toolkit/src/swmm/toolkit/solver_docs.i b/swmm-toolkit/src/swmm/toolkit/solver_docs.i
@@ -1293,3 +1293,57 @@ total_precip: double
     The new total precipitation intensity.
 "
 ) swmm_setGagePrecip;
+
+
+%feature("autodoc", 
+"Get a property value for the inlet of a specified link.
+
+Parameters
+----------
+index: int
+    The index of a link with desired inlets
+param: SM_InletProperty
+    The property type code (See :ref: SM_InletProperty)
+
+Returns
+-------
+value: double *
+    The value of the inlet's property
+"
+) swmm_getInletParam;
+
+
+%feature("autodoc", 
+"Get a property value for the inlet of a specified link.
+
+Parameters
+----------
+index: int
+    The index of a link with desired inlets
+param: SM_InletProperty
+    The property type code (See :ref: SM_InletProperty)
+
+Returns
+-------
+value: double *
+    The new value of the inlet's property
+"
+) swmm_setInletParam;
+
+
+%feature("autodoc", 
+"Get a result value for specified link.
+
+Parameters
+----------
+index: int
+    The index of a link with desired inlets
+type: SM_InletResult
+    The result type code (See :ref: SM_InletResult)
+
+Returns
+-------
+result: double *
+    The value of the inlet's result at the current simulation timestep
+"
+) swmm_getInletResult;
diff --git a/swmm-toolkit/src/swmm/toolkit/solver_rename.i b/swmm-toolkit/src/swmm/toolkit/solver_rename.i
@@ -68,6 +68,9 @@
 %rename(link_set_target_setting)            swmm_setLinkSetting;
 %rename(link_get_stats)                     swmm_getLinkStats;
 
+%rename(inlet_get_parameter)                swmm_getInletParam;
+%rename(inlet_set_parameter)                swmm_setInletParam;
+%rename(inlet_get_result)                   swmm_getInletResult;
 
 %rename(pump_get_stats)                     swmm_getPumpStats;
 

diff --git a/swmm-toolkit/swmm-solver b/swmm-toolkit/swmm-solver