measur-tools-suite 1.2.6-rc.4 → 1.2.6

package/package.json

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

package/ts_def/client.d.ts

@@ -34,6 +34,7 @@ export * from "./ts_def_modules/motorDriven/motor/motor";
 export * from "./ts_def_modules/motorDriven/motor/motorEnum";
 
 export * from "./ts_def_modules/motorDriven/pump/pump";
+export * from "./ts_def_modules/motorDriven/pump/pump_head";
 export * from "./ts_def_modules/motorDriven/pump/pump_valve_power_loss";
 
 export * from "./ts_def_modules/motorDriven/pumpFan/pumpFan";
@@ -145,6 +146,7 @@ export type MeasurToolsSuite =
     import("./ts_def_modules/motorDriven/motor/motor").MotorModule &
     // motorDriven/pump
     import("./ts_def_modules/motorDriven/pump/pump").PumpModule &
+    import("./ts_def_modules/motorDriven/pump/pump_head").PumpHeadModule &
     import("./ts_def_modules/motorDriven/pump/pump_valve_power_loss").PumpValvePowerLossModule &
     // motorDriven/pumpFan
     import("./ts_def_modules/motorDriven/pumpFan/pumpFan").PumpFanModule &

package/ts_def/ts_def_modules/motorDriven/pump/pump.d.ts

@@ -5,130 +5,9 @@ import { PumpStyle, SpecificSpeed } from "../pumpFan/pumpFan";
 /**
  * Pump calculations.
  *
- * Provides pump head tools and pump-system result calculators for baseline
- * and modified operating conditions.
+ * Provides pump-system result calculators for baseline and modified operating conditions.
  */
 
-/**
- * Result object returned by head tool calculations.
- */
-export declare class HeadToolOutput {
-    /**
-     * Constructor for HeadToolOutput
-     * @param differentialElevationHead Differential elevation head, units ft.
-     * @param differentialPressureHead Differential pressure head, units ft.
-     * @param differentialVelocityHead Differential velocity head, units ft.
-     * @param estimatedSuctionFrictionHead Estimated suction friction head, units ft.
-     * @param estimatedDischargeFrictionHead Estimated discharge friction head, units ft.
-     * @param pumpHead Total pump head, units ft.
-     */
-    constructor(
-        differentialElevationHead: number,
-        differentialPressureHead: number,
-        differentialVelocityHead: number,
-        estimatedSuctionFrictionHead: number,
-        estimatedDischargeFrictionHead: number,
-        pumpHead: number
-    );
-
-    /** Differential elevation head, units ft */
-    differentialElevationHead: number;
-    /** Differential pressure head, units ft */
-    differentialPressureHead: number;
-    /** Differential velocity head, units ft */
-    differentialVelocityHead: number;
-    /** Estimated suction friction head, units ft */
-    estimatedSuctionFrictionHead: number;
-    /** Estimated discharge friction head, units ft */
-    estimatedDischargeFrictionHead: number;
-    /** Total pump head, units ft */
-    pumpHead: number;
-
-    /** Frees the underlying resource; must be called when finished with the instance */
-    delete(): void;
-}
-
-/**
- * Head tool model for systems with a suction tank.
- */
-export declare class HeadToolSuctionTank {
-    /**
-     * @param specificGravity double, specific gravity, dimensionless (unitless)
-     * @param flowRate double, flow rate in gpm
-     * @param suctionPipeDiameter Suction pipe diameter, units ft.
-     * @param suctionTankGasOverPressure double, suction tank gas over pressure in psig
-     * @param suctionTankFluidSurfaceElevation double, suction tank fluid surface elevation in ft
-     * @param suctionLineLossCoefficients double, suction line loss coefficients (unitless)
-     * @param dischargePipeDiameter Discharge pipe diameter, units ft.
-     * @param dischargeGaugePressure double, discharge gauge pressure in psig
-     * @param dischargeGaugeElevation Discharge gauge elevation, units ft.
-     * @param dischargeLineLossCoefficients double, discharge line loss coefficients (unitless)
-     */
-    constructor(
-        specificGravity: number,
-        flowRate: number,
-        suctionPipeDiameter: number,
-        suctionTankGasOverPressure: number,
-        suctionTankFluidSurfaceElevation: number,
-        suctionLineLossCoefficients: number,
-        dischargePipeDiameter: number,
-        dischargeGaugePressure: number,
-        dischargeGaugeElevation: number,
-        dischargeLineLossCoefficients: number
-    );
-
-    /**
-     * Calculates the operating pump head
-     * @returns HeadToolOutput
-     */
-    calculate(): HeadToolOutput;
-
-    /** Frees the underlying resource; must be called when finished with the instance */
-    delete(): void;
-}
-
-/**
- * Head tool model for systems without a suction tank.
- */
-export declare class HeadTool {
-    /**
-     * Constructor for HeadTool with no Suction Tank, all inputs specified
-     *
-     * @param specificGravity double, specific gravity, dimensionless - unitless
-     * @param flowRate double, flow rate in gpm (gallons per minute)
-     * @param suctionPipeDiameter double, diameter of suction pipe in feet
-     * @param suctionGaugePressure double, gauge pressure of suction in psig (pounds per square inch guage)
-     * @param suctionGaugeElevation double, gauge elevation of suction in feet
-     * @param suctionLineLossCoefficients double, line loss coefficients of suction - unitless
-     * @param dischargePipeDiameter double, diameter of discharge pipe in feet
-     * @param dischargeGaugePressure double, gauge pressure of discharge in psig (pounds per square inch guage)
-     * @param dischargeGaugeElevation double, gauge elevation of discharge in feet
-     * @param dischargeLineLossCoefficients double, line loss coefficients of discharge - unitless
-     *
-     * */
-    constructor(
-        specificGravity: number,
-        flowRate: number,
-        suctionPipeDiameter: number,
-        suctionGaugePressure: number,
-        suctionGaugeElevation: number,
-        suctionLineLossCoefficients: number,
-        dischargePipeDiameter: number,
-        dischargeGaugePressure: number,
-        dischargeGaugeElevation: number,
-        dischargeLineLossCoefficients: number
-    );
-
-    /**
-     * Calculates the operating pump head
-     * @returns HeadToolOutput
-     */
-    calculate(): HeadToolOutput;
-
-    /** Frees the underlying resource; must be called when finished with the instance */
-    delete(): void;
-}
-
 /**
  * Input parameters for pump result calculations.
  */
@@ -226,8 +105,8 @@ export declare class PumpResults {
      * @param motor_power_factor Motor power factor, dimensionless.
      * @param motor_current Motor current, units A.
      * @param motor_power Motor power, units kW.
-     * @param annual_energy Annual energy, units kWh/year.
-     * @param annual_cost Annual cost, units $/year.
+     * @param annual_energy Annual energy, units MWh/year.
+     * @param annual_cost Annual cost, units thousand dollars/year.
      * @param load_factor Load factor, dimensionless fraction.
      * @param drive_efficiency Drive efficiency, dimensionless fraction.
      */
@@ -262,9 +141,9 @@ export declare class PumpResults {
     motor_current: number;
     /** Motor power, units kW */
     motor_power: number;
-    /** Annual energy, units kWh */
+    /** Annual energy, units MWh/year */
     annual_energy: number;
-    /** Annual cost, units $ */
+    /** Annual cost, units thousand dollars/year */
     annual_cost: number;
     /** Load factor, dimensionless fraction. */
     load_factor: number;
@@ -320,9 +199,6 @@ export declare class PumpResult {
 }
 
 export type PumpModule = {
-    HeadToolOutput: typeof HeadToolOutput;
-    HeadToolSuctionTank: typeof HeadToolSuctionTank;
-    HeadTool: typeof HeadTool;
     PumpResultInput: typeof PumpResultInput;
     PumpFieldData: typeof PumpFieldData;
     PumpResult: typeof PumpResult;

package/ts_def/ts_def_modules/motorDriven/pump/pump_head.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Inputs for pump-head calculation from suction- and discharge-gauge measurements.
+ * Gauge elevations refer to the centers of the gauges from a common datum and must correspond
+ * to the supplied pressure readings. For a reading corrected to another reference elevation,
+ * use that elevation instead.
+ */
+export interface PumpHeadSuctionGaugeInput {
+    /** Fluid specific gravity, dimensionless. */
+    specificGravity: number;
+    /** Volumetric flow rate, units gpm. */
+    flowRate: number;
+    /** Pipe inside diameter at the suction pressure-measurement location, units in. */
+    suctionPipeDiameter: number;
+    /** Suction gauge pressure, units psig. */
+    suctionGaugePressure: number;
+    /** Elevation of the suction gauge center or corrected pressure reference from the common datum, units ft. */
+    suctionGaugeElevation: number;
+    /** Aggregate suction-line loss coefficient, dimensionless. */
+    suctionLineLossCoefficients: number;
+    /** Pipe inside diameter at the discharge pressure-measurement location, units in. */
+    dischargePipeDiameter: number;
+    /** Discharge gauge pressure, units psig. */
+    dischargeGaugePressure: number;
+    /** Elevation of the discharge gauge center or corrected pressure reference from the common datum, units ft. */
+    dischargeGaugeElevation: number;
+    /** Aggregate discharge-line loss coefficient, dimensionless. */
+    dischargeLineLossCoefficients: number;
+}
+
+/**
+ * Inputs for pump-head calculation with a pressurized suction tank.
+ * The suction elevation refers to the tank fluid surface. Discharge elevation refers to the
+ * gauge center, or the reference elevation to which the pressure reading has been corrected,
+ * measured from the same datum.
+ */
+export interface PumpHeadSuctionTankInput {
+    /** Fluid specific gravity, dimensionless. */
+    specificGravity: number;
+    /** Volumetric flow rate, units gpm. */
+    flowRate: number;
+    /** Suction-pipe inside diameter used as the reference for suction-line losses, units in. */
+    suctionPipeDiameter: number;
+    /** Suction-tank gas overpressure, units psig. */
+    suctionTankGasOverPressure: number;
+    /** Suction-tank fluid-surface elevation from the common datum, units ft. */
+    suctionTankFluidSurfaceElevation: number;
+    /** Aggregate suction-line loss coefficient, dimensionless. */
+    suctionLineLossCoefficients: number;
+    /** Pipe inside diameter at the discharge pressure-measurement location, units in. */
+    dischargePipeDiameter: number;
+    /** Discharge gauge pressure, units psig. */
+    dischargeGaugePressure: number;
+    /** Elevation of the discharge gauge center or corrected pressure reference from the common datum, units ft. */
+    dischargeGaugeElevation: number;
+    /** Aggregate discharge-line loss coefficient, dimensionless. */
+    dischargeLineLossCoefficients: number;
+}
+
+/** Component heads and pump head returned as a plain object. */
+export interface PumpHeadResult {
+    /** Discharge-minus-suction elevation head, units ft. */
+    differentialElevationHead: number;
+    /** Discharge-minus-suction pressure head, units ft. */
+    differentialPressureHead: number;
+    /** Discharge-minus-suction velocity head, units ft. */
+    differentialVelocityHead: number;
+    /** Estimated suction-line friction head, units ft. */
+    estimatedSuctionFrictionHead: number;
+    /** Estimated discharge-line friction head, units ft. */
+    estimatedDischargeFrictionHead: number;
+    /** Pump head, units ft. */
+    pumpHead: number;
+}
+
+/**
+ * Calculates pump head from suction- and discharge-gauge measurements.
+ * @param input Flow, pipe, pressure, elevation, and loss-coefficient inputs in U.S. customary units.
+ * @returns Component heads and pump head, units ft.
+ */
+export declare function calculatePumpHeadFromSuctionGauge(
+    input: PumpHeadSuctionGaugeInput
+): PumpHeadResult;
+
+/**
+ * Calculates pump head for a system supplied from a pressurized suction tank.
+ * @param input Flow, pipe, tank, discharge, and loss-coefficient inputs in U.S. customary units.
+ * @returns Component heads and pump head, units ft.
+ */
+export declare function calculatePumpHeadFromSuctionTank(
+    input: PumpHeadSuctionTankInput
+): PumpHeadResult;
+
+/** Runtime exports contributed by the pump-head binding. */
+export type PumpHeadModule = {
+    calculatePumpHeadFromSuctionGauge: typeof calculatePumpHeadFromSuctionGauge;
+    calculatePumpHeadFromSuctionTank: typeof calculatePumpHeadFromSuctionTank;
+};