From 2a75f1e83cb4eaed559dbcbefa23e8ba30928321 Mon Sep 17 00:00:00 2001 From: 0tkl Date: Wed, 13 Aug 2025 15:51:15 +0800 Subject: [PATCH 1/4] fix a typo --- doc/toolkit-usage.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/toolkit-usage.dox b/doc/toolkit-usage.dox index ca31542..4d23198 100644 --- a/doc/toolkit-usage.dox +++ b/doc/toolkit-usage.dox @@ -70,7 +70,7 @@ EN_addlink(ph, "P1", EN_PIPE, "J1", "J2", &index); // additional function calls to complete building the network \endcode -See the @ref Example2 for a more complete example. The labels used to name objects cannot contain spaces, semi-colons, or double quotes nor exceed @ref EN_SizeLimits "EN_MAXID" characters in length. While adding objects their properties can be set as described in the next section. Attemtping to change a network's structure by adding or deleting nodes and links while the Toolkit's hydraulic or water quality solvers are open will result in an error condition. +See the @ref Example2 for a more complete example. The labels used to name objects cannot contain spaces, semi-colons, or double quotes nor exceed @ref EN_SizeLimits "EN_MAXID" characters in length. While adding objects their properties can be set as described in the next section. Attempting to change a network's structure by adding or deleting nodes and links while the Toolkit's hydraulic or water quality solvers are open will result in an error condition. @section Properties Setting Object Properties From 30e644330cfcd31c9a1af513ddda82c856b2b86f Mon Sep 17 00:00:00 2001 From: 0tkl Date: Wed, 13 Aug 2025 15:55:04 +0800 Subject: [PATCH 2/4] add a missing line break after list --- doc/toolkit-usage.dox | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/toolkit-usage.dox b/doc/toolkit-usage.dox index 4d23198..1bfd381 100644 --- a/doc/toolkit-usage.dox +++ b/doc/toolkit-usage.dox @@ -194,6 +194,7 @@ In addition, the following quantities related to a node's outflow can be retriev -# EN_DEMANDDEFICIT (difference between consumer demand requested and delivered) -# EN_EMITTERFLOW (outflow through a node's emitter) -# EN_LEAKAGEFLOW (outflow due to leakage in a node's connecting pipes) + where `EN_DEMAND` is the sum of `EN_DEMANDFLOW`, `EN_EMITTERFLOW`, and `EN_LEAKAGEFLOW`. The following code shows how to retrieve the pressure at each node of a network after each time step of a hydraulic analysis (`writetofile` is a user-defined function that will write a record to a file): From aabe60a6aecfb1dd7f227b74cd0011d838fe8ee8 Mon Sep 17 00:00:00 2001 From: 0tkl Date: Wed, 13 Aug 2025 15:56:03 +0800 Subject: [PATCH 3/4] add missing parentheses --- doc/toolkit-usage.dox | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/toolkit-usage.dox b/doc/toolkit-usage.dox index 1bfd381..b842e36 100644 --- a/doc/toolkit-usage.dox +++ b/doc/toolkit-usage.dox @@ -179,14 +179,14 @@ int runConcurrentQuality(EN_Project ph) The @ref EN_getnodevalue and @ref EN_getlinkvalue functions can also be used to retrieve the results of hydraulic and water quality simulations. The computed parameters (and their Toolkit codes) that can be retrieved are as follows: |For Nodes: | For Links: | |------------------------------------ | ----------------------------------------- | -|\b EN_DEMAND (total node outflow |\b EN_FLOW (flow rate) | +|\b EN_DEMAND (total node outflow) |\b EN_FLOW (flow rate) | |\b EN_HEAD (hydraulic head) |\b EN_VELOCITY (flow velocity) | |\b EN_PRESSURE (pressure) |\b EN_HEADLOSS (head loss) | |\b EN_TANKLEVEL (tank water level) |\b EN_STATUS (link status) | |\b EN_TANKVOLUME (tank water volume) |\b EN_SETTING (pump speed or valve setting)| |\b EN_QUALITY (water quality) |\b EN_ENERGY (pump energy usage) | |\b EN_SOURCEMASS (source mass inflow)|\b EN_PUMP_EFFIC (pump efficiency) | -| |\b EN_LINK_LEAKAGE (pipe leakage flow rate | +| |\b EN_LINK_LEAKAGE (pipe leakage flow rate)| In addition, the following quantities related to a node's outflow can be retrieved: -# EN_FULLDEMAND (consumer demand requested) From e62f69c939bbcd8f52d321b832ee04aeffd16e78 Mon Sep 17 00:00:00 2001 From: 0tkl Date: Wed, 13 Aug 2025 16:03:13 +0800 Subject: [PATCH 4/4] Document EN_LINKQUAL and EN_PUMP_STATE enums --- doc/toolkit-usage.dox | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/toolkit-usage.dox b/doc/toolkit-usage.dox index b842e36..e34c325 100644 --- a/doc/toolkit-usage.dox +++ b/doc/toolkit-usage.dox @@ -185,7 +185,9 @@ The @ref EN_getnodevalue and @ref EN_getlinkvalue functions can also be used to |\b EN_TANKLEVEL (tank water level) |\b EN_STATUS (link status) | |\b EN_TANKVOLUME (tank water volume) |\b EN_SETTING (pump speed or valve setting)| |\b EN_QUALITY (water quality) |\b EN_ENERGY (pump energy usage) | -|\b EN_SOURCEMASS (source mass inflow)|\b EN_PUMP_EFFIC (pump efficiency) | +|\b EN_SOURCEMASS (source mass inflow)|\b EN_LINKQUAL (water quality) | +| |\b EN_PUMP_STATE (pump state) | +| |\b EN_PUMP_EFFIC (pump efficiency) | | |\b EN_LINK_LEAKAGE (pipe leakage flow rate)| In addition, the following quantities related to a node's outflow can be retrieved: