measur-tools-suite 1.2.5-beta.3 → 1.2.5-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "measur-tools-suite",
-  "version": "1.2.5-beta.3",
+  "version": "1.2.5-beta.4",
   "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/positive_displacement_pump";
 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/positive_displacement_pump").PositiveDisplacementPumpModule &
     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/positive_displacement_pump.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Positive displacement pump calculations.
+ *
+ * Calculates pump power and annual energy use from flow rate, differential
+ * pressure, pump efficiency, and operating hours.
+ */
+
+/**
+ * Result object returned by {@link PositiveDisplacementPump.calculate}.
+ */
+export declare class PositiveDisplacementPumpOutput {
+    /**
+     * Constructor for PositiveDisplacementPumpOutput.
+     * @param power Pump power, units kW.
+     * @param energy Annual energy use, units kWh/year.
+     */
+    constructor(power: number, energy: number);
+
+    /** Pump power, units kW. */
+    power: number;
+    /** Annual energy use, units kWh/year. */
+    energy: number;
+
+    /** Frees the underlying resource; must be called when finished with the instance. */
+    delete(): void;
+}
+
+/**
+ * Calculates positive displacement pump power and annual energy use.
+ */
+export declare class PositiveDisplacementPump {
+    /**
+     * @param flowRate Volumetric flow rate, units gpm.
+     * @param differentialPressure Pump differential pressure, units psi.
+     * @param pumpEfficiency Pump efficiency, dimensionless fraction.
+     * @param operatingHours Annual operating hours, units hr/year.
+     */
+    constructor(
+        flowRate: number,
+        differentialPressure: number,
+        pumpEfficiency: number,
+        operatingHours: number
+    );
+
+    /**
+     * Calculate pump power and annual energy use.
+     * @returns {@link PositiveDisplacementPumpOutput}
+     */
+    calculate(): PositiveDisplacementPumpOutput;
+
+    /** Frees the underlying resource; must be called when finished with the instance. */
+    delete(): void;
+}
+
+export type PositiveDisplacementPumpModule = {
+    PositiveDisplacementPump: typeof PositiveDisplacementPump;
+    PositiveDisplacementPumpOutput: typeof PositiveDisplacementPumpOutput;
+};