@dnv-plant/typescriptpws 1.0.27 → 1.0.38-alpha.1846913

package/src/calculations/dispersion.ts

@@ -0,0 +1,511 @@
+/***********************************************************************
+ * This file has been auto-generated by a code generation tool.
+ * Version:   1.0.38
+ * Date/time: 24 Mar 2025 16:46:20
+ * Template:  templates/typescriptpws/calculations.razor.
+ ***********************************************************************/
+
+
+
+import * as Enums from "../enums";
+import * as Entities from "../entities";
+import * as EntitySchemas from "../entity-schemas";
+import { getAnalyticsApiTarget, getClientAliasId, postRequest } from "../utilities";
+
+import Joi from "joi";
+import { AxiosResponse } from "axios";
+
+
+class CalculationRequestBase {
+  /**
+   * Calculation request base class.
+   */
+  constructor() {
+    // Base class initialization code
+  }
+}
+
+class CalculationBase {
+  resultCode?: Enums.ResultCode = Enums.ResultCode.SUCCESS;
+  messages: string[] = [];
+  calculationElapsedTime?: number = 0.0;
+  operationId?: string = "";
+
+  /**
+   * Post JSON to URL and time the call
+   */
+  async postRequest(url: string, data: string): Promise<AxiosResponse> {
+    return postRequest(url, data);
+  }
+
+  /**
+   * Utility method to print the messages returned by the calculation.
+   */
+  printMessages(): void {
+    if (this.messages && this.messages.length > 0) {
+      this.messages.forEach((message) => console.log(message));
+    } else {
+      console.log("No messages");
+    }
+  }
+
+  /**
+   * Utility method to handle a failed response.
+   */
+  handleFailedResponse(response: AxiosResponse): void {
+    try {
+      const validatedFailedResponse = new CalculationFailedResponseSchema().validate(response.data);
+
+      this.resultCode = validatedFailedResponse.resultCode;
+      this.messages.push(...(validatedFailedResponse.messages ?? []));
+      this.calculationElapsedTime = validatedFailedResponse.calculationElapsedTime;
+      this.operationId = validatedFailedResponse.operationId;
+    } catch (error) {
+      if (error instanceof Error) {
+        this.messages.push(`Failed to parse response: ${error.message}`);
+      } else {
+        this.messages.push("An unknown error occurred during response parsing.");
+      }
+      console.error("Failed to parse response:", error);
+    } finally {
+      this.messages.push(`${response.statusText} (Status code: ${response.status})`);
+    }
+  }
+}
+
+class CalculationResponseBase {
+  resultCode?: Enums.ResultCode;
+  messages?: string[];
+  calculationElapsedTime?: number;
+  operationId?: string;
+
+  /**
+   * Calculation response base class.
+   */
+  constructor(
+    resultCode?: Enums.ResultCode,
+    messages?: string[],
+    calculationElapsedTime?: number,
+    operationId?: string
+  ) {
+    this.resultCode = resultCode;
+    this.messages = messages;
+    this.calculationElapsedTime = calculationElapsedTime;
+    this.operationId = operationId;
+  }
+}
+
+class CalculationFailedResponse extends CalculationResponseBase {
+  /**
+   * Calculation failed response class.
+   */
+  constructor(
+    resultCode?: Enums.ResultCode,
+    messages: string[] = [],
+    calculationElapsedTime: number = 0,
+    operationId: string = ""
+  ) {
+    super(resultCode, messages, calculationElapsedTime, operationId);
+  }
+}
+
+class CalculationFailedResponseSchema {
+  schema: Joi.ObjectSchema;
+
+  /**
+   * Calculation failed response schema.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      resultCode: Joi.string()
+        .valid(...Object.values(Enums.ResultCode))
+        .required(),
+      messages: Joi.array().items(Joi.string()).required(),
+      calculationElapsedTime: Joi.number().required(),
+      operationId: Joi.string().required(),
+    }).unknown(true);
+  }
+
+  validate(data: {
+    resultCode: Enums.ResultCode;
+    messages: string[];
+    calculationElapsedTime: number;
+    operationId: string;
+  }) {
+    const { error, value } = this.schema.validate(data);
+    if (error) throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    return this.makeCalculationFailedResponse(value);
+  }
+
+  makeCalculationFailedResponse(data: {
+    resultCode: Enums.ResultCode;
+    messages: string[];
+    calculationElapsedTime: number;
+    operationId: string;
+  }) {
+    return new CalculationFailedResponse(data.resultCode, data.messages, data.calculationElapsedTime, data.operationId);
+  }
+  }
+    
+export interface DispersionCalculationRequestSchemaData {
+  material: Entities.Material;
+  substrate: Entities.Substrate;
+  dischargeResult: Entities.DischargeResult;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  weather: Entities.Weather;
+  dispersionParameters: Entities.DispersionParameters;
+  endPointConcentration: number;
+}
+
+class DispersionCalculationRequest extends CalculationRequestBase {
+  material: Entities.Material;
+  substrate: Entities.Substrate;
+  dischargeResult: Entities.DischargeResult;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  weather: Entities.Weather;
+  dispersionParameters: Entities.DispersionParameters;
+  endPointConcentration: number;
+
+  /**
+   * 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(
+    material: Entities.Material,
+    substrate: Entities.Substrate,
+    dischargeResult: Entities.DischargeResult,
+    dischargeRecords: Entities.DischargeRecord[],
+    dischargeRecordCount: number,
+    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;
+  }
+}
+
+export class DispersionCalculationRequestSchema {
+  schema: Joi.ObjectSchema;
+  propertyTypes: Record<string, string>;
+
+  /**
+   * Schema for the Dispersion calculation request.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      material: new EntitySchemas.MaterialSchema().schema,
+      substrate: new EntitySchemas.SubstrateSchema().schema,
+      dischargeResult: new EntitySchemas.DischargeResultSchema().schema,
+      dischargeRecords: Joi.array().items(new EntitySchemas.DischargeRecordSchema().schema).allow(null),
+      dischargeRecordCount: Joi.number().integer(),
+      weather: new EntitySchemas.WeatherSchema().schema,
+      dispersionParameters: new EntitySchemas.DispersionParametersSchema().schema,
+      endPointConcentration: Joi.number().unsafe(),
+    }).unknown(true);
+
+    this.propertyTypes = {
+      material: "Entities.Material",
+      substrate: "Entities.Substrate",
+      dischargeResult: "Entities.DischargeResult",
+      dischargeRecords: "Entities.DischargeRecord[]",
+      dischargeRecordCount: "number",
+      weather: "Entities.Weather",
+      dispersionParameters: "Entities.DispersionParameters",
+      endPointConcentration: "number",
+    };
+  }
+
+  validate(data: DispersionCalculationRequestSchemaData): DispersionCalculationRequest {
+    const { error, value } = this.schema.validate(data, { abortEarly: false });
+    if (error) {
+      throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    }
+    return this.makeCalculationRequest(value);
+  }
+
+  makeCalculationRequest(data: DispersionCalculationRequestSchemaData): DispersionCalculationRequest {
+    return new DispersionCalculationRequest(
+      data.material,
+      data.substrate,
+      data.dischargeResult,
+      data.dischargeRecords,
+      data.dischargeRecordCount,
+      data.weather,
+      data.dispersionParameters,
+      data.endPointConcentration
+    );
+  }
+}
+
+export class DispersionCalculation extends CalculationBase {
+  material: Entities.Material;
+  substrate: Entities.Substrate;
+  dischargeResult: Entities.DischargeResult;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  weather: Entities.Weather;
+  dispersionParameters: Entities.DispersionParameters;
+  endPointConcentration: number;
+  scalarUdmOutputs?: Entities.ScalarUdmOutputs;
+  dispersionRecords?: Entities.DispersionRecord[];
+  poolRecords?: Entities.PoolRecord[];
+
+  /**
+   * Calculates atmospheric dispersion of a source term (either instantaneous, fixed duration, or time-varying). Simulates the dispersion of one or more "observers", which are returned as outputs and can be used to obtain post-processed concentrations and other views of the dispersing cloud. Each observer is comprised of a number 
+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(
+    material: Entities.Material,
+    substrate: Entities.Substrate,
+    dischargeResult: Entities.DischargeResult,
+    dischargeRecords: Entities.DischargeRecord[],
+    dischargeRecordCount: number,
+    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;
+  }
+
+  async run() {
+    try {
+      const request = new DispersionCalculationRequest(
+        this.material,
+        this.substrate,
+        this.dischargeResult,
+        this.dischargeRecords,
+        this.dischargeRecordCount,
+        this.weather,
+        this.dispersionParameters,
+        this.endPointConcentration
+      );
+
+      const schema = new DispersionCalculationRequestSchema();
+      const validatedRequest = schema.validate(request);
+
+      const requestJson = JSON.stringify(validatedRequest);
+      const url = `${getAnalyticsApiTarget()}calculatedispersion?clientId=${getClientAliasId()}`;
+
+      this.resultCode = Enums.ResultCode.UNEXPECTED_APPLICATION_ERROR;
+
+      const response = await this.postRequest(url, requestJson);
+
+      if (response.status >= 200 && response.status < 300) {
+        const schema = new DispersionCalculationResponseSchema();
+        const validatedResponse = schema.validate(response.data);
+
+        this.resultCode = validatedResponse.resultCode;
+        if (this.resultCode === Enums.ResultCode.SUCCESS) {
+          this.scalarUdmOutputs = validatedResponse.scalarUdmOutputs;
+          this.dispersionRecords = validatedResponse.dispersionRecords;
+          this.poolRecords = validatedResponse.poolRecords;
+          this.resultCode = validatedResponse.resultCode;
+          this.messages = validatedResponse.messages ?? [];
+          this.calculationElapsedTime = validatedResponse.calculationElapsedTime;
+          this.operationId = validatedResponse.operationId;
+        } else {
+          this.messages.push(...(validatedResponse.messages ?? []));
+        }
+      } else {
+        this.handleFailedResponse(response);
+      }
+    } catch (error) {
+      if (error instanceof Error) {
+        this.messages.push(`Error: ${error.message}`);
+      } else {
+        this.messages.push(`Unexpected error: ${JSON.stringify(error)}`);
+      }
+      console.error(error);
+      this.resultCode = Enums.ResultCode.UNEXPECTED_APPLICATION_ERROR;
+    }
+
+    return this.resultCode;
+  }
+
+  toString() {
+    const parts = ["* Dispersion"];
+
+    parts.push(`scalarUdmOutputs: ${String(this.scalarUdmOutputs)}`);
+    parts.push("*** dispersionRecords:");
+    parts.push(
+      this.dispersionRecords && this.dispersionRecords.length > 0
+        ? this.dispersionRecords.map((point) => `dispersionRecordsElement: ${point}`).join("\n")
+        : "dispersionRecords does not contain any elements"
+    );
+    parts.push("*** poolRecords:");
+    parts.push(
+      this.poolRecords && this.poolRecords.length > 0
+        ? this.poolRecords.map((point) => `poolRecordsElement: ${point}`).join("\n")
+        : "poolRecords does not contain any elements"
+    );
+    parts.push(`resultCode: ${String(this.resultCode)}`);
+    parts.push("*** messages:");
+    parts.push(`messages: ${this.messages !== undefined ? this.messages : "(None)"}`);
+    parts.push(`calculationElapsedTime: ${this.calculationElapsedTime !== undefined ? this.calculationElapsedTime : "(None)"}`);
+    parts.push(`operationId: ${this.operationId !== undefined ? this.operationId : "(None)"}`);
+
+    return parts.join("\n");
+  }
+}
+
+export class DispersionCalculationResponse extends CalculationResponseBase {
+  scalarUdmOutputs: Entities.ScalarUdmOutputs;
+  dispersionRecords: Entities.DispersionRecord[];
+  poolRecords: Entities.PoolRecord[];
+
+  /**
+   * 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(
+    scalarUdmOutputs: Entities.ScalarUdmOutputs,
+    dispersionRecords: Entities.DispersionRecord[],
+    poolRecords: Entities.PoolRecord[],
+    resultCode: Enums.ResultCode,
+    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;
+  }
+
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    if (data.scalarUdmOutputs) {
+      this.scalarUdmOutputs = new Entities.ScalarUdmOutputs();
+      this.scalarUdmOutputs.initialiseFromDictionary(data.scalarUdmOutputs as { [key: string]: unknown });
+    }
+    if (data.dispersionRecords && Array.isArray(data.dispersionRecords)) {
+      this.dispersionRecords = data.dispersionRecords.map(
+        (item) => {
+          const record = new Entities.DispersionRecord();
+          record.initialiseFromDictionary(item);
+          return record;
+        }
+      );
+    }
+    if (data.poolRecords && Array.isArray(data.poolRecords)) {
+      this.poolRecords = data.poolRecords.map(
+        (item) => {
+          const record = new Entities.PoolRecord();
+          record.initialiseFromDictionary(item);
+          return record;
+        }
+      );
+    }
+    if (data.resultCode !== undefined && (typeof data.resultCode === "string" || typeof data.resultCode === "number")) {
+      this.resultCode = data.resultCode as Enums.ResultCode;
+    }
+    this.messages = this.messages ?? [];
+    if (data.messages && Array.isArray(data.messages)) {
+      this.messages.push(...data.messages);
+    }
+    if (data.calculationElapsedTime !== undefined && typeof data.calculationElapsedTime === "number") {
+      this.calculationElapsedTime = data.calculationElapsedTime as number;
+    }
+    if (data.operationId !== undefined && typeof data.operationId === "string") {
+      this.operationId = data.operationId as string;
+    }
+  }
+}
+
+export interface DispersionCalculationResponseSchemaData {
+  scalarUdmOutputs: Entities.ScalarUdmOutputs;
+  dispersionRecords: Entities.DispersionRecord[];
+  poolRecords: Entities.PoolRecord[];
+  resultCode: Enums.ResultCode;
+  messages: string[];
+  calculationElapsedTime: number;
+  operationId: string;
+}
+
+export class DispersionCalculationResponseSchema {
+  schema: Joi.ObjectSchema;
+  propertyTypes: Record<string, string>;
+
+  /**
+   * Schema for the Dispersion calculation response.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      scalarUdmOutputs: new EntitySchemas.ScalarUdmOutputsSchema().schema,
+      dispersionRecords: Joi.array().items(new EntitySchemas.DispersionRecordSchema().schema).allow(null),
+      poolRecords: Joi.array().items(new EntitySchemas.PoolRecordSchema().schema).allow(null),
+      resultCode: Joi.string().valid(...Object.values(Enums.ResultCode)),
+      messages: Joi.array().items(Joi.string()),
+      calculationElapsedTime: Joi.number().unsafe(),
+      operationId: Joi.string().uuid().allow(null),
+    }).unknown(true);
+
+    this.propertyTypes = {
+      scalarUdmOutputs: "Entities.ScalarUdmOutputs",
+      dispersionRecords: "Entities.DispersionRecord[]",
+      poolRecords: "Entities.PoolRecord[]",
+    };
+  }
+
+  validate(data: DispersionCalculationResponseSchemaData): DispersionCalculationResponse {
+    const { error, value } = this.schema.validate(data, { abortEarly: false });
+    if (error) {
+      throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    }
+    return this.makeCalculationResponse(value);
+  }
+
+  makeCalculationResponse(data: DispersionCalculationResponseSchemaData): DispersionCalculationResponse {
+    return new DispersionCalculationResponse(
+      data.scalarUdmOutputs,
+      data.dispersionRecords,
+      data.poolRecords,
+      data.resultCode,
+      data.messages,
+      data.calculationElapsedTime,
+      data.operationId
+    );
+  }
+}