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

epyt_flow/EPANET/EPANET/SRC_engines/include/epanet2_enums.h

@@ -3,13 +3,13 @@
 /*
  ******************************************************************************
  Project:      OWA EPANET
- Version:      2.2
+ Version:      2.3
  Module:       epanet2_enums.h
  Description:  enumerations of symbolic constants used by the API functions
  Authors:      see AUTHORS
  Copyright:    see AUTHORS
  License:      see LICENSE
- Last Updated: 11/06/2019
+ Last Updated: 04/23/2025
  ******************************************************************************
 */
 
@@ -17,13 +17,11 @@
 #ifndef EPANET2_ENUMS_H
 #define EPANET2_ENUMS_H
 
-
 // --- Define the EPANET toolkit constants
-
-/// Size Limts
-/**
-Limits on the size of character arrays used to store ID names
-and text messages.
+/// Character array size limits
+/*! \enum EN_SizeLimits
+ * Limits on the size of character arrays used to store ID names
+ * and text messages.
 */
 typedef enum {
   EN_MAXID   = 31,     //!< Max. # characters in ID name
@@ -31,11 +29,11 @@ typedef enum {
 } EN_SizeLimits;
 
 /// Node properties
-/**
-These node properties are used with @ref EN_getnodevalue and @ref EN_setnodevalue.
-Those marked as read only are computed values that can only be retrieved.
+/*! \enum EN_NodeProperty
+ * These node properties are used with @ref EN_getnodevalue and @ref EN_setnodevalue.
+ * Those marked as read only are computed values that can only be retrieved.
 */
-typedef enum {
+typedef enum {    
   EN_ELEVATION    = 0, //!< Elevation
   EN_BASEDEMAND   = 1, //!< Primary demand baseline value
   EN_PATTERN      = 2, //!< Primary demand time pattern index
@@ -62,8 +60,13 @@ typedef enum {
   EN_TANK_KBULK   = 23, //!< Tank bulk decay coefficient
   EN_TANKVOLUME   = 24, //!< Current computed tank volume (read only)
   EN_MAXVOLUME    = 25, //!< Tank maximum volume (read only)
-  EN_CANOVERFLOW  = 26, //!< Tank can overflow (= 1) or not (= 0)
-  EN_DEMANDDEFICIT = 27 //!< Amount that full demand is reduced under PDA (read only)
+  EN_CANOVERFLOW  = 26, //!< `EN_TRUE` (= 1) if the Tank can overflow, `EN_FALSE` (= 0) if it cannot
+  EN_DEMANDDEFICIT = 27,//!< Amount that full demand is reduced under PDA (read only)
+  EN_NODE_INCONTROL = 28, //!< `EN_TRUE` (= 1) if the node appears in any control, `EN_FALSE` (= 0) if not
+  EN_EMITTERFLOW    = 29, //!< Current emitter flow (read only)
+  EN_LEAKAGEFLOW    = 30, //!< Current leakage flow (read only)
+  EN_DEMANDFLOW     = 31, //!< Current consumer demand delivered (read only)
+  EN_FULLDEMAND     = 32  //!< Current consumer demand requested (read only)
 } EN_NodeProperty;
 
 /// Link properties
@@ -78,7 +81,7 @@ typedef enum {
   EN_MINORLOSS    = 3,  //!< Pipe/valve minor loss coefficient
   EN_INITSTATUS   = 4,  //!< Initial status (see @ref EN_LinkStatusType)
   EN_INITSETTING  = 5,  //!< Initial pump speed or valve setting
-  EN_KBULK        = 6,  //!< Bulk chemical reaction coefficient
+  EN_KBULK        = 6,  //!< Bulk flow chemical reaction coefficient
   EN_KWALL        = 7,  //!< Pipe wall chemical reaction coefficient
   EN_FLOW         = 8,  //!< Current computed flow rate (read only)
   EN_VELOCITY     = 9,  //!< Current computed flow velocity (read only)
@@ -94,7 +97,14 @@ typedef enum {
   EN_PUMP_HCURVE  = 19, //!< Pump head v. flow curve index
   EN_PUMP_ECURVE  = 20, //!< Pump efficiency v. flow curve index
   EN_PUMP_ECOST   = 21, //!< Pump average energy price
-  EN_PUMP_EPAT    = 22  //!< Pump energy price time pattern index
+  EN_PUMP_EPAT    = 22, //!< Pump energy price time pattern index
+  EN_LINK_INCONTROL = 23,  //!< Is present in any simple or rule-based control (= 1) or not (= 0)
+  EN_GPV_CURVE    = 24, //!< GPV head loss v. flow curve index
+  EN_PCV_CURVE    = 25, //!< PCV characteristic curve index
+  EN_LEAK_AREA    = 26, //!< Pipe leak area (sq mm per 100 length units)
+  EN_LEAK_EXPAN   = 27, //!< Leak expansion rate (sq mm per unit of pressure head)
+  EN_LINK_LEAKAGE = 28, //!< Current leakage rate (read only)
+  EN_VALVE_TYPE   = 29  //!< Type of valve (see @ref EN_LinkType)
 } EN_LinkProperty;
 
 /// Time parameters
@@ -122,6 +132,18 @@ typedef enum {
   EN_NEXTEVENTTANK = 15  //!< Index of tank with shortest time to become empty or full (read only)
 } EN_TimeParameter;
 
+/// Time step events
+/**
+These are the types of events that can cause a new time step to be taken.
+**/
+typedef enum {
+  EN_STEP_REPORT       = 0,  //!< A reporting time step has ended 
+  EN_STEP_HYD          = 1,  //!< A hydraulic time step has ended
+  EN_STEP_WQ           = 2,  //!< A water quality time step has ended
+  EN_STEP_TANKEVENT    = 3,  //!< A tank has become empty or full
+  EN_STEP_CONTROLEVENT = 4   //!< A link control needs to be activated
+} EN_TimestepEvent;
+
 /// Analysis convergence statistics
 /**
 These statistics report the convergence criteria for the most current hydraulic analysis
@@ -135,7 +157,8 @@ typedef enum {
   EN_MAXFLOWCHANGE   = 3, //!< Largest flow change in links
   EN_MASSBALANCE     = 4, //!< Cumulative water quality mass balance ratio
   EN_DEFICIENTNODES  = 5, //!< Number of pressure deficient nodes
-  EN_DEMANDREDUCTION = 6  //!< % demand reduction at pressure deficient nodes
+  EN_DEMANDREDUCTION = 6, //!< % demand reduction at pressure deficient nodes
+  EN_LEAKAGELOSS     = 7  //!< % flow lost to system leakage
 } EN_AnalysisStatistic;
 
 /// Types of network objects
@@ -188,25 +211,26 @@ typedef enum {
   EN_PBV          = 5,  //!< Pressure breaker valve
   EN_FCV          = 6,  //!< Flow control valve
   EN_TCV          = 7,  //!< Throttle control valve
-  EN_GPV          = 8   //!< General purpose valve
+  EN_GPV          = 8,  //!< General purpose valve
+  EN_PCV          = 9   //!< Positional control valve
 } EN_LinkType;
 
 /// Link status
 /**
 One of these values is returned when @ref EN_getlinkvalue is used to retrieve a link's
-initial status ( \b EN_INITSTATUS ) or its current status ( \b EN_STATUS ). These options are
+initial status (`EN_INITSTATUS`) or its current status (`EN_STATUS`). These options are
 also used with @ref EN_setlinkvalue to set values for these same properties.
 */
 typedef enum {
-  EN_CLOSED       = 0,
-  EN_OPEN         = 1
+  EN_CLOSED       = 0,  //!< Link is closed and cannot convey any flow
+  EN_OPEN         = 1   //!< Link is open and is able to convey flow
 } EN_LinkStatusType;
 
 /// Pump states
 /**
 One of these codes is returned when @ref EN_getlinkvalue is used to retrieve a pump's
-current operating state ( \b EN_PUMP_STATE ). \b EN_PUMP_XHEAD indicates that the pump has been
-shut down because it is being asked to deliver more than its shutoff head. \b EN_PUMP_XFLOW
+current operating state (`EN_PUMP_STATE`). `EN_PUMP_XHEAD` indicates that the pump has been
+shut down because it is being asked to deliver more than its shutoff head. `EN_PUMP_XFLOW`
 indicates that the pump is being asked to deliver more than its maximum flow.
 */
 typedef enum {
@@ -231,7 +255,7 @@ typedef enum {
 /// Water quality source types
 /**
 These are the different types of external water quality sources that can be assigned
-to a node's \b EN_SOURCETYPE property as used by @ref EN_getnodevalue and @ref EN_setnodevalue.
+to a node's `EN_SOURCETYPE` property as used by @ref EN_getnodevalue and @ref EN_setnodevalue.
 */
 typedef enum {
   EN_CONCEN      = 0,   //!< Sets the concentration of external inflow entering a node
@@ -242,9 +266,9 @@ typedef enum {
 
 /// Head loss formulas
 /**
-The available choices for the \b EN_HEADLOSSFORM option in @ref EN_getoption and
+The available choices for the `EN_HEADLOSSFORM` option in @ref EN_getoption and
 @ref EN_setoption. They are also used for the head loss type argument in @ref EN_init.
-Each head loss formula uses a different type of roughness coefficient ( \b EN_ROUGHNESS )
+Each head loss formula uses a different type of roughness coefficient (`EN_ROUGHNESS`)
 that can be set with @ref EN_setlinkvalue.
 */
 typedef enum {
@@ -257,7 +281,7 @@ typedef enum {
 /**
 These choices for flow units are used with @ref EN_getflowunits and @ref EN_setflowunits.
 They are also used for the flow units type argument in @ref EN_init. If flow units are
-expressed in US Customary units ( \b EN_CFS through \b EN_AFD ) then all other quantities are
+expressed in US Customary units (`EN_CFS` through `EN_AFD`) then all other quantities are
 in US Customary units. Otherwise they are in metric units.
 */
 typedef enum {
@@ -270,9 +294,23 @@ typedef enum {
   EN_LPM         = 6,   //!< Liters per minute
   EN_MLD         = 7,   //!< Million liters per day
   EN_CMH         = 8,   //!< Cubic meters per hour
-  EN_CMD         = 9    //!< Cubic meters per day
+  EN_CMD         = 9,   //!< Cubic meters per day
+  EN_CMS         = 10   //!< Cubic meters per second
 } EN_FlowUnits;
 
+/// Pressure units
+/**
+The available choices for pressure units for the `EN_PRESS_UNITS` option in @ref EN_getoption
+and @ref EN_setoption. 
+*/
+typedef enum {
+  EN_PSI          = 0,  //!< Pounds per square inch
+  EN_KPA          = 1,  //!< Kilopascals
+  EN_METERS       = 2,   //!< Meters
+  EN_BAR          = 3,   //!< Bar
+  EN_FEET         = 4    //!< Feet
+} EN_PressUnits;
+
 /// Demand models
 /**
 These choices for modeling consumer demands are used with @ref EN_getdemandmodel
@@ -317,7 +355,11 @@ typedef enum {
   EN_BULKORDER      = 19, //!< Bulk water reaction order for pipes
   EN_WALLORDER      = 20, //!< Wall reaction order for pipes (either 0 or 1)
   EN_TANKORDER      = 21, //!< Bulk water reaction order for tanks
-  EN_CONCENLIMIT    = 22  //!< Limiting concentration for growth reactions
+  EN_CONCENLIMIT    = 22, //!< Limiting concentration for growth reactions
+  EN_DEMANDPATTERN  = 23, //!< Name of default demand pattern
+  EN_EMITBACKFLOW   = 24, //!< `EN_TRUE` (= 1) if emitters can backflow, `EN_FALSE` (= 0) if not
+  EN_PRESS_UNITS    = 25, //!< Pressure units (see @ref EN_PressUnits)
+  EN_STATUS_REPORT  = 26  //!< Type of status report to produce (see @ref EN_StatusReport)
 } EN_Option;
 
 /// Simple control types
@@ -336,9 +378,10 @@ typedef enum {
 /// Reporting statistic choices
 /**
 These options determine what kind of statistical post-processing should be done on
-the time series of simulation results generated before they are reported using
-@ref EN_report. An option can be chosen by using \b STATISTIC _option_ as the argument
-to @ref EN_setreport.
+the time series of simulation results before they are reported using @ref EN_report
+or saved to the project's binary output file. These options are used in the
+@ref EN_gettimeparam and @ref EN_settimeparam functions when `EN_STATISTIC` is the
+time parameter being set or retrieved.
 */
 typedef enum {
   EN_SERIES      = 0,   //!< Report all time series points
@@ -351,7 +394,7 @@ typedef enum {
 /// Tank mixing models
 /**
 These are the different types of models that describe water quality mixing in storage tanks.
-The choice of model is accessed with the \b EN_MIXMODEL property of a Tank node using
+The choice of model is accessed with the `EN_MIXMODEL` property of a Tank node using
 @ref EN_getnodevalue and @ref EN_setnodevalue.
 */
 typedef enum {
@@ -393,7 +436,8 @@ typedef enum {
   EN_PUMP_CURVE    = 1,   //!< Pump head v. flow curve
   EN_EFFIC_CURVE   = 2,   //!< Pump efficiency v. flow curve
   EN_HLOSS_CURVE   = 3,   //!< Valve head loss v. flow curve
-  EN_GENERIC_CURVE = 4    //!< Generic curve
+  EN_GENERIC_CURVE = 4,   //!< Generic curve
+  EN_VALVE_CURVE   = 5    //!< % of fully open flow v. % open
 } EN_CurveType;
 
 /// Deletion action codes
@@ -403,14 +447,15 @@ should be taken if the node or link being deleted appears in any simple or rule-
 controls or if a deleted node has any links connected to it.
 */
 typedef enum {
-  EN_UNCONDITIONAL = 0, //!< Delete all controls and connecing links
+  EN_UNCONDITIONAL = 0, //!< Delete all controls and connecting links
   EN_CONDITIONAL   = 1  //!< Cancel object deletion if it appears in controls or has connecting links
 } EN_ActionCodeType;
 
 /// Status reporting levels
 /**
 These choices specify the level of status reporting written to a project's report
-file during a hydraulic analysis. The level is set using the @ref EN_setstatusreport function.
+file during a hydraulic analysis. The level is set using the @ref EN_setstatusreport
+or the @ref EN_setoption functions.
 */
 typedef enum {
   EN_NO_REPORT = 0,     //!< No status reporting
@@ -463,6 +508,11 @@ typedef enum {
   EN_R_IS_ACTIVE = 3    //!< Control valve is active
 } EN_RuleStatus;
 
-#define EN_MISSING -1.E10  //!< Missing value indicator
+#define EN_MISSING    -1.E10  //!< Missing value indicator
+#define EN_SET_CLOSED -1.E10  //!< Link set closed indicator
+#define EN_SET_OPEN    1.E10  //!< Link set open indicator
+
+#define EN_FALSE 0  //!< boolean false
+#define EN_TRUE 1   //!< boolean true
 
 #endif //EPANET2_ENUMS_H