measur-tools-suite 1.0.14-rc.30 → 1.0.14-rc.32

package/docs/dox-content/calculators/solid_load_charge_material_heat_required_calculator.dox

@@ -2,7 +2,19 @@
  * @defgroup solid_load_charge_material_heat_required_calculator Solid Load Charge Material Heat Required Calculator
  * @ingroup heat_loss_calculators
  * @brief Calculates total heat required for a solid load/charge material.
- * @details The following formulas describe the calculation of total heat required for a solid load/charge material, including sensible heat, latent heat, vaporization, reaction heat, and additional heat. Each step is documented with its own formula and symbol table.
+ * @details The following formulas describe the calculation of total heat required for a solid load/charge material, 
+ * including sensible heat, latent heat, vaporization, reaction heat, and additional heat. Each step is documented 
+ * with its own formula and symbol table.
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Total Heat Required** - Sum of moisture removal, solid heating, reaction heat, and additional heat
+ * 2. **Moisture Removal** - Heat to evaporate water content (varies based on discharge temperature)
+ *    - Below boiling: Sensible heat only
+ *    - Above boiling: Sensible heat to boiling + latent heat + sensible heat of vapor
+ * 3. **Solid Heating** - Heat to raise temperature of dry solid (varies based on melting)
+ *    - Below melting: Sensible heat only
+ *    - Above melting: Sensible heat to melting + latent heat + sensible heat of liquid/remaining solid
+ * 4. **Heat of Reaction** - Endothermic reaction heat if applicable
  *
  * @heading{Total Heat Required}
  * @copydoc solid_load_charge_material_total_heat_required_cpp_formula
@@ -10,7 +22,7 @@
  * @heading{Moisture Removal (Below boiling point)}
  * @copydoc solid_load_charge_material_moisture_removal_cpp_formula
  *
-* @heading{Moisture Removal (Above boiling point)}
+ * @heading{Moisture Removal (Above boiling point)}
  * @copydoc solid_load_charge_material_moisture_removal_above_boiling_cpp_formula
  *
  * @heading{Heat for Remaining Moisture}
@@ -19,15 +31,17 @@
  * @heading{Solid Heating (Below melting point)}
  * @copydoc solid_load_charge_material_sensible_heat_cpp_formula
  *
-* @heading{Solid Heating (Above melting point)}
+ * @heading{Solid Heating (Above melting point)}
  * @copydoc solid_load_charge_material_full_heat_cpp_formula
  *
  * @heading{Heat of Reaction}
  * @copydoc solid_load_charge_material_heat_of_reaction_cpp_formula
  *
  * @see solid_load_charge_material_data_database
+ * @see physics::us::kWaterBoilingPointF for water boiling point
+ * @see physics::us::kWaterEvaporation for latent heat of evaporation
+ * @see physics::us::kSpecificHeatWaterVapor for water vapor specific heat
  */
-
 /**
  * @defgroup solid_load_charge_material_total_heat_required_cpp_formula Total Heat Required Formula
  * @ingroup solid_load_charge_material_heat_required_calculator

package/docs/dox-content/calculators/wall_heat_loss_calculator.dox

@@ -5,9 +5,14 @@
  * @details This calculator can be used to calculate fuel savings from improving wall insulation or otherwise reduce
  * heat lost through the walls. Wall losses occur as heat is transferred from the outer surface of the walls or casing
  * of process heating equipment to the surrounding environment. This can occur via convection and radiation. Wall losses
- * are high for systems that are poorly insulated or use poorly designed materials or surfaces. The calculator computes
- * the total heat loss as the sum of convective and radiative heat losses, adjusted by a correction factor. Relevant
- * formulas and factors are documented below.
+ * are high for systems that are poorly insulated or use poorly designed materials or surfaces.
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Total Heat Loss** - Sum of convective and radiative losses, adjusted by correction factor
+ * 2. **Convective Heat Loss** - Heat transfer due to air movement around the wall surface
+ * 3. **Radiative Heat Loss** - Heat transfer due to thermal radiation from the wall surface
+ *
+ * Relevant formulas and factors are documented below.
  *
  * @heading{Total Heat Loss}
  * @copydoc wall_total_heat_loss_formula
@@ -25,7 +30,12 @@
 /**
  * @defgroup wall_total_heat_loss_formula Wall Total Heat Loss Formula
  * @ingroup wall_heat_loss_calculator
+ * @brief Total heat loss from wall to ambient environment.
+ * @details The total heat loss is the sum of convective and radiative components, multiplied by a correction factor
+ * to account for operational conditions and uncertainties.
+ * 
  * @formula{wall-total-heat-loss; Q_\text{total} = \left(Q_\text{conv} + Q_\text{rad}\right) \cdot f_\text{corr}}
+ * 
  * @subheading{Symbols}
  * @symtable
  * @symrow{Q_\text{total}; Total heat loss; \btu\per\hour}
@@ -38,24 +48,33 @@
 /**
  * @defgroup wall_convective_heat_loss_formula Wall Convective Heat Loss Formula
  * @ingroup wall_heat_loss_calculator
+ * @brief Heat loss due to natural and forced convection.
+ * @details Convective heat loss is calculated using the convection coefficient, surface area, and temperature difference.
+ * The convection coefficient accounts for geometry (shape factor), operating conditions (duty factor), temperature effects,
+ * and wind velocity.
+ * 
  * @formula{wall-qconv; Q_\text{conv} = h A \Delta T}
+ * 
  * @subheading{Convection Coefficient}
- * @formula{wall-h; h = f_\text{shape} \cdot f_\text{duty} \cdot f_{\Delta T} \cdot f_{\bar{T}} \cdot
- * f_\text{wind}}
+ * @formula{wall-h; h = f_\text{shape} \cdot f_\text{duty} \cdot f_{\Delta T} \cdot f_{\bar{T}} \cdot f_\text{wind}}
+ * 
  * @subheading{Factors}
  * @formula{wall-duty; f_\text{duty} = \left(\frac{1}{24}\right)^{0.2}}
  * @formula{wall-dTfactor; f_{\Delta T} = (\Delta T)^{0.266}}
  * @formula{wall-Tbarfactor; f_{\bar{T}} = \left(\frac{1}{\bar{T}}\right)^{0.181}}
  * @formula{wall-windfactor; f_\text{wind} = \sqrt{1 + 1.277 \cdot v_\text{wind}}}
+ * 
  * @subheading{Temperature Definitions}
  * @formula{wall-dT; \Delta T = T_s - T_a}
  * @formula{wall-Tbar; \bar{T} = \frac{T_s + T_a}{2}}
+ * 
  * @subheading{Symbols}
  * @symtable
  * @symrow{Q_\text{conv}; Convective heat loss; \btu\per\hour}
  * @symrow{h; Convection coefficient; \btu\per\hour\foot\squared\degreeFahrenheit}
  * @symrow{A; Surface area; \foot\squared}
  * @symrow{\Delta T; Temperature difference between surface and ambient; \degreeFahrenheit}
+ * @symrow{\bar{T}; Mean temperature; \degreeFahrenheit}
  * @symrow{f_\text{shape}; @ref shape_factors "Shape factor"; \unitless}
  * @symrow{f_\text{duty}; Duty factor; \unitless}
  * @symrow{f_{\Delta T}; Temperature difference factor; \unitless}

package/docs/dox-content/calculators/water_cooling_heat_loss_calculator.dox

@@ -2,7 +2,14 @@
  * @defgroup water_cooling_heat_loss_calculator Water Cooling Heat Loss Calculator
  * @ingroup heat_loss_calculators
  * @brief Calculates heat loss due to water cooling in process heating equipment.
- * @details This calculator estimates the heat removed by water cooling systems, using flow rate, inlet and outlet temperatures, and a correction factor. It accounts for water density variation with temperature and converts between SI and U.S. Customary units as needed. The algorithm is suitable for modeling cooling losses in industrial furnaces, ovens, and similar systems.
+ * @details This calculator estimates the heat removed by water cooling systems, using flow rate, inlet and outlet 
+ * temperatures, and a correction factor. It accounts for water density variation with temperature and converts between 
+ * SI and U.S. Customary units as needed. The algorithm is suitable for modeling cooling losses in industrial furnaces, 
+ * ovens, and similar systems.
+ *
+ * The calculation follows a top-down approach:
+ * 1. **Total Heat Loss** - Calculate heat removed by water based on flow rate and temperature rise
+ * 2. **Water Density** - Compute temperature-dependent water density for accurate mass flow calculation
  *
  * @heading{Total Water Cooling Heat Loss}
  * @copydoc water_cooling_heat_loss_formula
@@ -11,35 +18,47 @@
  * @copydoc water_density_formula
  *
  * @note For heat losses due to liquid cooling see @ref liquid_cooling_heat_loss_calculator or for gas cooling see @ref gas_cooling_heat_loss_calculator.
- *
- *
- * @see Perry’s Chemical Engineers’ Handbook; NIST Engineering Statistics; Tanaka et al. (2001)
+ * @see Perry's Chemical Engineers' Handbook; NIST Engineering Statistics; Tanaka et al. (2001)
+ * @see physics::si::kWaterDensityBase for the base water density constant
+ * @see physics::conversions::kMinutesPerHour for time conversion
+ * @see physics::conversions::kKgPerM3ToLbPerGal for density unit conversion
  */
 
 /**
  * @defgroup water_cooling_heat_loss_formula Water Cooling Heat Loss Formula
  * @ingroup water_cooling_heat_loss_calculator
+ * @brief Total heat loss due to water cooling.
+ * @details The heat loss is calculated by multiplying the water flow rate, water density, temperature rise, 
+ * and correction factor. Water density is temperature-dependent and calculated using the Tanaka correlation. 
+ * The factor of 60 converts from gallons per minute to gallons per hour.
+ * 
  * @formula{water-cooling-heat-loss; Q_\text{cool} = FR \cdot 60 \cdot \rho_{w,lb/gal} \cdot \Delta T \cdot CF}
+ * 
  * @subheading{Symbols}
  * @symtable
  * @symrow{Q_\text{cool}; Water cooling heat loss; \btu\per\hour}
  * @symrow{FR; Water flow rate; \gallon\per\minute}
- * @symrow{60; Minutes per hour (GPM to GPH conversion); \unitless}
+ * @symrow{60; Minutes per hour (GPM to GPH conversion) - see @ref physics::conversions::kMinutesPerHour; \unitless}
  * @symrow{\rho_{w,lb/gal}; Water density; \pound\per\gallon}
  * @symrow{\Delta T; Temperature rise (outlet - inlet); \degreeFahrenheit}
  * @symrow{CF; Correction factor; \unitless}
  * @endsymtable
- * @details Water density is calculated using Tanaka et al. (2001) empirical formula, then converted to lb/gal. The formula multiplies flow rate (GPM), minutes per hour, water density, temperature rise, and correction factor to obtain total heat loss.
  */
 
 /**
  * @defgroup water_density_formula Water Density Calculation Formula
  * @ingroup water_cooling_heat_loss_calculator
+ * @brief Temperature-dependent water density calculation.
+ * @details This formula from Tanaka et al. (2001) calculates the density of water as a function of temperature. 
+ * The base density of 1000 kg/m³ (see @ref physics::si::kWaterDensityBase) is adjusted by a temperature-dependent 
+ * correction factor. The result is converted to lb/gal using @ref physics::conversions::kKgPerM3ToLbPerGal.
+ * 
  * @formula{water-density-tanaka; \rho_w = 1000 \left[1 - \frac{(T_C + 288.9414)}{508929.2 (T_C + 68.12963)} (T_C - 3.9863)^2 \right]}
+ * 
  * @subheading{Symbols}
  * @symtable
  * @symrow{\rho_w; Water density; \kilogram\per\meter\cubed}
  * @symrow{T_C; Average water temperature; \degreeCelsius}
+ * @symrow{1000; Base water density - see @ref physics::si::kWaterDensityBase; \kilogram\per\meter\cubed}
  * @endsymtable
- * @details This formula is from Tanaka et al. (2001) and is used to calculate the density of water as a function of temperature in degrees Celsius.
  */

package/docs/dox-content/physics/constants.dox

@@ -0,0 +1,70 @@
+/**
+ * @defgroup physics_constants Physics Constants
+ * @ingroup physics
+ * @brief Physical constants used in process heating and thermodynamic calculations.
+ * @details
+ * This page documents the fundamental physical constants used throughout the MEASUR Tools Suite for heat transfer, 
+ * thermodynamic, and energy calculations. Constants are provided in both SI (Standard International) and 
+ * U.S. Customary units to support various engineering applications.
+ *
+ * The constants are organized by unit system and include:
+ * - **Radiation Constants:** Stefan-Boltzmann constant for thermal radiation calculations
+ * - **Water Properties:** Specific heat, latent heat, boiling point, and density
+ * - **Temperature Conversions:** Offsets and conversion factors between unit systems
+ * - **Energy Conversions:** Kilowatt to BTU/hr and other power unit conversions
+ *
+ * All constants are defined with appropriate units and source references where applicable.
+ *
+ * @heading{SI Unit System Constants}
+ * The following constants are defined in Standard International (SI) units:
+ *
+ * | Constant Name                      | Symbol | Value           | Unit                                 | Description |
+ * |------------------------------------|--------|-----------------|--------------------------------------|-------------|
+ * | Stefan-Boltzmann constant          | @math{\sigma} | @qty{5.670374419e-8; \watt\per\meter\squared\kelvin\tothe{4}} | physics::si::kStefanBoltzmann | Radiation heat transfer constant |
+ * | Standard water density at 4°C      | @math{\rho_w} | @qty{1000.0; \kilogram\per\meter\cubed} | physics::si::kWaterDensityBase | Base density for water property calculations |
+ *
+ * @heading{U.S. Customary Unit System Constants}
+ * The following constants are defined in U.S. Customary units:
+ *
+ * | Constant Name                      | Symbol | Value           | Unit                                 | Description |
+ * |------------------------------------|--------|-----------------|--------------------------------------|-------------|
+ * | Stefan-Boltzmann constant          | @math{\sigma} | @qty{1.713441e-9; \btu\per\hour\foot\squared\degreeRankine\tothe{4}} | physics::us::kStefanBoltzmann | Radiation heat transfer constant (see @cite capehart2007guide) |
+ * | Water boiling point                | @math{T_{boil}} | @qty{212.0; \degreeFahrenheit} | physics::us::kWaterBoilingPointF | Standard atmospheric pressure boiling point |
+ * | Specific heat of water vapor       | @math{C_{p,vapor}} | @qty{0.481; \btu\per\pound\degreeFahrenheit} | physics::us::kSpecificHeatWaterVapor | Specific heat capacity of water vapor |
+ * | Latent heat of evaporation         | @math{H_{evap}} | @qty{970.0; \btu\per\pound} | physics::us::kWaterEvaporation | Heat required for water phase change |
+ * | Standard gas temperature           | @math{T_{std}} | @qty{520.0; \degreeRankine} | physics::us::kStandardGasTemperatureR | Reference temperature (60°F + 460) for gas calculations |
+ * | Ambient reference temperature      | @math{T_{amb}} | @qty{60.0; \degreeFahrenheit} | physics::us::kAmbientTemperatureF | Standard ambient temperature for calculations |
+ * | Base specific heat of air          | @math{C_{p,air,base}} | @qty{0.017828518; \btu\per\pound\degreeFahrenheit} | physics::us::kSpecificHeatAirBase | Base value for exhaust gas calculations |
+ * | Specific heat temperature coefficient | @math{C_{p,air,coeff}} | @qty{0.000002556; \btu\per\pound\degreeFahrenheit\per\degreeFahrenheit} | physics::us::kSpecificHeatAirCoeff | Temperature-dependent coefficient |
+ * | Air correction base                | - | @qty{-1.078913827; \btu\per\pound} | physics::us::kAirCorrectionBase | Correction term for exhaust gas calculations |
+ *
+ * @heading{Unit Conversion Constants}
+ * The following constants are used for converting between different unit systems:
+ *
+ * | Constant Name                      | Symbol | Value           | Unit                                 | Description |
+ * |------------------------------------|--------|-----------------|--------------------------------------|-------------|
+ * | Fahrenheit to Rankine offset       | - | @qty{459.67; \degreeRankine} | physics::conversions::kFahrenheitToRankineOffset | Add to °F to get °R |
+ * | Hours per day                      | - | 24.0 | @unitb{\unitless} | physics::conversions::kHoursPerDay | Time conversion factor |
+ * | Minutes per hour                   | - | 60.0 | @unitb{\unitless} | physics::conversions::kMinutesPerHour | Time conversion factor |
+ * | Kilowatt to BTU/hr                 | - | @qty{3412.136247820839; \btu\per\hour\per\kilowatt} | physics::conversions::kKilowattToBtuPerHour | Energy conversion factor |
+ * | kg/m³ to lb/gal                    | - | @qty{0.0083454; \pound\per\gallon\per\kilogram\per\meter\cubed} | physics::conversions::kKgPerM3ToLbPerGal | Density conversion factor |
+ *
+ * @heading{Temperature Conversion Formulas}
+ * @subheading{Fahrenheit to Rankine}
+ * @formula{fahrenheit-to-rankine-const; T_R = T_F + 459.67}
+ * @subheading{Fahrenheit to Celsius}
+ * @formula{fahrenheit-to-celsius-const; T_C = \frac{5}{9}(T_F - 32)}
+ *
+ * @par Symbol Definitions
+ * @symtable
+ * @symrow{T_R; Temperature in degrees Rankine; \degreeRankine}
+ * @symrow{T_F; Temperature in degrees Fahrenheit; \degreeFahrenheit}
+ * @symrow{T_C; Temperature in degrees Celsius; \degreeCelsius}
+ * @endsymtable
+ *
+ * @note All constants are inline constexpr in C++ for compile-time optimization.
+ * @see physics::si Namespace for SI unit constants
+ * @see physics::us Namespace for U.S. Customary unit constants
+ * @see physics::conversions Namespace for unit conversion constants
+ * @see gas_constants for thermodynamic and stoichiometric constants
+ */

package/package.json

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