measur-tools-suite 1.0.14-rc.38 → 1.0.14-rc.40

package/bin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "measur-tools-suite",
-  "version": "1.0.14-rc.38",
+  "version": "1.0.14-rc.40",
   "engines": {
     "node": "20.19.4",
     "npm": "10.8.2"

package/docs/dependencies/mathjax-config.js

@@ -48,6 +48,8 @@ window.MathJax = {
         ready() {
             MathJax.startup.defaultReady();
             MathJax.tex2mml(String.raw`
+                \DeclareSIUnit{\abs}{abs}
+                \DeclareSIUnit{\dollar}{$}
                 \DeclareSIUnit{\britishThermalUnit}{Btu}
                 \DeclareSIUnit{\btu}{Btu}
                 \DeclareSIUnit{\MMBtu}{MMBtu}
@@ -85,11 +87,14 @@ window.MathJax = {
                 \DeclareSIUnit{\standardCubicFeet}{scf}
                 \DeclareSIUnit{\scf}{scf}
                 \DeclareSIUnit{\cubicFoot}{ft^3}
+                \DeclareSIUnit{\normalCubicMeter}{Nm^3}
+                \DeclareSIUnit{\NmCubed}{Nm^3}
                 \DeclareSIUnit{\inchWaterColumn}{in\,WC}
                 \DeclareSIUnit{\kilowatt}{kW}
                 \DeclareSIUnit{\atm}{atm}
                 \DeclareSIUnit{\lbmol}{lbmol}
                 \DeclareSIUnit{\year}{yr}
+                \DeclareSIUnit{\ton}{ton}
             `);
         }
     },

package/docs/dox-content/calculators/processHeat/water_heating_using_exhaust_calculator.dox

@@ -0,0 +1,115 @@
+/**
+ * @defgroup water_heating_using_exhaust_calculator Water Heating Using Exhaust Calculator
+ * @ingroup process_heat_calculators
+ * @brief Calculates energy savings from using exhaust gas (waste heat) to provide energy for an absorption chiller in place of a compressor.
+ * @details This calculator estimates the benefit of using waste heat from exhaust gas for water heating and chiller operation. The calculation uses available heat fraction, heat input, heat exchanger efficiency, chiller temperatures, and performance coefficients. The method is based on standard industrial practice for waste heat recovery in process heating and cooling systems.
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Recovered Heat** - Calculate heat recovered from exhaust gas through the heat exchanger
+ * 2. **Hot Water Flow** - Determine hot water flow rate based on temperature difference
+ * 3. **Tons of Refrigeration** - Calculate refrigeration capacity using chiller COP
+ * 4. **Chiller Capacity** - Compute effective chiller capacity accounting for efficiency
+ * 5. **Electrical Energy** - Determine equivalent electrical energy saved from compressor operation
+ *
+ * Relevant formulas and symbol definitions are documented below.
+ *
+ * @heading{Recovered Heat}
+ * @copydoc water_heating_using_exhaust_recovered_heat_formula
+ *
+ * @heading{Hot Water Flow}
+ * @copydoc water_heating_using_exhaust_hot_water_flow_formula
+ *
+ * @heading{Tons of Refrigeration}
+ * @copydoc water_heating_using_exhaust_tons_refrigeration_formula
+ *
+ * @heading{Chiller Capacity}
+ * @copydoc water_heating_using_exhaust_chiller_capacity_formula
+ *
+ * @heading{Electrical Energy}
+ * @copydoc water_heating_using_exhaust_electrical_energy_formula
+ */
+
+/**
+ * @defgroup water_heating_using_exhaust_recovered_heat_formula Recovered Heat Formula
+ * @ingroup water_heating_using_exhaust_calculator
+ * @brief Heat recovered from exhaust gas through the heat exchanger.
+ * @details The recovered heat is calculated by multiplying the unavailable heat (waste heat) by the heat input and heat exchanger efficiency. The unavailable heat is the complement of the available heat fraction.
+ *
+ * @formula{water-heating-exhaust-recovered-heat; Q_{rec} = (1 - AH) \cdot Q_{in} \cdot \eta_{hx}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{Q_{rec}; Recovered heat; \btu\per\hour}
+ * @symrow{AH; Available heat fraction; \unitless}
+ * @symrow{Q_{in}; Heat input; \btu\per\hour}
+ * @symrow{\eta_{hx}; Heat exchanger efficiency; \unitless}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_exhaust_hot_water_flow_formula Hot Water Flow Formula
+ * @ingroup water_heating_using_exhaust_calculator
+ * @brief Hot water flow rate based on recovered heat and temperature difference.
+ * @details The hot water flow rate is calculated by dividing the recovered heat by the product of temperature difference and water density. Water density is @ref physics::us::kWaterDensity (8.335 lb/gal).
+ *
+ * @formula{water-heating-exhaust-hot-water-flow; \dot{m}_{water} = \frac{Q_{rec}}{\Delta T \cdot \rho_{water}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{m}_{water}; Hot water flow rate; \gallon\per\hour}
+ * @symrow{Q_{rec}; Recovered heat; \btu\per\hour}
+ * @symrow{\Delta T; Temperature difference (chiller inlet - chiller outlet); \degreeFahrenheit}
+ * @symrow{\rho_{water}; Water density - see @ref physics::us::kWaterDensity; \pound\per\gallon}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_exhaust_tons_refrigeration_formula Tons of Refrigeration Formula
+ * @ingroup water_heating_using_exhaust_calculator
+ * @brief Refrigeration capacity using chiller coefficient of performance.
+ * @details The tons of refrigeration is calculated by multiplying the recovered heat by the chiller COP and dividing by the BTU per ton conversion factor. The conversion factor is @ref physics::conversions::kBtuPerTonRefrigeration (12,000 Btu/hr per Ton).
+ *
+ * @formula{water-heating-exhaust-tons-refrigeration; TR = \frac{Q_{rec} \cdot COP_{chiller}}{CF_{ton}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{TR; Tons of refrigeration; tons}
+ * @symrow{Q_{rec}; Recovered heat; \btu\per\hour}
+ * @symrow{COP_{chiller}; Coefficient of performance for chiller; \unitless}
+ * @symrow{CF_{ton}; Btu per ton conversion factor (12,000) - see @ref physics::conversions::kBtuPerTonRefrigeration; \btu\per\hour\per\ton}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_exhaust_chiller_capacity_formula Chiller Capacity Formula
+ * @ingroup water_heating_using_exhaust_calculator
+ * @brief Effective chiller capacity accounting for efficiency.
+ * @details The chiller capacity is calculated by multiplying the tons of refrigeration by the chiller efficiency. This represents the actual cooling capacity available after accounting for system inefficiencies.
+ *
+ * @formula{water-heating-exhaust-chiller-capacity; C_{chiller} = TR \cdot \eta_{chiller}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{C_{chiller}; Chiller capacity; tons}
+ * @symrow{TR; Tons of refrigeration; tons}
+ * @symrow{\eta_{chiller}; Chiller efficiency; \unitless}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_exhaust_electrical_energy_formula Electrical Energy Formula
+ * @ingroup water_heating_using_exhaust_calculator
+ * @brief Equivalent electrical energy saved from compressor operation.
+ * @details The electrical energy is calculated by multiplying the recovered heat, chiller COP, and chiller efficiency, then dividing by the compressor COP. This represents the electrical energy that would have been required to achieve the same cooling effect using a compressor-based system.
+ *
+ * @formula{water-heating-exhaust-electrical-energy; E_{elec} = \frac{Q_{rec} \cdot COP_{chiller} \cdot \eta_{chiller}}{COP_{comp}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{E_{elec}; Electrical energy; \btu\per\hour}
+ * @symrow{Q_{rec}; Recovered heat; \btu\per\hour}
+ * @symrow{COP_{chiller}; Coefficient of performance for chiller; \unitless}
+ * @symrow{\eta_{chiller}; Chiller efficiency; \unitless}
+ * @symrow{COP_{comp}; Coefficient of performance for compressor; \unitless}
+ * @endsymtable
+ */

package/docs/dox-content/calculators/steam/water_heating_using_flue_calculator.dox

@@ -0,0 +1,235 @@
+/**
+ * @defgroup water_heating_using_flue_calculator Water Heating Using Flue Calculator
+ * @ingroup steam_system_assessments
+ * @brief Calculates energy and cost savings from using flue gas (waste heat) to preheat boiler feedwater using a non-condensing heat exchanger.
+ * @details This calculator estimates the benefit of using waste heat from flue gas to preheat boiler feedwater through a heat exchanger. The calculation uses flue gas properties, steam system parameters, heat exchanger efficiency, and operating costs. The method is based on standard industrial practice for waste heat recovery in boiler systems utilizing the effectiveness-NTU heat exchanger method.
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Flue Gas Properties** - Determine flue gas mass flow, specific heat, and available heat from combustion
+ * 2. **Steam and Feedwater Properties** - Calculate steam and feedwater enthalpies and mass flows
+ * 3. **Heat Capacity Calculations** - Compute heat capacities for flue gas and feedwater streams
+ * 4. **Recovered Heat** - Calculate heat recovered using minimum heat capacity and heat exchanger efficiency
+ * 5. **Exit Temperatures** - Determine exit temperatures for both flue gas and feedwater streams
+ * 6. **Annual Energy and Cost Savings** - Calculate annual energy savings and cost benefits
+ *
+ * Relevant formulas and symbol definitions are documented below.
+ *
+ * @heading{Flue Gas Mass Flow}
+ * @copydoc water_heating_using_flue_gas_mass_flow_formula
+ *
+ * @heading{Steam Mass Flow}
+ * @copydoc water_heating_using_flue_steam_mass_flow_formula
+ *
+ * @heading{Feedwater Mass Flow}
+ * @copydoc water_heating_using_flue_feedwater_mass_flow_formula
+ *
+ * @heading{Flue Gas Heat Capacity}
+ * @copydoc water_heating_using_flue_gas_heat_capacity_formula
+ *
+ * @heading{Feedwater Heat Capacity}
+ * @copydoc water_heating_using_flue_feedwater_heat_capacity_formula
+ *
+ * @heading{Minimum Heat Capacity}
+ * @copydoc water_heating_using_flue_min_heat_capacity_formula
+ *
+ * @heading{Recovered Heat}
+ * @copydoc water_heating_using_flue_recovered_heat_formula
+ *
+ * @heading{Flue Gas Exit Temperature}
+ * @copydoc water_heating_using_flue_gas_exit_temp_formula
+ *
+ * @heading{Feedwater Exit Temperature}
+ * @copydoc water_heating_using_flue_feedwater_exit_temp_formula
+ *
+ * @heading{Annual Energy Savings}
+ * @copydoc water_heating_using_flue_annual_energy_savings_formula
+ *
+ * @heading{Annual Cost Savings}
+ * @copydoc water_heating_using_flue_annual_cost_savings_formula
+ */
+
+/**
+ * @defgroup water_heating_using_flue_gas_mass_flow_formula Flue Gas Mass Flow Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Flue gas mass flow rate based on boiler rating and fuel properties.
+ * @details The flue gas mass flow rate is calculated using the total generated flue gas (from gas composition and combustion analysis), boiler rating, and fuel higher heating value. The density conversion factor @ref physics::conversions::kLbPerFt3ToKgPerM3 (16.018463 kg/m³ per lb/ft³) is applied.
+ *
+ * @formula{water-heating-flue-gas-mass-flow; \dot{m}_{flue} = \rho_{conv} \cdot Q_{gen} \cdot R_{boiler} \cdot \frac{10^{6}}{HHV_{fuel}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{m}_{flue}; Flue gas mass flow rate; \kilogram\per\hour}
+ * @symrow{\rho_{conv}; Density conversion factor - see @ref physics::conversions::kLbPerFt3ToKgPerM3; \kilogram\per\meter\cubed\per\pound\per\foot\cubed}
+ * @symrow{Q_{gen}; Total generated flue gas from combustion; \pound\per\foot\cubed}
+ * @symrow{R_{boiler}; Boiler rating; \giga\joule\per\hour}
+ * @symrow{HHV_{fuel}; Fuel higher heating value; \kilo\joule\per\normalCubicMeter}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_steam_mass_flow_formula Steam Mass Flow Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Steam mass flow rate based on boiler rating and enthalpy difference.
+ * @details The steam mass flow rate is calculated using the boiler rating, available heat fraction, blowdown percentage, and the enthalpy difference between steam and feedwater. Available heat accounts for losses in the combustion process.
+ *
+ * @formula{water-heating-flue-steam-mass-flow; \dot{m}_{steam} = \frac{R_{boiler} \cdot 10^{6} \cdot AH \cdot (1 - BD)}{h_{steam} - h_{fw}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @symrow{R_{boiler}; Boiler rating; \giga\joule\per\hour}
+ * @symrow{AH; Available heat fraction; \unitless}
+ * @symrow{BD; Blowdown percentage (fraction); \unitless}
+ * @symrow{h_{steam}; Steam specific enthalpy; \kilo\joule\per\kilogram}
+ * @symrow{h_{fw}; Feedwater specific enthalpy; \kilo\joule\per\kilogram}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_feedwater_mass_flow_formula Feedwater Mass Flow Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Feedwater mass flow rate accounting for steam production and blowdown.
+ * @details The feedwater mass flow rate is calculated by adding the blowdown fraction to the steam mass flow. Blowdown is the water deliberately discharged from the boiler to control dissolved solids concentration.
+ *
+ * @formula{water-heating-flue-feedwater-mass-flow; \dot{m}_{fw} = \dot{m}_{steam} \cdot (1 + BD)}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{m}_{fw}; Feedwater mass flow rate; \kilogram\per\hour}
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @symrow{BD; Blowdown percentage (fraction); \unitless}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_gas_heat_capacity_formula Flue Gas Heat Capacity Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Heat capacity rate of the flue gas stream.
+ * @details The flue gas heat capacity rate is the product of the mass flow rate and specific heat. This represents the thermal capacity of the flue gas stream to transfer heat.
+ *
+ * @formula{water-heating-flue-gas-heat-capacity; \dot{C}_{flue} = C_{p,flue} \cdot \dot{m}_{flue}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{C}_{flue}; Flue gas heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @symrow{C_{p,flue}; Flue gas specific heat; \kilo\joule\per\kilogram\kelvin}
+ * @symrow{\dot{m}_{flue}; Flue gas mass flow rate; \kilogram\per\hour}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_feedwater_heat_capacity_formula Feedwater Heat Capacity Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Heat capacity rate of the feedwater stream.
+ * @details The feedwater heat capacity rate is the product of the mass flow rate and specific heat. The feedwater specific heat is calculated using an empirical polynomial fit in @ref gas_constants::specificHeatFeedwater.
+ *
+ * @formula{water-heating-flue-feedwater-heat-capacity; \dot{C}_{fw} = C_{p,fw} \cdot \dot{m}_{fw}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{C}_{fw}; Feedwater heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @symrow{C_{p,fw}; Feedwater specific heat; \kilo\joule\per\kilogram\kelvin}
+ * @symrow{\dot{m}_{fw}; Feedwater mass flow rate; \kilogram\per\hour}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_min_heat_capacity_formula Minimum Heat Capacity Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Minimum heat capacity rate between the two streams.
+ * @details The minimum heat capacity rate determines the maximum possible heat transfer in a heat exchanger. It is the smaller of the flue gas and feedwater heat capacity rates.
+ *
+ * @formula{water-heating-flue-min-heat-capacity; \dot{C}_{min} = \min(\dot{C}_{flue}, \dot{C}_{fw})}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{C}_{min}; Minimum heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @symrow{\dot{C}_{flue}; Flue gas heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @symrow{\dot{C}_{fw}; Feedwater heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_recovered_heat_formula Recovered Heat Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Heat recovered through the heat exchanger using effectiveness-NTU method.
+ * @details The recovered heat is calculated using the heat exchanger efficiency (effectiveness), minimum heat capacity rate, and temperature difference between the flue gas inlet and feedwater inlet. This represents the actual heat transferred from the flue gas to the feedwater.
+ *
+ * @formula{water-heating-flue-recovered-heat; Q_{rec} = \eta_{hx} \cdot \dot{C}_{min} \cdot (T_{flue,in} - T_{fw,in})}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{Q_{rec}; Recovered heat; \kilo\joule\per\hour}
+ * @symrow{\eta_{hx}; Heat exchanger efficiency (effectiveness); \unitless}
+ * @symrow{\dot{C}_{min}; Minimum heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @symrow{T_{flue,in}; Flue gas inlet temperature; \kelvin}
+ * @symrow{T_{fw,in}; Feedwater inlet temperature; \kelvin}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_gas_exit_temp_formula Flue Gas Exit Temperature Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Exit temperature of flue gas after heat exchanger.
+ * @details The flue gas exit temperature is calculated by subtracting the heat lost (recovered heat) divided by the flue gas heat capacity rate from the inlet temperature. This represents the cooled flue gas temperature leaving the heat exchanger.
+ *
+ * @formula{water-heating-flue-gas-exit-temp; T_{flue,out} = T_{flue,in} - \frac{Q_{rec}}{\dot{C}_{flue}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{T_{flue,out}; Flue gas exit temperature; \kelvin}
+ * @symrow{T_{flue,in}; Flue gas inlet temperature; \kelvin}
+ * @symrow{Q_{rec}; Recovered heat; \kilo\joule\per\hour}
+ * @symrow{\dot{C}_{flue}; Flue gas heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_feedwater_exit_temp_formula Feedwater Exit Temperature Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Exit temperature of feedwater after heat exchanger.
+ * @details The feedwater exit temperature is calculated by adding the heat gained (recovered heat) divided by the feedwater heat capacity rate to the inlet temperature. This represents the preheated feedwater temperature leaving the heat exchanger.
+ *
+ * @formula{water-heating-flue-feedwater-exit-temp; T_{fw,out} = T_{fw,in} + \frac{Q_{rec}}{\dot{C}_{fw}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{T_{fw,out}; Feedwater exit temperature; \kelvin}
+ * @symrow{T_{fw,in}; Feedwater inlet temperature; \kelvin}
+ * @symrow{Q_{rec}; Recovered heat; \kilo\joule\per\hour}
+ * @symrow{\dot{C}_{fw}; Feedwater heat capacity rate; \kilo\joule\per\hour\kelvin}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_annual_energy_savings_formula Annual Energy Savings Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Annual energy savings from using waste heat recovery.
+ * @details The annual energy savings is calculated by dividing the recovered heat by the available heat fraction and multiplying by the operating hours. This is then converted to GJ/yr by dividing by 1,000,000. The division by available heat fraction accounts for the boiler efficiency to determine the fuel energy savings.
+ *
+ * @formula{water-heating-flue-annual-energy-savings; E_{annual} = \frac{Q_{rec}}{AH} \cdot t_{op} \cdot \frac{1}{10^{6}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{E_{annual}; Annual energy savings; \giga\joule\per\year}
+ * @symrow{Q_{rec}; Recovered heat; \kilo\joule\per\hour}
+ * @symrow{AH; Available heat fraction; \unitless}
+ * @symrow{t_{op}; Operating hours; \hour\per\year}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_flue_annual_cost_savings_formula Annual Cost Savings Formula
+ * @ingroup water_heating_using_flue_calculator
+ * @brief Annual cost savings from using waste heat recovery.
+ * @details The annual cost savings is calculated by multiplying the annual energy savings by the fuel cost. This represents the monetary benefit of implementing the waste heat recovery system.
+ *
+ * @formula{water-heating-flue-annual-cost-savings; C_{annual} = E_{annual} \cdot C_{fuel}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{C_{annual}; Annual cost savings; \dollar\per\year}
+ * @symrow{E_{annual}; Annual energy savings; \giga\joule\per\year}
+ * @symrow{C_{fuel}; Fuel cost; \dollar\per\giga\joule}
+ * @endsymtable
+ */

package/docs/dox-content/calculators/steam/water_heating_using_steam_calculator.dox

@@ -0,0 +1,187 @@
+/**
+ * @defgroup water_heating_using_steam_calculator Water Heating Using Steam Calculator
+ * @ingroup steam_system_assessments
+ * @brief Calculates energy and water savings from using vent steam to heat water through a steam-to-liquid heat exchanger.
+ * @details This calculator estimates the benefit of using vent steam for water heating applications. The calculation uses steam and water properties, flow rates, pressures, temperatures, and system efficiencies. The method is based on standard industrial practice for waste heat recovery in steam systems.
+ *
+ * @image html assets/water-heating-diagram.png "Water Heating Using Steam Diagram"*
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Steam and Water Properties** - Determine steam enthalpies at inlet conditions and saturation properties, boiling point temperature, and makeup water enthalpy
+ * 2. **Outlet Water Temperature** - Calculate heated water outlet temperature based on energy balance
+ * 3. **Boiling Point Check** - Verify outlet water temperature is below safe boiling point threshold
+ * 4. **Bypass Steam Flow** - Calculate bypass steam flow if boiling point is exceeded (conditional)
+ * 5. **Heat Gain Rate** - Determine the rate of heat transfer to the water
+ * 6. **Energy Saved in Domestic Water Heater** - Calculate annual energy savings in the water heating system
+ * 7. **Energy Saved in Boiler** - Calculate annual energy savings from reduced boiler makeup water heating
+ * 8. **Water Saved** - Calculate annual water savings from condensate return
+ *
+ * Relevant formulas and symbol definitions are documented below.
+ *
+ * @heading{Outlet Water Temperature}
+ * @copydoc water_heating_using_steam_outlet_temp_formula
+ *
+ * @heading{Safe Boiling Point Temperature}
+ * @copydoc water_heating_using_steam_safe_boiling_point_formula
+ *
+ * @heading{Heat Gain Rate}
+ * @copydoc water_heating_using_steam_heat_gain_rate_formula
+ *
+ * @heading{Adjusted Heat Gain Rate (If Boiling Point Exceeded)}
+ * @copydoc water_heating_using_steam_adjusted_heat_gain_rate_formula
+ *
+ * @heading{Bypass Steam Flow}
+ * @copydoc water_heating_using_steam_bypass_steam_flow_formula
+ *
+ * @heading{Energy Saved in Domestic Water Heater}
+ * @copydoc water_heating_using_steam_energy_saved_dwh_formula
+ *
+ * @heading{Energy Saved in Boiler}
+ * @copydoc water_heating_using_steam_energy_saved_boiler_formula
+ *
+ * @heading{Water Saved}
+ * @copydoc water_heating_using_steam_water_saved_formula
+ */
+
+/**
+ * @defgroup water_heating_using_steam_outlet_temp_formula Outlet Water Temperature Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Outlet water temperature based on energy balance between steam and water.
+ * @details The outlet water temperature is calculated by adding the temperature rise to the inlet water temperature. The temperature rise is determined by the energy transferred from the condensing steam (enthalpy difference) divided by the heat capacity of the water. Water specific heat is @ref physics::si::kSpecificHeatWater (4.1796 kJ/(kg·K)).
+ *
+ * @formula{water-heating-steam-outlet-temp; T_{w,out} = T_{w,in} + \frac{(h_{s,in} - h_{s,out}) \cdot \dot{m}_{steam}}{C_{p,w} \cdot 1000 \cdot \dot{V}_{water}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{T_{w,out}; Outlet water temperature; \kelvin}
+ * @symrow{T_{w,in}; Inlet water temperature; \kelvin}
+ * @symrow{h_{s,in}; Inlet steam specific enthalpy (saturated vapor); \kilo\joule\per\kilogram}
+ * @symrow{h_{s,out}; Outlet steam specific enthalpy (saturated liquid/condensate); \kilo\joule\per\kilogram}
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @symrow{C_{p,w}; Water specific heat - see @ref physics::si::kSpecificHeatWater; \kilo\joule\per\kilogram\kelvin}
+ * @symrow{\dot{V}_{water}; Water volumetric flow rate; \meter\cubed\per\hour}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_safe_boiling_point_formula Safe Boiling Point Temperature Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Safe operating temperature threshold to prevent boiling.
+ * @details The safe boiling point temperature is calculated as 96.328% of the saturation temperature at the outlet water pressure. This safety margin prevents the outlet water from reaching the boiling point, which could cause operational issues in the heat exchanger. The saturation temperature is determined from steam tables based on the outlet water pressure.
+ *
+ * @formula{water-heating-steam-safe-boiling-point; T_{bp,safe} = 0.96328 \cdot T_{sat}(P_{w,out})}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{T_{bp,safe}; Safe boiling point temperature; \kelvin}
+ * @symrow{T_{sat}; Saturation temperature at outlet pressure; \kelvin}
+ * @symrow{P_{w,out}; Outlet water pressure; \mega\pascal\abs}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_heat_gain_rate_formula Heat Gain Rate Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Rate of heat transfer from steam to water (normal operation).
+ * @details The heat gain rate is calculated as the product of the steam mass flow rate and the enthalpy difference between inlet steam (saturated vapor) and outlet condensate (saturated liquid). This represents the latent heat of condensation transferred to the water. This formula is used when the outlet water temperature is below the safe boiling point.
+ *
+ * @formula{water-heating-steam-heat-gain-rate; \dot{Q}_{gain} = (h_{s,in} - h_{s,out}) \cdot \dot{m}_{steam}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{Q}_{gain}; Heat gain rate; \kilo\joule\per\hour}
+ * @symrow{h_{s,in}; Inlet steam specific enthalpy (saturated vapor); \kilo\joule\per\kilogram}
+ * @symrow{h_{s,out}; Outlet steam specific enthalpy (saturated liquid/condensate); \kilo\joule\per\kilogram}
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_adjusted_heat_gain_rate_formula Adjusted Heat Gain Rate Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Rate of heat transfer when boiling point is exceeded.
+ * @details If the calculated outlet water temperature exceeds the safe boiling point, the heat gain rate is recalculated based on the temperature rise limited to the safe boiling point. The adjusted heat gain rate uses the water heat capacity, temperature difference, and volumetric flow rate. The factor of 1000 converts the water density from kg/m³ to proper units.
+ *
+ * @formula{water-heating-steam-adjusted-heat-gain-rate; \dot{Q}_{gain,adj} = 1000 \cdot C_{p,w} \cdot (T_{bp,safe} - T_{w,in}) \cdot \dot{V}_{water}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{Q}_{gain,adj}; Adjusted heat gain rate; \kilo\joule\per\hour}
+ * @symrow{C_{p,w}; Water specific heat - see @ref physics::si::kSpecificHeatWater; \kilo\joule\per\kilogram\kelvin}
+ * @symrow{T_{bp,safe}; Safe boiling point temperature; \kelvin}
+ * @symrow{T_{w,in}; Inlet water temperature; \kelvin}
+ * @symrow{\dot{V}_{water}; Water volumetric flow rate; \meter\cubed\per\hour}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_bypass_steam_flow_formula Bypass Steam Flow Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Excess steam flow that must be bypassed to prevent boiling.
+ * @details When the outlet water temperature would exceed the safe boiling point, some steam must be bypassed around the heat exchanger to limit the heat transfer. The bypass steam flow is calculated as the difference between the total steam flow and the steam flow required to achieve the safe boiling point temperature. This is only calculated when the boiling point warning flag is triggered.
+ *
+ * @formula{water-heating-steam-bypass-steam-flow; \dot{m}_{bypass} = \dot{m}_{steam} - \frac{\dot{Q}_{gain,adj}}{h_{s,in} - h_{s,out}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{\dot{m}_{bypass}; Bypass steam flow; \kilogram\per\hour}
+ * @symrow{\dot{m}_{steam}; Total steam mass flow rate; \kilogram\per\hour}
+ * @symrow{\dot{Q}_{gain,adj}; Adjusted heat gain rate; \kilo\joule\per\hour}
+ * @symrow{h_{s,in}; Inlet steam specific enthalpy (saturated vapor); \kilo\joule\per\kilogram}
+ * @symrow{h_{s,out}; Outlet steam specific enthalpy (saturated liquid/condensate); \kilo\joule\per\kilogram}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_energy_saved_dwh_formula Energy Saved in Domestic Water Heater Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Annual energy savings in the domestic water heating system.
+ * @details The energy saved in the domestic water heater (DWH) is calculated by multiplying the heat gain rate by the annual operating hours and dividing by the water heater efficiency. The division by efficiency accounts for the fuel energy that would have been required to provide the same amount of useful heat. This represents the primary energy savings from using waste steam instead of conventional water heating.
+ *
+ * @formula{water-heating-steam-energy-saved-dwh; E_{saved,DWH} = \frac{\dot{Q}_{gain} \cdot t_{op}}{\eta_{heater}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{E_{saved,DWH}; Annual energy saved in domestic water heater; \kilo\joule\per\year}
+ * @symrow{\dot{Q}_{gain}; Heat gain rate; \kilo\joule\per\hour}
+ * @symrow{t_{op}; Operating hours per year; \hour\per\year}
+ * @symrow{\eta_{heater}; Water heater efficiency (fraction); \unitless}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_energy_saved_boiler_formula Energy Saved in Boiler Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Annual energy savings in the boiler from condensate return.
+ * @details The energy saved in the boiler is calculated from the condensate returned to the boiler system. By returning hot condensate instead of using cold makeup water, less energy is needed to generate steam. The calculation multiplies the net steam flow (excluding bypass), the enthalpy difference between condensate and makeup water, and the operating hours, then divides by the boiler efficiency. The net steam flow accounts for the usable condensate that can be returned to the boiler.
+ *
+ * @formula{water-heating-steam-energy-saved-boiler; E_{saved,boiler} = \frac{(\dot{m}_{steam} - \dot{m}_{bypass}) \cdot (h_{s,out} - h_{makeup}) \cdot t_{op}}{\eta_{boiler}}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{E_{saved,boiler}; Annual energy saved in boiler; \kilo\joule\per\year}
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @symrow{\dot{m}_{bypass}; Bypass steam flow; \kilogram\per\hour}
+ * @symrow{h_{s,out}; Outlet steam specific enthalpy (saturated liquid/condensate); \kilo\joule\per\kilogram}
+ * @symrow{h_{makeup}; Makeup water specific enthalpy; \kilo\joule\per\kilogram}
+ * @symrow{t_{op}; Operating hours per year; \hour\per\year}
+ * @symrow{\eta_{boiler}; Boiler efficiency (fraction); \unitless}
+ * @endsymtable
+ */
+
+/**
+ * @defgroup water_heating_using_steam_water_saved_formula Water Saved Formula
+ * @ingroup water_heating_using_steam_calculator
+ * @brief Annual water savings from condensate return.
+ * @details The water saved is calculated from the condensate that can be returned to the boiler instead of being discharged. This is the net steam flow (excluding bypass) converted to volumetric flow and multiplied by the operating hours. The division by 1000 converts the mass flow (kg/hr) to volumetric flow (m³/hr) assuming water density of 1000 kg/m³. Returning condensate reduces the need for makeup water and provides both water conservation and energy savings benefits.
+ *
+ * @formula{water-heating-steam-water-saved; V_{saved} = \frac{(\dot{m}_{steam} - \dot{m}_{bypass}) \cdot t_{op}}{1000}}
+ *
+ * @subheading{Symbols}
+ * @symtable
+ * @symrow{V_{saved}; Annual water saved; \meter\cubed\per\year}
+ * @symrow{\dot{m}_{steam}; Steam mass flow rate; \kilogram\per\hour}
+ * @symrow{\dot{m}_{bypass}; Bypass steam flow; \kilogram\per\hour}
+ * @symrow{t_{op}; Operating hours per year; \hour\per\year}
+ * @endsymtable
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "measur-tools-suite",
-  "version": "1.0.14-rc.38",
+  "version": "1.0.14-rc.40",
   "engines": {
     "node": "20.19.4",
     "npm": "10.8.2"