Merge pull request #360 from ORNL-AMO/ca-docs

Ca docs updates

Author: rmroot

docs/dox-content/calculators/compressedAir/leak_survey/orifice_method_calculator.dox

@@ -21,6 +21,14 @@
  * techniques when the discharge coefficient @f$C_d@f$ is known. For surveys where geometry
  * details are unavailable, @f$C_d = 1.0@f$ serves as a conservative upper bound.
  *
+ * @note This method differs from the orifice/pressure method used in the
+ * @ref compressed_air_reduction_pressure_formula. Here the leak source is an unintended opening
+ * of known (measured) diameter, so first-principles compressible-flow equations applied to the
+ * hole geometry yield the best estimate. In the compressed air reduction calculator the flow
+ * source is a manufactured end-use nozzle whose exact geometry may be unknown; empirically
+ * fitted quadratic coefficients indexed by nozzle type are therefore used in place of a
+ * geometry-based calculation.
+ *
  * The calculation proceeds through the following steps:
  * 1. **Temperature conversion** – Convert air temperature from °F to °R.
  * 2. **Pressure conversion** – Add atmospheric pressure to gauge pressure to obtain absolute

docs/dox-content/calculators/compressedAir/operating_cost_calculator.dox

@@ -8,19 +8,17 @@
  *
  * - **Loaded** – the compressor delivers air at full capacity. The motor draws
  *   full-load power proportional to the nameplate brake horsepower (BHP).
- * - **Unloaded** – the compressor is unloaded (inlet valve closed or fully open to
- *   atmosphere) but the motor continues to run. Power consumption drops to a
- *   fraction of full-load BHP (the *unloaded BHP percentage*).
+ * - **Unloaded** – the compressor is unloaded but the motor continues to idle.
+ *   Power consumption drops to a fraction of full-load BHP (the *unloaded BHP percentage*).
  *
  * Load/unload control is one of the most common strategies for industrial
  * compressors. It is energy-efficient at high utilization but wastes electricity
  * at low utilization because the motor idles continuously rather than shutting
- * down. Quantifying both cost components helps engineers evaluate whether a
- * variable-speed drive (VSD) retrofit or a different control strategy is
- * economically justified.
+ * Quantifying both cost components helps engineers evaluate whether a different
+ * control strategy is economically justified.
  *
  * The four calculation outputs are:
- * 1. **Run Time Unloaded** – the complement of the loaded run-time percentage.
+ * 1. **Run Time Unloaded** – percent of the time the compressor is unloaded.
  * 2. **Loaded Cost** – annual electricity cost while delivering air.
  * 3. **Unloaded Cost** – annual electricity cost while idling (no air delivery).
  * 4. **Total Annual Cost** – sum of the loaded and unloaded costs.

docs/dox-content/calculators/compressedAir/pipe_sizing_calculator.dox

@@ -36,11 +36,11 @@
  *          fluid. The free-air flow rate @math{Q} is first converted to the actual
  *          compressed-air volumetric flow at operating pressure using Boyle's Law:
  *
- * @formula{Q_{compressed} = Q \cdot \dfrac{P_{atm}}{P_{line} + P_{atm}}}
+ * @formula{boyles-law; Q_{compressed} = Q \cdot \dfrac{P_{atm}}{P_{line} + P_{atm}}}
  *
  * The required cross-sectional area at the design velocity is:
  *
- * @formula{A_{ft^2} = \dfrac{Q_{compressed}}{v \cdot k_{60}}}
+ * @formula{cross-sectional-area; A_{ft^2} = \dfrac{Q_{compressed}}{v \cdot k_{60}}}
  *
  * Converting from ft² to in² by multiplying by @math{k_{144}}:
  *

docs/dox-content/calculators/compressedAir/receiver_tank_calculator.dox

@@ -25,11 +25,16 @@
  *    between two operating pressures for an existing or proposed tank.
  * 2. **General** – the simplest sizing method; computes the tank volume needed to supply a
  *    known air demand within an allowable pressure drop.
- * 3. **Dedicated Storage** – sizes a tank that must independently supply a sustained flow
- *    for a defined time interval by drawing down from a stored pressure.
- * 4. **Metered Storage** – extends Dedicated Storage by accounting for a metering (needle)
- *    valve that continuously replenishes the tank during the demand event; also computes
- *    the tank refill time after the event.
+ * 3. **Dedicated Storage** – determines the amount of compressed air storage required to
+ *    support a short-duration event without causing system pressure to fall below an
+ *    acceptable minimum. Assumes storage alone supplies the additional air demand during
+ *    the event, with no significant compressor recovery during the storage discharge period.
+ * 4. **Metered Storage** – used when a compressor can partially replenish the storage
+ *    volume during the demand event through a controlled recovery flow. The recovery flow
+ *    is typically regulated by a needle valve that meters air into or out of the storage
+ *    receiver at a slower fixed rate. Accounts for both the stored air and the metered
+ *    recovery flow available during the event, often reducing the required storage volume
+ *    compared to a storage-only design; also computes the tank refill time after the event.
  * 5. **Bridging Compressor Reaction Delay** – sizes a tank that must supply air during
  *    the time the pressure signal propagates from a demand event back to the compressor
  *    room and the compressor responds.
@@ -115,11 +120,12 @@
 /**
  * @defgroup receiver_tank_dedicated_storage_size_formula Dedicated Storage Method Tank Size Formula
  * @ingroup receiver_tank_calculator
- * @brief Sizes a tank that must supply a sustained flow for a defined duration from stored pressure.
- * @details The Dedicated Storage method is used when a process requires a fixed flow rate
- *          for a known duration and the compressor cannot keep up. The tank is sized to
- *          provide that flow over the demand period while the pressure falls from the
- *          initial to the final value.
+ * @brief Determines the compressed air storage volume needed to support a short-duration demand event without letting system pressure fall below an acceptable minimum.
+ * @details Use this method when storage alone must supply the additional air demand during
+ *          the event, with no significant compressor recovery occurring during the storage
+ *          discharge period. The tank is sized so that pressure can fall from the initial
+ *          stored value to the minimum acceptable value while satisfying the full demand
+ *          flow rate for the duration of the event.
  *
  * @formula{receiver-tank-dedicated-storage-size;
  *   V_{required} = \frac{k_{gal} \cdot t_{demand} \cdot Q_{flow} \cdot P_{atm}}{P_{in} - P_{out}}
@@ -140,13 +146,16 @@
 /**
  * @defgroup receiver_tank_metered_storage_size_formula Metered Storage Method Tank Size Formula
  * @ingroup receiver_tank_calculator
- * @brief Sizes a tank when flow is regulated through a metering (needle) valve.
- * @details The Metered Storage method extends the Dedicated Storage method for the case
- *          where a needle valve or flow-control orifice continuously supplies air to the
- *          downstream process at a controlled rate @math{Q_{metered}} during the demand
- *          event. Only the net demand @math{(Q_{flow} - Q_{metered})} draws from the
- *          stored volume, so the required tank is smaller than the Dedicated Storage size
- *          for the same scenario.
+ * @brief Sizes a dedicated storage tank when the compressor can partially replenish storage during the demand event through a controlled recovery flow.
+ * @details Use this method when a compressor can partially replenish the storage volume
+ *          during the demand event through a controlled recovery flow. In many compressed
+ *          air systems this recovery flow is regulated by a needle valve that meters air
+ *          into or out of the storage receiver at a slower fixed rate @math{Q_{metered}}.
+ *          The calculator accounts for both the stored air and the metered recovery flow
+ *          available during the event: only the net demand @math{(Q_{flow} - Q_{metered})}
+ *          draws from the stored volume, often reducing the required tank size compared to
+ *          a storage-only design. This method is appropriate for intermittent, high-flow
+ *          applications where a controlled refill rate is desired.
  *
  * @formula{receiver-tank-metered-storage-size;
  *   V_{required} = \frac{k_{gal} \cdot t_{demand} \cdot (Q_{flow} - Q_{metered}) \cdot P_{atm}}{P_{in} - P_{out}}

docs/dox-content/calculators/treasureHunt/compressed_air_nozzle_coefficients.dox

@@ -1,7 +1,7 @@
 /**
  * @defgroup compressed_air_nozzle_coefficients Nozzle Coefficient Lookup Table
  * @ingroup compressed_air_reduction_calculator
- * @brief Pre-calibrated quadratic coefficients for 13 standard compressed air nozzle types used
+ * @brief Pre-calibrated quadratic coefficients for 12 standard compressed air nozzle types used
  *        in the orifice/pressure measurement method.
  * @details These coefficients parameterize the quadratic flow-versus-pressure relationship for
  * each nozzle type. Given a supply pressure @math{P} @unitb{\psi}, the single-nozzle flow rate
@@ -13,7 +13,6 @@
  * listed in the table below. Each index (0–12) represents a distinct nozzle geometry; the
  * coefficients were fitted to measured flow data at known pressures.
  *
- * @note Indices 11 and 12 share identical coefficients and represent the same nozzle geometry.
  *
  * @heading{Coefficient Table}
  * @copydoc compressed_air_nozzle_coefficient_data
@@ -23,25 +22,23 @@
  * @defgroup compressed_air_nozzle_coefficient_data Nozzle Coefficient Data
  * @ingroup compressed_air_nozzle_coefficients
  * The following table lists the empirical quadratic coefficients @math{a}, @math{b}, and
- * @math{c} for each of the 13 supported nozzle types. Select the row whose index matches the
+ * @math{c} for each of the 12 supported nozzle types. Select the row whose index matches the
  * @p nozzle_type field of @ref compressed_air_reduction::PressureMethodData.
  *
- * | Index | @math{a} @unitb{\scfm\per\psi\squared} | @math{b} @unitb{\scfm\per\psi} | @math{c} @unitb{\scfm} |
- * |:-----:|----------------------------------------:|--------------------------------:|------------------------:|
- * | 0     | @math{-2.200 \times 10^{-7}}            | 0.018893                        | 0.268476                |
- * | 1     | @math{-2.800 \times 10^{-5}}            | 0.038377                        | 1.061905                |
- * | 2     | @math{-7.600 \times 10^{-5}}            | 1.537424                        | 14.300000               |
- * | 3     | @math{-2.200 \times 10^{-5}}            | 0.345931                        | 5.780952                |
- * | 4     | @math{6.820 \times 10^{-4}}             | 0.643182                        | 13.833330               |
- * | 5     | @math{5.410 \times 10^{-6}}             | 0.228851                        | 2.968095                |
- * | 6     | @math{-2.100 \times 10^{-6}}            | 0.075463                        | 1.089857                |
- * | 7     | @math{-2.800 \times 10^{-5}}            | 0.148710                        | 1.841905                |
- * | 8     | @math{2.652 \times 10^{-3}}             | 2.250152                        | 46.566670               |
- * | 9     | @math{7.470 \times 10^{-4}}             | 0.842056                        | 15.957140               |
- * | 10    | @math{4.110 \times 10^{-4}}             | 0.560649                        | 10.161900               |
- * | 11    | @math{9.350 \times 10^{-4}}             | 0.130792                        | 4.429524                |
- * | 12    | @math{9.350 \times 10^{-4}}             | 0.130792                        | 4.429524                |
+ * | Index | Nozzle Type        | @math{a} @unitb{\scfm\per\psi\squared} | @math{b} @unitb{\scfm\per\psi} | @math{c} @unitb{\scfm} |
+ * |:-----:|:-------------------|----------------------------------------:|--------------------------------:|------------------------:|
+ * | 0     | 1.0 mm nozzle      | @math{-2.200 \times 10^{-7}}            | 0.018893                        | 0.268476                |
+ * | 1     | 1.5 mm nozzle      | @math{-2.800 \times 10^{-5}}            | 0.038377                        | 1.061905                |
+ * | 2     | 1/4" pipe, open    | @math{-7.600 \times 10^{-5}}            | 1.537424                        | 14.300000               |
+ * | 3     | 1/4" tubing        | @math{-2.200 \times 10^{-5}}            | 0.345931                        | 5.780952                |
+ * | 4     | 1/8" pipe, open    | @math{6.820 \times 10^{-4}}             | 0.643182                        | 13.833330               |
+ * | 5     | 1/8" tubing        | @math{5.410 \times 10^{-6}}             | 0.228851                        | 2.968095                |
+ * | 6     | 2.0 mm nozzle      | @math{-2.100 \times 10^{-6}}            | 0.075463                        | 1.089857                |
+ * | 7     | 2.5 mm nozzle      | @math{-2.800 \times 10^{-5}}            | 0.148710                        | 1.841905                |
+ * | 8     | 3/8" pipe, open    | @math{2.652 \times 10^{-3}}             | 2.250152                        | 46.566670               |
+ * | 9     | 3/8" tubing        | @math{7.470 \times 10^{-4}}             | 0.842056                        | 15.957140               |
+ * | 10    | 5/16" tubing       | @math{4.110 \times 10^{-4}}             | 0.560649                        | 10.161900               |
+ * | 11    | Air Knife          | @math{9.350 \times 10^{-4}}             | 0.130792                        | 4.429524                |
  *
- * @note Indices 11 and 12 are identical and represent the same physical nozzle geometry.
  * @see compressed_air_reduction_pressure_formula for the formula that uses these coefficients.
  */

docs/dox-content/calculators/treasureHunt/compressed_air_reduction_calculator.dox

@@ -92,7 +92,7 @@
  * @ingroup compressed_air_reduction_calculator
  * @brief Compressed airflow rate estimated from nozzle type and supply pressure.
  * @details The orifice/pressure method estimates flow rate using a quadratic equation fit to
- * empirical flow-versus-pressure data for 13 standard nozzle types (indices 0–12). Each nozzle
+ * empirical flow-versus-pressure data for 12 standard nozzle types (indices 0–11). Each nozzle
  * type has a distinct set of coefficients @math{a}, @math{b}, and @math{c} from the lookup table
  * in @ref compressed_air_nozzle_coefficients. The single-nozzle flow rate is computed from the
  * supply pressure; total flow rate and annual consumption then scale with the number of nozzles.
@@ -114,7 +114,15 @@
  * @endsymtable
  *
  * @note The coefficients @math{a}, @math{b}, and @math{c} depend entirely on the selected nozzle
- * type. All 13 nozzle-type coefficient sets are listed in @ref compressed_air_nozzle_coefficients.
+ * type. All 12 nozzle-type coefficient sets are listed in @ref compressed_air_nozzle_coefficients.
+ *
+ * @note This method differs fundamentally from the orifice method used in the
+ * @ref orifice_method_calculator. Here the flow source is a manufactured end-use nozzle whose
+ * exact orifice geometry may be unknown but whose flow characteristics have been empirically
+ * characterised; a pre-fitted quadratic curve is therefore more accurate than a geometry-based
+ * calculation. In the leak survey the source is an unintended opening of known diameter, so
+ * first-principles compressible-flow equations applied directly to the hole geometry give the
+ * best estimate.
  * @see compressed_air_nozzle_coefficients
  */