@dnv-plant/typescriptpws 1.0.63 → 1.0.64

package/src/entities.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:16
+ * Version:   1.0.64
+ * Date/time: 04 Apr 2025 15:02:04
  * Template:  templates/typescriptpws/entities.razor.
  ***********************************************************************/
 
@@ -401,6 +401,208 @@ export class AtmosphericStorageTank extends Asset {
   }
 }
 
+export class Scenario extends EntityBase {
+  /**
+   * Base struct/class for all scenario types.
+   *
+   */
+  constructor(options?: {
+    id?: string;
+    typeId?: string;
+    displayName?: string;
+  }) {
+    super(options?.id, options?.typeId, options?.displayName);
+  }
+
+  /** Initialise the entity with data from a dictionary. */
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    super.initialiseFromDictionary(data);
+  }
+
+  toString() {
+    const parts = [
+      super.toString(),
+      "* Scenario",
+    ];
+    return parts.join("\n");
+  }
+}
+
+export class ReleaseOverTime extends Scenario {
+  releaseAngle: number;
+  timeVaryingOption?: Enums.TimeVaryingOption;
+
+  /**
+   * Scenario representing a release over time.
+   *
+   * @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
+   * @param {Enums.TimeVaryingOption} timeVaryingOption - Whether the release is a time-varying release or a steady state release using the initial rate. (default value is Enums.TimeVaryingOption.INITIAL_RATE)
+   */
+  constructor(options?: {
+    id?: string;
+    typeId?: string;
+    displayName?: string;
+    releaseAngle?: number;
+    timeVaryingOption?: Enums.TimeVaryingOption;
+  }) {
+    super(options);
+    this.releaseAngle = options?.releaseAngle ?? 0.0; 
+    this.timeVaryingOption = options?.timeVaryingOption ?? Enums.TimeVaryingOption.INITIAL_RATE; 
+  }
+
+  /** Initialise the entity with data from a dictionary. */
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    super.initialiseFromDictionary(data);
+    if (data.releaseAngle !== undefined && typeof data.releaseAngle === "number") {
+      this.releaseAngle = data.releaseAngle as number;
+    }
+    if (data.timeVaryingOption !== undefined && (typeof data.timeVaryingOption === "string" || typeof data.timeVaryingOption === "number")) {
+      this.timeVaryingOption = this.parseEnumValue(data.timeVaryingOption, Enums.TimeVaryingOption);
+    }
+  }
+
+  private parseEnumValue<T extends object>(value: unknown, enumType: T): T[keyof T] | undefined {
+    if (typeof value === "string" && value in enumType) {
+      return enumType[value as keyof T];
+    } else if (typeof value === "number" && Object.values(enumType).includes(value)) {
+      return value as T[keyof T];
+    }
+    return undefined; // Return undefined if the value does not match the enum
+  }
+
+  toString() {
+    const parts = [
+      super.toString(),
+      "* ReleaseOverTime",
+      `releaseAngle:    ${this.releaseAngle}`,
+      `timeVaryingOption:    ${this.timeVaryingOption}`,
+    ];
+    return parts.join("\n");
+  }
+}
+
+export class BESSRelease extends ReleaseOverTime {
+  height?: number;
+  area?: number;
+  temperature?: number;
+  duration?: number;
+
+  /**
+   * A release from a BESS unit in thermal runaway.
+   *
+   * @param {number} height - The height from which the release occurs.
+   * @param {number} area - The area over which the release occurs.
+   * @param {number} temperature - The exit temperature of the release (from the BESS unit).
+   * @param {number} duration - The duration of the release.
+   * @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
+   * @param {Enums.TimeVaryingOption} timeVaryingOption - Whether the release is a time-varying release or a steady state release using the initial rate. (default value is Enums.TimeVaryingOption.INITIAL_RATE)
+   */
+  constructor(options?: {
+    id?: string;
+    typeId?: string;
+    displayName?: string;
+    height?: number;
+    area?: number;
+    temperature?: number;
+    duration?: number;
+    releaseAngle?: number;
+    timeVaryingOption?: Enums.TimeVaryingOption;
+  }) {
+    super(options);
+    this.height = options?.height; 
+    this.area = options?.area; 
+    this.temperature = options?.temperature; 
+    this.duration = options?.duration; 
+  }
+
+  /** Initialise the entity with data from a dictionary. */
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    super.initialiseFromDictionary(data);
+    if (data.height !== undefined && typeof data.height === "number") {
+      this.height = data.height as number;
+    }
+    if (data.area !== undefined && typeof data.area === "number") {
+      this.area = data.area as number;
+    }
+    if (data.temperature !== undefined && typeof data.temperature === "number") {
+      this.temperature = data.temperature as number;
+    }
+    if (data.duration !== undefined && typeof data.duration === "number") {
+      this.duration = data.duration as number;
+    }
+  }
+
+  toString() {
+    const parts = [
+      super.toString(),
+      "* BESSRelease",
+      `height:    ${this.height}`,
+      `area:    ${this.area}`,
+      `temperature:    ${this.temperature}`,
+      `duration:    ${this.duration}`,
+      `releaseAngle:    ${this.releaseAngle}`,
+      `timeVaryingOption:    ${this.timeVaryingOption}`,
+    ];
+    return parts.join("\n");
+  }
+}
+
+export class BESSUnit extends Asset {
+  energyCapacity?: number;
+  chemistry?: Enums.BESSChemistry;
+
+  /**
+   * A BESS unit, containing Li-ion betteries.
+   *
+   * @param {LocalPosition} location - Location of the asset.
+   * @param {number} energyCapacity - The energy capacity of the installation.
+   * @param {Enums.BESSChemistry} chemistry - The chemistry type of the BESS unit. (default value is Enums.BESSChemistry.LFP)
+   */
+  constructor(options?: {
+    id?: string;
+    typeId?: string;
+    displayName?: string;
+    location?: LocalPosition;
+    energyCapacity?: number;
+    chemistry?: Enums.BESSChemistry;
+  }) {
+    super(options);
+    this.energyCapacity = options?.energyCapacity; 
+    this.chemistry = options?.chemistry ?? Enums.BESSChemistry.LFP; 
+  }
+
+  /** Initialise the entity with data from a dictionary. */
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    super.initialiseFromDictionary(data);
+    if (data.energyCapacity !== undefined && typeof data.energyCapacity === "number") {
+      this.energyCapacity = data.energyCapacity as number;
+    }
+    if (data.chemistry !== undefined && (typeof data.chemistry === "string" || typeof data.chemistry === "number")) {
+      this.chemistry = this.parseEnumValue(data.chemistry, Enums.BESSChemistry);
+    }
+  }
+
+  private parseEnumValue<T extends object>(value: unknown, enumType: T): T[keyof T] | undefined {
+    if (typeof value === "string" && value in enumType) {
+      return enumType[value as keyof T];
+    } else if (typeof value === "number" && Object.values(enumType).includes(value)) {
+      return value as T[keyof T];
+    }
+    return undefined; // Return undefined if the value does not match the enum
+  }
+
+  toString() {
+    const parts = [
+      super.toString(),
+      "* BESSUnit",
+      `location:    ${this.location?.toString()}`,
+      `energyCapacity:    ${this.energyCapacity}`,
+      `chemistry:    ${this.chemistry}`,
+    ];
+    return parts.join("\n");
+  }
+}
+
 export class Bund extends EntityBase {
   bundHeight: number;
   bundDiameter: number;
@@ -453,33 +655,6 @@ export class Bund extends EntityBase {
   }
 }
 
-export class Scenario extends EntityBase {
-  /**
-   * Base struct/class for all scenario types.
-   *
-   */
-  constructor(options?: {
-    id?: string;
-    typeId?: string;
-    displayName?: string;
-  }) {
-    super(options?.id, options?.typeId, options?.displayName);
-  }
-
-  /** Initialise the entity with data from a dictionary. */
-  initialiseFromDictionary(data: { [key: string]: unknown }) {
-    super.initialiseFromDictionary(data);
-  }
-
-  toString() {
-    const parts = [
-      super.toString(),
-      "* Scenario",
-    ];
-    return parts.join("\n");
-  }
-}
-
 export class Instantaneous extends Scenario {
   /**
    * Base struct/class for instantaneous release scenarios.
@@ -2144,59 +2319,6 @@ export class FlashResult extends EntityBase {
   }
 }
 
-export class ReleaseOverTime extends Scenario {
-  releaseAngle: number;
-  timeVaryingOption?: Enums.TimeVaryingOption;
-
-  /**
-   * Scenario representing a release over time.
-   *
-   * @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
-   * @param {Enums.TimeVaryingOption} timeVaryingOption - Whether the release is a time-varying release or a steady state release using the initial rate. (default value is Enums.TimeVaryingOption.INITIAL_RATE)
-   */
-  constructor(options?: {
-    id?: string;
-    typeId?: string;
-    displayName?: string;
-    releaseAngle?: number;
-    timeVaryingOption?: Enums.TimeVaryingOption;
-  }) {
-    super(options);
-    this.releaseAngle = options?.releaseAngle ?? 0.0; 
-    this.timeVaryingOption = options?.timeVaryingOption ?? Enums.TimeVaryingOption.INITIAL_RATE; 
-  }
-
-  /** Initialise the entity with data from a dictionary. */
-  initialiseFromDictionary(data: { [key: string]: unknown }) {
-    super.initialiseFromDictionary(data);
-    if (data.releaseAngle !== undefined && typeof data.releaseAngle === "number") {
-      this.releaseAngle = data.releaseAngle as number;
-    }
-    if (data.timeVaryingOption !== undefined && (typeof data.timeVaryingOption === "string" || typeof data.timeVaryingOption === "number")) {
-      this.timeVaryingOption = this.parseEnumValue(data.timeVaryingOption, Enums.TimeVaryingOption);
-    }
-  }
-
-  private parseEnumValue<T extends object>(value: unknown, enumType: T): T[keyof T] | undefined {
-    if (typeof value === "string" && value in enumType) {
-      return enumType[value as keyof T];
-    } else if (typeof value === "number" && Object.values(enumType).includes(value)) {
-      return value as T[keyof T];
-    }
-    return undefined; // Return undefined if the value does not match the enum
-  }
-
-  toString() {
-    const parts = [
-      super.toString(),
-      "* ReleaseOverTime",
-      `releaseAngle:    ${this.releaseAngle}`,
-      `timeVaryingOption:    ${this.timeVaryingOption}`,
-    ];
-    return parts.join("\n");
-  }
-}
-
 export class Leak extends ReleaseOverTime {
   holeDiameter?: number;
   holeHeightFraction: number;
@@ -3845,6 +3967,7 @@ export class Weather extends EntityBase {
   relativeHumidity: number;
   mixingLayerHeight: number;
   solarRadiation: number;
+  windProfileFlag?: Enums.WindProfileFlag;
 
   /**
    * A set of weather conditions for use in the modelling of a release and its effects.
@@ -3855,6 +3978,7 @@ export class Weather extends EntityBase {
    * @param {number} relativeHumidity - The amount of water vapour present in the air compared to the maximum amount the air can hold at a given temperature. (default value is 0.7)
    * @param {number} mixingLayerHeight - The height of the atmospheric boundary layer which caps the centreline of the plume. (default value is 800)
    * @param {number} solarRadiation - The radiation received from the sun, which contributes to pool evaporation. (default value is 500)
+   * @param {Enums.WindProfileFlag} windProfileFlag - Wind profile flag. (default value is Enums.WindProfileFlag.LOGARITHMIC_PROFILE)
    */
   constructor(options?: {
     id?: string;
@@ -3866,6 +3990,7 @@ export class Weather extends EntityBase {
     relativeHumidity?: number;
     mixingLayerHeight?: number;
     solarRadiation?: number;
+    windProfileFlag?: Enums.WindProfileFlag;
   }) {
     super(options?.id, options?.typeId, options?.displayName);
     this.windSpeed = options?.windSpeed ?? 5; 
@@ -3874,6 +3999,7 @@ export class Weather extends EntityBase {
     this.relativeHumidity = options?.relativeHumidity ?? 0.7; 
     this.mixingLayerHeight = options?.mixingLayerHeight ?? 800; 
     this.solarRadiation = options?.solarRadiation ?? 500; 
+    this.windProfileFlag = options?.windProfileFlag ?? Enums.WindProfileFlag.LOGARITHMIC_PROFILE; 
   }
 
   /** Initialise the entity with data from a dictionary. */
@@ -3897,6 +4023,9 @@ export class Weather extends EntityBase {
     if (data.solarRadiation !== undefined && typeof data.solarRadiation === "number") {
       this.solarRadiation = data.solarRadiation as number;
     }
+    if (data.windProfileFlag !== undefined && (typeof data.windProfileFlag === "string" || typeof data.windProfileFlag === "number")) {
+      this.windProfileFlag = this.parseEnumValue(data.windProfileFlag, Enums.WindProfileFlag);
+    }
   }
 
   private parseEnumValue<T extends object>(value: unknown, enumType: T): T[keyof T] | undefined {
@@ -3918,6 +4047,7 @@ export class Weather extends EntityBase {
       `relativeHumidity:    ${this.relativeHumidity}`,
       `mixingLayerHeight:    ${this.mixingLayerHeight}`,
       `solarRadiation:    ${this.solarRadiation}`,
+      `windProfileFlag:    ${this.windProfileFlag}`,
     ];
     return parts.join("\n");
   }

package/src/entity-schemas.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:16
+ * Version:   1.0.64
+ * Date/time: 04 Apr 2025 15:02:05
  * Template:  templates/typescriptpws/entityschemas.razor.
  ***********************************************************************/
 
@@ -336,26 +336,54 @@ export class AtmosphericStorageTankSchema extends SchemaBase<AtmosphericStorageT
   }
 }
 
-export interface BundSchemaData extends SchemaBaseData {
-  bundHeight: number;
-  bundDiameter: number;
-  specifyBund: boolean;
+export interface ScenarioSchemaData extends SchemaBaseData {}
+
+/**
+ * ================================================================================
+ * Class:        ScenarioSchema
+ * Description:  Base struct/class for all scenario types.
+ * ================================================================================
+ */
+export class ScenarioSchema extends SchemaBase<ScenarioSchemaData> {
+  constructor() {
+    super();
+    this.schema = this.schema.concat(
+      Joi.object()
+    )
+    .pattern(
+      ignoredPropertiesRegex,
+      Joi.alternatives().try(Joi.string(), Joi.number(), Joi.date(), Joi.any())
+    )
+    .unknown(false);
+
+    this.propertyTypes = {
+      ...this.propertyTypes,};
+  }
+
+  makeEntity(data: ScenarioSchemaData): Entities.Scenario {
+    return new Entities.Scenario(
+      data);
+  }
+}
+
+export interface ReleaseOverTimeSchemaData extends SchemaBaseData {
+  releaseAngle: number;
+  timeVaryingOption: Enums.TimeVaryingOption;
 }
 
 /**
  * ================================================================================
- * Class:        BundSchema
- * Description:  A bund entity used in the modelling of pool spreading and vaporisation.
+ * Class:        ReleaseOverTimeSchema
+ * Description:  Scenario representing a release over time.
  * ================================================================================
  */
-export class BundSchema extends SchemaBase<BundSchemaData> {
+export class ReleaseOverTimeSchema extends SchemaBase<ReleaseOverTimeSchemaData> {
   constructor() {
     super();
     this.schema = this.schema.concat(
       Joi.object({
-        bundHeight: Joi.number().unsafe(),
-        bundDiameter: Joi.number().unsafe(),
-        specifyBund: Joi.boolean(),
+        releaseAngle: Joi.number().unsafe(),
+        timeVaryingOption: Joi.string().valid(...Object.values(Enums.TimeVaryingOption)),
       })
     )
     .pattern(
@@ -366,31 +394,44 @@ export class BundSchema extends SchemaBase<BundSchemaData> {
 
     this.propertyTypes = {
       ...this.propertyTypes,
-      bundHeight: "number",
-      bundDiameter: "number",
-      specifyBund: "boolean",
+      releaseAngle: "number",
+      timeVaryingOption: "Enums.TimeVaryingOption",
     };
   }
 
-  makeEntity(data: BundSchemaData): Entities.Bund {
-    return new Entities.Bund(
+  makeEntity(data: ReleaseOverTimeSchemaData): Entities.ReleaseOverTime {
+    return new Entities.ReleaseOverTime(
       data);
   }
 }
 
-export interface ScenarioSchemaData extends SchemaBaseData {}
+export interface BESSReleaseSchemaData extends SchemaBaseData {
+  height: number;
+  area: number;
+  temperature: number;
+  duration: number;
+  releaseAngle: number;
+  timeVaryingOption: Enums.TimeVaryingOption;
+}
 
 /**
  * ================================================================================
- * Class:        ScenarioSchema
- * Description:  Base struct/class for all scenario types.
+ * Class:        BESSReleaseSchema
+ * Description:  A release from a BESS unit in thermal runaway
  * ================================================================================
  */
-export class ScenarioSchema extends SchemaBase<ScenarioSchemaData> {
+export class BESSReleaseSchema extends SchemaBase<BESSReleaseSchemaData> {
   constructor() {
     super();
     this.schema = this.schema.concat(
-      Joi.object()
+      Joi.object({
+        height: Joi.number().unsafe(),
+        area: Joi.number().unsafe(),
+        temperature: Joi.number().unsafe(),
+        duration: Joi.number().unsafe(),
+        releaseAngle: Joi.number().unsafe(),
+        timeVaryingOption: Joi.string().valid(...Object.values(Enums.TimeVaryingOption)),
+      })
     )
     .pattern(
       ignoredPropertiesRegex,
@@ -399,11 +440,102 @@ export class ScenarioSchema extends SchemaBase<ScenarioSchemaData> {
     .unknown(false);
 
     this.propertyTypes = {
-      ...this.propertyTypes,};
+      ...this.propertyTypes,
+      height: "number",
+      area: "number",
+      temperature: "number",
+      duration: "number",
+      releaseAngle: "number",
+      timeVaryingOption: "Enums.TimeVaryingOption",
+    };
   }
 
-  makeEntity(data: ScenarioSchemaData): Entities.Scenario {
-    return new Entities.Scenario(
+  makeEntity(data: BESSReleaseSchemaData): Entities.BESSRelease {
+    return new Entities.BESSRelease(
+      data);
+  }
+}
+
+export interface BESSUnitSchemaData extends SchemaBaseData {
+  location: Entities.LocalPosition;
+  energyCapacity: number;
+  chemistry: Enums.BESSChemistry;
+}
+
+/**
+ * ================================================================================
+ * Class:        BESSUnitSchema
+ * Description:  A BESS unit, containing Li-ion betteries
+ * ================================================================================
+ */
+export class BESSUnitSchema extends SchemaBase<BESSUnitSchemaData> {
+  constructor() {
+    super();
+    this.schema = this.schema.concat(
+      Joi.object({
+        location: new LocalPositionSchema().schema,
+        energyCapacity: Joi.number().unsafe(),
+        chemistry: Joi.string().valid(...Object.values(Enums.BESSChemistry)),
+      })
+    )
+    .pattern(
+      ignoredPropertiesRegex,
+      Joi.alternatives().try(Joi.string(), Joi.number(), Joi.date(), Joi.any())
+    )
+    .unknown(false);
+
+    this.propertyTypes = {
+      ...this.propertyTypes,
+      location: "LocalPosition",
+      energyCapacity: "number",
+      chemistry: "Enums.BESSChemistry",
+    };
+  }
+
+  makeEntity(data: BESSUnitSchemaData): Entities.BESSUnit {
+    return new Entities.BESSUnit(
+      data);
+  }
+}
+
+export interface BundSchemaData extends SchemaBaseData {
+  bundHeight: number;
+  bundDiameter: number;
+  specifyBund: boolean;
+}
+
+/**
+ * ================================================================================
+ * Class:        BundSchema
+ * Description:  A bund entity used in the modelling of pool spreading and vaporisation.
+ * ================================================================================
+ */
+export class BundSchema extends SchemaBase<BundSchemaData> {
+  constructor() {
+    super();
+    this.schema = this.schema.concat(
+      Joi.object({
+        bundHeight: Joi.number().unsafe(),
+        bundDiameter: Joi.number().unsafe(),
+        specifyBund: Joi.boolean(),
+      })
+    )
+    .pattern(
+      ignoredPropertiesRegex,
+      Joi.alternatives().try(Joi.string(), Joi.number(), Joi.date(), Joi.any())
+    )
+    .unknown(false);
+
+    this.propertyTypes = {
+      ...this.propertyTypes,
+      bundHeight: "number",
+      bundDiameter: "number",
+      specifyBund: "boolean",
+    };
+  }
+
+  makeEntity(data: BundSchemaData): Entities.Bund {
+    return new Entities.Bund(
       data);
   }
 }
@@ -1440,45 +1572,6 @@ export class FlashResultSchema extends SchemaBase<FlashResultSchemaData> {
   }
 }
 
-export interface ReleaseOverTimeSchemaData extends SchemaBaseData {
-  releaseAngle: number;
-  timeVaryingOption: Enums.TimeVaryingOption;
-}
-
-/**
- * ================================================================================
- * Class:        ReleaseOverTimeSchema
- * Description:  Scenario representing a release over time.
- * ================================================================================
- */
-export class ReleaseOverTimeSchema extends SchemaBase<ReleaseOverTimeSchemaData> {
-  constructor() {
-    super();
-    this.schema = this.schema.concat(
-      Joi.object({
-        releaseAngle: Joi.number().unsafe(),
-        timeVaryingOption: Joi.string().valid(...Object.values(Enums.TimeVaryingOption)),
-      })
-    )
-    .pattern(
-      ignoredPropertiesRegex,
-      Joi.alternatives().try(Joi.string(), Joi.number(), Joi.date(), Joi.any())
-    )
-    .unknown(false);
-
-    this.propertyTypes = {
-      ...this.propertyTypes,
-      releaseAngle: "number",
-      timeVaryingOption: "Enums.TimeVaryingOption",
-    };
-  }
-
-  makeEntity(data: ReleaseOverTimeSchemaData): Entities.ReleaseOverTime {
-    return new Entities.ReleaseOverTime(
-      data);
-  }
-}
-
 export interface LeakSchemaData extends SchemaBaseData {
   holeDiameter: number;
   releaseAngle: number;
@@ -2575,6 +2668,7 @@ export interface WeatherSchemaData extends SchemaBaseData {
   relativeHumidity: number;
   mixingLayerHeight: number;
   solarRadiation: number;
+  windProfileFlag: Enums.WindProfileFlag;
 }
 
 /**
@@ -2594,6 +2688,7 @@ export class WeatherSchema extends SchemaBase<WeatherSchemaData> {
         relativeHumidity: Joi.number().unsafe(),
         mixingLayerHeight: Joi.number().unsafe(),
         solarRadiation: Joi.number().unsafe(),
+        windProfileFlag: Joi.string().valid(...Object.values(Enums.WindProfileFlag)),
       })
     )
     .pattern(
@@ -2610,6 +2705,7 @@ export class WeatherSchema extends SchemaBase<WeatherSchemaData> {
       relativeHumidity: "number",
       mixingLayerHeight: "number",
       solarRadiation: "number",
+      windProfileFlag: "Enums.WindProfileFlag",
     };
   }