@dnv-plant/typescriptpws 1.0.86 → 1.0.88

package/src/calculations/dispersion.ts

@@ -6,12 +6,10 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:06
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:11
 * Template:  templates/typescriptpws/calculations.razor.
- ***********************************************************************/
-
-
+***********************************************************************/
 
 import * as Enums from "../enums";
 import * as Entities from "../entities";
@@ -36,12 +34,17 @@ class CalculationBase {
   messages: string[] = [];
   calculationElapsedTime?: number = 0.0;
   operationId?: string = "";
+  controller?: AbortController;
+
+  constructor(controller?: AbortController) {
+    this.controller = controller;
+  }
 
   /**
    * Post JSON to URL and time the call
    */
   async postRequest(url: string, data: string): Promise<AxiosResponse> {
-    return postRequest(url, data);
+    return postRequest(url, data, this.controller);
   }
 
   /**
@@ -177,16 +180,8 @@ class DispersionCalculationRequest extends CalculationRequestBase {
   /**
    * Dispersion calculation request class.
    *
-   * @param {Entities.Material} material -  a material entity with post-discharge composition.
-   * @param {Entities.Substrate} substrate -  a substrate entity.
-   * @param {Entities.DischargeResult} dischargeResult - Discharge / source term definition.
-   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
-   * @param {number} dischargeRecordCount - Number of discharge records.
-   * @param {Entities.Weather} weather -  a weather entity.
-   * @param {Entities.DispersionParameters} dispersionParameters -  a dispersion parameters entity.
-   * @param {number} endPointConcentration - Concentration at which the dispersion calculations will terminate (v/v fraction).
    */
-  constructor(
+  constructor(data: {
     material: Entities.Material,
     substrate: Entities.Substrate,
     dischargeResult: Entities.DischargeResult,
@@ -195,16 +190,16 @@ class DispersionCalculationRequest extends CalculationRequestBase {
     weather: Entities.Weather,
     dispersionParameters: Entities.DispersionParameters,
     endPointConcentration: number
-  ) {
+  }) {
     super();
-    this.material = material;
-    this.substrate = substrate;
-    this.dischargeResult = dischargeResult;
-    this.dischargeRecords = dischargeRecords;
-    this.dischargeRecordCount = dischargeRecordCount;
-    this.weather = weather;
-    this.dispersionParameters = dispersionParameters;
-    this.endPointConcentration = endPointConcentration;
+    this.material = data.material;
+    this.substrate = data.substrate;
+    this.dischargeResult = data.dischargeResult;
+    this.dischargeRecords = data.dischargeRecords;
+    this.dischargeRecordCount = data.dischargeRecordCount;
+    this.weather = data.weather;
+    this.dispersionParameters = data.dispersionParameters;
+    this.endPointConcentration = data.endPointConcentration;
   }
 }
 
@@ -248,16 +243,7 @@ export class DispersionCalculationRequestSchema {
   }
 
   makeCalculationRequest(data: DispersionCalculationRequestSchemaData): DispersionCalculationRequest {
-    return new DispersionCalculationRequest(
-      data.material,
-      data.substrate,
-      data.dischargeResult,
-      data.dischargeRecords,
-      data.dischargeRecordCount,
-      data.weather,
-      data.dispersionParameters,
-      data.endPointConcentration
-    );
+    return new DispersionCalculationRequest(data);
   }
 }
 
@@ -279,16 +265,8 @@ export class DispersionCalculation extends CalculationBase {
 of DispersionRecords. The modelling includes rainout and re-evaporation for 2-phase releases.  
 Time-varying scenarios with mixtures are not currently handled and will give an error. It is recommended therefore to use a continuous or instantaneous source for mixtures.
    *
-   * @param {Entities.Material} material -  a material entity with post-discharge composition.
-   * @param {Entities.Substrate} substrate -  a substrate entity.
-   * @param {Entities.DischargeResult} dischargeResult - Discharge / source term definition.
-   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
-   * @param {number} dischargeRecordCount - Number of discharge records.
-   * @param {Entities.Weather} weather -  a weather entity.
-   * @param {Entities.DispersionParameters} dispersionParameters -  a dispersion parameters entity.
-   * @param {number} endPointConcentration - Concentration at which the dispersion calculations will terminate (v/v fraction).
    */
-  constructor(
+  constructor(data: {
     material: Entities.Material,
     substrate: Entities.Substrate,
     dischargeResult: Entities.DischargeResult,
@@ -297,30 +275,31 @@ Time-varying scenarios with mixtures are not currently handled and will give an
     weather: Entities.Weather,
     dispersionParameters: Entities.DispersionParameters,
     endPointConcentration: number
-  ) {
-    super();
-    this.material = material;
-    this.substrate = substrate;
-    this.dischargeResult = dischargeResult;
-    this.dischargeRecords = dischargeRecords;
-    this.dischargeRecordCount = dischargeRecordCount;
-    this.weather = weather;
-    this.dispersionParameters = dispersionParameters;
-    this.endPointConcentration = endPointConcentration;
+    controller?: AbortController;
+  }) {
+    super(data.controller);
+    this.material = data.material;
+    this.substrate = data.substrate;
+    this.dischargeResult = data.dischargeResult;
+    this.dischargeRecords = data.dischargeRecords;
+    this.dischargeRecordCount = data.dischargeRecordCount;
+    this.weather = data.weather;
+    this.dispersionParameters = data.dispersionParameters;
+    this.endPointConcentration = data.endPointConcentration;
   }
 
   async run() {
     try {
-      const request = new DispersionCalculationRequest(
-        this.material,
-        this.substrate,
-        this.dischargeResult,
-        this.dischargeRecords,
-        this.dischargeRecordCount,
-        this.weather,
-        this.dispersionParameters,
-        this.endPointConcentration
-      );
+      const request = new DispersionCalculationRequest({
+        material: this.material,
+        substrate: this.substrate,
+        dischargeResult: this.dischargeResult,
+        dischargeRecords: this.dischargeRecords,
+        dischargeRecordCount: this.dischargeRecordCount,
+        weather: this.weather,
+        dispersionParameters: this.dispersionParameters,
+        endPointConcentration: this.endPointConcentration
+      });
 
       const schema = new DispersionCalculationRequestSchema();
       const validatedRequest = schema.validate(request);
@@ -395,11 +374,8 @@ export class DispersionCalculationResponse extends CalculationResponseBase {
   /**
    * Dispersion calculation response class.
    *
-   * @param {Entities.ScalarUdmOutputs} scalarUdmOutputs - Scalar dispersion results.
-   * @param {Entities.DispersionRecord[]} dispersionRecords -  an array of dispersion records.
-   * @param {Entities.PoolRecord[]} poolRecords -  an array of pool records.
    */
-  constructor(
+  constructor(data: {
     scalarUdmOutputs: Entities.ScalarUdmOutputs,
     dispersionRecords: Entities.DispersionRecord[],
     poolRecords: Entities.PoolRecord[],
@@ -407,15 +383,15 @@ export class DispersionCalculationResponse extends CalculationResponseBase {
     messages: string[],
     calculationElapsedTime: number,
     operationId: string
-  ) {
+  }) {
     super();
-    this.scalarUdmOutputs = scalarUdmOutputs;
-    this.dispersionRecords = dispersionRecords;
-    this.poolRecords = poolRecords;
-    this.resultCode = resultCode;
-    this.messages = messages;
-    this.calculationElapsedTime = calculationElapsedTime;
-    this.operationId = operationId;
+    this.scalarUdmOutputs = data.scalarUdmOutputs;
+    this.dispersionRecords = data.dispersionRecords;
+    this.poolRecords = data.poolRecords;
+    this.resultCode = data.resultCode;
+    this.messages = data.messages;
+    this.calculationElapsedTime = data.calculationElapsedTime;
+    this.operationId = data.operationId;
   }
 
   initialiseFromDictionary(data: { [key: string]: unknown }) {
@@ -501,14 +477,6 @@ export class DispersionCalculationResponseSchema {
   }
 
   makeCalculationResponse(data: DispersionCalculationResponseSchemaData): DispersionCalculationResponse {
-    return new DispersionCalculationResponse(
-      data.scalarUdmOutputs,
-      data.dispersionRecords,
-      data.poolRecords,
-      data.resultCode,
-      data.messages,
-      data.calculationElapsedTime,
-      data.operationId
-    );
+    return new DispersionCalculationResponse(data);
   }
 }