Supplement options

api/__init__.py

@@ -90,6 +90,7 @@ from .s21_times import TIME_STATISTIC_NONE, TIME_STATISTIC_AVERAGED, TIME_STATIS
 from .s21_times import get_time_schema, get_time, set_time
 
 from .s23_options import OPTION_UNITS_CFS, OPTION_UNITS_GPM, OPTION_UNITS_MGD, OPTION_UNITS_IMGD, OPTION_UNITS_AFD, OPTION_UNITS_LPS, OPTION_UNITS_LPM, OPTION_UNITS_MLD, OPTION_UNITS_CMH, OPTION_UNITS_CMD
+from .s23_options import OPTION_PRESSURE_PSI, OPTION_PRESSURE_KPA, OPTION_PRESSURE_M
 from .s23_options import OPTION_HEADLOSS_HW, OPTION_HEADLOSS_DW, OPTION_HEADLOSS_CM
 from .s23_options import OPTION_UNBALANCED_STOP, OPTION_UNBALANCED_CONTINUE
 from .s23_options import OPTION_DEMAND_MODEL_DDA, OPTION_DEMAND_MODEL_PDA

api/s23_options.py

@@ -11,13 +11,14 @@ OPTION_UNITS_MLD = 'MLD'
 OPTION_UNITS_CMH = 'CMH'
 OPTION_UNITS_CMD = 'CMD'
 
+OPTION_PRESSURE_PSI = 'PSI'
+OPTION_PRESSURE_KPA = 'KPA'
+OPTION_PRESSURE_M = 'M'
+
 OPTION_HEADLOSS_HW = 'H-W'
 OPTION_HEADLOSS_DW = 'D-W'
 OPTION_HEADLOSS_CM = 'C-M'
 
-#OPTION_HYDRAULICS_USE = 'USE'
-#OPTION_HYDRAULICS_SAVE = 'SAVE'
-
 OPTION_UNBALANCED_STOP = 'STOP'
 OPTION_UNBALANCED_CONTINUE = 'CONTINUE'
 
@@ -31,32 +32,34 @@ OPTION_QUALITY_TRACE = 'TRACE'
 
 element_schema = {'type': 'str' , 'optional': True , 'readonly': False}
 
+
 def get_option_schema(name: str) -> dict[str, dict[str, Any]]:
     return { 'UNITS'             : element_schema,
+             'PRESSURE'          : element_schema,
              'HEADLOSS'          : element_schema,
-            #'HYDRAULICS'        : element_schema,
+             'QUALITY'           : element_schema,
+             'UNBALANCED'        : element_schema,
+             'PATTERN'           : element_schema,
+             'DEMAND MODEL'      : element_schema,
+             'DEMAND MULTIPLIER' : element_schema,
+             'EMITTER EXPONENT'  : element_schema,
              'VISCOSITY'         : element_schema,
+             'DIFFUSIVITY'       : element_schema,
              'SPECIFIC GRAVITY'  : element_schema,
              'TRIALS'            : element_schema,
              'ACCURACY'          : element_schema,
-             'FLOWCHANGE'        : element_schema,
              'HEADERROR'         : element_schema,
-             'CHECKFREQ'         : element_schema,
+             'FLOWCHANGE'        : element_schema,
-             'MAXCHECK'          : element_schema,
-             'DAMPLIMIT'         : element_schema,
-             'UNBALANCED'        : element_schema,
-             'DEMAND MODEL'      : element_schema,
              'MINIMUM PRESSURE'  : element_schema,
              'REQUIRED PRESSURE' : element_schema,
              'PRESSURE EXPONENT' : element_schema,
-             'PATTERN'           : element_schema,
-             'DEMAND MULTIPLIER' : element_schema,
-             'EMITTER EXPONENT'  : element_schema,
-             'QUALITY'           : element_schema,
-             'DIFFUSIVITY'       : element_schema,
              'TOLERANCE'         : element_schema,
-            #'MAP'               : element_schema,
+             'HTOL'              : element_schema,
-           }
+             'QTOL'              : element_schema,
+             'RQTOL'             : element_schema,
+             'CHECKFREQ'         : element_schema,
+             'MAXCHECK'          : element_schema,
+             'DAMPLIMIT'         : element_schema }
 
 
 def get_option(name: str) -> dict[str, Any]:
@@ -106,37 +109,36 @@ def set_option(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2]
+# [EPANET2][IN][OUT]
-#   UNITS               CFS/GPM/MGD/IMGD/AFD/LPS/LPM/MLD/CMH/CMD/SI
+# UNITS               CFS/GPM/MGD/IMGD/AFD/LPS/LPM/MLD/CMH/CMD/SI
-#   PRESSURE            PSI/KPA/M
+# PRESSURE            PSI/KPA/M
-#   HEADLOSS            H-W/D-W/C-M
+# HEADLOSS            H-W/D-W/C-M
-#   HYDRAULICS          USE/SAVE  filename
+# QUALITY             NONE/AGE/TRACE/CHEMICAL  (TraceNode)
-#   QUALITY             NONE/AGE/TRACE/CHEMICAL  (TraceNode)
+# UNBALANCED          STOP/CONTINUE {Niter}
-#   MAP                 filename
+# PATTERN             id
-#   VERIFY              filename
+# DEMAND MODEL        DDA/PDA
-#   UNBALANCED          STOP/CONTINUE {Niter}
+# DEMAND MULTIPLIER   value
-#   PATTERN             id
+# EMITTER EXPONENT    value
-#   DEMAND MODEL        DDA/PDA
+# VISCOSITY           value
-#   DEMAND MULTIPLIER   value
+# DIFFUSIVITY         value
-#   EMITTER EXPONENT    value
+# SPECIFIC GRAVITY    value
-#   VISCOSITY           value
+# TRIALS              value
-#   DIFFUSIVITY         value
+# ACCURACY            value# 
-#   SPECIFIC GRAVITY    value
+# HEADERROR           value
-#   TRIALS              value
+# FLOWCHANGE          value
-#   ACCURACY            value# 
+# MINIMUM PRESSURE    value
-#   HEADERROR           value
+# REQUIRED PRESSURE   value
-#   FLOWCHANGE          value
+# PRESSURE EXPONENT   value# 
-#   MINIMUM PRESSURE    value
+# TOLERANCE           value
-#   REQUIRED PRESSURE   value
+# HTOL                value
-#   PRESSURE EXPONENT   value# 
+# QTOL                value
-#   TOLERANCE           value
+# RQTOL               value
-#   ---- Undocumented Options -----
+# CHECKFREQ           value
-#   HTOL                value
+# MAXCHECK            value
-#   QTOL                value
+# DAMPLIMIT           value
-#   RQTOL               value
+# ---- Unsupported Options -----
-#   CHECKFREQ           value
+# HYDRAULICS          USE/SAVE  filename
-#   MAXCHECK            value
+# MAP                 filename
-#   DAMPLIMIT           value
 #--------------------------------------------------------------
 def inp_in_option(section: list[str]) -> ChangeSet:
     if len(section) > 0:
@@ -146,9 +148,9 @@ def inp_in_option(section: list[str]) -> ChangeSet:
                 continue
 
             tokens = s.strip().split()
-            if tokens[0].upper() == 'PATTERN':
+            if tokens[0].upper() == 'PATTERN': # can not upper id
                 cs |= { 'PATTERN' : tokens[1] }
-            elif tokens[0].upper() == 'QUALITY':
+            elif tokens[0].upper() == 'QUALITY': # can not upper trace node
                 value = tokens[1]
                 if len(tokens) > 2:
                     value += f' {tokens[2]}'

script/sql/create/23.options.sql

@@ -10,27 +10,29 @@ create table options
 
 insert into options (key, value) values
   ('UNITS', 'GPM')
+, ('PRESSURE', 'PSI')
 , ('HEADLOSS', 'H-W')
---, ('HYDRAULICS', '')
+, ('QUALITY', 'NONE')
+, ('UNBALANCED', 'STOP')
+, ('PATTERN', '1')
+, ('DEMAND MODEL', 'DDA')
+, ('DEMAND MULTIPLIER', '1.0')
+, ('EMITTER EXPONENT', '0.5')
 , ('VISCOSITY', '1.0')
+, ('DIFFUSIVITY', '1.0')
 , ('SPECIFIC GRAVITY', '1.0')
 , ('TRIALS', '40')
 , ('ACCURACY', '0.001')
-, ('FLOWCHANGE', '0')
 , ('HEADERROR', '0')
-, ('CHECKFREQ', '2')
+, ('FLOWCHANGE', '0')
-, ('MAXCHECK', '10')
-, ('DAMPLIMIT', '0')
-, ('UNBALANCED', 'STOP')
-, ('DEMAND MODEL', 'DDA')
 , ('MINIMUM PRESSURE', '0')
 , ('REQUIRED PRESSURE', '0.1')
 , ('PRESSURE EXPONENT', '0.5')
-, ('PATTERN', '1')
-, ('DEMAND MULTIPLIER', '1.0')
-, ('EMITTER EXPONENT', '0.5')
-, ('QUALITY', 'NONE')
-, ('DIFFUSIVITY', '1.0')
 , ('TOLERANCE', '0.01')
---, ('MAP', '')
+, ('HTOL', '0.0005')
+, ('QTOL', '0.0001')
+, ('RQTOL', '0.0000001')
+, ('CHECKFREQ', '2')
+, ('MAXCHECK', '10')
+, ('DAMPLIMIT', '0')
 ;

test_tjnetwork.py

@@ -3251,6 +3251,10 @@ class TestApi:
         assert o['QUALITY'] == OPTION_QUALITY_NONE
         assert o['DIFFUSIVITY'] == '1.0'
         assert o['TOLERANCE'] == '0.01'
+        assert o['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert o['HTOL'] == '0.0005'
+        assert o['QTOL'] == '0.0001'
+        assert o['RQTOL'] == '0.0000001'
 
         o['UNITS'] = OPTION_UNITS_LPS
         set_option(p, ChangeSet(o))
@@ -3278,6 +3282,10 @@ class TestApi:
         assert o['QUALITY'] == OPTION_QUALITY_NONE
         assert o['DIFFUSIVITY'] == '1.0'
         assert o['TOLERANCE'] == '0.01'
+        assert o['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert o['HTOL'] == '0.0005'
+        assert o['QTOL'] == '0.0001'
+        assert o['RQTOL'] == '0.0000001'
 
         self.leave(p)
 
@@ -3309,6 +3317,10 @@ class TestApi:
         assert o['QUALITY'] == OPTION_QUALITY_NONE
         assert o['DIFFUSIVITY'] == '1.0'
         assert o['TOLERANCE'] == '0.01'
+        assert o['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert o['HTOL'] == '0.0005'
+        assert o['QTOL'] == '0.0001'
+        assert o['RQTOL'] == '0.0000001'
 
         o['UNITS'] = OPTION_UNITS_LPS
         cs = set_option(p, ChangeSet(o)).operations[0]
@@ -3336,6 +3348,10 @@ class TestApi:
         assert cs['QUALITY'] == OPTION_QUALITY_NONE
         assert cs['DIFFUSIVITY'] == '1.0'
         assert cs['TOLERANCE'] == '0.01'
+        assert cs['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert cs['HTOL'] == '0.0005'
+        assert cs['QTOL'] == '0.0001'
+        assert cs['RQTOL'] == '0.0000001'
 
         cs = execute_undo(p).operations[0]
         assert cs['operation'] == API_UPDATE
@@ -3362,6 +3378,10 @@ class TestApi:
         assert cs['QUALITY'] == OPTION_QUALITY_NONE
         assert cs['DIFFUSIVITY'] == '1.0'
         assert cs['TOLERANCE'] == '0.01'
+        assert cs['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert cs['HTOL'] == '0.0005'
+        assert cs['QTOL'] == '0.0001'
+        assert cs['RQTOL'] == '0.0000001'
 
         cs = execute_redo(p).operations[0]
         assert cs['operation'] == API_UPDATE
@@ -3388,6 +3408,10 @@ class TestApi:
         assert cs['QUALITY'] == OPTION_QUALITY_NONE
         assert cs['DIFFUSIVITY'] == '1.0'
         assert cs['TOLERANCE'] == '0.01'
+        assert cs['PRESSURE'] == OPTION_PRESSURE_PSI
+        assert cs['HTOL'] == '0.0005'
+        assert cs['QTOL'] == '0.0001'
+        assert cs['RQTOL'] == '0.0000001'
 
         self.leave(p)
 

tjnetwork.py

@@ -80,6 +80,10 @@ OPTION_UNITS_MLD = api.OPTION_UNITS_MLD
 OPTION_UNITS_CMH = api.OPTION_UNITS_CMH
 OPTION_UNITS_CMD = api.OPTION_UNITS_CMD
 
+OPTION_PRESSURE_PSI = api.OPTION_PRESSURE_PSI
+OPTION_PRESSURE_KPA = api.OPTION_PRESSURE_KPA
+OPTION_PRESSURE_M = api.OPTION_PRESSURE_M
+
 OPTION_HEADLOSS_HW = api.OPTION_HEADLOSS_HW
 OPTION_HEADLOSS_DW = api.OPTION_HEADLOSS_DW
 OPTION_HEADLOSS_CM = api.OPTION_HEADLOSS_CM