@dnv-plant/typescriptpws 1.0.97 → 1.0.98

package/src/enums.ts

@@ -6,15 +6,16 @@
  * 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.97
- * Date/time: 13 Apr 2026 17:02:52
- * Template:  templates/typescriptpws/enums.razor.
+ * Version:   1.0.0
+ * Date/time: 23 Jun 2026 12:11:11
+ * Template:  TYPE_SCRIPT_PWS/enums.sbn.
  ***********************************************************************/
 
 /**
  * The Pasquill atmospheric stability classes, a common method for categorizing the amount of atmospheric turbulence present.
  */
 export enum AtmosphericStabilityClass {
+
   /** A - very unstable - sunny, light winds. */
   STABILITY_A = 1,
 
@@ -50,17 +51,34 @@ export enum AtmosphericStabilityClass {
  * The different types of BESS installations.
  */
 export enum BESSChemistry {
+
   /** Lithium-iron-phosphate. */
   LFP = 1,
 
   /** Nickel-manganese-cobalt. */
   NMC = 2,
+
+  /** Where no chemistry is required due to user-defined inputs. */
+  NONE = 0,
+}
+
+/**
+ * Breach sizing method.
+ */
+export enum BreachSizingMethod {
+
+  /** Actual diameter of the breach. */
+  ACTUAL_SIZE = 0,
+
+  /** Ratio of the area of the breach to the total pipe discharge area. */
+  RELATIVE_SIZE = 1,
 }
 
 /**
  * Type of contour plot or grid.
  */
 export enum ContourType {
+
   /** Crosswind (YZ plane). */
   CROSSWIND = 5,
 
@@ -90,6 +108,7 @@ export enum ContourType {
  * Whether day or night.
  */
 export enum DayNight {
+
   /** Day. */
   DAY = 1,
 
@@ -104,6 +123,7 @@ export enum DayNight {
  * Whether the release or cloud is instantaneous, continuous or time-varying.
  */
 export enum DynamicType {
+
   /** A release of mass at a rate which does not vary with time. */
   CONTINUOUS = 2,
 
@@ -121,6 +141,7 @@ export enum DynamicType {
  * The type of fire that occurs or is modelled.
  */
 export enum FireType {
+
   /** A high-velocity burning jet, modelled using the API model, which treats the flame as a banana-shaped plume. */
   APIJET = 3,
 
@@ -144,6 +165,7 @@ export enum FireType {
  * Whether a material is flammable, toxic, both or inert.
  */
 export enum FlammableToxic {
+
   /** Both. */
   BOTH = 0,
 
@@ -164,6 +186,7 @@ export enum FlammableToxic {
  * Method to describe how phase changes between storage and orifice conditions will be modelled.
  */
 export enum FlashAtOrifice {
+
   /** No flashing of liquid (metastable liquid) upstream of the orifice. */
   DISALLOW_LIQUID_FLASH = 2,
 
@@ -178,6 +201,7 @@ export enum FlashAtOrifice {
  * Fluid state specification.
  */
 export enum FluidSpec {
+
   /** Specify bubble point at fixed pressure. */
   PBUB = 3,
 
@@ -207,6 +231,7 @@ export enum FluidSpec {
  * The type of flame produced when a material burns.
  */
 export enum LuminousSmokyFlame {
+
   /** Used or compounds with unknown experimental profile for surface emissive power. */
   GENERAL = 2,
 
@@ -224,6 +249,7 @@ export enum LuminousSmokyFlame {
  * The multi energy confined method for modelling the effects of explosions.
  */
 export enum MEConfinedMethod {
+
   /** A method where the explosion calculations model a single confined source that contains the entire mass of the cloud, with a strength of confinement defined by the ExplosionUniformStrength in the ExplosionParameters. */
   UNIFORM_CONFINED = 3,
 
@@ -235,6 +261,7 @@ export enum MEConfinedMethod {
  * Method for modelling a mixture.
  */
 export enum MixtureModelling {
+
   /** Multi-component multiple aerosol. */
   MC_MULTIPLE_AEROSOL = 3,
 
@@ -249,6 +276,7 @@ export enum MixtureModelling {
  * Fluid phase (vapour, liquid or two-phase).
  */
 export enum Phase {
+
   /** Liquid. */
   LIQUID = 3,
 
@@ -266,6 +294,7 @@ export enum Phase {
  * Type of pool fire.
  */
 export enum PoolFireType {
+
   /** A type of pool fire assumed to take place at the time when the spill rate into the pool is equal to the burn rate of the pool fire. */
   EARLY = 1,
 
@@ -280,6 +309,7 @@ export enum PoolFireType {
  * Surface onto which the liquid which rains out will spread.
  */
 export enum PoolSurfaceType {
+
   /** Concrete. */
   CONCRETE = 3,
 
@@ -309,6 +339,7 @@ export enum PoolSurfaceType {
  * The template to be used for the selection of calculation methods for material properties.
  */
 export enum PropertyTemplate {
+
   /** Acid association template for modelling reactive Hydrogen Fluoride. */
   ACID_ASSOCIATION = 102,
 
@@ -335,6 +366,7 @@ export enum PropertyTemplate {
  * The type of radiation result of interest.
  */
 export enum RadiationType {
+
   /** The cumulative thermal energy produced from a flame and absorbed by a person or object, measured in W/m2.s. */
   DOSE = 1,
 
@@ -358,6 +390,7 @@ export enum RadiationType {
  * Sets the model for droplet evaporation calculations.
  */
 export enum RainoutThermoFlag {
+
   /** Suppress rainout and force the liquid droplets to stay inside the cloud, which can have a significant effect on the properties of the cloud. */
   NO_RAINOUT_EQUILIBRIUM = -1,
 
@@ -368,10 +401,23 @@ export enum RainoutThermoFlag {
   RAINOUT_NON_EQUILIBRIUM = 2,
 }
 
+/**
+ * Averaging method to determine the input to the dispersion.
+ */
+export enum ReleaseAveragingMethod {
+
+  /** Averaging between two times. */
+  AVERAGING_BETWEEN_TWO_TIMES = 3,
+
+  /** Multiple rates (up to 10). */
+  UP_TO_TEN_RATES = 4,
+}
+
 /**
  * The initial direction of the discharge from its source.
  */
 export enum ReleaseDirection {
+
   /** Horizontal. */
   HORIZONTAL = 0,
 
@@ -383,6 +429,7 @@ export enum ReleaseDirection {
  * Output resolution (and performance) controlling the spacing in the x, y, z and time dimensions.
  */
 export enum Resolution {
+
   /** Extremely high. */
   EXTREME = 5,
 
@@ -403,19 +450,20 @@ export enum Resolution {
  * Result codes returned from calls to the MDE.
  */
 export enum ResultCode {
-  /** . */
+
+  /** Client ID was not specified or is missing. */
   CLIENT_ID_NOT_SPECIFIED_ERROR = 21110,
 
-  /** . */
+  /** An error occurred while storing or retrieving data. */
   DATA_STORAGE_ERROR = 21113,
 
-  /** . */
+  /** Failed to initialize the discharge calculation engine. */
   DISCHARGE_CALCULATION_INITIALIZATION_ERROR = 21107,
 
-  /** . */
+  /** Failed to initialize the dispersion calculation engine. */
   DISPERSION_CALCULATION_INITIALIZATION_ERROR = 21108,
 
-  /** . */
+  /** An error occurred while reading the input file. */
   ERROR_READING_INPUT_FILE_ERROR = 21011,
 
   /** Execution fail. */
@@ -424,136 +472,136 @@ export enum ResultCode {
   /** Validation fail. */
   FAIL_VALIDATION = -1,
 
-  /** . */
+  /** Failed to initialize the MDE error reporting system. */
   FAILED_TO_INITIALISE_MDE_ERROR_REPORTING_ERROR = 21012,
 
-  /** . */
+  /** Failed to initialize the physical property system. */
   FAILED_TO_INITIALISE_PROPERTY_SYSTEM_ERROR = 21013,
 
-  /** . */
+  /** HTTP 300 Ambiguous - the requested information has multiple representations. */
   HTTP_AMBIGUOUS_ERROR = 30300,
 
-  /** . */
+  /** HTTP 502 Bad Gateway - the server received an invalid response from an upstream server. */
   HTTP_BAD_GATEWAY_ERROR = 30502,
 
-  /** . */
+  /** HTTP 400 Bad Request - the server cannot process the request due to a client error. */
   HTTP_BAD_REQUEST_ERROR = 30400,
 
-  /** . */
+  /** HTTP 409 Conflict - the request conflicts with the current state of the server. */
   HTTP_CONFLICT_ERROR = 30409,
 
-  /** . */
+  /** HTTP 417 Expectation Failed - the expectation given in the Expect request header could not be met. */
   HTTP_EXPECTATION_FAILED_ERROR = 30417,
 
-  /** . */
+  /** HTTP 403 Forbidden - the server understood the request but refuses to authorize it. */
   HTTP_FORBIDDEN_ERROR = 30403,
 
-  /** . */
+  /** HTTP 302 Found - the requested resource has been temporarily moved to a different URI. */
   HTTP_FOUND_ERROR = 30302,
 
-  /** . */
+  /** HTTP 504 Gateway Timeout - the server did not receive a timely response from an upstream server. */
   HTTP_GATEWAY_TIMEOUT_ERROR = 30504,
 
-  /** . */
+  /** HTTP 410 Gone - the requested resource is no longer available and will not be available again. */
   HTTP_GONE_ERROR = 30410,
 
-  /** . */
+  /** HTTP 505 HTTP Version Not Supported - the HTTP version used in the request is not supported by the server. */
   HTTP_HTTP_VERSION_NOT_SUPPORTED_ERROR = 30505,
 
-  /** . */
+  /** HTTP 500 Internal Server Error - the server encountered an unexpected condition that prevented it from fulfilling the request. */
   HTTP_INTERNAL_SERVER_ERROR_ERROR = 30500,
 
-  /** . */
+  /** HTTP 411 Length Required - the server refuses to accept the request without a defined Content-Length header. */
   HTTP_LENGTH_REQUIRED_ERROR = 30411,
 
-  /** . */
+  /** HTTP 405 Method Not Allowed - the request method is not supported for the requested resource. */
   HTTP_METHOD_NOT_ALLOWED_ERROR = 30405,
 
-  /** . */
+  /** HTTP 301 Moved Permanently - the requested resource has been permanently moved to a new URI. */
   HTTP_MOVED_ERROR = 30301,
 
-  /** . */
+  /** HTTP 301 Moved Permanently - the requested resource has been permanently moved to a new URI. */
   HTTP_MOVED_PERMANENTLY_ERROR = 30301,
 
-  /** . */
+  /** HTTP 300 Multiple Choices - the requested resource has multiple representations, each with its own specific location. */
   HTTP_MULTIPLE_CHOICES_ERROR = 30300,
 
-  /** . */
+  /** HTTP 406 Not Acceptable - the server cannot produce a response matching the list of acceptable values in the request headers. */
   HTTP_NOT_ACCEPTABLE_ERROR = 30406,
 
-  /** . */
+  /** HTTP 404 Not Found - the server cannot find the requested resource. */
   HTTP_NOT_FOUND_ERROR = 30404,
 
-  /** . */
+  /** HTTP 501 Not Implemented - the server does not support the functionality required to fulfill the request. */
   HTTP_NOT_IMPLEMENTED_ERROR = 30501,
 
-  /** . */
+  /** HTTP 304 Not Modified - the resource has not been modified since the version specified by the request headers. */
   HTTP_NOT_MODIFIED_ERROR = 30304,
 
-  /** . */
+  /** HTTP 402 Payment Required - reserved for future use. */
   HTTP_PAYMENT_REQUIRED_ERROR = 30402,
 
-  /** . */
+  /** HTTP 412 Precondition Failed - one or more conditions given in the request header fields evaluated to false. */
   HTTP_PRECONDITION_FAILED_ERROR = 30412,
 
-  /** . */
+  /** HTTP 407 Proxy Authentication Required - the client must first authenticate itself with the proxy. */
   HTTP_PROXY_AUTHENTICATION_REQUIRED_ERROR = 30407,
 
-  /** . */
+  /** HTTP 302 Redirect - the requested resource has been temporarily moved to a different URI. */
   HTTP_REDIRECT_ERROR = 30302,
 
-  /** . */
+  /** HTTP 307 Temporary Redirect - the requested resource temporarily resides under a different URI, keep the same HTTP method. */
   HTTP_REDIRECT_KEEP_VERB_ERROR = 30307,
 
-  /** . */
+  /** HTTP 303 See Other - the response to the request can be found under a different URI using a GET method. */
   HTTP_REDIRECT_METHOD_ERROR = 30303,
 
-  /** . */
+  /** HTTP 416 Range Not Satisfiable - the client has asked for a portion of the file that the server cannot supply. */
   HTTP_REQUESTED_RANGE_NOT_SATISFIABLE_ERROR = 30416,
 
-  /** . */
+  /** HTTP 413 Payload Too Large - the request entity is larger than the server is willing or able to process. */
   HTTP_REQUEST_ENTITY_TOO_LARGE_ERROR = 30413,
 
-  /** . */
+  /** HTTP 408 Request Timeout - the server timed out waiting for the request. */
   HTTP_REQUEST_TIMEOUT_ERROR = 30408,
 
-  /** . */
+  /** HTTP 414 URI Too Long - the URI provided was too long for the server to process. */
   HTTP_REQUEST_URI_TOO_LONG_ERROR = 30414,
 
-  /** . */
+  /** HTTP 303 See Other - the response to the request can be found under a different URI using a GET method. */
   HTTP_SEE_OTHER_ERROR = 30303,
 
-  /** . */
+  /** HTTP 503 Service Unavailable - the server is currently unable to handle the request due to temporary overload or maintenance. */
   HTTP_SERVICE_UNAVAILABLE_ERROR = 30503,
 
-  /** . */
+  /** HTTP 307 Temporary Redirect - the requested resource temporarily resides under a different URI. */
   HTTP_TEMPORARY_REDIRECT_ERROR = 30307,
 
-  /** . */
+  /** HTTP 401 Unauthorized - the request requires user authentication. */
   HTTP_UNAUTHORIZED_ERROR = 30401,
 
-  /** . */
+  /** HTTP 415 Unsupported Media Type - the server refuses to accept the request because the payload format is not supported. */
   HTTP_UNSUPPORTED_MEDIA_TYPE_ERROR = 30415,
 
-  /** . */
+  /** HTTP 306 Unused - this status code is no longer used. */
   HTTP_UNUSED_ERROR = 30306,
 
-  /** . */
+  /** HTTP 426 Upgrade Required - the client should switch to a different protocol. */
   HTTP_UPGRADE_REQUIRED_ERROR = 30426,
 
-  /** . */
+  /** HTTP 305 Use Proxy - the requested resource must be accessed through the proxy specified in the Location header. */
   HTTP_USE_PROXY_ERROR = 30305,
 
-  /** . */
+  /** An array index is outside the bounds of the array. */
   INDEX_OUT_OF_RANGE_ERROR = 21112,
 
-  /** . */
+  /** The specified input file could not be found. */
   INPUT_FILE_NOT_FOUND_ERROR = 21009,
 
-  /** . */
+  /** No input file was specified. */
   INPUT_FILE_NOT_SPECIFIED_ERROR = 21008,
 
-  /** . */
+  /** The provided access token is invalid or has expired. */
   INVALID_ACCESS_TOKEN_ERROR = 21014,
 
   /** No or invalid application root directory specified. */
@@ -568,13 +616,13 @@ export enum ResultCode {
   /** No or invalid working directory specified. */
   INVALID_WORKING_DIRECTORY_ERROR = 21003,
 
-  /** . */
+  /** An error occurred while parsing or reading JSON data. */
   JSON_READER_ERROR = 21111,
 
-  /** . */
+  /** Failed to initialize the MDE error reporting system. */
   MDEERROR_REPORTING_INITIALIZATION_ERROR = 21105,
 
-  /** . */
+  /** Failed to initialize the MDE calculation engine. */
   MDEINITIALIZATION_ERROR = 21104,
 
   /** MDE directory was correctly specified but the directory does not exist. */
@@ -583,31 +631,31 @@ export enum ResultCode {
   /** Missing parameters. */
   MISSING_PARAMETERS_ERROR = 21002,
 
-  /** . */
+  /** No discharge records were generated or available. */
   NO_DISCHARGE_RECORDS_ERROR = 21100,
 
-  /** . */
+  /** Warning: No discharge records were generated during the calculation. */
   NO_DISCHARGE_RECORDS_GENERATED_WARNING = 63001,
 
-  /** . */
+  /** No dispersion records were generated or available. */
   NO_DISPERSION_RECORDS_ERROR = 21102,
 
-  /** . */
+  /** Warning: No dispersion records were generated during the calculation. */
   NO_DISPERSION_RECORDS_GENERATED_WARNING = 63002,
 
-  /** . */
+  /** No flame records were generated or available. */
   NO_FLAME_RECORDS_ERROR = 21103,
 
-  /** . */
+  /** No output file was specified. */
   OUTPUT_FILE_NOT_SPECIFIED_ERROR = 21010,
 
-  /** . */
+  /** Failed to initialize the physical property system. */
   PHYSICAL_PROPERTY_SYSTEM_INITIALIZATION_ERROR = 21106,
 
   /** Success. */
   SUCCESS = 0,
 
-  /** . */
+  /** Unable to read data from the specified source. */
   UNABLE_TO_READ_DATA_ERROR = 21109,
 
   /** Unexpected application error encountered. */
@@ -615,12 +663,16 @@ export enum ResultCode {
 
   /** The calculation has not been run yet. */
   NOT_RUN = -2,
+
+  /** Calculation currently running. */
+  RUNNING = -3,
 }
 
 /**
  * Flag for whether we want to deploy or disable solid modelling. In addition to this flag, each component has its own allowSolids flag.
  */
 export enum SolidModelling {
+
   /** Solid modelling will be deployed if it is supported by the component in question. */
   DEPLOY_SOLID_MODELLING = 1,
 
@@ -632,6 +684,7 @@ export enum SolidModelling {
  * The method used to determine the concentration of interest when post processing dispersion calculations.
  */
 export enum SpecialConcentration {
+
   /** The concentration of interest will be the LFL of the material. */
   LFL = 2,
 
@@ -652,6 +705,7 @@ export enum SpecialConcentration {
  * Surface over which the dispersion occurs.
  */
 export enum SurfaceType {
+
   /** Dispersion over land. */
   LAND = 1,
 
@@ -663,6 +717,7 @@ export enum SurfaceType {
  * Whether the release is a time-varying release or a steady state release using the initial rate.
  */
 export enum TimeVaryingOption {
+
   /** Use initial rate modelling. */
   INITIAL_RATE = 1,
 
@@ -674,6 +729,7 @@ export enum TimeVaryingOption {
  * The type of toxic result.
  */
 export enum ToxicResultType {
+
   /** Toxic dose. */
   TOXIC_DOSE = 3,
 
@@ -691,6 +747,7 @@ export enum ToxicResultType {
  * The conditions of the material in a vessel.
  */
 export enum VesselConditions {
+
   /** Liquid stored at atmospheric pressure. */
   ATMOSPHERIC_LIQUID_VESSEL = 5,
 
@@ -714,6 +771,7 @@ export enum VesselConditions {
  * The shape of a vessel.
  */
 export enum VesselShape {
+
   /** Horizontal cylinder shape for a vessel. */
   HORIZONTAL_CYLINDER = 2,
 
@@ -731,9 +789,10 @@ export enum VesselShape {
  * Wind profile flag.
  */
 export enum WindProfileFlag {
+
   /** Logarithmic wind profile. */
   LOGARITHMIC_PROFILE = 4,
 
   /** Power law wind profile. */
   POWER_LAW_PROFILE = 2,
-}
+}