@dnv-plant/typescriptpws 1.0.78 → 1.0.80-alpha.1959992
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.ts +10 -4
- package/package.json +6 -6
- package/src/calculations/applicationTools.ts +10 -4
- package/src/calculations/discharge.ts +10 -4
- package/src/calculations/dispersion.ts +10 -4
- package/src/calculations/dispersionView.ts +10 -4
- package/src/calculations/fireball.ts +10 -4
- package/src/calculations/jetFire.ts +10 -4
- package/src/calculations/lateExplosion.ts +10 -4
- package/src/calculations/linkedRunners.ts +10 -4
- package/src/calculations/poolFire.ts +10 -4
- package/src/calculations/properties.ts +10 -4
- package/src/calculations/radiation.ts +10 -4
- package/src/calculations/standalones.ts +10 -4
- package/src/calculations/toxics.ts +10 -4
- package/src/calculations/utilities.ts +10 -4
- package/src/constants.ts +10 -4
- package/src/entities.ts +194 -188
- package/src/entity-schemas.ts +10 -4
- package/src/enums.ts +10 -4
- package/src/materials.ts +10 -4
- package/src/utilities.ts +10 -4
package/index.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/index.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
export * from "./src/constants";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dnv-plant/typescriptpws",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.80-alpha.1959992",
|
|
4
4
|
"description": "Integrate Phast models with our versatile APIs for enhanced customization and efficiency.",
|
|
5
5
|
"main": "index.ts",
|
|
6
6
|
"scripts": {
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
"typescript": "^5.7.3"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
"@types/jsonwebtoken": "^9.0.8",
|
|
20
|
+
"@types/jest": "^29.5.14",
|
|
21
|
+
"jest": "^29.7.0",
|
|
22
|
+
"ts-jest": "^29.3.0"
|
|
23
23
|
}
|
|
24
|
-
}
|
|
24
|
+
}
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:14
|
|
11
|
+
* Template: templates/typescriptpws/calculations.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
|
package/src/constants.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:12
|
|
11
|
+
* Template: templates/typescriptpws/constants.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
export const ABS_TOL_RAD = 0.0000000001;
|
package/src/entities.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:13
|
|
11
|
+
* Template: templates/typescriptpws/entities.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
import * as Enums from "./enums";
|
|
@@ -51,9 +57,9 @@ export class LocalPosition extends EntityBase {
|
|
|
51
57
|
/**
|
|
52
58
|
* Position with reference to some arbitrary local origin and axes.
|
|
53
59
|
*
|
|
54
|
-
* @param {number} x - x coordinate. (default value is 0)
|
|
55
|
-
* @param {number} y - y coordinate. (default value is 0)
|
|
56
|
-
* @param {number} z - z coordinate. (default value is 0)
|
|
60
|
+
* @param {number} x - x coordinate. [m] (default value is 0)
|
|
61
|
+
* @param {number} y - y coordinate. [m] (default value is 0)
|
|
62
|
+
* @param {number} z - z coordinate. [m] (default value is 0)
|
|
57
63
|
*/
|
|
58
64
|
constructor(options?: {
|
|
59
65
|
id?: string;
|
|
@@ -140,7 +146,7 @@ export class MaterialComponent extends EntityBase {
|
|
|
140
146
|
* Constituent component of a material.
|
|
141
147
|
*
|
|
142
148
|
* @param {string} name - Name of the component. (default value is "")
|
|
143
|
-
* @param {number} moleFraction - Mole fraction of the component in the material. (default value is 1)
|
|
149
|
+
* @param {number} moleFraction - Mole fraction of the component in the material. [fraction] (default value is 1)
|
|
144
150
|
*/
|
|
145
151
|
constructor(options?: {
|
|
146
152
|
id?: string;
|
|
@@ -261,9 +267,9 @@ export class State extends EntityBase {
|
|
|
261
267
|
/**
|
|
262
268
|
* Description of the fluid state.
|
|
263
269
|
*
|
|
264
|
-
* @param {number} pressure - Absolute pressure of the fluid.
|
|
265
|
-
* @param {number} temperature - Temperature of the fluid.
|
|
266
|
-
* @param {number} liquidFraction - Mole fraction of liquid in the fluid.
|
|
270
|
+
* @param {number} pressure - Absolute pressure of the fluid. [N/m2]
|
|
271
|
+
* @param {number} temperature - Temperature of the fluid. [K]
|
|
272
|
+
* @param {number} liquidFraction - Mole fraction of liquid in the fluid. [fraction]
|
|
267
273
|
* @param {Enums.FluidSpec} flashFlag - Specification of the fluid equilibrium. (default value is Enums.FluidSpec.TP)
|
|
268
274
|
* @param {Enums.MixtureModelling} mixtureModelling - Method for modelling a mixture. (default value is Enums.MixtureModelling.PC)
|
|
269
275
|
*/
|
|
@@ -340,10 +346,10 @@ export class AtmosphericStorageTank extends Asset {
|
|
|
340
346
|
*
|
|
341
347
|
* @param {LocalPosition} location - Location of the asset.
|
|
342
348
|
* @param {State} state - The fluid state within the tank.
|
|
343
|
-
* @param {number} diameter - Diameter of the tank.
|
|
344
|
-
* @param {number} height - Height of the tank.
|
|
349
|
+
* @param {number} diameter - Diameter of the tank. [m]
|
|
350
|
+
* @param {number} height - Height of the tank. [m]
|
|
345
351
|
* @param {Material} material - Material within the tank.
|
|
346
|
-
* @param {number} liquidFillFractionByVolume - The proportion of the tank occupied by liquid. (default value is 0.9)
|
|
352
|
+
* @param {number} liquidFillFractionByVolume - The proportion of the tank occupied by liquid. [fraction] (default value is 0.9)
|
|
347
353
|
*/
|
|
348
354
|
constructor(options?: {
|
|
349
355
|
id?: string;
|
|
@@ -435,7 +441,7 @@ export class ReleaseOverTime extends Scenario {
|
|
|
435
441
|
/**
|
|
436
442
|
* Scenario representing a release over time.
|
|
437
443
|
*
|
|
438
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
444
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
439
445
|
* @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)
|
|
440
446
|
*/
|
|
441
447
|
constructor(options?: {
|
|
@@ -490,11 +496,11 @@ export class BESSRelease extends ReleaseOverTime {
|
|
|
490
496
|
/**
|
|
491
497
|
* A release from a BESS unit in thermal runaway.
|
|
492
498
|
*
|
|
493
|
-
* @param {number} height - The height from which the release occurs.
|
|
494
|
-
* @param {number} area - The area over which the release occurs.
|
|
495
|
-
* @param {number} temperature - The exit temperature of the release (from the BESS unit).
|
|
496
|
-
* @param {number} duration - The duration of the release.
|
|
497
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
499
|
+
* @param {number} height - The height from which the release occurs. [m]
|
|
500
|
+
* @param {number} area - The area over which the release occurs. [m2]
|
|
501
|
+
* @param {number} temperature - The exit temperature of the release (from the BESS unit). [K]
|
|
502
|
+
* @param {number} duration - The duration of the release. [s]
|
|
503
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
498
504
|
* @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)
|
|
499
505
|
*/
|
|
500
506
|
constructor(options?: {
|
|
@@ -555,7 +561,7 @@ export class BESSUnit extends Asset {
|
|
|
555
561
|
* A BESS unit, containing Li-ion betteries.
|
|
556
562
|
*
|
|
557
563
|
* @param {LocalPosition} location - Location of the asset.
|
|
558
|
-
* @param {number} energyCapacity - The energy capacity of the installation.
|
|
564
|
+
* @param {number} energyCapacity - The energy capacity of the installation. [J]
|
|
559
565
|
* @param {Enums.BESSChemistry} chemistry - The chemistry type of the BESS unit. (default value is Enums.BESSChemistry.LFP)
|
|
560
566
|
*/
|
|
561
567
|
constructor(options?: {
|
|
@@ -611,8 +617,8 @@ export class Bund extends EntityBase {
|
|
|
611
617
|
/**
|
|
612
618
|
* A bund entity used in the modelling of pool spreading and vaporisation.
|
|
613
619
|
*
|
|
614
|
-
* @param {number} bundHeight - Used in calculating the volume of the bund and in modelling bund failure and the location of rainout. (default value is 0.0)
|
|
615
|
-
* @param {number} bundDiameter - The diameter of the (circular) bund. (default value is 0.0)
|
|
620
|
+
* @param {number} bundHeight - Used in calculating the volume of the bund and in modelling bund failure and the location of rainout. [m] (default value is 0.0)
|
|
621
|
+
* @param {number} bundDiameter - The diameter of the (circular) bund. [m] (default value is 0.0)
|
|
616
622
|
* @param {boolean} specifyBund - Whether to model the effect of a bund on the spreading of a liquid pool. (default value is false)
|
|
617
623
|
*/
|
|
618
624
|
constructor(options?: {
|
|
@@ -716,7 +722,7 @@ export class ConcentrationRecord extends EntityBase {
|
|
|
716
722
|
/**
|
|
717
723
|
* A record containing the cloud concentration at a specified x, y, z position.
|
|
718
724
|
*
|
|
719
|
-
* @param {number} concentration - Cloud concentration at an x, y, z position.
|
|
725
|
+
* @param {number} concentration - Cloud concentration at an x, y, z position. [fraction]
|
|
720
726
|
* @param {LocalPosition} position - x, y, z position.
|
|
721
727
|
*/
|
|
722
728
|
constructor(options?: {
|
|
@@ -762,9 +768,9 @@ export class ConstantMaterialResult extends EntityBase {
|
|
|
762
768
|
/**
|
|
763
769
|
* Constant material properties, i.e. critical pressure, temperature, molecular weight.
|
|
764
770
|
*
|
|
765
|
-
* @param {number} criticalPressure - The critical pressure of the material.
|
|
766
|
-
* @param {number} criticalTemperature - The critical temperature of the material.
|
|
767
|
-
* @param {number} totalMolecularWeight - The total molecular weight of the material.
|
|
771
|
+
* @param {number} criticalPressure - The critical pressure of the material. [N/m2]
|
|
772
|
+
* @param {number} criticalTemperature - The critical temperature of the material. [K]
|
|
773
|
+
* @param {number} totalMolecularWeight - The total molecular weight of the material. [kg/kmol]
|
|
768
774
|
*/
|
|
769
775
|
constructor(options?: {
|
|
770
776
|
id?: string;
|
|
@@ -865,15 +871,15 @@ export class DischargeRecord extends EntityBase {
|
|
|
865
871
|
/**
|
|
866
872
|
* A record containing discharge results at a given time.
|
|
867
873
|
*
|
|
868
|
-
* @param {number} time - The time elapsed since the start of the discharge.
|
|
869
|
-
* @param {number} massFlow - The mass flow rate at the specified time.
|
|
874
|
+
* @param {number} time - The time elapsed since the start of the discharge. [s]
|
|
875
|
+
* @param {number} massFlow - The mass flow rate at the specified time. [kg/s]
|
|
870
876
|
* @param {State} finalState - The fluid state after expansion to atmosphere at the specified time.
|
|
871
|
-
* @param {number} finalVelocity - The velocity after expansion to atmosphere at the specified time.
|
|
877
|
+
* @param {number} finalVelocity - The velocity after expansion to atmosphere at the specified time. [m/s]
|
|
872
878
|
* @param {State} orificeState - The fluid state at the orifice at the specified time.
|
|
873
|
-
* @param {number} orificeVelocity - The velocity at the orifice at the specified time.
|
|
879
|
+
* @param {number} orificeVelocity - The velocity at the orifice at the specified time. [m/s]
|
|
874
880
|
* @param {State} storageState - The fluid state of the storage at the specified time.
|
|
875
|
-
* @param {number} dropletDiameter - A representative size of entrained liquid droplets.
|
|
876
|
-
* @param {number} expandedDiameter - The diameter of the assumed circular cross-sectional flow at the point where the fluid has depressurised to ambient pressure. (default value is 0.0)
|
|
881
|
+
* @param {number} dropletDiameter - A representative size of entrained liquid droplets. [m]
|
|
882
|
+
* @param {number} expandedDiameter - The diameter of the assumed circular cross-sectional flow at the point where the fluid has depressurised to ambient pressure. [m] (default value is 0.0)
|
|
877
883
|
*/
|
|
878
884
|
constructor(options?: {
|
|
879
885
|
id?: string;
|
|
@@ -966,13 +972,13 @@ export class DischargeResult extends EntityBase {
|
|
|
966
972
|
/**
|
|
967
973
|
* A set of discharge results that do not vary with time.
|
|
968
974
|
*
|
|
969
|
-
* @param {number} expansionEnergy - The energy released when a pressurized substance, such as a liquid or vapor, is released following an instantaneous rupture.
|
|
970
|
-
* @param {number} releaseMass - Amount of mass released during the discharge.
|
|
971
|
-
* @param {number} height - Release height above ground.
|
|
972
|
-
* @param {number} angle - Release angle (non-instantaneous releases only).
|
|
973
|
-
* @param {number} holeDiameter - Diameter of the hole.
|
|
975
|
+
* @param {number} expansionEnergy - The energy released when a pressurized substance, such as a liquid or vapor, is released following an instantaneous rupture. [J]
|
|
976
|
+
* @param {number} releaseMass - Amount of mass released during the discharge. [kg]
|
|
977
|
+
* @param {number} height - Release height above ground. [m]
|
|
978
|
+
* @param {number} angle - Release angle (non-instantaneous releases only). [rad]
|
|
979
|
+
* @param {number} holeDiameter - Diameter of the hole. [m]
|
|
974
980
|
* @param {Enums.DynamicType} releaseType - Instantaneous, continuous or time-varying. (default value is Enums.DynamicType.UNSET)
|
|
975
|
-
* @param {number} preDilutionAirRate - The rate at which air at ambient conditions mixes with the released material before the cloud starts to move away from the point of release. (default value is 0)
|
|
981
|
+
* @param {number} preDilutionAirRate - The rate at which air at ambient conditions mixes with the released material before the cloud starts to move away from the point of release. [kg/s] (default value is 0)
|
|
976
982
|
*/
|
|
977
983
|
constructor(options?: {
|
|
978
984
|
id?: string;
|
|
@@ -1063,15 +1069,15 @@ export class DispersionOutputConfig extends EntityBase {
|
|
|
1063
1069
|
/**
|
|
1064
1070
|
* Dispersion plotting and reporting parameters.
|
|
1065
1071
|
*
|
|
1066
|
-
* @param {number} downwindDistance - The distance downwind at which concentration at a point is provided. (default value is 100)
|
|
1067
|
-
* @param {number} time - The time of interest, measured from the start of the release. (default value is 60)
|
|
1072
|
+
* @param {number} downwindDistance - The distance downwind at which concentration at a point is provided. [m] (default value is 100)
|
|
1073
|
+
* @param {number} time - The time of interest, measured from the start of the release. [s] (default value is 60)
|
|
1068
1074
|
* @param {Enums.Resolution} resolution - Output resolution of results. (default value is Enums.Resolution.MEDIUM)
|
|
1069
|
-
* @param {number} elevation - The distance that an XY plane of interest is offset from the ground level. (default value is 1)
|
|
1075
|
+
* @param {number} elevation - The distance that an XY plane of interest is offset from the ground level. [m] (default value is 1)
|
|
1070
1076
|
* @param {Enums.SpecialConcentration} specialConcentration - The method used to determine the concentration of interest when post processing dispersion calculations. (default value is Enums.SpecialConcentration.MIN)
|
|
1071
|
-
* @param {number} concentration - Concentration of interest (vol fraction). Not used unless SpecialConcentration is NotDefined. (default value is 0)
|
|
1072
|
-
* @param {number} crosswindDistance - The distance that an XZ plane of interest is offset from the downwind direction (x-axis). (default value is 0)
|
|
1077
|
+
* @param {number} concentration - Concentration of interest (vol fraction). Not used unless SpecialConcentration is NotDefined. [fraction] (default value is 0)
|
|
1078
|
+
* @param {number} crosswindDistance - The distance that an XZ plane of interest is offset from the downwind direction (x-axis). [m] (default value is 0)
|
|
1073
1079
|
* @param {Enums.ContourType} contourType - The type of contour on which the contour points will be based. (default value is Enums.ContourType.FOOTPRINT)
|
|
1074
|
-
* @param {number} lflFractionValue - Value of the lower flammable limit fraction, used when SpecialConcentration is set to Min or LflFraction. (default value is 0.5)
|
|
1080
|
+
* @param {number} lflFractionValue - Value of the lower flammable limit fraction, used when SpecialConcentration is set to Min or LflFraction. [fraction] (default value is 0.5)
|
|
1075
1081
|
* @param {number} componentToTrackIndex - Index of a component that you want to track within a mixture. (default value is -1)
|
|
1076
1082
|
* @param {string} componentToTrackName - Name of the component to track.
|
|
1077
1083
|
*/
|
|
@@ -1187,16 +1193,16 @@ export class DispersionParameters extends EntityBase {
|
|
|
1187
1193
|
/**
|
|
1188
1194
|
* A set of parameters used in dispersion calculations.
|
|
1189
1195
|
*
|
|
1190
|
-
* @param {number} relativeTolerance - Controls the step size used in the core dispersion calculations for integrations of the differential equations for the cloud dynamics and droplet dynamics so as to maximize computational efficiency while minimising the errors involved. (default value is 0.001)
|
|
1196
|
+
* @param {number} relativeTolerance - Controls the step size used in the core dispersion calculations for integrations of the differential equations for the cloud dynamics and droplet dynamics so as to maximize computational efficiency while minimising the errors involved. [fraction] (default value is 0.001)
|
|
1191
1197
|
* @param {Enums.RainoutThermoFlag} rainoutThermoFlag - Sets the model for droplet evaporation calculations. (default value is Enums.RainoutThermoFlag.RAINOUT_NON_EQUILIBRIUM)
|
|
1192
|
-
* @param {number} fixedStepSize - The size of steps within the core dispersion calculations. (default value is 0.01)
|
|
1198
|
+
* @param {number} fixedStepSize - The size of steps within the core dispersion calculations. [s] (default value is 0.01)
|
|
1193
1199
|
* @param {number} outputStepMultiplier - Multiplier to increase each step size after the initial fixed steps. (default value is 1.2)
|
|
1194
|
-
* @param {number} maxDispersionDistance - The maximum dispersion distance that will be modelled. Modelling will stop at this distance even if the lowest concentration of interest has not been reached. (default value is 50000)
|
|
1195
|
-
* @param {number} maxDispersionHeight - The dispersion calculation will stop when this height is exceeded. This provides a means of preventing the calculation of dispersion of buoyant releases going too far above the ground. (default value is 1000)
|
|
1200
|
+
* @param {number} maxDispersionDistance - The maximum dispersion distance that will be modelled. Modelling will stop at this distance even if the lowest concentration of interest has not been reached. [m] (default value is 50000)
|
|
1201
|
+
* @param {number} maxDispersionHeight - The dispersion calculation will stop when this height is exceeded. This provides a means of preventing the calculation of dispersion of buoyant releases going too far above the ground. [m] (default value is 1000)
|
|
1196
1202
|
* @param {number} numberOfReleaseObservers - Number of release observers for time-varying releases. (default value is 5)
|
|
1197
1203
|
* @param {number} numberOfPoolObservers - Number of pool observers for rainout cases. (default value is 10)
|
|
1198
|
-
* @param {number} averagingTime - The core averaging time, used to take into account the effects of changes in the wind direction over the course of the release. (default value is 18.75)
|
|
1199
|
-
* @param {number} lflFractionToStop - The LFL multipler, which determines the minimum concentration of interest for a flammable release. If the concentration of interest determined from the DispersionOutputConfig is lowest than this value, an error will occur. (default value is 0.5)
|
|
1204
|
+
* @param {number} averagingTime - The core averaging time, used to take into account the effects of changes in the wind direction over the course of the release. [s] (default value is 18.75)
|
|
1205
|
+
* @param {number} lflFractionToStop - The LFL multipler, which determines the minimum concentration of interest for a flammable release. If the concentration of interest determined from the DispersionOutputConfig is lowest than this value, an error will occur. [fraction] (default value is 0.5)
|
|
1200
1206
|
*/
|
|
1201
1207
|
constructor(options?: {
|
|
1202
1208
|
id?: string;
|
|
@@ -1324,33 +1330,33 @@ export class DispersionRecord extends EntityBase {
|
|
|
1324
1330
|
* A record containing observer dispersion results at a given time.
|
|
1325
1331
|
*
|
|
1326
1332
|
* @param {number} observerIndex - Id of the observer associated with the record.
|
|
1327
|
-
* @param {number} centrelineConcentration - The (molar) concentraton of the centreline of the cloud, calculated using the averaging time set in the DispersionParameters and taking into account gravity spreading.
|
|
1328
|
-
* @param {number} downwindDistance - The downwind distance reached by the observer, measured from the release location.
|
|
1329
|
-
* @param {number} time - Elapsed time since the start of the release.
|
|
1330
|
-
* @param {number} centrelineConcentrationUncorrected - The uncorrected (molar) concentraton of the centreline of the cloud, which does not take into account gravity spreading.
|
|
1331
|
-
* @param {number} crosswindRadius - A measure of the standard deviation of the concentration profile in the crosswind direction.
|
|
1332
|
-
* @param {number} verticalRadius - A measure of the standard deviation of the concentration profile in the vertical direction.
|
|
1333
|
+
* @param {number} centrelineConcentration - The (molar) concentraton of the centreline of the cloud, calculated using the averaging time set in the DispersionParameters and taking into account gravity spreading. [fraction]
|
|
1334
|
+
* @param {number} downwindDistance - The downwind distance reached by the observer, measured from the release location. [m]
|
|
1335
|
+
* @param {number} time - Elapsed time since the start of the release. [s]
|
|
1336
|
+
* @param {number} centrelineConcentrationUncorrected - The uncorrected (molar) concentraton of the centreline of the cloud, which does not take into account gravity spreading. [fraction]
|
|
1337
|
+
* @param {number} crosswindRadius - A measure of the standard deviation of the concentration profile in the crosswind direction. [m]
|
|
1338
|
+
* @param {number} verticalRadius - A measure of the standard deviation of the concentration profile in the vertical direction. [m]
|
|
1333
1339
|
* @param {number} crosswindExponent - Describe the sharpness or smoothness of the concentration profile in the crosswind direction.
|
|
1334
1340
|
* @param {number} verticalExponent - Describe the sharpness or smoothness of the concentration profile in the vertical direction.
|
|
1335
|
-
* @param {number} theta - Centreline angle from horizontal.
|
|
1336
|
-
* @param {number} centrelineHeight - The height of the centreline of the cloud, measured from ground level.
|
|
1337
|
-
* @param {number} liquidFraction - The liquid fraction in the cloud. If there is liquid in the cloud at the start of the release, the fraction will usually drop gradually during the dispersion as the liquid droplets evaporate, and then drop to zero at the end of the segment when the droplets reach the ground and rain out of the cloud to form a pool.
|
|
1338
|
-
* @param {number} vapourTemperature - The temperature of the vapour portion of the cloud, including entrained air and any entrained water vapour.
|
|
1339
|
-
* @param {number} massConc - The mass concentration of release material, given as the mass in a given volume of cloud. The concentration is calculated using the Averaging Time set in the Dispersion Parameters. At the beginning of the release, this will be the same as the Cloud density, and it then drops below the density as air is entrained into the cloud.
|
|
1340
|
-
* @param {number} velocity - The velocity of the cloud at the centroid.
|
|
1341
|
-
* @param {number} massFlow - Mass flow rate of material in the cloud (non-instantaneous releases) . The value will be constant for a given segment, but can be useful when you are investigating the effects of rainout and evaporation, and the segments that model these phenomena.
|
|
1341
|
+
* @param {number} theta - Centreline angle from horizontal. [rad]
|
|
1342
|
+
* @param {number} centrelineHeight - The height of the centreline of the cloud, measured from ground level. [m]
|
|
1343
|
+
* @param {number} liquidFraction - The liquid fraction in the cloud. If there is liquid in the cloud at the start of the release, the fraction will usually drop gradually during the dispersion as the liquid droplets evaporate, and then drop to zero at the end of the segment when the droplets reach the ground and rain out of the cloud to form a pool. [fraction]
|
|
1344
|
+
* @param {number} vapourTemperature - The temperature of the vapour portion of the cloud, including entrained air and any entrained water vapour. [K]
|
|
1345
|
+
* @param {number} massConc - The mass concentration of release material, given as the mass in a given volume of cloud. The concentration is calculated using the Averaging Time set in the Dispersion Parameters. At the beginning of the release, this will be the same as the Cloud density, and it then drops below the density as air is entrained into the cloud. [kg/m3]
|
|
1346
|
+
* @param {number} velocity - The velocity of the cloud at the centroid. [m/s]
|
|
1347
|
+
* @param {number} massFlow - Mass flow rate of material in the cloud (non-instantaneous releases) . The value will be constant for a given segment, but can be useful when you are investigating the effects of rainout and evaporation, and the segments that model these phenomena. [kg/s]
|
|
1342
1348
|
* @param {number} profileFlag - This shows the type of dispersion modelling being used for the current step.
|
|
1343
1349
|
* @param {number} elevFlag - A flag to indicate whether the release is elevated, touching down, grounded or capped (by the mixing layer height).
|
|
1344
|
-
* @param {number} rhoCloud - The density of the cloud at the centreline.
|
|
1345
|
-
* @param {number} liqTemp - The temperature of the liquid droplets in the cloud.
|
|
1346
|
-
* @param {number} effectiveWidth - The width of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout.
|
|
1347
|
-
* @param {number} effectiveHeight - The height of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout.
|
|
1348
|
-
* @param {number} passTranDist - The distance at which the observer has made the transition to passive dispersion.
|
|
1349
|
-
* @param {number} downwindRadius - A measure of the standard deviation of the concentration profile in the downwind direction.
|
|
1350
|
-
* @param {number} dropletDiameter - The representative diameter for liquid droplets in the cloud.
|
|
1351
|
-
* @param {number} dropletHeight - The representative height for liquid droplets in the cloud, measured above ground level.
|
|
1352
|
-
* @param {number} dropletDistance - The downwind distance of droplets in the cloud.
|
|
1353
|
-
* @param {number} mass - The mass of released material in the cloud (instantaneous releases).
|
|
1350
|
+
* @param {number} rhoCloud - The density of the cloud at the centreline. [kg/m3]
|
|
1351
|
+
* @param {number} liqTemp - The temperature of the liquid droplets in the cloud. [K]
|
|
1352
|
+
* @param {number} effectiveWidth - The width of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout. [m]
|
|
1353
|
+
* @param {number} effectiveHeight - The height of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout. [m]
|
|
1354
|
+
* @param {number} passTranDist - The distance at which the observer has made the transition to passive dispersion. [m]
|
|
1355
|
+
* @param {number} downwindRadius - A measure of the standard deviation of the concentration profile in the downwind direction. [m]
|
|
1356
|
+
* @param {number} dropletDiameter - The representative diameter for liquid droplets in the cloud. [m]
|
|
1357
|
+
* @param {number} dropletHeight - The representative height for liquid droplets in the cloud, measured above ground level. [m]
|
|
1358
|
+
* @param {number} dropletDistance - The downwind distance of droplets in the cloud. [m]
|
|
1359
|
+
* @param {number} mass - The mass of released material in the cloud (instantaneous releases). [kg]
|
|
1354
1360
|
* @param {Enums.DynamicType} instCon - Instantanous or continuous (time-varying not permitted). (default value is Enums.DynamicType.UNSET)
|
|
1355
1361
|
*/
|
|
1356
1362
|
constructor(options?: {
|
|
@@ -1566,7 +1572,7 @@ export class ExplosionConfinedVolume extends EntityBase {
|
|
|
1566
1572
|
* Confined explosion volume data.
|
|
1567
1573
|
*
|
|
1568
1574
|
* @param {number} confinedStrength - The degree of confinement in the area or source, described by an integer between 3 (lowest) and 10 (highest). (default value is 7)
|
|
1569
|
-
* @param {number} confinedVolume - The volume of the cloud that is contained in the area of confinement. (default value is 1)
|
|
1575
|
+
* @param {number} confinedVolume - The volume of the cloud that is contained in the area of confinement. [m3] (default value is 1)
|
|
1570
1576
|
*/
|
|
1571
1577
|
constructor(options?: {
|
|
1572
1578
|
id?: string;
|
|
@@ -1609,7 +1615,7 @@ export class ExplosionOutputConfig extends EntityBase {
|
|
|
1609
1615
|
/**
|
|
1610
1616
|
* Explosion plotting and reporting parameters.
|
|
1611
1617
|
*
|
|
1612
|
-
* @param {number} overpressureLevel - Overpressure of interest for explosions. (default value is 2068)
|
|
1618
|
+
* @param {number} overpressureLevel - Overpressure of interest for explosions. [N/m2] (default value is 2068)
|
|
1613
1619
|
* @param {Enums.MEConfinedMethod} meConfinedMethod - The multi energy confined method for modelling the effects of explosions. (default value is Enums.MEConfinedMethod.UNIFORM_CONFINED)
|
|
1614
1620
|
*/
|
|
1615
1621
|
constructor(options?: {
|
|
@@ -1666,12 +1672,12 @@ export class ExplosionOverpressureResult extends EntityBase {
|
|
|
1666
1672
|
/**
|
|
1667
1673
|
* Worst case explosion summary results for a given overpressure.
|
|
1668
1674
|
*
|
|
1669
|
-
* @param {number} overpressure - The target overpressure level for the worst-case explosion.
|
|
1670
|
-
* @param {number} explosionCentre - The distance downwind from the release source to the centre of the explosion.
|
|
1671
|
-
* @param {number} maximumDistance - The maximum downwind distance reached by the effect zone for the overpressure level of interest.
|
|
1672
|
-
* @param {number} explodedMass - The flammable mass used in the explosion.
|
|
1673
|
-
* @param {number} ignitionTime - The time that the cloud is ignited, measured from the start of the release.
|
|
1674
|
-
* @param {number} radius - The radius of the effect zone for the overpressure level of interest.
|
|
1675
|
+
* @param {number} overpressure - The target overpressure level for the worst-case explosion. [N/m2]
|
|
1676
|
+
* @param {number} explosionCentre - The distance downwind from the release source to the centre of the explosion. [m]
|
|
1677
|
+
* @param {number} maximumDistance - The maximum downwind distance reached by the effect zone for the overpressure level of interest. [m]
|
|
1678
|
+
* @param {number} explodedMass - The flammable mass used in the explosion. [kg]
|
|
1679
|
+
* @param {number} ignitionTime - The time that the cloud is ignited, measured from the start of the release. [s]
|
|
1680
|
+
* @param {number} radius - The radius of the effect zone for the overpressure level of interest. [m]
|
|
1675
1681
|
*/
|
|
1676
1682
|
constructor(options?: {
|
|
1677
1683
|
id?: string;
|
|
@@ -1776,10 +1782,10 @@ export class FlameRecord extends EntityBase {
|
|
|
1776
1782
|
/**
|
|
1777
1783
|
* A record containing flame geometry data.
|
|
1778
1784
|
*
|
|
1779
|
-
* @param {number} xCoordinate - The distance downwind from the release source to the centre of a circle describing the frustum base or tip.
|
|
1780
|
-
* @param {number} zCoordinate - The height above the ground of the centre of a circle describing the frustum base or tip.
|
|
1781
|
-
* @param {number} rCoordinate - The radius of the frustum base or tip.
|
|
1782
|
-
* @param {number} phiCoordinate - Inclination of the frustum base or tip from the vertical.
|
|
1785
|
+
* @param {number} xCoordinate - The distance downwind from the release source to the centre of a circle describing the frustum base or tip. [m]
|
|
1786
|
+
* @param {number} zCoordinate - The height above the ground of the centre of a circle describing the frustum base or tip. [m]
|
|
1787
|
+
* @param {number} rCoordinate - The radius of the frustum base or tip. [m]
|
|
1788
|
+
* @param {number} phiCoordinate - Inclination of the frustum base or tip from the vertical. [rad]
|
|
1783
1789
|
*/
|
|
1784
1790
|
constructor(options?: {
|
|
1785
1791
|
id?: string;
|
|
@@ -1837,10 +1843,10 @@ export class FlameResult extends EntityBase {
|
|
|
1837
1843
|
/**
|
|
1838
1844
|
* A set of flame results.
|
|
1839
1845
|
*
|
|
1840
|
-
* @param {number} time - Time of interest for time varying releases, or duration for initial rate releases.
|
|
1841
|
-
* @param {number} surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area.
|
|
1842
|
-
* @param {number} flameLength - Length of the flame.
|
|
1843
|
-
* @param {number} flameDiameter - Diameter of the flame.
|
|
1846
|
+
* @param {number} time - Time of interest for time varying releases, or duration for initial rate releases. [s]
|
|
1847
|
+
* @param {number} surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area. [W/m2]
|
|
1848
|
+
* @param {number} flameLength - Length of the flame. [m]
|
|
1849
|
+
* @param {number} flameDiameter - Diameter of the flame. [m]
|
|
1844
1850
|
* @param {Enums.FireType} fireType - Type of fire. (default value is Enums.FireType.NO_FIRE)
|
|
1845
1851
|
*/
|
|
1846
1852
|
constructor(options?: {
|
|
@@ -1972,7 +1978,7 @@ export class FlammableOutputConfig extends EntityBase {
|
|
|
1972
1978
|
* @param {number} radiationLevel - The radiation level of interest for the RadiationType. (default value is 4000)
|
|
1973
1979
|
* @param {Enums.Resolution} radiationResolution - Spatial resolution for radiation calculations. (default value is Enums.Resolution.MEDIUM)
|
|
1974
1980
|
* @param {number} fixedOrientation - Whether to specify the orientation of a flat surface on which an observer lies with respect to the flame. (default value is 0)
|
|
1975
|
-
* @param {number} orientation - Angle between the projection of the observer normal onto the horizontal plane and the y axis. (default value is 0)
|
|
1981
|
+
* @param {number} orientation - Angle between the projection of the observer normal onto the horizontal plane and the y axis. [rad] (default value is 0)
|
|
1976
1982
|
* @param {number} fixedInclination - Whether to specify the inclination of a flat surface on which an observer lies with respect to the flame. (default value is 0)
|
|
1977
1983
|
* @param {number} inclination - Angle between the observer normal and the horizontal plane. (default value is 0)
|
|
1978
1984
|
*/
|
|
@@ -2080,8 +2086,8 @@ export class FlammableParameters extends EntityBase {
|
|
|
2080
2086
|
/**
|
|
2081
2087
|
* A set of parameters used in fire and radiation calculations.
|
|
2082
2088
|
*
|
|
2083
|
-
* @param {number} maxExposureDuration - The time that someone will remain in range of the radiation before attempting to escape. It is used in the calculations of dose and lethality. (default value is 20)
|
|
2084
|
-
* @param {number} radiationRelativeTolerance - Controls the precision of the numerical integration over the visible surface of the flame when calculating the view factor of the flame as seen by an observer at a specific position. (default value is 0.01)
|
|
2089
|
+
* @param {number} maxExposureDuration - The time that someone will remain in range of the radiation before attempting to escape. It is used in the calculations of dose and lethality. [s] (default value is 20)
|
|
2090
|
+
* @param {number} radiationRelativeTolerance - Controls the precision of the numerical integration over the visible surface of the flame when calculating the view factor of the flame as seen by an observer at a specific position. [fraction] (default value is 0.01)
|
|
2085
2091
|
* @param {Enums.PoolFireType} poolFireType - Type of pool fire modelling. (default value is Enums.PoolFireType.LATE)
|
|
2086
2092
|
* @param {boolean} jetFireAutoSelect - Whether to have the calculations automatically select the type of jet fire modelling. (default value is false)
|
|
2087
2093
|
* @param {boolean} timeAveraging - Whether to base the jet fire calculations on a discharge rate averaged between 0 seconds and a TimeOfInterest. (default value is true)
|
|
@@ -2175,21 +2181,21 @@ export class FlashResult extends EntityBase {
|
|
|
2175
2181
|
/**
|
|
2176
2182
|
* Physical properties for a material generated at a particular pressure and temperature.
|
|
2177
2183
|
*
|
|
2178
|
-
* @param {number} pressure - Pressure.
|
|
2179
|
-
* @param {number} temperature - Temperature.
|
|
2180
|
-
* @param {number} liquidMoleFraction - Liquid fraction (mole).
|
|
2181
|
-
* @param {number} liquidDensity - Density of liquid phase.
|
|
2182
|
-
* @param {number} vapourDensity - Density of vapour phase.
|
|
2183
|
-
* @param {number} liquidEntropy - Entropy of liquid phase.
|
|
2184
|
-
* @param {number} vapourEntropy - Entropy of vapour phase.
|
|
2184
|
+
* @param {number} pressure - Pressure. [N/m2]
|
|
2185
|
+
* @param {number} temperature - Temperature. [K]
|
|
2186
|
+
* @param {number} liquidMoleFraction - Liquid fraction (mole). [fraction]
|
|
2187
|
+
* @param {number} liquidDensity - Density of liquid phase. [kg/m3]
|
|
2188
|
+
* @param {number} vapourDensity - Density of vapour phase. [kg/m3]
|
|
2189
|
+
* @param {number} liquidEntropy - Entropy of liquid phase. [J/kg.K]
|
|
2190
|
+
* @param {number} vapourEntropy - Entropy of vapour phase. [J/kg.K]
|
|
2185
2191
|
* @param {number} liquidEnthalpy - Enthalpy of liquid phase.
|
|
2186
2192
|
* @param {number} vapourEnthalpy - Enthalpy of vapour phase.
|
|
2187
|
-
* @param {number} bubblePointPressure - Mixture bubble point pressure at given temperature.
|
|
2188
|
-
* @param {number} bubblePointTemperature - Mixture bubble point temperature at given pressure.
|
|
2189
|
-
* @param {number} dewPointPressure - Mixture dew point pressure at given temperature.
|
|
2190
|
-
* @param {number} dewPointTemperature - Mixture dew point temperature at given pressure.
|
|
2191
|
-
* @param {number} totalFluidDensity - Total fluid density (mass-based).
|
|
2192
|
-
* @param {number} liquidMassFraction - Liquid mass fraction.
|
|
2193
|
+
* @param {number} bubblePointPressure - Mixture bubble point pressure at given temperature. [N/m2]
|
|
2194
|
+
* @param {number} bubblePointTemperature - Mixture bubble point temperature at given pressure. [K]
|
|
2195
|
+
* @param {number} dewPointPressure - Mixture dew point pressure at given temperature. [N/m2]
|
|
2196
|
+
* @param {number} dewPointTemperature - Mixture dew point temperature at given pressure. [K]
|
|
2197
|
+
* @param {number} totalFluidDensity - Total fluid density (mass-based). [kg/m3]
|
|
2198
|
+
* @param {number} liquidMassFraction - Liquid mass fraction. [fraction]
|
|
2193
2199
|
* @param {Enums.Phase} fluidPhase - Vapour, liquid or two-phase. (default value is Enums.Phase.UNSET)
|
|
2194
2200
|
*/
|
|
2195
2201
|
constructor(options?: {
|
|
@@ -2327,11 +2333,11 @@ export class Leak extends ReleaseOverTime {
|
|
|
2327
2333
|
/**
|
|
2328
2334
|
* A storage scenario which models a release of material through a hole in a vessel or pipe.
|
|
2329
2335
|
*
|
|
2330
|
-
* @param {number} holeDiameter - The diameter of the equivalent circular orifice with the same area as the area of the leak.
|
|
2331
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
2336
|
+
* @param {number} holeDiameter - The diameter of the equivalent circular orifice with the same area as the area of the leak. [m]
|
|
2337
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2332
2338
|
* @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)
|
|
2333
|
-
* @param {number} holeHeightFraction - Location of the hole above the base of a vessel as a fraction of the vessel's vertical dimension. (default value is 0.5)
|
|
2334
|
-
* @param {number} releaseElevation - The elevation of the release. (default value is 1)
|
|
2339
|
+
* @param {number} holeHeightFraction - Location of the hole above the base of a vessel as a fraction of the vessel's vertical dimension. [fraction] (default value is 0.5)
|
|
2340
|
+
* @param {number} releaseElevation - The elevation of the release. [m] (default value is 1)
|
|
2335
2341
|
*/
|
|
2336
2342
|
constructor(options?: {
|
|
2337
2343
|
id?: string;
|
|
@@ -2386,12 +2392,12 @@ export class LineRupture extends ReleaseOverTime {
|
|
|
2386
2392
|
/**
|
|
2387
2393
|
* A storage scenario which models a release of material due to rupture of a short length of pipework attached to a vessel or any kind of pressure reservoir.
|
|
2388
2394
|
*
|
|
2389
|
-
* @param {number} pipeDiameter - Internal diameter of the short pipe.
|
|
2390
|
-
* @param {number} pipeLength - Length of the short pipe.
|
|
2391
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
2395
|
+
* @param {number} pipeDiameter - Internal diameter of the short pipe. [m]
|
|
2396
|
+
* @param {number} pipeLength - Length of the short pipe. [m]
|
|
2397
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2392
2398
|
* @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)
|
|
2393
|
-
* @param {number} pipeRoughness - Roughness of the short pipe. (default value is 0.000045)
|
|
2394
|
-
* @param {number} pipeHeightFraction - Height of the pipe connection measured from the base of the vessel. (default value is 0.5)
|
|
2399
|
+
* @param {number} pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
2400
|
+
* @param {number} pipeHeightFraction - Height of the pipe connection measured from the base of the vessel. [fraction] (default value is 0.5)
|
|
2395
2401
|
*/
|
|
2396
2402
|
constructor(options?: {
|
|
2397
2403
|
id?: string;
|
|
@@ -2614,20 +2620,20 @@ export class MixtureConstantPropertiesResult extends EntityBase {
|
|
|
2614
2620
|
/**
|
|
2615
2621
|
* Constant properties of a mixture.
|
|
2616
2622
|
*
|
|
2617
|
-
* @param {number} lowerFlammabilityLimit - The minimum concentration of vapour in air that is capable of propagating a flame through a homogeneous mixture of air and the vapour.
|
|
2618
|
-
* @param {number} upperFlammabilityLimit - The maximum concentration of vapour in air that is capable of propagating a flame through a homogeneous mixture of air and the vapour.
|
|
2619
|
-
* @param {number} criticalPressure - The pressure above which liquid and gas cannot coexist at any temperature.
|
|
2620
|
-
* @param {number} criticalTemperature - The temperature above which the gas cannot become liquid, regardless of the applied pressure.
|
|
2621
|
-
* @param {number} flashPoint - The lowest temperature at which a liquid can create enough vapour to ignite when exposed to an external heat source.
|
|
2623
|
+
* @param {number} lowerFlammabilityLimit - The minimum concentration of vapour in air that is capable of propagating a flame through a homogeneous mixture of air and the vapour. [fraction]
|
|
2624
|
+
* @param {number} upperFlammabilityLimit - The maximum concentration of vapour in air that is capable of propagating a flame through a homogeneous mixture of air and the vapour. [fraction]
|
|
2625
|
+
* @param {number} criticalPressure - The pressure above which liquid and gas cannot coexist at any temperature. [N/m2]
|
|
2626
|
+
* @param {number} criticalTemperature - The temperature above which the gas cannot become liquid, regardless of the applied pressure. [K]
|
|
2627
|
+
* @param {number} flashPoint - The lowest temperature at which a liquid can create enough vapour to ignite when exposed to an external heat source. [K]
|
|
2622
2628
|
* @param {number} heatCombustion - The amount of energy released in the form of heat when one mole of a substance is burned.
|
|
2623
2629
|
* @param {number} maximumBurnRate - The maximum mass rate at which a material burns per unit area, used in pool fire modelling.
|
|
2624
2630
|
* @param {number} maximumSEP - The maximum surface emissive power of a material.
|
|
2625
|
-
* @param {number} molecularWeight - The sum of the atomic masses of all atoms in a molecule.
|
|
2626
|
-
* @param {number} bubblePoint - The temperature where the first bubble of vapor is formed when heating a liquid at atmospheric pressure.
|
|
2627
|
-
* @param {number} poolFireBurnRateLength - A characteristic pool fire burn rate length.
|
|
2628
|
-
* @param {number} dewPoint - The temperature at which the first liquid drop will form when cooling a gas at atmospheric pressure.
|
|
2629
|
-
* @param {number} emissivePowerLengthScale - Used in pool fire modelling for calculating the emissive power for a fire with a given diameter.
|
|
2630
|
-
* @param {number} laminarBurningVelocity - The flame speed, used in the Multi-Energy explosion modelling to calculate the peak overpressure, and can also be used in the pool fire calculations to calculate the MaximumBurnRate.
|
|
2631
|
+
* @param {number} molecularWeight - The sum of the atomic masses of all atoms in a molecule. [kg/kmol]
|
|
2632
|
+
* @param {number} bubblePoint - The temperature where the first bubble of vapor is formed when heating a liquid at atmospheric pressure. [K]
|
|
2633
|
+
* @param {number} poolFireBurnRateLength - A characteristic pool fire burn rate length. [m]
|
|
2634
|
+
* @param {number} dewPoint - The temperature at which the first liquid drop will form when cooling a gas at atmospheric pressure. [K]
|
|
2635
|
+
* @param {number} emissivePowerLengthScale - Used in pool fire modelling for calculating the emissive power for a fire with a given diameter. [m]
|
|
2636
|
+
* @param {number} laminarBurningVelocity - The flame speed, used in the Multi-Energy explosion modelling to calculate the peak overpressure, and can also be used in the pool fire calculations to calculate the MaximumBurnRate. [m/s]
|
|
2631
2637
|
* @param {Enums.FlammableToxic} flammableToxicFlag - Whether a material is flammable, toxic, both or inert. (default value is Enums.FlammableToxic.INERT)
|
|
2632
2638
|
* @param {Enums.LuminousSmokyFlame} luminousSmokyFlame - A flag to indicate whether a flame is luminous or smoky. (default value is Enums.LuminousSmokyFlame.GENERAL)
|
|
2633
2639
|
*/
|
|
@@ -2773,11 +2779,11 @@ export class Pipe extends Asset {
|
|
|
2773
2779
|
* @param {LocalPosition} location - Location of the asset.
|
|
2774
2780
|
* @param {LocalPosition[]} nodes - A set of points along the pipe.
|
|
2775
2781
|
* @param {number} nodeCount - The number of nodes along the pipe.
|
|
2776
|
-
* @param {number} diameter - Diameter of the pipe.
|
|
2782
|
+
* @param {number} diameter - Diameter of the pipe. [m]
|
|
2777
2783
|
* @param {Material} material - Material.
|
|
2778
2784
|
* @param {State} state - Fluid state in the pipe.
|
|
2779
|
-
* @param {number} roughness - A measure of the roughness of internal surfaces of the pipe. (default value is 4.5e-5)
|
|
2780
|
-
* @param {number} pumpedInflow - Flowrate along the pipeline under normal operating conditions. (default value is 0)
|
|
2785
|
+
* @param {number} roughness - A measure of the roughness of internal surfaces of the pipe. [m] (default value is 4.5e-5)
|
|
2786
|
+
* @param {number} pumpedInflow - Flowrate along the pipeline under normal operating conditions. [kg/s] (default value is 0)
|
|
2781
2787
|
*/
|
|
2782
2788
|
constructor(options?: {
|
|
2783
2789
|
id?: string;
|
|
@@ -2860,10 +2866,10 @@ export class PipeBreach extends ReleaseOverTime {
|
|
|
2860
2866
|
/**
|
|
2861
2867
|
* A storage scenario which models a time-dependent release of material from its process or transport conditions in a pipeline.
|
|
2862
2868
|
*
|
|
2863
|
-
* @param {number} distanceDownstream - The distance of the pipe breach, measured along the pipeline from the upstream end.
|
|
2864
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
2869
|
+
* @param {number} distanceDownstream - The distance of the pipe breach, measured along the pipeline from the upstream end. [m]
|
|
2870
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2865
2871
|
* @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)
|
|
2866
|
-
* @param {number} relativeAperture - The size of the outflow area as a fraction of the total potential outflow area for the breach location. (default value is 1)
|
|
2872
|
+
* @param {number} relativeAperture - The size of the outflow area as a fraction of the total potential outflow area for the breach location. [fraction] (default value is 1)
|
|
2867
2873
|
*/
|
|
2868
2874
|
constructor(options?: {
|
|
2869
2875
|
id?: string;
|
|
@@ -2909,11 +2915,11 @@ export class PoolFireFlameResult extends FlameResult {
|
|
|
2909
2915
|
/**
|
|
2910
2916
|
* Flame results for a pool fire.
|
|
2911
2917
|
*
|
|
2912
|
-
* @param {number} time - Time of interest for time varying releases, or duration for initial rate releases.
|
|
2913
|
-
* @param {number} surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area.
|
|
2914
|
-
* @param {number} flameLength - Length of the flame.
|
|
2915
|
-
* @param {number} flameDiameter - Diameter of the flame.
|
|
2916
|
-
* @param {number[]} poolZoneSEP - Surface emissive power from each of the two pool fire zones.
|
|
2918
|
+
* @param {number} time - Time of interest for time varying releases, or duration for initial rate releases. [s]
|
|
2919
|
+
* @param {number} surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area. [W/m2]
|
|
2920
|
+
* @param {number} flameLength - Length of the flame. [m]
|
|
2921
|
+
* @param {number} flameDiameter - Diameter of the flame. [m]
|
|
2922
|
+
* @param {number[]} poolZoneSEP - Surface emissive power from each of the two pool fire zones. [W/m2]
|
|
2917
2923
|
* @param {Enums.FireType} fireType - Type of fire. (default value is Enums.FireType.NO_FIRE)
|
|
2918
2924
|
*/
|
|
2919
2925
|
constructor(options?: {
|
|
@@ -2972,19 +2978,19 @@ export class PoolRecord extends EntityBase {
|
|
|
2972
2978
|
/**
|
|
2973
2979
|
* A record containing pool results at a given time.
|
|
2974
2980
|
*
|
|
2975
|
-
* @param {number} time - Time since rainout occurred.
|
|
2976
|
-
* @param {number} massSpilt - The mass that rains out and forms a pool.
|
|
2977
|
-
* @param {number} massVaporised - Mass vaporised from the pool.
|
|
2978
|
-
* @param {number} massDissolved - The mass of the pool dissolved in water.
|
|
2979
|
-
* @param {number} massRemaining - Mass remaining in the pool.
|
|
2980
|
-
* @param {number} vapourisationRate - The rate of vapourisation from the pool.
|
|
2981
|
-
* @param {number} solutionRate - The rate at which the pool will dissolve in water.
|
|
2982
|
-
* @param {number} effectiveRadius - The radius of the area of the pool which is taking into account the amount of mass re-evaporated into the cloud.
|
|
2983
|
-
* @param {number} depth - Depth of the pool.
|
|
2984
|
-
* @param {number} temperature - Temperature of the material in the pool.
|
|
2985
|
-
* @param {number} spillRate - The mass rate at which the cloud is raining out and forming a pool.
|
|
2986
|
-
* @param {number} actualRadius - The radius of the pool formed.
|
|
2987
|
-
* @param {number} poolCentre - The downwind distance at which rainout occurs and a pool is formed.
|
|
2981
|
+
* @param {number} time - Time since rainout occurred. [s]
|
|
2982
|
+
* @param {number} massSpilt - The mass that rains out and forms a pool. [kg]
|
|
2983
|
+
* @param {number} massVaporised - Mass vaporised from the pool. [kg]
|
|
2984
|
+
* @param {number} massDissolved - The mass of the pool dissolved in water. [kg]
|
|
2985
|
+
* @param {number} massRemaining - Mass remaining in the pool. [kg]
|
|
2986
|
+
* @param {number} vapourisationRate - The rate of vapourisation from the pool. [kg/s]
|
|
2987
|
+
* @param {number} solutionRate - The rate at which the pool will dissolve in water. [kg/s]
|
|
2988
|
+
* @param {number} effectiveRadius - The radius of the area of the pool which is taking into account the amount of mass re-evaporated into the cloud. [m]
|
|
2989
|
+
* @param {number} depth - Depth of the pool. [m]
|
|
2990
|
+
* @param {number} temperature - Temperature of the material in the pool. [K]
|
|
2991
|
+
* @param {number} spillRate - The mass rate at which the cloud is raining out and forming a pool. [kg/s]
|
|
2992
|
+
* @param {number} actualRadius - The radius of the pool formed. [m]
|
|
2993
|
+
* @param {number} poolCentre - The downwind distance at which rainout occurs and a pool is formed. [m]
|
|
2988
2994
|
*/
|
|
2989
2995
|
constructor(options?: {
|
|
2990
2996
|
id?: string;
|
|
@@ -3094,9 +3100,9 @@ export class PoolVapourisationParameters extends EntityBase {
|
|
|
3094
3100
|
/**
|
|
3095
3101
|
* Pool vapourisation parameters.
|
|
3096
3102
|
*
|
|
3097
|
-
* @param {number} toxicsCutoffRate - The rate below which pool vaporisation calculations for toxic releases stop and any remaining mass in the pool no longer contributes to toxic effects. (default value is 0.001)
|
|
3098
|
-
* @param {number} flammableCutoffRate - The rate below which pool vaporisation calculations for flammable releases stop and any remaining mass in the pool contributes to pool fire effects only. (default value is 0.1)
|
|
3099
|
-
* @param {number} relativeTolerance - Controls the step size used by the pool modelling in the integrations of the differential equations for the pool behaviour so as to maximize computational efficiency while minimising the errors involved. (default value is 0.001)
|
|
3103
|
+
* @param {number} toxicsCutoffRate - The rate below which pool vaporisation calculations for toxic releases stop and any remaining mass in the pool no longer contributes to toxic effects. [kg/s] (default value is 0.001)
|
|
3104
|
+
* @param {number} flammableCutoffRate - The rate below which pool vaporisation calculations for flammable releases stop and any remaining mass in the pool contributes to pool fire effects only. [kg/s] (default value is 0.1)
|
|
3105
|
+
* @param {number} relativeTolerance - Controls the step size used by the pool modelling in the integrations of the differential equations for the pool behaviour so as to maximize computational efficiency while minimising the errors involved. [fraction] (default value is 0.001)
|
|
3100
3106
|
*/
|
|
3101
3107
|
constructor(options?: {
|
|
3102
3108
|
id?: string;
|
|
@@ -3210,13 +3216,13 @@ export class ReliefValve extends ReleaseOverTime {
|
|
|
3210
3216
|
/**
|
|
3211
3217
|
* A storage scenario which models a release of material from the vapour side of a vessel due to the lifting of a relief valve.
|
|
3212
3218
|
*
|
|
3213
|
-
* @param {number} reliefValveConstrictionDiameter - Constriction at the upstream end of the pipe.
|
|
3214
|
-
* @param {number} pipeDiameter - Internal diameter of the short pipe.
|
|
3215
|
-
* @param {number} pipeLength - Length of the short pipe.
|
|
3216
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
3219
|
+
* @param {number} reliefValveConstrictionDiameter - Constriction at the upstream end of the pipe. [m]
|
|
3220
|
+
* @param {number} pipeDiameter - Internal diameter of the short pipe. [m]
|
|
3221
|
+
* @param {number} pipeLength - Length of the short pipe. [m]
|
|
3222
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
3217
3223
|
* @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)
|
|
3218
|
-
* @param {number} pipeRoughness - Roughness of the short pipe. (default value is 0.000045)
|
|
3219
|
-
* @param {number} pipeHeightFraction - Location of the pipe connection above the base of the vessel. (default value is 0.5)
|
|
3224
|
+
* @param {number} pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
3225
|
+
* @param {number} pipeHeightFraction - Location of the pipe connection above the base of the vessel. [fraction] (default value is 0.5)
|
|
3220
3226
|
*/
|
|
3221
3227
|
constructor(options?: {
|
|
3222
3228
|
id?: string;
|
|
@@ -3285,12 +3291,12 @@ export class SafetySystem extends EntityBase {
|
|
|
3285
3291
|
/**
|
|
3286
3292
|
* A safety system entity which defines isolation and blowdown settings for a pressurised vessel.
|
|
3287
3293
|
*
|
|
3288
|
-
* @param {number} isolationTime - Time from start of release to failed or successful isolation. (default value is 0.0)
|
|
3294
|
+
* @param {number} isolationTime - Time from start of release to failed or successful isolation. [s] (default value is 0.0)
|
|
3289
3295
|
* @param {boolean} isolationSuccess - Does isolation succeed?. (default value is true)
|
|
3290
|
-
* @param {number} massAddedIsolationFailure - Upstream mass to add in case of isolation failure. (default value is 0.0)
|
|
3291
|
-
* @param {number} blowdownTime - Time from start of release to failed or successful blowdown. (default value is 0.0)
|
|
3296
|
+
* @param {number} massAddedIsolationFailure - Upstream mass to add in case of isolation failure. [kg] (default value is 0.0)
|
|
3297
|
+
* @param {number} blowdownTime - Time from start of release to failed or successful blowdown. [s] (default value is 0.0)
|
|
3292
3298
|
* @param {boolean} blowdownSuccess - Does blowdown succeed?. (default value is false)
|
|
3293
|
-
* @param {number} blowdownValveSize - Diameter of blowdown valve. (default value is 0.025)
|
|
3299
|
+
* @param {number} blowdownValveSize - Diameter of blowdown valve. [m] (default value is 0.025)
|
|
3294
3300
|
*/
|
|
3295
3301
|
constructor(options?: {
|
|
3296
3302
|
id?: string;
|
|
@@ -3364,10 +3370,10 @@ export class ScalarUdmOutputs extends EntityBase {
|
|
|
3364
3370
|
*
|
|
3365
3371
|
* @param {number} observerCount - Number of observers either from the release or from the pool.
|
|
3366
3372
|
* @param {number} recordCount - Number of total dispersion records from all observers.
|
|
3367
|
-
* @param {number} minimumConcentration - Minimum concentration to which dispersion calculations have been performed.
|
|
3373
|
+
* @param {number} minimumConcentration - Minimum concentration to which dispersion calculations have been performed. [fraction]
|
|
3368
3374
|
* @param {number} windPower - A wind profile exponent describing how wind changes with height.
|
|
3369
|
-
* @param {number} frictionVelocity - The shear stress between the air and the ground.
|
|
3370
|
-
* @param {number} dispersionReleaseDuration - The time at which the last observer is released.
|
|
3375
|
+
* @param {number} frictionVelocity - The shear stress between the air and the ground. [m/s]
|
|
3376
|
+
* @param {number} dispersionReleaseDuration - The time at which the last observer is released. [s]
|
|
3371
3377
|
* @param {Enums.DynamicType} cloudType - Type of release or cloud. (default value is Enums.DynamicType.UNSET)
|
|
3372
3378
|
*/
|
|
3373
3379
|
constructor(options?: {
|
|
@@ -3452,12 +3458,12 @@ export class ShortPipeRupture extends ReleaseOverTime {
|
|
|
3452
3458
|
/**
|
|
3453
3459
|
* Short pipe rupture scenario.
|
|
3454
3460
|
*
|
|
3455
|
-
* @param {number} pipeLength - Length of short pipe.
|
|
3456
|
-
* @param {number} pipeDiameter - Inner diameter of the short pipe.
|
|
3457
|
-
* @param {number} releaseAngle - Angle of release above a horizontal plane. (default value is 0.0)
|
|
3461
|
+
* @param {number} pipeLength - Length of short pipe. [m]
|
|
3462
|
+
* @param {number} pipeDiameter - Inner diameter of the short pipe. [m]
|
|
3463
|
+
* @param {number} releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
3458
3464
|
* @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)
|
|
3459
|
-
* @param {number} pipeRoughness - Roughness of the short pipe. (default value is 0.000045)
|
|
3460
|
-
* @param {number} pipeHeightFraction - Location of the pipe connection above the base of the vessel. (default value is 0.5)
|
|
3465
|
+
* @param {number} pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
3466
|
+
* @param {number} pipeHeightFraction - Location of the pipe connection above the base of the vessel. [fraction] (default value is 0.5)
|
|
3461
3467
|
*/
|
|
3462
3468
|
constructor(options?: {
|
|
3463
3469
|
id?: string;
|
|
@@ -3565,7 +3571,7 @@ export class Substrate extends EntityBase {
|
|
|
3565
3571
|
* The ground over which a release is taking place.
|
|
3566
3572
|
*
|
|
3567
3573
|
* @param {Bund} bund - A bund entity used in the modelling of pool spreading and vaporisation.
|
|
3568
|
-
* @param {number} surfaceRoughness - The height above the ground below which the wind speed is theoretically zero due to friction from the surface. (default value is 0.183)
|
|
3574
|
+
* @param {number} surfaceRoughness - The height above the ground below which the wind speed is theoretically zero due to friction from the surface. [m] (default value is 0.183)
|
|
3569
3575
|
* @param {Enums.SurfaceType} surfaceType - Surface over which the dispersion occurs. (default value is Enums.SurfaceType.LAND)
|
|
3570
3576
|
* @param {Enums.PoolSurfaceType} poolSurfaceType - Surface onto which the liquid which rains out will spread. (default value is Enums.PoolSurfaceType.CONCRETE)
|
|
3571
3577
|
*/
|
|
@@ -3706,13 +3712,13 @@ export class Vessel extends Asset {
|
|
|
3706
3712
|
* @param {State} state - Fluid state in the vessel.
|
|
3707
3713
|
* @param {Material} material - Material in the vessel.
|
|
3708
3714
|
* @param {SafetySystem} safetySystem - A safety system entity which defines isolation and blowdown settings for a pressurised vessel.
|
|
3709
|
-
* @param {number} diameter - Internal diameter of the vessel. (default value is 2)
|
|
3710
|
-
* @param {number} height - Internal height of a VerticalCylinder or VesselCuboid. (default value is 4)
|
|
3711
|
-
* @param {number} length - Internal length of HorizontalCylinder or VesselCuboid. (default value is 4)
|
|
3712
|
-
* @param {number} width - Internal width of a VesselCuboid. (default value is 2.0)
|
|
3715
|
+
* @param {number} diameter - Internal diameter of the vessel. [m] (default value is 2)
|
|
3716
|
+
* @param {number} height - Internal height of a VerticalCylinder or VesselCuboid. [m] (default value is 4)
|
|
3717
|
+
* @param {number} length - Internal length of HorizontalCylinder or VesselCuboid. [m] (default value is 4)
|
|
3718
|
+
* @param {number} width - Internal width of a VesselCuboid. [m] (default value is 2.0)
|
|
3713
3719
|
* @param {Enums.VesselShape} shape - Shape of the vessel. (default value is Enums.VesselShape.HORIZONTAL_CYLINDER)
|
|
3714
3720
|
* @param {Enums.VesselConditions} vesselConditions - The conditions inside the vessel. (default value is Enums.VesselConditions.UNSET)
|
|
3715
|
-
* @param {number} liquidFillFractionByVolume - The proportion of the vessel occupied by liquid. Used when the VesselConditions are two-phase or pressurized liquid. (default value is 0.0)
|
|
3721
|
+
* @param {number} liquidFillFractionByVolume - The proportion of the vessel occupied by liquid. Used when the VesselConditions are two-phase or pressurized liquid. [fraction] (default value is 0.0)
|
|
3716
3722
|
*/
|
|
3717
3723
|
constructor(options?: {
|
|
3718
3724
|
id?: string;
|
|
@@ -3821,11 +3827,11 @@ export class VesselLeakMaxFlammableCloudResults extends EntityBase {
|
|
|
3821
3827
|
/**
|
|
3822
3828
|
* Results for a linked run of vessel leak followed by dispersion and views from the cloud.
|
|
3823
3829
|
*
|
|
3824
|
-
* @param {number} dischargeRate - Mass flow rate from the leak.
|
|
3825
|
-
* @param {number} expandedTemperature - Post atmospheric expansion temperature.
|
|
3826
|
-
* @param {number} lflExtent - Maximum downwind distance to LFL.
|
|
3827
|
-
* @param {number} lflArea - Horizontal area of the LFL envelope.
|
|
3828
|
-
* @param {number} lflHeight - Height of the maximum LFL extent.
|
|
3830
|
+
* @param {number} dischargeRate - Mass flow rate from the leak. [kg/s]
|
|
3831
|
+
* @param {number} expandedTemperature - Post atmospheric expansion temperature. [K]
|
|
3832
|
+
* @param {number} lflExtent - Maximum downwind distance to LFL. [m]
|
|
3833
|
+
* @param {number} lflArea - Horizontal area of the LFL envelope. [m2]
|
|
3834
|
+
* @param {number} lflHeight - Height of the maximum LFL extent. [m]
|
|
3829
3835
|
* @param {Enums.Phase} phase - Post atmospheric expansion fluid phase. (default value is Enums.Phase.UNSET)
|
|
3830
3836
|
*/
|
|
3831
3837
|
constructor(options?: {
|
|
@@ -3906,7 +3912,7 @@ export class VesselSphere extends Asset {
|
|
|
3906
3912
|
* @param {LocalPosition} location - Location of the asset.
|
|
3907
3913
|
* @param {State} state - Fluid state in the vessel.
|
|
3908
3914
|
* @param {Material} material - Material in the vessel.
|
|
3909
|
-
* @param {number} massInventory - Mass of the material in the vessel.
|
|
3915
|
+
* @param {number} massInventory - Mass of the material in the vessel. [kg]
|
|
3910
3916
|
*/
|
|
3911
3917
|
constructor(options?: {
|
|
3912
3918
|
id?: string;
|
|
@@ -3964,12 +3970,12 @@ export class Weather extends EntityBase {
|
|
|
3964
3970
|
/**
|
|
3965
3971
|
* A set of weather conditions for use in the modelling of a release and its effects.
|
|
3966
3972
|
*
|
|
3967
|
-
* @param {number} windSpeed - Wind speed at a reference height. (default value is 5)
|
|
3973
|
+
* @param {number} windSpeed - Wind speed at a reference height. [m/s] (default value is 5)
|
|
3968
3974
|
* @param {Enums.AtmosphericStabilityClass} stabilityClass - The Pasquill atmospheric stability class. (default value is Enums.AtmosphericStabilityClass.STABILITY_D)
|
|
3969
|
-
* @param {number} temperature - The atmospheric temperature. (default value is 283)
|
|
3970
|
-
* @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)
|
|
3971
|
-
* @param {number} mixingLayerHeight - The height of the atmospheric boundary layer which caps the centreline of the plume. (default value is 800)
|
|
3972
|
-
* @param {number} solarRadiation - The radiation received from the sun, which contributes to pool evaporation. (default value is 500)
|
|
3975
|
+
* @param {number} temperature - The atmospheric temperature. [K] (default value is 283)
|
|
3976
|
+
* @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. [fraction] (default value is 0.7)
|
|
3977
|
+
* @param {number} mixingLayerHeight - The height of the atmospheric boundary layer which caps the centreline of the plume. [m] (default value is 800)
|
|
3978
|
+
* @param {number} solarRadiation - The radiation received from the sun, which contributes to pool evaporation. [W/m2] (default value is 500)
|
|
3973
3979
|
* @param {Enums.WindProfileFlag} windProfileFlag - Wind profile flag. (default value is Enums.WindProfileFlag.POWER_LAW_PROFILE)
|
|
3974
3980
|
*/
|
|
3975
3981
|
constructor(options?: {
|
package/src/entity-schemas.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:13
|
|
11
|
+
* Template: templates/typescriptpws/entityschemas.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
import * as Enums from "./enums";
|
package/src/enums.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:12
|
|
11
|
+
* Template: templates/typescriptpws/enums.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
/**
|
package/src/materials.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:11
|
|
11
|
+
* Template: templates/typescriptpws/materials.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
import { getRequest, postRequest, putRequest, getMaterialsApiTarget, getClientAliasId } from "./utilities";
|
package/src/utilities.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
/***********************************************************************
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
* This file has been auto-generated by a code generation tool.
|
|
3
|
+
*
|
|
4
|
+
* DO NOT MODIFY THIS FILE
|
|
5
|
+
* This file is maintained by DNV.
|
|
6
|
+
* Editing it may lead to inconsistent results and limit DNV's ability to provide support.
|
|
7
|
+
* Please contact DNV if you believe changes are required.
|
|
8
|
+
*
|
|
9
|
+
* Version: 1.0.80
|
|
10
|
+
* Date/time: 04 Jul 2025 16:32:11
|
|
11
|
+
* Template: templates/typescriptpws/utilities.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
import jwt from "jsonwebtoken";
|