epyt-flow 0.14.0__py3-none-any.whl → 0.14.1__py3-none-any.whl

epyt_flow/EPANET/EPANET/SRC_engines/hydstatus.c

@@ -1,13 +1,13 @@
 /*
 ******************************************************************************
 Project:      OWA EPANET
-Version:      2.2
+Version:      2.3
 Module:       hydstatus.c
 Description:  updates hydraulic status of network elements
 Authors:      see AUTHORS
 Copyright:    see AUTHORS
 License:      see LICENSE
-Last Updated: 05/15/2019
+Last Updated: 02/03/2023
 ******************************************************************************
 */
 
@@ -27,7 +27,7 @@ static StatusType pumpstatus(Project *, int, double);
 static StatusType prvstatus(Project *, int, StatusType, double, double, double);
 static StatusType psvstatus(Project *, int, StatusType, double, double, double);
 static StatusType fcvstatus(Project *, int, StatusType, double, double);
-static void       tankstatus(Project *, int, int, int);
+static void       tankstatus(Project *, int, int, double);
 
 
 int  valvestatus(Project *pr)
@@ -155,10 +155,8 @@ int  linkstatus(Project *pr)
         }
 
         // Check for flow into (out of) full (empty) tanks
-        if (n1 > net->Njuncs || n2 > net->Njuncs)
-        {
-            tankstatus(pr, k, n1, n2);
-        }
+        if (n1 > net->Njuncs) tankstatus(pr, k, n1, hyd->LinkFlow[k]);
+        if (n2 > net->Njuncs) tankstatus(pr, k, n2, -hyd->LinkFlow[k]);
 
         // Note any change in link status; do not revise link flow
         if (status != hyd->LinkStatus[k])
@@ -224,6 +222,7 @@ StatusType  pumpstatus(Project *pr, int k, double dh)
     {
         // Use huge value for constant HP pump
         hmax = BIG;
+        if (hyd->LinkFlow[k] < TINY) return TEMPCLOSED;
     }
     else
     {
@@ -394,16 +393,25 @@ StatusType  fcvstatus(Project *pr, int k, StatusType s, double h1, double h2)
     {
         status = ACTIVE;
     }
+
+    // Active valve's loss coeff. can't be < fully open loss coeff.
+    else if (status == ACTIVE)
+    {
+        if ((h1 - h2) / SQR(hyd->LinkFlow[k]) < pr->network.Link[k].Km)
+        {
+            status = XFCV;
+        }
+    }        
     return status;
 }
 
 
-void  tankstatus(Project *pr, int k, int n1, int n2)
+void  tankstatus(Project *pr, int k, int n, double q)
 /*
 **----------------------------------------------------------------
-**  Input:   k  = link index
-**           n1 = start node of link
-**           n2 = end node of link
+**  Input:   k = link index
+**           n = tank node index
+**           q = link flow rate out of (+) or into (-) tank
 **  Output:  none
 **  Purpose: closes link flowing into full or out of empty tank
 **----------------------------------------------------------------
@@ -412,65 +420,23 @@ void  tankstatus(Project *pr, int k, int n1, int n2)
     Network *net = &pr->network;
     Hydraul *hyd = &pr->hydraul;
 
-    int   i, n;
-    double h, q;
+    int   i;
     Stank *tank;
     Slink *link = &net->Link[k];
 
     // Return if link is closed
     if (hyd->LinkStatus[k] <= CLOSED) return;
 
-    // Make node n1 be the tank, reversing flow (q) if need be
-    q = hyd->LinkFlow[k];
-    i = n1 - net->Njuncs;
-    if (i <= 0)
-    {
-        i = n2 - net->Njuncs;
-        if (i <= 0) return;
-        n = n1;
-        n1 = n2;
-        n2 = n;
-        q = -q;
-    }
-
     // Ignore reservoirs
+    i = n - net->Njuncs;
     tank = &net->Tank[i];
     if (tank->A == 0.0) return;
-
-    // Find head difference across link
-    h = hyd->NodeHead[n1] - hyd->NodeHead[n2];
-
-    // If tank is full, then prevent flow into it
-    if (hyd->NodeHead[n1] >= tank->Hmax - hyd->Htol && !tank->CanOverflow)
-    {
-        // Case 1: Link is a pump discharging into tank
-        if (link->Type == PUMP)
-        {
-            if (link->N2 == n1) hyd->LinkStatus[k] = TEMPCLOSED;
-        }
-
-        // Case 2: Downstream head > tank head
-        // (e.g., an open outflow check valve would close)
-        else if (cvstatus(pr, OPEN, h, q) == CLOSED)
-        {
-            hyd->LinkStatus[k] = TEMPCLOSED;
-        }
-    }
-
-    // If tank is empty, then prevent flow out of it
-    if (hyd->NodeHead[n1] <= tank->Hmin + hyd->Htol)
-    {
-        // Case 1: Link is a pump discharging from tank
-        if (link->Type == PUMP)
-        {
-            if (link->N1 == n1) hyd->LinkStatus[k] = TEMPCLOSED;
-        }
-
-        // Case 2: Tank head > downstream head
-        // (e.g., a closed outflow check valve would open)
-        else if (cvstatus(pr, CLOSED, h, q) == OPEN)
-        {
-            hyd->LinkStatus[k] = TEMPCLOSED;
-        }
-    }
+    
+    // Can't add flow to a full tank
+    if (hyd->NodeHead[n] >= tank->Hmax && !tank->CanOverflow && q < 0.0)
+        hyd->LinkStatus[k] = TEMPCLOSED;
+ 
+    // Can't remove flow from an empty tank
+    else if (hyd->NodeHead[n] <= tank->Hmin && q > 0.0)
+        hyd->LinkStatus[k] = TEMPCLOSED;
 }

epyt_flow/EPANET/EPANET/SRC_engines/include/epanet2.h

@@ -1,13 +1,13 @@
 /*
  ******************************************************************************
  Project:      OWA EPANET
- Version:      2.2
+ Version:      2.3
  Module:       epanet2.h
  Description:  declarations of the legacy style EPANET 2 API functions
  Authors:      see AUTHORS
  Copyright:    see AUTHORS
  License:      see LICENSE
- Last Updated: 10/29/2019
+ Last Updated: 02/14/2025
  ******************************************************************************
  */
 
@@ -18,7 +18,7 @@ set of thread safe API functions that allows one to run concurrent analyses on
 multiple EPANET projects can be found in the epanet2_2.h header file. The two
 APIs share the same function names and arguments with the difference being that
 the thread safe functions use the prefix "EN_" and include an extra argument that
-represents the EPANET project being analyzed. To avoid unneccesary repetition,
+represents the EPANET project being analyzed. To avoid unnecessary repetition,
 only the thread safe API functions have been documented. To see a description of
 a legacy style API function declared here please refer to its complementary named
 function in epanet2_2.h.
@@ -72,14 +72,21 @@ extern "C" {
 
   int  DLLEXPORT ENopen(const char *inpFile, const char *rptFile,
                  const char *outFile);
-  
+
+  int  DLLEXPORT ENopenX(const char *inpFile, const char *rptFile,
+                 const char *outFile);
+
   int  DLLEXPORT ENgettitle(char *line1, char *line2, char *line3);
-  
-  int  DLLEXPORT ENsettitle(char *line1, char *line2, char *line3);
+
+  int  DLLEXPORT ENsettitle(const char *line1, const char *line2, const char *line3);
 
   int  DLLEXPORT ENgetcomment(int object, int index, char *comment);
 
-  int  DLLEXPORT ENsetcomment(int object, int index, char *comment);
+  int  DLLEXPORT ENsetcomment(int object, int index, const char *comment);
+
+  int  DLLEXPORT ENgettag(int object, int index, char *tag);
+
+  int  DLLEXPORT ENsettag(int object, int index, const char *tag);
 
   int  DLLEXPORT ENgetcount(int object, int *count);
 
@@ -107,9 +114,9 @@ extern "C" {
 
   int  DLLEXPORT ENcloseH();
 
-  int  DLLEXPORT ENsavehydfile(char *filename);
+  int  DLLEXPORT ENsavehydfile(const char *filename);
 
-  int  DLLEXPORT ENusehydfile(char *filename);
+  int  DLLEXPORT ENusehydfile(const char *filename);
 
 /********************************************************************
 
@@ -137,17 +144,17 @@ extern "C" {
 
 ********************************************************************/
 
-  int  DLLEXPORT ENwriteline(char *line);
+  int  DLLEXPORT ENwriteline(const char *line);
 
   int  DLLEXPORT ENreport();
 
-  int  DLLEXPORT ENcopyreport(char *filename);
+  int  DLLEXPORT ENcopyreport(const char *filename);
 
   int  DLLEXPORT ENclearreport();
 
   int  DLLEXPORT ENresetreport();
 
-  int  DLLEXPORT ENsetreport(char *format);
+  int  DLLEXPORT ENsetreport(const char *format);
 
   int  DLLEXPORT ENsetstatusreport(int level);
 
@@ -156,9 +163,16 @@ extern "C" {
   int  DLLEXPORT ENgeterror(int errcode, char *errmsg, int maxLen);
 
   int  DLLEXPORT ENgetstatistic(int type, EN_API_FLOAT_TYPE* value);
-  
+
   int  DLLEXPORT ENgetresultindex(int type, int index, int *value);
 
+  int  DLLEXPORT ENtimetonextevent(int *eventType, long *duration, int *elementIndex);
+
+  int DLLEXPORT ENsetreportcallback(void (*callback)(void *userData, void *EN_projectHandle, const char*));
+  
+  int DLLEXPORT ENsetreportcallbackuserdata(void *userData);
+
+
 /********************************************************************
 
     Analysis Options Functions
@@ -182,8 +196,8 @@ extern "C" {
 
   int  DLLEXPORT ENgetqualtype(int *qualType, int *traceNode);
 
-  int  DLLEXPORT ENsetqualtype(int qualType, char *chemName, char *chemUnits,
-                 char *traceNode);
+  int  DLLEXPORT ENsetqualtype(int qualType, const char *chemName,
+                 const char *chemUnits, const char *traceNode);
 
 /********************************************************************
 
@@ -191,29 +205,31 @@ extern "C" {
 
 ********************************************************************/
 
-   int DLLEXPORT ENaddnode(char *id, int nodeType, int *index);
+   int DLLEXPORT ENaddnode(const char *id, int nodeType, int *index);
 
    int DLLEXPORT ENdeletenode(int index, int actionCode);
 
-   int DLLEXPORT ENgetnodeindex(char *id, int *index);
+   int DLLEXPORT ENgetnodeindex(const char *id, int *index);
 
    int DLLEXPORT ENgetnodeid(int index, char *id);
 
-   int DLLEXPORT ENsetnodeid(int index, char *newid);
+   int DLLEXPORT ENsetnodeid(int index, const char *newid);
 
    int DLLEXPORT ENgetnodetype(int index, int *nodeType);
 
    int DLLEXPORT ENgetnodevalue(int index, int property, EN_API_FLOAT_TYPE *value);
 
+   int DLLEXPORT ENgetnodevalues(int property, EN_API_FLOAT_TYPE *value);
+
    int DLLEXPORT ENsetnodevalue(int index, int property, EN_API_FLOAT_TYPE value);
 
    int DLLEXPORT ENsetjuncdata(int index, EN_API_FLOAT_TYPE elev,
-                 EN_API_FLOAT_TYPE dmnd, char *dmndpat);
+                 EN_API_FLOAT_TYPE dmnd, const char *dmndpat);
 
   int  DLLEXPORT ENsettankdata(int index, EN_API_FLOAT_TYPE elev,
                  EN_API_FLOAT_TYPE initlvl, EN_API_FLOAT_TYPE minlvl,
                  EN_API_FLOAT_TYPE maxlvl, EN_API_FLOAT_TYPE diam,
-                 EN_API_FLOAT_TYPE minvol, char *volcurve);
+                 EN_API_FLOAT_TYPE minvol, const char *volcurve);
 
   int  DLLEXPORT ENgetcoord(int index, double *x, double *y);
 
@@ -232,13 +248,14 @@ extern "C" {
                 EN_API_FLOAT_TYPE preq, EN_API_FLOAT_TYPE pexp);
 
   int DLLEXPORT ENadddemand(int nodeIndex, EN_API_FLOAT_TYPE baseDemand,
-                char *demandPattern, char *demandName);
+                const char *demandPattern, const char *demandName);
 
   int DLLEXPORT ENdeletedemand(int nodeIndex, int demandIndex);
-  
+
   int DLLEXPORT ENgetnumdemands(int nodeIndex, int *numDemands);
 
-  int DLLEXPORT ENgetdemandindex(int nodeIndex, char *demandName, int *demandIndex);
+  int DLLEXPORT ENgetdemandindex(int nodeIndex, const char *demandName,
+                int *demandIndex);
 
   int DLLEXPORT ENgetbasedemand(int nodeIndex, int demandIndex,
                 EN_API_FLOAT_TYPE *baseDemand);
@@ -252,7 +269,7 @@ extern "C" {
 
   int DLLEXPORT ENgetdemandname(int nodeIndex, int demandIndex, char *demandName);
 
-  int DLLEXPORT ENsetdemandname(int nodeIndex, int demandIndex, char *demandName);
+  int DLLEXPORT ENsetdemandname(int nodeIndex, int demandIndex, const char *demandName);
 
 /********************************************************************
 
@@ -260,15 +277,16 @@ extern "C" {
 
 ********************************************************************/
 
-  int DLLEXPORT ENaddlink(char *id, int linkType, char *fromNode, char *toNode, int *index);
+  int DLLEXPORT ENaddlink(const char *id, int linkType, const char *fromNode,
+                const char *toNode, int *index);
 
   int DLLEXPORT ENdeletelink(int index, int actionCode);
 
-  int DLLEXPORT ENgetlinkindex(char *id, int *index);
+  int DLLEXPORT ENgetlinkindex(const char *id, int *index);
 
   int DLLEXPORT ENgetlinkid(int index, char *id);
 
-  int DLLEXPORT ENsetlinkid(int index, char *newid);
+  int DLLEXPORT ENsetlinkid(int index, const char *newid);
 
   int DLLEXPORT ENgetlinktype(int index, int *linkType);
 
@@ -280,16 +298,20 @@ extern "C" {
 
   int DLLEXPORT ENgetlinkvalue(int index, int property, EN_API_FLOAT_TYPE *value);
 
+  int DLLEXPORT ENgetlinkvalues(int property, EN_API_FLOAT_TYPE *value);
+
   int DLLEXPORT ENsetlinkvalue(int index, int property, EN_API_FLOAT_TYPE value);
 
   int DLLEXPORT ENsetpipedata(int index, EN_API_FLOAT_TYPE length,
                 EN_API_FLOAT_TYPE diam, EN_API_FLOAT_TYPE rough,
                 EN_API_FLOAT_TYPE mloss);
-                
+
   int DLLEXPORT ENgetvertexcount(int index, int *count);
-  
+
   int DLLEXPORT ENgetvertex(int index, int vertex, double *x, double *y);
-  
+
+  int DLLEXPORT ENsetvertex(int index, int vertex, double x, double y);
+
   int DLLEXPORT ENsetvertices(int index, double *x, double *y, int count);
 
 /********************************************************************
@@ -310,15 +332,15 @@ extern "C" {
 
 ********************************************************************/
 
-  int DLLEXPORT ENaddpattern(char *id);
+  int DLLEXPORT ENaddpattern(const char *id);
 
   int DLLEXPORT ENdeletepattern(int index);
 
-  int DLLEXPORT ENgetpatternindex(char *id, int *index);
+  int DLLEXPORT ENgetpatternindex(const char *id, int *index);
 
   int DLLEXPORT ENgetpatternid(int index, char *id);
 
-  int DLLEXPORT ENsetpatternid(int index, char *id);
+  int DLLEXPORT ENsetpatternid(int index, const char *id);
 
   int DLLEXPORT ENgetpatternlen(int index, int *len);
 
@@ -330,26 +352,30 @@ extern "C" {
 
   int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *values, int len);
 
+  int DLLEXPORT ENloadpatternfile(const char *filename, const char *id);
+
 /********************************************************************
 
     Data Curve Functions
 
 ********************************************************************/
 
-  int DLLEXPORT ENaddcurve(char *id);
+  int DLLEXPORT ENaddcurve(const char *id);
 
   int DLLEXPORT ENdeletecurve(int index);
 
-  int DLLEXPORT ENgetcurveindex(char *id, int *index);
+  int DLLEXPORT ENgetcurveindex(const char *id, int *index);
 
   int DLLEXPORT ENgetcurveid(int index, char *id);
 
-  int DLLEXPORT ENsetcurveid(int index, char *id);
+  int DLLEXPORT ENsetcurveid(int index, const char *id);
 
   int DLLEXPORT ENgetcurvelen(int index, int *len);
 
   int DLLEXPORT ENgetcurvetype(int index, int *type);
 
+  int DLLEXPORT ENsetcurvetype(int index, int type);
+
   int DLLEXPORT ENgetcurvevalue(int curveIndex, int pointIndex,
                 EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y);
 
@@ -379,6 +405,9 @@ extern "C" {
   int DLLEXPORT ENsetcontrol(int index, int type, int linkIndex,
                 EN_API_FLOAT_TYPE setting, int nodeIndex, EN_API_FLOAT_TYPE level);
 
+  int DLLEXPORT ENgetcontrolenabled(int index, int *out_enabled);
+
+  int DLLEXPORT ENsetcontrolenabled(int index, int enabled);
 
 /********************************************************************
 
@@ -421,9 +450,13 @@ extern "C" {
 
   int DLLEXPORT ENsetelseaction(int ruleIndex, int actionIndex, int linkIndex,
                 int status, EN_API_FLOAT_TYPE setting);
-  
+
   int DLLEXPORT ENsetrulepriority(int index, EN_API_FLOAT_TYPE priority);
 
+  int DLLEXPORT ENgetruleenabled(int index, int *out_enabled);
+
+  int DLLEXPORT ENsetruleenabled(int index, int enabled);
+
   #if defined(__cplusplus)
   }
   #endif