From 844e86b34dc07460c769699292402ce057e7f80c Mon Sep 17 00:00:00 2001
From: "WQY\\qiong" <qiongyu.wang@outlook.com>
Date: Thu, 2 Mar 2023 19:43:10 +0800
Subject: [PATCH] Add EPANET3 format

---
 api/s16_emitters.py    | 5 ++++-
 api/s17_quality.py     | 2 +-
 api/s18_sources.py     | 2 +-
 api/s19_reactions.py   | 2 +-
 api/s20_mixing.py      | 3 ++-
 api/s24_coordinates.py | 2 +-
 api/s4_tanks.py        | 5 ++++-
 api/s9_demands.py      | 2 +-
 8 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/api/s16_emitters.py b/api/s16_emitters.py
index 751782d..844a3fc 100644
--- a/api/s16_emitters.py
+++ b/api/s16_emitters.py
@@ -60,9 +60,12 @@ def set_emitter(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][IN][OUT]
 #   node   Ke
 #--------------------------------------------------------------
+# [EPA3][IN][OUT]
+#   node   Ke  (exponent pattern)
+#--------------------------------------------------------------
 class InpEmitter:
     def __init__(self, line: str) -> None:
         tokens = line.split()
diff --git a/api/s17_quality.py b/api/s17_quality.py
index 620e8d5..faf30fe 100644
--- a/api/s17_quality.py
+++ b/api/s17_quality.py
@@ -60,7 +60,7 @@ def set_quality(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #   node   initqual
 #--------------------------------------------------------------
 class InpQuality:
diff --git a/api/s18_sources.py b/api/s18_sources.py
index 47d8797..9c1e210 100644
--- a/api/s18_sources.py
+++ b/api/s18_sources.py
@@ -103,7 +103,7 @@ def delete_source(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #   node  sourcetype  quality  (pattern)
 #--------------------------------------------------------------
 class InpSource:
diff --git a/api/s19_reactions.py b/api/s19_reactions.py
index 859d63c..5c9117a 100644
--- a/api/s19_reactions.py
+++ b/api/s19_reactions.py
@@ -182,7 +182,7 @@ def set_tank_reaction(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #   ORDER     {BULK/WALL/TANK} value
 #   GLOBAL    BULK             coeff
 #   GLOBAL    WALL             coeff
diff --git a/api/s20_mixing.py b/api/s20_mixing.py
index cd1d52d..1a9704c 100644
--- a/api/s20_mixing.py
+++ b/api/s20_mixing.py
@@ -97,8 +97,9 @@ def delete_mixing(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #   TankID  MixModel  FractVolume
+#   FractVolume if type == MIX2
 #--------------------------------------------------------------
 class InpMixing:
     def __init__(self, line: str) -> None:
diff --git a/api/s24_coordinates.py b/api/s24_coordinates.py
index 44cd2cd..aa30517 100644
--- a/api/s24_coordinates.py
+++ b/api/s24_coordinates.py
@@ -12,7 +12,7 @@ def get_node_coord(name: str, id: str) -> dict[str, float]:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #   id  x  y
 #--------------------------------------------------------------
 # exception ! need merge to node change set !
diff --git a/api/s4_tanks.py b/api/s4_tanks.py
index 5c5c88d..ad92d8f 100644
--- a/api/s4_tanks.py
+++ b/api/s4_tanks.py
@@ -145,7 +145,7 @@ def delete_tank(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2]
+# [EPA2]
 # [IN]
 #   id elev initlevel minlevel maxlevel diam (minvol vcurve overflow) ;desc
 #                                                      xxx
@@ -153,6 +153,9 @@ def delete_tank(name: str, cs: ChangeSet) -> ChangeSet:
 # [OUT]
 #   id elev initlevel minlevel maxlevel diam minvol (vcurve overflow) ;desc
 #--------------------------------------------------------------
+# [EPA3]
+#   id elev initlevel minlevel maxlevel diam minvol (vcurve)
+#--------------------------------------------------------------
 class InpTank:
     def __init__(self, line: str) -> None:
         tokens = line.split()
diff --git a/api/s9_demands.py b/api/s9_demands.py
index a90e046..2fedb1e 100644
--- a/api/s9_demands.py
+++ b/api/s9_demands.py
@@ -60,7 +60,7 @@ def set_demand(name: str, cs: ChangeSet) -> ChangeSet:
 
 
 #--------------------------------------------------------------
-# [EPANET2][IN][OUT]
+# [EPA2][EPA3][IN][OUT]
 #    node  base_demand  (pattern) ;category
 #--------------------------------------------------------------
 class InpDemand: