@dnv-plant/typescriptpws 1.0.63 → 1.0.64

package/src/calculations/toxics.ts

@@ -1,7 +1,7 @@
 /***********************************************************************
  * This file has been auto-generated by a code generation tool.
- * Version:   1.0.63
- * Date/time: 01 Apr 2025 10:24:17
+ * Version:   1.0.64
+ * Date/time: 04 Apr 2025 15:02:06
  * Template:  templates/typescriptpws/calculations.razor.
  ***********************************************************************/
 
@@ -171,14 +171,14 @@ class LethalityDistanceCalculationRequest extends CalculationRequestBase {
   /**
    * LethalityDistance calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity with post-discharge composition.
+   * @param {Entities.Material} material -  a material entity with post-discharge composition.
    * @param {Entities.ScalarUdmOutputs} scalarUdmOutputs - Scalar dispersion results.
-   * @param {Entities.Weather} weather - A Weather entity.
-   * @param {Entities.DispersionRecord[]} dispersionRecords - An array of Dispersion Records.
-   * @param {number} dispersionRecordCount - Number of Dispersion Records.
-   * @param {Entities.Substrate} substrate - A substrate entity.
-   * @param {Entities.DispersionOutputConfig} dispersionOutputConfig - A Dispersion Output Config entity.
-   * @param {Entities.DispersionParameters} dispersionParameters - A Dispersion Parameters entity.
+   * @param {Entities.Weather} weather -  a weather entity.
+   * @param {Entities.DispersionRecord[]} dispersionRecords -  an array of dispersion records.
+   * @param {number} dispersionRecordCount - Number of dispersion records.
+   * @param {Entities.Substrate} substrate -  a substrate entity.
+   * @param {Entities.DispersionOutputConfig} dispersionOutputConfig -  a dispersion output config entity.
+   * @param {Entities.DispersionParameters} dispersionParameters -  a dispersion parameters entity.
    */
   constructor(
     material: Entities.Material,
@@ -269,14 +269,14 @@ export class LethalityDistanceCalculation extends CalculationBase {
   /**
    * Probability of death vs distance from a dispersing toxic cloud, down to the minimum probability of death.  Integrates dose over time at each location and uses probit relations to convert to a probability of death.  A successful dispersion calculation is required as inputfirst.
    *
-   * @param {Entities.Material} material - A Material entity with post-discharge composition.
+   * @param {Entities.Material} material -  a material entity with post-discharge composition.
    * @param {Entities.ScalarUdmOutputs} scalarUdmOutputs - Scalar dispersion results.
-   * @param {Entities.Weather} weather - A Weather entity.
-   * @param {Entities.DispersionRecord[]} dispersionRecords - An array of Dispersion Records.
-   * @param {number} dispersionRecordCount - Number of Dispersion Records.
-   * @param {Entities.Substrate} substrate - A substrate entity.
-   * @param {Entities.DispersionOutputConfig} dispersionOutputConfig - A Dispersion Output Config entity.
-   * @param {Entities.DispersionParameters} dispersionParameters - A Dispersion Parameters entity.
+   * @param {Entities.Weather} weather -  a weather entity.
+   * @param {Entities.DispersionRecord[]} dispersionRecords -  an array of dispersion records.
+   * @param {number} dispersionRecordCount - Number of dispersion records.
+   * @param {Entities.Substrate} substrate -  a substrate entity.
+   * @param {Entities.DispersionOutputConfig} dispersionOutputConfig -  a dispersion output config entity.
+   * @param {Entities.DispersionParameters} dispersionParameters -  a dispersion parameters entity.
    */
   constructor(
     material: Entities.Material,
@@ -377,7 +377,7 @@ export class LethalityDistanceCalculationResponse extends CalculationResponseBas
   /**
    * LethalityDistance calculation response class.
    *
-   * @param {Entities.ToxicRecord[]} toxicRecords - An Array of Toxic Records.
+   * @param {Entities.ToxicRecord[]} toxicRecords -  an array of toxic records.
    */
   constructor(
     toxicRecords: Entities.ToxicRecord[],

package/src/calculations/utilities.ts

@@ -1,7 +1,7 @@
 /***********************************************************************
  * This file has been auto-generated by a code generation tool.
- * Version:   1.0.63
- * Date/time: 01 Apr 2025 10:24:17
+ * Version:   1.0.64
+ * Date/time: 04 Apr 2025 15:02:06
  * Template:  templates/typescriptpws/calculations.razor.
  ***********************************************************************/
 
@@ -161,7 +161,7 @@ class ConvertCompositionMassToMoleCalculationRequest extends CalculationRequestB
   /**
    * ConvertCompositionMassToMole calculation request class.
    *
-   * @param {Entities.Material} mixture - A Material entity with two or more Material Components to have composition converted.
+   * @param {Entities.Material} mixture -  a material entity with two or more material components to have composition converted.
    * @param {number[]} compositionMass - Array of mass fractions.
    * @param {number} compositionMassCount - Number of components in mixture.
    */
@@ -224,7 +224,7 @@ export class ConvertCompositionMassToMoleCalculation extends CalculationBase {
   /**
    * Converts mixture composition from mass to mole basis.
    *
-   * @param {Entities.Material} mixture - A Material entity with two or more Material Components to have composition converted.
+   * @param {Entities.Material} mixture -  a material entity with two or more material components to have composition converted.
    * @param {number[]} compositionMass - Array of mass fractions.
    * @param {number} compositionMassCount - Number of components in mixture.
    */
@@ -411,7 +411,7 @@ class ConvertCompositionMoleToMassCalculationRequest extends CalculationRequestB
   /**
    * ConvertCompositionMoleToMass calculation request class.
    *
-   * @param {Entities.Material} mixture - A Material entity with two or more Material Components to have composition converted.
+   * @param {Entities.Material} mixture -  a material entity with two or more material components to have composition converted.
    * @param {number[]} compositionMoles - Array of mole fractions.
    * @param {number} compositionMolesCount - Number of components in mixture.
    */
@@ -474,7 +474,7 @@ export class ConvertCompositionMoleToMassCalculation extends CalculationBase {
   /**
    * Converts mixture composition from mole to mass basis.
    *
-   * @param {Entities.Material} mixture - A Material entity with two or more Material Components to have composition converted.
+   * @param {Entities.Material} mixture -  a material entity with two or more material components to have composition converted.
    * @param {number[]} compositionMoles - Array of mole fractions.
    * @param {number} compositionMolesCount - Number of components in mixture.
    */
@@ -657,7 +657,7 @@ class GetMassFromVesselCalculationRequest extends CalculationRequestBase {
   /**
    * GetMassFromVessel calculation request class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     vessel: Entities.Vessel
@@ -706,7 +706,7 @@ export class GetMassFromVesselCalculation extends CalculationBase {
   /**
    * Calculates the mass in a vessel.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     vessel: Entities.Vessel
@@ -888,7 +888,7 @@ class LoadMassInventoryVesselForLeakScenarioCalculationRequest extends Calculati
   /**
    * LoadMassInventoryVesselForLeakScenario calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Temperature of the fluid.
@@ -980,7 +980,7 @@ export class LoadMassInventoryVesselForLeakScenarioCalculation extends Calculati
   /**
    * Sets up a vessel and a leak scenario from a mass inventory, pressure, temperature and hole size specifications.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Temperature of the fluid.
@@ -1082,8 +1082,8 @@ export class LoadMassInventoryVesselForLeakScenarioCalculationResponse extends C
   /**
    * LoadMassInventoryVesselForLeakScenario calculation response class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.Leak} leak - A Leak entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.Leak} leak -  a leak entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1203,12 +1203,12 @@ class LoadMassInventoryVesselForLineRuptureScenarioCalculationRequest extends Ca
   /**
    * LoadMassInventoryVesselForLineRuptureScenario calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Temperature of the fluid.
    * @param {number} pipeDiameter - Internal diameter of the pipe.
-   * @param {number} pipeLength - length of the pipe.
+   * @param {number} pipeLength - Length of the pipe.
    * @param {number} releaseElevation - Elevation of the release above ground level.
    * @param {number} releaseAngle - Angle of release above a horizontal plane.
    */
@@ -1302,12 +1302,12 @@ export class LoadMassInventoryVesselForLineRuptureScenarioCalculation extends Ca
   /**
    * Sets up a vessel and a line rupture scenario from a mass inventory, pressure, temperature  pipe diameter and length specifications.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Temperature of the fluid.
    * @param {number} pipeDiameter - Internal diameter of the pipe.
-   * @param {number} pipeLength - length of the pipe.
+   * @param {number} pipeLength - Length of the pipe.
    * @param {number} releaseElevation - Elevation of the release above ground level.
    * @param {number} releaseAngle - Angle of release above a horizontal plane.
    */
@@ -1408,8 +1408,8 @@ export class LoadMassInventoryVesselForLineRuptureScenarioCalculationResponse ex
   /**
    * LoadMassInventoryVesselForLineRuptureScenario calculation response class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.LineRupture} lineRupture - A Line Rupture entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.LineRupture} lineRupture -  a line rupture entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1531,7 +1531,7 @@ class LoadMassInventoryVesselForReliefValveScenarioCalculationRequest extends Ca
   /**
    * LoadMassInventoryVesselForReliefValveScenario calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Tmperature of the fluid.
@@ -1637,7 +1637,7 @@ export class LoadMassInventoryVesselForReliefValveScenarioCalculation extends Ca
   /**
    * Sets up a vessel and a relief valve scenario from a mass inventory, pressure, temperature pipe diameter, length and constriction size specifications.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} mass - Total vessel mass inventory.
    * @param {number} pressure - Absolute pressure of the fluid.
    * @param {number} temperature - Tmperature of the fluid.
@@ -1747,8 +1747,8 @@ export class LoadMassInventoryVesselForReliefValveScenarioCalculationResponse ex
   /**
    * LoadMassInventoryVesselForReliefValveScenario calculation response class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.ReliefValve} reliefValve - A Relief Valve entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.ReliefValve} reliefValve -  a relief valve entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1856,7 +1856,7 @@ class ReliefValveMinTemperatureCalculationRequest extends CalculationRequestBase
   /**
    * ReliefValveMinTemperature calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} pressure - Input pressure (absolute) at which to evaluate bubble point temperature.
    */
   constructor(
@@ -1912,7 +1912,7 @@ export class ReliefValveMinTemperatureCalculation extends CalculationBase {
   /**
    * The Relief Valve scenario does not allow fluid conditions to be liquid. As such, his method calculates the lower limit for the input temperature to ensure vapour or two-phase fluid state.
    *
-   * @param {Entities.Material} material - A Material entity.
+   * @param {Entities.Material} material -  a material entity.
    * @param {number} pressure - Input pressure (absolute) at which to evaluate bubble point temperature.
    */
   constructor(
@@ -2086,7 +2086,7 @@ class SetMixingLayerHeightCalculationRequest extends CalculationRequestBase {
   /**
    * SetMixingLayerHeight calculation request class.
    *
-   * @param {Entities.Weather} weather - A Weather entity.
+   * @param {Entities.Weather} weather -  a weather entity.
    */
   constructor(
     weather: Entities.Weather
@@ -2135,7 +2135,7 @@ export class SetMixingLayerHeightCalculation extends CalculationBase {
   /**
    * Updates the mixing layer height in a weather according to the stability class,.
    *
-   * @param {Entities.Weather} weather - A Weather entity.
+   * @param {Entities.Weather} weather -  a weather entity.
    */
   constructor(
     weather: Entities.Weather
@@ -2210,7 +2210,7 @@ export class SetMixingLayerHeightCalculationResponse extends CalculationResponse
   /**
    * SetMixingLayerHeight calculation response class.
    *
-   * @param {Entities.Weather} updatedWeather - Updated Weather entity.
+   * @param {Entities.Weather} updatedWeather - Updated weather entity.
    */
   constructor(
     updatedWeather: Entities.Weather,
@@ -2312,7 +2312,7 @@ class SetPhaseToReleaseForLeakScenarioCalculationRequest extends CalculationRequ
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -2376,7 +2376,7 @@ export class SetPhaseToReleaseForLeakScenarioCalculation extends CalculationBase
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -2571,7 +2571,7 @@ class SetPhaseToReleaseForLineRuptureScenarioCalculationRequest extends Calculat
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -2635,7 +2635,7 @@ export class SetPhaseToReleaseForLineRuptureScenarioCalculation extends Calculat
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -2830,7 +2830,7 @@ class SetPhaseToReleaseForReliefValveScenarioCalculationRequest extends Calculat
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -2894,7 +2894,7 @@ export class SetPhaseToReleaseForReliefValveScenarioCalculation extends Calculat
    *
    * @param {Enums.Phase} phaseToRelease - Requested fluid phase to release.
    * @param {number} releaseElevation - Release point elevation above ground.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     phaseToRelease: Enums.Phase,
@@ -3089,7 +3089,7 @@ class SetReleaseElevationForScenarioCalculationRequest extends CalculationReques
    *
    * @param {number} releaseElevation - Release point elevation above ground.
    * @param {number} releaseHeightFraction - Release height fraction of the total vessel height.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     releaseElevation: number,
@@ -3152,7 +3152,7 @@ export class SetReleaseElevationForScenarioCalculation extends CalculationBase {
    *
    * @param {number} releaseElevation - Release point elevation above ground.
    * @param {number} releaseHeightFraction - Release height fraction of the total vessel height.
-   * @param {Entities.Vessel} vessel - A Vessel entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
    */
   constructor(
     releaseElevation: number,
@@ -3233,7 +3233,7 @@ export class SetReleaseElevationForScenarioCalculationResponse extends Calculati
   /**
    * SetReleaseElevationForScenario calculation response class.
    *
-   * @param {Entities.Vessel} updatedVessel - Updated Vessel entity with modified z coordinate.
+   * @param {Entities.Vessel} updatedVessel - Updated vessel entity with modified z coordinate.
    */
   constructor(
     updatedVessel: Entities.Vessel,

package/src/constants.ts

@@ -1,7 +1,7 @@
 /***********************************************************************
  * This file has been auto-generated by a code generation tool.
- * Version:   1.0.63
- * Date/time: 01 Apr 2025 10:24:15
+ * Version:   1.0.64
+ * Date/time: 04 Apr 2025 15:02:03
  * Template:  templates/typescriptpws/constants.razor.
  ***********************************************************************/
 
@@ -23,6 +23,30 @@ export const ATM_PRESSURE = 101325.0;
 export const AWD_FLAG = 3;
 // Along wind diffusion method for non instantaneous dispersion.
 
+export const BESS_MAX_ANGLE = 90;
+// Maximum release angle for a BESS event (deg.).
+
+export const BESS_MAX_DURATION = 3600;
+// Maximum duration of a BESS event (s).
+
+export const BESS_MIN_ANGLE = 0;
+// Minimum release angle for a BESS event (deg.).
+
+export const BESS_MIN_AREA = 0;
+// Minimum area for a BESS release source (m2).
+
+export const BESS_MIN_DURATION = 0;
+// Minimum duration of a BESS event (s).
+
+export const BESS_MIN_ENERGY = 0;
+// Minimum energy capacity for a BESS unit (kWh).
+
+export const BESS_MIN_HEIGHT = 0;
+// Minimum release height for a BESS event (m).
+
+export const BESS_MIN_TEMP = 273.15;
+// Minimum gas temperature for a BESS event (K).
+
 export const BUND_AREA_MULTIPLIER_FOR_RUPTURE = 1.5;
 // Bund area multiplier for catastrophic ruptures.
 
@@ -299,9 +323,6 @@ export const USER_INPUT_POST_EXPANSION_VELOCITY = 0;
 export const WIND_CUTOFF_HEIGHT = 1.0;
 // Cut-off height for wind speed calculations.
 
-export const WIND_PROFILE_FLAG = 4;
-// Logarithmic wind profile.
-
 export const PWS_CLIENT_ID = "eeca6885-127e-4405-aa1f-3a8e69acc451";
 // Application constants.