Check value of pump power and tests (#520)

* Check value of pump power and tests

* replace power setter code block with checker utility.

* fix check function used

* move subclass specific attributes out of Pump and into respective subclasses

* fix super init bug

---------

Co-authored-by: angusmcb <[email protected]>
Co-authored-by: kbonney <[email protected]>

Author: 3 people

wntr/network/elements.py

@@ -1126,8 +1126,6 @@ class Pump(Link):
     def __init__(self, name, start_node_name, end_node_name, wn):
         super(Pump, self).__init__(wn, name, start_node_name, end_node_name)
         self._speed_timeseries = TimeSeries(wn._pattern_reg, 1.0)
-        self._base_power = None
-        self._pump_curve_name = None
         self._efficiency_curve_name = None
         self._energy_price = None 
         self._energy_pattern = None
@@ -1348,13 +1346,10 @@ class HeadPump(Pump):
 
     """
 
-#    def __init__(self, name, start_node_name, end_node_name, wn):
-#        super(HeadPump,self).__init__(name, start_node_name, 
-#                                      end_node_name, wn)
-#        self._curve_coeffs = None
-#        self._coeffs_curve_points = None # these are used to verify whether
-#                                         # the pump curve was changed since
-#                                         # the _curve_coeffs were calculated
+    def __init__(self, name, start_node_name, end_node_name, wn):
+        super(HeadPump,self).__init__(name, start_node_name, 
+                                        end_node_name, wn)
+        self._pump_curve_name = None
 
     def __repr__(self):
         return "<Pump '{}' from '{}' to '{}', pump_type='{}', pump_curve={}, speed={}, status={}>".format(self._link_name,
@@ -1568,6 +1563,10 @@ class PowerPump(Pump):
         setting
 
     """
+    def __init__(self, name, start_node_name, end_node_name, wn):
+        super(PowerPump,self).__init__(name, start_node_name, 
+                                        end_node_name, wn)
+        self._base_power = None
 
     def __repr__(self):
         return "<Pump '{}' from '{}' to '{}', pump_type='{}', power={}, speed={}, status={}>".format(self._link_name,
@@ -1593,8 +1592,8 @@ def power(self):
         return self._base_power
     @power.setter
     def power(self, value):
-        self._curve_reg.remove_usage(self._pump_curve_name, (self._link_name, 'Pump'))
-        self._base_power = value
+        self._base_power = _check_positive_non_zero_float(value, "Pump power")
+        
 
 
 class Valve(Link):

wntr/tests/test_network_elements.py

@@ -1,6 +1,8 @@
 """
 Test the wntr.network.elements classes
 """
+
+import pytest
 import unittest
 from os.path import abspath, dirname, join
 from unittest import SkipTest
@@ -321,5 +323,67 @@ def test_float_or_none_bad_value(value):
         _check_float_or_none(value, "test")
 
 
+def test_pump_power_on_add_float():
+    wn = wntr.network.WaterNetworkModel()
+    wn.add_junction("1")
+    wn.add_junction("2")
+
+    wn.add_pump("pump1", "1", "2", pump_type="POWER", pump_parameter=1000.0)
+
+    assert wn.links["pump1"].power == 1000.0
+
+
+def test_pump_power_on_add_int():
+    wn = wntr.network.WaterNetworkModel()
+    wn.add_junction("1")
+    wn.add_junction("2")
+
+    wn.add_pump("pump1", "1", "2", pump_type="POWER", pump_parameter=1000)
+
+    assert wn.links["pump1"].power == 1000.0
+
+
+@pytest.fixture
+def power_pump():
+    wn = wntr.network.WaterNetworkModel()
+    wn.add_junction("1")
+    wn.add_junction("2")
+    wn.add_pump("pump1", "1", "2", pump_type="POWER")
+    return wn.links["pump1"]
+
+
+def test_pump_power_set_property_float(power_pump):
+    power_pump.power = 500.0
+
+    assert power_pump.power == 500.0
+
+
+def test_pump_power_set_property_int(power_pump):
+    power_pump.power = 500
+
+    assert power_pump.power == 500.0
+
+
+def test_pump_power_set_property_string(power_pump):
+    power_pump.power = "500"
+
+    assert power_pump.power == 500.0
+
+
+def test_pump_power_set_property_negative(power_pump):
+    with pytest.raises(ValueError):
+        power_pump.power = -500
+
+
+def test_pump_power_set_property_zero(power_pump):
+    with pytest.raises(ValueError):
+        power_pump.power = 0
+
+
+def test_pump_power_set_property_invalid_string(power_pump):
+    with pytest.raises(ValueError):
+        power_pump.power = "invalid_string"
+
+
 if __name__ == "__main__":
     unittest.main()