Merge pull request #451 from OpenWaterAnalytics/lrossman-dev

Bug fix for 2Comp and LIFO tank mixing models (issue #448)

README.md

@@ -9,7 +9,7 @@ EPANET {#epanet-readme}
 
 
 ## For EPANET-related questions and discussion
-For community discussion, FAQ, and roadmapping of the project, go to the [Community Forum](http://community.wateranalytics.org/category/epanet).
+For community discussion, FAQ, and roadmapping of the project, go to the [Community Forum](http://community.wateranalytics.org/category/epanet). 
 
 ## What is on this Repository?
 The EPANET Library is a pressurized pipe network hydraulic and water quality analysis toolkit written in C. If you are interested in using/extending EPANET for academic, personal, or commercial use, then you've come to the right place.

appveyor.yml

@@ -22,14 +22,14 @@ environment:
     GROUP: "SUPPORTED"
     BOOST_ROOT: "C:/Libraries/boost_1_67_0"
     PLATFORM: "win32"
-    REF_BUILD_ID: "220dev5"
+    REF_BUILD_ID: "538_1"
   # New build on Visual Studio 15 2017
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
     GENERATOR: "Visual Studio 15 2017 Win64"
     GROUP: "EXPERIMENTAL"
     BOOST_ROOT: "C:/Libraries/boost_1_67_0"
     PLATFORM: "win64"
-    REF_BUILD_ID: "381_2"
+    REF_BUILD_ID: "538_2"
 
 # called before repo cloning
 init:

src/qualreact.c

@@ -32,6 +32,7 @@ double  mixtank(Project *, int, double, double ,double);
 
 // Imported functions
 extern  void addseg(Project *, int, double, double);
+extern  void reversesegs(Project *, int);
 
 // Local functions
 static double  piperate(Project *, int);
@@ -170,7 +171,7 @@ void reactpipes(Project *pr, long dt)
 }
 
 
-void reacttanks(Project *pr, long dt)
+void  reacttanks(Project *pr, long dt)
 /*
 **--------------------------------------------------------------
 **   Input:   dt = time step
@@ -539,7 +540,7 @@ void tankmix2(Project *pr, int i, double vin, double win, double vnet)
         vt = MAX(0.0, (mixzone->v + vnet - vmz));
         if (vin > 0.0)
         {
-            mixzone->c = ((stagzone->c) * (stagzone->v) + win) /
+            mixzone->c = ((mixzone->c) * (mixzone->v) + win) /
                          (mixzone->v + vin);
         }
         if (vt > 0.0)
@@ -683,18 +684,14 @@ void tankmix4(Project *pr, int i, double vin, double win, double vnet)
     seg = qual->LastSeg[k];
     if (vnet > 0.0)
     {
-        // ... quality is the same, so just add flow volume to last seg
+        // ... inflow quality is same as last segment's quality,
+        //     so just add inflow volume to last segment
         if (fabs(seg->c - cin) < qual->Ctol) seg->v += vnet;
 
-        // ... otherwise add a new last seg to tank which points to old last seg
-        else
-        {
-            qual->LastSeg[k] = NULL;
-            addseg(pr, k, vnet, cin);
-            qual->LastSeg[k]->prev = seg;
-        }
+        // ... otherwise add a new last segment with inflow quality
+        else addseg(pr, k, vnet, cin);
 
-        // ... update reported tank quality
+        // Update reported tank quality
         tank->C = qual->LastSeg[k]->c;
     }
 
@@ -704,28 +701,48 @@ void tankmix4(Project *pr, int i, double vin, double win, double vnet)
         vsum = 0.0;
         wsum = 0.0;
         vnet = -vnet;
+
+        // Reverse segment chain so segments are processed from last to first
+        reversesegs(pr, k);
+
+        // While there is still volume to remove
         while (vnet > 0.0)
         {
-            seg = qual->LastSeg[k];
+            // ... start with reversed first segment
+            seg = qual->FirstSeg[k];
             if (seg == NULL) break;
+
+            // ... find volume to remove from it
             vseg = seg->v;
             vseg = MIN(vseg, vnet);
-            if (seg == qual->FirstSeg[k]) vseg = vnet;
+            if (seg == qual->LastSeg[k]) vseg = vnet;
+
+            // ... update total volume & mass removed
             vsum += vseg;
             wsum += (seg->c) * vseg;
+
+            // ... update remiaing volume to remove
             vnet -= vseg;
-            if (vnet >= 0.0 && vseg >= seg->v)   // Seg used up
+
+            // ... if no more volume left in current segment
+            if (vnet >= 0.0 && vseg >= seg->v)
             {
+                // ... replace current segment with previous one
                 if (seg->prev)
                 {
-                    qual->LastSeg[k] = seg->prev;
+                    qual->FirstSeg[k] = seg->prev;
                     seg->prev = qual->FreeSeg;
                     qual->FreeSeg = seg;
                 }
             }
-            else seg->v -= vseg;       // Remaining volume in segment
+
+            // ... otherwise reduce volume of current segment
+            else seg->v -= vseg;
         }
 
+        // Restore original orientation of segment chain
+        reversesegs(pr, k);
+
         // Reported tank quality is mixture of flow released and any inflow
         tank->C = (wsum + win) / (vsum + vin);
     }