@dnv-plant/typescriptpws 1.0.63 → 1.0.64

package/index.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/index.razor.
  ***********************************************************************/
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dnv-plant/typescriptpws",
-  "version": "1.0.63",
+  "version": "1.0.64",
   "description": "Integrate Phast models with our versatile APIs for enhanced customization and efficiency.",
   "main": "index.ts",
   "scripts": {

package/src/calculations/applicationTools.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.
  ***********************************************************************/
 
@@ -157,7 +157,7 @@ class MixtureConstantPropertiesCalculationRequest extends CalculationRequestBase
   /**
    * MixtureConstantProperties calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity representing a mixture.
+   * @param {Entities.Material} material -  a material entity representing a mixture.
    */
   constructor(
     material: Entities.Material
@@ -206,7 +206,7 @@ export class MixtureConstantPropertiesCalculation extends CalculationBase {
   /**
    * Calculates constant fluid properties for a mixture.
    *
-   * @param {Entities.Material} material - A Material entity representing a mixture.
+   * @param {Entities.Material} material -  a material entity representing a mixture.
    */
   constructor(
     material: Entities.Material

package/src/calculations/discharge.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,9 +161,9 @@ class LongPipeBreachCalculationRequest extends CalculationRequestBase {
   /**
    * LongPipeBreach calculation request class.
    *
-   * @param {Entities.Pipe} pipe - A Pipe entity.
-   * @param {Entities.PipeBreach} pipeBreach - A Pipe Breach entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Pipe} pipe -  a pipe entity.
+   * @param {Entities.PipeBreach} pipeBreach -  a pipe breach entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     pipe: Entities.Pipe,
@@ -229,9 +229,9 @@ export class LongPipeBreachCalculation extends CalculationBase {
 state entity for which pressure gauge is not the right definition, i.e. the final state discharge, state specification for 
 flash calculation, etc.
    *
-   * @param {Entities.Pipe} pipe - A Pipe entity.
-   * @param {Entities.PipeBreach} pipeBreach - A Pipe Breach entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Pipe} pipe -  a pipe entity.
+   * @param {Entities.PipeBreach} pipeBreach -  a pipe breach entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     pipe: Entities.Pipe,
@@ -323,9 +323,9 @@ export class LongPipeBreachCalculationResponse extends CalculationResponseBase {
   /**
    * LongPipeBreach calculation response class.
    *
-   * @param {Entities.Material} exitMaterial - A Material entity, representing composition of the released material.
+   * @param {Entities.Material} exitMaterial -  a material entity, representing composition of the released material.
    * @param {Entities.DischargeResult} dischargeResult - Scalar discharge results.
-   * @param {Entities.DischargeRecord[]} dischargeRecords - An array of discharge records.
+   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
    */
   constructor(
     exitMaterial: Entities.Material,
@@ -448,8 +448,8 @@ class VesselCatastrophicRuptureCalculationRequest extends CalculationRequestBase
   /**
    * VesselCatastrophicRupture calculation request class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -506,8 +506,8 @@ export class VesselCatastrophicRuptureCalculation extends CalculationBase {
   /**
    * Calculates the instantaneous release from a pressure vessel or storage tank. It includes expansion modelling to atmospheric conditions. The discharge mass, temperature, and other outputs are reported back as discharge records. The height of the release is located at the midpoint of the vessel.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -596,9 +596,9 @@ export class VesselCatastrophicRuptureCalculationResponse extends CalculationRes
   /**
    * VesselCatastrophicRupture calculation response class.
    *
-   * @param {Entities.Material} exitMaterial - A Material entity representing the released material (indentical to storage composition).
+   * @param {Entities.Material} exitMaterial -  a material entity representing the released material (indentical to storage composition).
    * @param {Entities.DischargeResult} dischargeResult - Scalar discharge results.
-   * @param {Entities.DischargeRecord[]} dischargeRecords - An array of Discharge Records.
+   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
    */
   constructor(
     exitMaterial: Entities.Material,
@@ -723,9 +723,9 @@ class VesselLeakCalculationRequest extends CalculationRequestBase {
   /**
    * VesselLeak calculation request class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.Leak} leak - A Leak entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.Leak} leak -  a leak entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -788,9 +788,9 @@ export class VesselLeakCalculation extends CalculationBase {
   /**
    * Calculates the steady state or time-varying leak from a pressure vessel or storage tank. It includes expansion modelling (from the vessel orifice to atmospheric conditions). The discharge rate, temperature, and other time-dependent outputs at a particular time are reported back as discharge records. For steady-state there are always two DischargeRecords generated; for time-varying the number can vary.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.Leak} leak - A Leak entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.Leak} leak -  a leak entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -882,9 +882,9 @@ export class VesselLeakCalculationResponse extends CalculationResponseBase {
   /**
    * VesselLeak calculation response class.
    *
-   * @param {Entities.Material} exitMaterial - A Material entity representing the released material (may differ from storage composition).
+   * @param {Entities.Material} exitMaterial -  a material entity representing the released material (may differ from storage composition).
    * @param {Entities.DischargeResult} dischargeResult - Scalar discharge results.
-   * @param {Entities.DischargeRecord[]} dischargeRecords - An array of Discharge Records.
+   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
    */
   constructor(
     exitMaterial: Entities.Material,
@@ -1009,9 +1009,9 @@ class VesselLineRuptureCalculationRequest extends CalculationRequestBase {
   /**
    * VesselLineRupture calculation request class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.LineRupture} lineRupture - A Line Rupture entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.LineRupture} lineRupture -  a line rupture entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1074,9 +1074,9 @@ export class VesselLineRuptureCalculation extends CalculationBase {
   /**
    * Calculations of discharge from a short pipe attached to a vessel.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.LineRupture} lineRupture - A Line Rupture entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.LineRupture} lineRupture -  a line rupture entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1168,9 +1168,9 @@ export class VesselLineRuptureCalculationResponse extends CalculationResponseBas
   /**
    * VesselLineRupture calculation response class.
    *
-   * @param {Entities.Material} exitMaterial - A Material entity representing the released material (which may differ from storage composition).
+   * @param {Entities.Material} exitMaterial -  a material entity representing the released material (which may differ from storage composition).
    * @param {Entities.DischargeResult} dischargeResult - Scalar discharge results.
-   * @param {Entities.DischargeRecord[]} dischargeRecords - An array of Discharge Records.
+   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
    */
   constructor(
     exitMaterial: Entities.Material,
@@ -1295,9 +1295,9 @@ class VesselReliefValveCalculationRequest extends CalculationRequestBase {
   /**
    * VesselReliefValve calculation request class.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.ReliefValve} reliefValve - A Relief Valve entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.ReliefValve} reliefValve -  a relief valve entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1360,9 +1360,9 @@ export class VesselReliefValveCalculation extends CalculationBase {
   /**
    * Calculations of venting from a relief valve attached to a vessel.
    *
-   * @param {Entities.Vessel} vessel - A Vessel entity.
-   * @param {Entities.ReliefValve} reliefValve - A Relief Valve entity.
-   * @param {Entities.DischargeParameters} dischargeParameters - A Discharge Parameters entity.
+   * @param {Entities.Vessel} vessel -  a vessel entity.
+   * @param {Entities.ReliefValve} reliefValve -  a relief valve entity.
+   * @param {Entities.DischargeParameters} dischargeParameters -  a discharge parameters entity.
    */
   constructor(
     vessel: Entities.Vessel,
@@ -1454,9 +1454,9 @@ export class VesselReliefValveCalculationResponse extends CalculationResponseBas
   /**
    * VesselReliefValve calculation response class.
    *
-   * @param {Entities.Material} exitMaterial - A Material entity representing the released material (which may differ from storage composition).
+   * @param {Entities.Material} exitMaterial -  a material entity representing the released material (which may differ from storage composition).
    * @param {Entities.DischargeResult} dischargeResult - Scalar discharge results.
-   * @param {Entities.DischargeRecord[]} dischargeRecords - An array of Discharge Records.
+   * @param {Entities.DischargeRecord[]} dischargeRecords -  an array of discharge records.
    */
   constructor(
     exitMaterial: Entities.Material,
@@ -1579,8 +1579,8 @@ class VesselStateCalculationRequest extends CalculationRequestBase {
   /**
    * VesselState calculation request class.
    *
-   * @param {Entities.Material} material - A Material entity.
-   * @param {Entities.State} materialState - A State entity describing the fluid pressure, temperature, liquid fraction.
+   * @param {Entities.Material} material -  a material entity.
+   * @param {Entities.State} materialState -  a state entity describing the fluid pressure, temperature, liquid fraction.
    */
   constructor(
     material: Entities.Material,
@@ -1638,8 +1638,8 @@ export class VesselStateCalculation extends CalculationBase {
 the vessel conditions (e.g. Pure gas, Stratified Two-Phase vessel, Pressurised Liquid) that can be input to the 
 source term models: vessel leak and vessel catastrophic rupture.
    *
-   * @param {Entities.Material} material - A Material entity.
-   * @param {Entities.State} materialState - A State entity describing the fluid pressure, temperature, liquid fraction.
+   * @param {Entities.Material} material -  a material entity.
+   * @param {Entities.State} materialState -  a state entity describing the fluid pressure, temperature, liquid fraction.
    */
   constructor(
     material: Entities.Material,
@@ -1721,7 +1721,7 @@ export class VesselStateCalculationResponse extends CalculationResponseBase {
    * VesselState calculation response class.
    *
    * @param {Enums.VesselConditions} vesselConditions - The conditions of the material in the vessel.
-   * @param {Entities.State} outputState - A State entity describing the fluid pressure, temperature and liquid fraction after the flash calculation.
+   * @param {Entities.State} outputState -  a state entity describing the fluid pressure, temperature and liquid fraction after the flash calculation.
    */
   constructor(
     vesselConditions: Enums.VesselConditions,

package/src/calculations/dispersion.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,13 +171,13 @@ 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.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 {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(
@@ -273,13 +273,13 @@ 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.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 {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(
@@ -393,8 +393,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.
+   * @param {Entities.DispersionRecord[]} dispersionRecords -  an array of dispersion records.
+   * @param {Entities.PoolRecord[]} poolRecords -  an array of pool records.
    */
   constructor(
     scalarUdmOutputs: Entities.ScalarUdmOutputs,