@dnv-plant/typescriptpws 1.0.78 → 1.0.83-alpha.1963580
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 +359 -303
- 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/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.83
|
|
10
|
+
* Date/time: 08 Jul 2025 16:03:09
|
|
11
|
+
* Template: templates/typescriptpws/entities.razor.
|
|
6
12
|
***********************************************************************/
|
|
7
13
|
|
|
8
14
|
import * as Enums from "./enums";
|
|
@@ -51,9 +57,10 @@ export class LocalPosition extends EntityBase {
|
|
|
51
57
|
/**
|
|
52
58
|
* Position with reference to some arbitrary local origin and axes.
|
|
53
59
|
*
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {number}
|
|
56
|
-
* @param {number}
|
|
60
|
+
* @param {Object} options - Initialisation options
|
|
61
|
+
* @param {number} options.x - x coordinate. [m] (default value is 0)
|
|
62
|
+
* @param {number} options.y - y coordinate. [m] (default value is 0)
|
|
63
|
+
* @param {number} options.z - z coordinate. [m] (default value is 0)
|
|
57
64
|
*/
|
|
58
65
|
constructor(options?: {
|
|
59
66
|
id?: string;
|
|
@@ -101,7 +108,8 @@ export class Asset extends EntityBase {
|
|
|
101
108
|
/**
|
|
102
109
|
* Any equipment to be modeled, vessels, pipelines.
|
|
103
110
|
*
|
|
104
|
-
* @param {
|
|
111
|
+
* @param {Object} options - Initialisation options
|
|
112
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
105
113
|
*/
|
|
106
114
|
constructor(options?: {
|
|
107
115
|
id?: string;
|
|
@@ -139,8 +147,9 @@ export class MaterialComponent extends EntityBase {
|
|
|
139
147
|
/**
|
|
140
148
|
* Constituent component of a material.
|
|
141
149
|
*
|
|
142
|
-
* @param {
|
|
143
|
-
* @param {
|
|
150
|
+
* @param {Object} options - Initialisation options
|
|
151
|
+
* @param {string} options.name - Name of the component. (default value is "")
|
|
152
|
+
* @param {number} options.moleFraction - Mole fraction of the component in the material. [fraction] (default value is 1)
|
|
144
153
|
*/
|
|
145
154
|
constructor(options?: {
|
|
146
155
|
id?: string;
|
|
@@ -185,10 +194,11 @@ export class Material extends EntityBase {
|
|
|
185
194
|
/**
|
|
186
195
|
* The material to use in calculations.
|
|
187
196
|
*
|
|
188
|
-
* @param {
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
197
|
+
* @param {Object} options - Initialisation options
|
|
198
|
+
* @param {string} options.name - Name of the material.
|
|
199
|
+
* @param {MaterialComponent[]} options.components - Constituent components.
|
|
200
|
+
* @param {number} options.componentCount - Number of components in the material. (default value is 1)
|
|
201
|
+
* @param {Enums.PropertyTemplate} options.propertyTemplate - The template to be used for the selection of calculation methods for material properties. (default value is Enums.PropertyTemplate.PHAST_MC)
|
|
192
202
|
*/
|
|
193
203
|
constructor(options?: {
|
|
194
204
|
id?: string;
|
|
@@ -261,11 +271,12 @@ export class State extends EntityBase {
|
|
|
261
271
|
/**
|
|
262
272
|
* Description of the fluid state.
|
|
263
273
|
*
|
|
264
|
-
* @param {
|
|
265
|
-
* @param {number}
|
|
266
|
-
* @param {number}
|
|
267
|
-
* @param {
|
|
268
|
-
* @param {Enums.
|
|
274
|
+
* @param {Object} options - Initialisation options
|
|
275
|
+
* @param {number} options.pressure - Absolute pressure of the fluid. [N/m2]
|
|
276
|
+
* @param {number} options.temperature - Temperature of the fluid. [K]
|
|
277
|
+
* @param {number} options.liquidFraction - Mole fraction of liquid in the fluid. [fraction]
|
|
278
|
+
* @param {Enums.FluidSpec} options.flashFlag - Specification of the fluid equilibrium. (default value is Enums.FluidSpec.TP)
|
|
279
|
+
* @param {Enums.MixtureModelling} options.mixtureModelling - Method for modelling a mixture. (default value is Enums.MixtureModelling.PC)
|
|
269
280
|
*/
|
|
270
281
|
constructor(options?: {
|
|
271
282
|
id?: string;
|
|
@@ -338,12 +349,13 @@ export class AtmosphericStorageTank extends Asset {
|
|
|
338
349
|
/**
|
|
339
350
|
* An atmospheric storage tank asset to model events that involve releases from unpressurised containment.
|
|
340
351
|
*
|
|
341
|
-
* @param {
|
|
342
|
-
* @param {
|
|
343
|
-
* @param {
|
|
344
|
-
* @param {number}
|
|
345
|
-
* @param {
|
|
346
|
-
* @param {
|
|
352
|
+
* @param {Object} options - Initialisation options
|
|
353
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
354
|
+
* @param {State} options.state - The fluid state within the tank.
|
|
355
|
+
* @param {number} options.diameter - Diameter of the tank. [m]
|
|
356
|
+
* @param {number} options.height - Height of the tank. [m]
|
|
357
|
+
* @param {Material} options.material - Material within the tank.
|
|
358
|
+
* @param {number} options.liquidFillFractionByVolume - The proportion of the tank occupied by liquid. [fraction] (default value is 0.9)
|
|
347
359
|
*/
|
|
348
360
|
constructor(options?: {
|
|
349
361
|
id?: string;
|
|
@@ -435,8 +447,9 @@ export class ReleaseOverTime extends Scenario {
|
|
|
435
447
|
/**
|
|
436
448
|
* Scenario representing a release over time.
|
|
437
449
|
*
|
|
438
|
-
* @param {
|
|
439
|
-
* @param {
|
|
450
|
+
* @param {Object} options - Initialisation options
|
|
451
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
452
|
+
* @param {Enums.TimeVaryingOption} options.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
453
|
*/
|
|
441
454
|
constructor(options?: {
|
|
442
455
|
id?: string;
|
|
@@ -490,12 +503,13 @@ export class BESSRelease extends ReleaseOverTime {
|
|
|
490
503
|
/**
|
|
491
504
|
* A release from a BESS unit in thermal runaway.
|
|
492
505
|
*
|
|
493
|
-
* @param {
|
|
494
|
-
* @param {number}
|
|
495
|
-
* @param {number}
|
|
496
|
-
* @param {number}
|
|
497
|
-
* @param {number}
|
|
498
|
-
* @param {
|
|
506
|
+
* @param {Object} options - Initialisation options
|
|
507
|
+
* @param {number} options.height - The height from which the release occurs. [m]
|
|
508
|
+
* @param {number} options.area - The area over which the release occurs. [m2]
|
|
509
|
+
* @param {number} options.temperature - The exit temperature of the release (from the BESS unit). [K]
|
|
510
|
+
* @param {number} options.duration - The duration of the release. [s]
|
|
511
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
512
|
+
* @param {Enums.TimeVaryingOption} options.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
513
|
*/
|
|
500
514
|
constructor(options?: {
|
|
501
515
|
id?: string;
|
|
@@ -554,9 +568,10 @@ export class BESSUnit extends Asset {
|
|
|
554
568
|
/**
|
|
555
569
|
* A BESS unit, containing Li-ion betteries.
|
|
556
570
|
*
|
|
557
|
-
* @param {
|
|
558
|
-
* @param {
|
|
559
|
-
* @param {
|
|
571
|
+
* @param {Object} options - Initialisation options
|
|
572
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
573
|
+
* @param {number} options.energyCapacity - The energy capacity of the installation. [J]
|
|
574
|
+
* @param {Enums.BESSChemistry} options.chemistry - The chemistry type of the BESS unit. (default value is Enums.BESSChemistry.LFP)
|
|
560
575
|
*/
|
|
561
576
|
constructor(options?: {
|
|
562
577
|
id?: string;
|
|
@@ -611,9 +626,10 @@ export class Bund extends EntityBase {
|
|
|
611
626
|
/**
|
|
612
627
|
* A bund entity used in the modelling of pool spreading and vaporisation.
|
|
613
628
|
*
|
|
614
|
-
* @param {
|
|
615
|
-
* @param {number}
|
|
616
|
-
* @param {
|
|
629
|
+
* @param {Object} options - Initialisation options
|
|
630
|
+
* @param {number} options.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)
|
|
631
|
+
* @param {number} options.bundDiameter - The diameter of the (circular) bund. [m] (default value is 0.0)
|
|
632
|
+
* @param {boolean} options.specifyBund - Whether to model the effect of a bund on the spreading of a liquid pool. (default value is false)
|
|
617
633
|
*/
|
|
618
634
|
constructor(options?: {
|
|
619
635
|
id?: string;
|
|
@@ -716,8 +732,9 @@ export class ConcentrationRecord extends EntityBase {
|
|
|
716
732
|
/**
|
|
717
733
|
* A record containing the cloud concentration at a specified x, y, z position.
|
|
718
734
|
*
|
|
719
|
-
* @param {
|
|
720
|
-
* @param {
|
|
735
|
+
* @param {Object} options - Initialisation options
|
|
736
|
+
* @param {number} options.concentration - Cloud concentration at an x, y, z position. [fraction]
|
|
737
|
+
* @param {LocalPosition} options.position - x, y, z position.
|
|
721
738
|
*/
|
|
722
739
|
constructor(options?: {
|
|
723
740
|
id?: string;
|
|
@@ -762,9 +779,10 @@ export class ConstantMaterialResult extends EntityBase {
|
|
|
762
779
|
/**
|
|
763
780
|
* Constant material properties, i.e. critical pressure, temperature, molecular weight.
|
|
764
781
|
*
|
|
765
|
-
* @param {
|
|
766
|
-
* @param {number}
|
|
767
|
-
* @param {number}
|
|
782
|
+
* @param {Object} options - Initialisation options
|
|
783
|
+
* @param {number} options.criticalPressure - The critical pressure of the material. [N/m2]
|
|
784
|
+
* @param {number} options.criticalTemperature - The critical temperature of the material. [K]
|
|
785
|
+
* @param {number} options.totalMolecularWeight - The total molecular weight of the material. [kg/kmol]
|
|
768
786
|
*/
|
|
769
787
|
constructor(options?: {
|
|
770
788
|
id?: string;
|
|
@@ -812,7 +830,8 @@ export class DischargeParameters extends EntityBase {
|
|
|
812
830
|
/**
|
|
813
831
|
* A set of parameters used in discharge calculations.
|
|
814
832
|
*
|
|
815
|
-
* @param {
|
|
833
|
+
* @param {Object} options - Initialisation options
|
|
834
|
+
* @param {Enums.FlashAtOrifice} options.flashAtOrifice - Whether discharge calculations should allow the phase to change between storage and orifice conditions. (default value is Enums.FlashAtOrifice.DISALLOW_LIQUID_FLASH)
|
|
816
835
|
*/
|
|
817
836
|
constructor(options?: {
|
|
818
837
|
id?: string;
|
|
@@ -865,15 +884,16 @@ export class DischargeRecord extends EntityBase {
|
|
|
865
884
|
/**
|
|
866
885
|
* A record containing discharge results at a given time.
|
|
867
886
|
*
|
|
868
|
-
* @param {
|
|
869
|
-
* @param {number}
|
|
870
|
-
* @param {
|
|
871
|
-
* @param {
|
|
872
|
-
* @param {
|
|
873
|
-
* @param {
|
|
874
|
-
* @param {
|
|
875
|
-
* @param {
|
|
876
|
-
* @param {number}
|
|
887
|
+
* @param {Object} options - Initialisation options
|
|
888
|
+
* @param {number} options.time - The time elapsed since the start of the discharge. [s]
|
|
889
|
+
* @param {number} options.massFlow - The mass flow rate at the specified time. [kg/s]
|
|
890
|
+
* @param {State} options.finalState - The fluid state after expansion to atmosphere at the specified time.
|
|
891
|
+
* @param {number} options.finalVelocity - The velocity after expansion to atmosphere at the specified time. [m/s]
|
|
892
|
+
* @param {State} options.orificeState - The fluid state at the orifice at the specified time.
|
|
893
|
+
* @param {number} options.orificeVelocity - The velocity at the orifice at the specified time. [m/s]
|
|
894
|
+
* @param {State} options.storageState - The fluid state of the storage at the specified time.
|
|
895
|
+
* @param {number} options.dropletDiameter - A representative size of entrained liquid droplets. [m]
|
|
896
|
+
* @param {number} options.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
897
|
*/
|
|
878
898
|
constructor(options?: {
|
|
879
899
|
id?: string;
|
|
@@ -966,13 +986,14 @@ export class DischargeResult extends EntityBase {
|
|
|
966
986
|
/**
|
|
967
987
|
* A set of discharge results that do not vary with time.
|
|
968
988
|
*
|
|
969
|
-
* @param {
|
|
970
|
-
* @param {number}
|
|
971
|
-
* @param {number}
|
|
972
|
-
* @param {number}
|
|
973
|
-
* @param {number}
|
|
974
|
-
* @param {
|
|
975
|
-
* @param {
|
|
989
|
+
* @param {Object} options - Initialisation options
|
|
990
|
+
* @param {number} options.expansionEnergy - The energy released when a pressurized substance, such as a liquid or vapor, is released following an instantaneous rupture. [J]
|
|
991
|
+
* @param {number} options.releaseMass - Amount of mass released during the discharge. [kg]
|
|
992
|
+
* @param {number} options.height - Release height above ground. [m]
|
|
993
|
+
* @param {number} options.angle - Release angle (non-instantaneous releases only). [rad]
|
|
994
|
+
* @param {number} options.holeDiameter - Diameter of the hole. [m]
|
|
995
|
+
* @param {Enums.DynamicType} options.releaseType - Instantaneous, continuous or time-varying. (default value is Enums.DynamicType.UNSET)
|
|
996
|
+
* @param {number} options.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
997
|
*/
|
|
977
998
|
constructor(options?: {
|
|
978
999
|
id?: string;
|
|
@@ -1063,17 +1084,18 @@ export class DispersionOutputConfig extends EntityBase {
|
|
|
1063
1084
|
/**
|
|
1064
1085
|
* Dispersion plotting and reporting parameters.
|
|
1065
1086
|
*
|
|
1066
|
-
* @param {
|
|
1067
|
-
* @param {number}
|
|
1068
|
-
* @param {
|
|
1069
|
-
* @param {
|
|
1070
|
-
* @param {
|
|
1071
|
-
* @param {
|
|
1072
|
-
* @param {number}
|
|
1073
|
-
* @param {
|
|
1074
|
-
* @param {
|
|
1075
|
-
* @param {number}
|
|
1076
|
-
* @param {
|
|
1087
|
+
* @param {Object} options - Initialisation options
|
|
1088
|
+
* @param {number} options.downwindDistance - The distance downwind at which concentration at a point is provided. [m] (default value is 100)
|
|
1089
|
+
* @param {number} options.time - The time of interest, measured from the start of the release. [s] (default value is 60)
|
|
1090
|
+
* @param {Enums.Resolution} options.resolution - Output resolution of results. (default value is Enums.Resolution.MEDIUM)
|
|
1091
|
+
* @param {number} options.elevation - The distance that an XY plane of interest is offset from the ground level. [m] (default value is 1)
|
|
1092
|
+
* @param {Enums.SpecialConcentration} options.specialConcentration - The method used to determine the concentration of interest when post processing dispersion calculations. (default value is Enums.SpecialConcentration.MIN)
|
|
1093
|
+
* @param {number} options.concentration - Concentration of interest (vol fraction). Not used unless SpecialConcentration is NotDefined. [fraction] (default value is 0)
|
|
1094
|
+
* @param {number} options.crosswindDistance - The distance that an XZ plane of interest is offset from the downwind direction (x-axis). [m] (default value is 0)
|
|
1095
|
+
* @param {Enums.ContourType} options.contourType - The type of contour on which the contour points will be based. (default value is Enums.ContourType.FOOTPRINT)
|
|
1096
|
+
* @param {number} options.lflFractionValue - Value of the lower flammable limit fraction, used when SpecialConcentration is set to Min or LflFraction. [fraction] (default value is 0.5)
|
|
1097
|
+
* @param {number} options.componentToTrackIndex - Index of a component that you want to track within a mixture. (default value is -1)
|
|
1098
|
+
* @param {string} options.componentToTrackName - Name of the component to track.
|
|
1077
1099
|
*/
|
|
1078
1100
|
constructor(options?: {
|
|
1079
1101
|
id?: string;
|
|
@@ -1187,16 +1209,17 @@ export class DispersionParameters extends EntityBase {
|
|
|
1187
1209
|
/**
|
|
1188
1210
|
* A set of parameters used in dispersion calculations.
|
|
1189
1211
|
*
|
|
1190
|
-
* @param {
|
|
1191
|
-
* @param {
|
|
1192
|
-
* @param {
|
|
1193
|
-
* @param {number}
|
|
1194
|
-
* @param {number}
|
|
1195
|
-
* @param {number}
|
|
1196
|
-
* @param {number}
|
|
1197
|
-
* @param {number}
|
|
1198
|
-
* @param {number}
|
|
1199
|
-
* @param {number}
|
|
1212
|
+
* @param {Object} options - Initialisation options
|
|
1213
|
+
* @param {number} options.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)
|
|
1214
|
+
* @param {Enums.RainoutThermoFlag} options.rainoutThermoFlag - Sets the model for droplet evaporation calculations. (default value is Enums.RainoutThermoFlag.RAINOUT_NON_EQUILIBRIUM)
|
|
1215
|
+
* @param {number} options.fixedStepSize - The size of steps within the core dispersion calculations. [s] (default value is 0.01)
|
|
1216
|
+
* @param {number} options.outputStepMultiplier - Multiplier to increase each step size after the initial fixed steps. (default value is 1.2)
|
|
1217
|
+
* @param {number} options.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)
|
|
1218
|
+
* @param {number} options.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)
|
|
1219
|
+
* @param {number} options.numberOfReleaseObservers - Number of release observers for time-varying releases. (default value is 5)
|
|
1220
|
+
* @param {number} options.numberOfPoolObservers - Number of pool observers for rainout cases. (default value is 10)
|
|
1221
|
+
* @param {number} options.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)
|
|
1222
|
+
* @param {number} options.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
1223
|
*/
|
|
1201
1224
|
constructor(options?: {
|
|
1202
1225
|
id?: string;
|
|
@@ -1323,35 +1346,36 @@ export class DispersionRecord extends EntityBase {
|
|
|
1323
1346
|
/**
|
|
1324
1347
|
* A record containing observer dispersion results at a given time.
|
|
1325
1348
|
*
|
|
1326
|
-
* @param {
|
|
1327
|
-
* @param {number}
|
|
1328
|
-
* @param {number}
|
|
1329
|
-
* @param {number}
|
|
1330
|
-
* @param {number}
|
|
1331
|
-
* @param {number}
|
|
1332
|
-
* @param {number}
|
|
1333
|
-
* @param {number}
|
|
1334
|
-
* @param {number}
|
|
1335
|
-
* @param {number}
|
|
1336
|
-
* @param {number}
|
|
1337
|
-
* @param {number}
|
|
1338
|
-
* @param {number}
|
|
1339
|
-
* @param {number}
|
|
1340
|
-
* @param {number}
|
|
1341
|
-
* @param {number}
|
|
1342
|
-
* @param {number}
|
|
1343
|
-
* @param {number}
|
|
1344
|
-
* @param {number}
|
|
1345
|
-
* @param {number}
|
|
1346
|
-
* @param {number}
|
|
1347
|
-
* @param {number}
|
|
1348
|
-
* @param {number}
|
|
1349
|
-
* @param {number}
|
|
1350
|
-
* @param {number}
|
|
1351
|
-
* @param {number}
|
|
1352
|
-
* @param {number}
|
|
1353
|
-
* @param {number}
|
|
1354
|
-
* @param {
|
|
1349
|
+
* @param {Object} options - Initialisation options
|
|
1350
|
+
* @param {number} options.observerIndex - Id of the observer associated with the record.
|
|
1351
|
+
* @param {number} options.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]
|
|
1352
|
+
* @param {number} options.downwindDistance - The downwind distance reached by the observer, measured from the release location. [m]
|
|
1353
|
+
* @param {number} options.time - Elapsed time since the start of the release. [s]
|
|
1354
|
+
* @param {number} options.centrelineConcentrationUncorrected - The uncorrected (molar) concentraton of the centreline of the cloud, which does not take into account gravity spreading. [fraction]
|
|
1355
|
+
* @param {number} options.crosswindRadius - A measure of the standard deviation of the concentration profile in the crosswind direction. [m]
|
|
1356
|
+
* @param {number} options.verticalRadius - A measure of the standard deviation of the concentration profile in the vertical direction. [m]
|
|
1357
|
+
* @param {number} options.crosswindExponent - Describe the sharpness or smoothness of the concentration profile in the crosswind direction.
|
|
1358
|
+
* @param {number} options.verticalExponent - Describe the sharpness or smoothness of the concentration profile in the vertical direction.
|
|
1359
|
+
* @param {number} options.theta - Centreline angle from horizontal. [rad]
|
|
1360
|
+
* @param {number} options.centrelineHeight - The height of the centreline of the cloud, measured from ground level. [m]
|
|
1361
|
+
* @param {number} options.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]
|
|
1362
|
+
* @param {number} options.vapourTemperature - The temperature of the vapour portion of the cloud, including entrained air and any entrained water vapour. [K]
|
|
1363
|
+
* @param {number} options.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]
|
|
1364
|
+
* @param {number} options.velocity - The velocity of the cloud at the centroid. [m/s]
|
|
1365
|
+
* @param {number} options.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]
|
|
1366
|
+
* @param {number} options.profileFlag - This shows the type of dispersion modelling being used for the current step.
|
|
1367
|
+
* @param {number} options.elevFlag - A flag to indicate whether the release is elevated, touching down, grounded or capped (by the mixing layer height).
|
|
1368
|
+
* @param {number} options.rhoCloud - The density of the cloud at the centreline. [kg/m3]
|
|
1369
|
+
* @param {number} options.liqTemp - The temperature of the liquid droplets in the cloud. [K]
|
|
1370
|
+
* @param {number} options.effectiveWidth - The width of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout. [m]
|
|
1371
|
+
* @param {number} options.effectiveHeight - The height of an equivalent cloud that contains the same mass as the real cloud but that has a uniform concentration throughout. [m]
|
|
1372
|
+
* @param {number} options.passTranDist - The distance at which the observer has made the transition to passive dispersion. [m]
|
|
1373
|
+
* @param {number} options.downwindRadius - A measure of the standard deviation of the concentration profile in the downwind direction. [m]
|
|
1374
|
+
* @param {number} options.dropletDiameter - The representative diameter for liquid droplets in the cloud. [m]
|
|
1375
|
+
* @param {number} options.dropletHeight - The representative height for liquid droplets in the cloud, measured above ground level. [m]
|
|
1376
|
+
* @param {number} options.dropletDistance - The downwind distance of droplets in the cloud. [m]
|
|
1377
|
+
* @param {number} options.mass - The mass of released material in the cloud (instantaneous releases). [kg]
|
|
1378
|
+
* @param {Enums.DynamicType} options.instCon - Instantanous or continuous (time-varying not permitted). (default value is Enums.DynamicType.UNSET)
|
|
1355
1379
|
*/
|
|
1356
1380
|
constructor(options?: {
|
|
1357
1381
|
id?: string;
|
|
@@ -1565,8 +1589,9 @@ export class ExplosionConfinedVolume extends EntityBase {
|
|
|
1565
1589
|
/**
|
|
1566
1590
|
* Confined explosion volume data.
|
|
1567
1591
|
*
|
|
1568
|
-
* @param {
|
|
1569
|
-
* @param {number}
|
|
1592
|
+
* @param {Object} options - Initialisation options
|
|
1593
|
+
* @param {number} options.confinedStrength - The degree of confinement in the area or source, described by an integer between 3 (lowest) and 10 (highest). (default value is 7)
|
|
1594
|
+
* @param {number} options.confinedVolume - The volume of the cloud that is contained in the area of confinement. [m3] (default value is 1)
|
|
1570
1595
|
*/
|
|
1571
1596
|
constructor(options?: {
|
|
1572
1597
|
id?: string;
|
|
@@ -1609,8 +1634,9 @@ export class ExplosionOutputConfig extends EntityBase {
|
|
|
1609
1634
|
/**
|
|
1610
1635
|
* Explosion plotting and reporting parameters.
|
|
1611
1636
|
*
|
|
1612
|
-
* @param {
|
|
1613
|
-
* @param {
|
|
1637
|
+
* @param {Object} options - Initialisation options
|
|
1638
|
+
* @param {number} options.overpressureLevel - Overpressure of interest for explosions. [N/m2] (default value is 2068)
|
|
1639
|
+
* @param {Enums.MEConfinedMethod} options.meConfinedMethod - The multi energy confined method for modelling the effects of explosions. (default value is Enums.MEConfinedMethod.UNIFORM_CONFINED)
|
|
1614
1640
|
*/
|
|
1615
1641
|
constructor(options?: {
|
|
1616
1642
|
id?: string;
|
|
@@ -1666,12 +1692,13 @@ export class ExplosionOverpressureResult extends EntityBase {
|
|
|
1666
1692
|
/**
|
|
1667
1693
|
* Worst case explosion summary results for a given overpressure.
|
|
1668
1694
|
*
|
|
1669
|
-
* @param {
|
|
1670
|
-
* @param {number}
|
|
1671
|
-
* @param {number}
|
|
1672
|
-
* @param {number}
|
|
1673
|
-
* @param {number}
|
|
1674
|
-
* @param {number}
|
|
1695
|
+
* @param {Object} options - Initialisation options
|
|
1696
|
+
* @param {number} options.overpressure - The target overpressure level for the worst-case explosion. [N/m2]
|
|
1697
|
+
* @param {number} options.explosionCentre - The distance downwind from the release source to the centre of the explosion. [m]
|
|
1698
|
+
* @param {number} options.maximumDistance - The maximum downwind distance reached by the effect zone for the overpressure level of interest. [m]
|
|
1699
|
+
* @param {number} options.explodedMass - The flammable mass used in the explosion. [kg]
|
|
1700
|
+
* @param {number} options.ignitionTime - The time that the cloud is ignited, measured from the start of the release. [s]
|
|
1701
|
+
* @param {number} options.radius - The radius of the effect zone for the overpressure level of interest. [m]
|
|
1675
1702
|
*/
|
|
1676
1703
|
constructor(options?: {
|
|
1677
1704
|
id?: string;
|
|
@@ -1737,7 +1764,8 @@ export class ExplosionParameters extends EntityBase {
|
|
|
1737
1764
|
/**
|
|
1738
1765
|
* A set of parameters used in explosion calculations.
|
|
1739
1766
|
*
|
|
1740
|
-
* @param {
|
|
1767
|
+
* @param {Object} options - Initialisation options
|
|
1768
|
+
* @param {number} options.explosionUniformStrength - The confined strength in the multi-energy uniform confined method. (default value is 10.0)
|
|
1741
1769
|
*/
|
|
1742
1770
|
constructor(options?: {
|
|
1743
1771
|
id?: string;
|
|
@@ -1776,10 +1804,11 @@ export class FlameRecord extends EntityBase {
|
|
|
1776
1804
|
/**
|
|
1777
1805
|
* A record containing flame geometry data.
|
|
1778
1806
|
*
|
|
1779
|
-
* @param {
|
|
1780
|
-
* @param {number}
|
|
1781
|
-
* @param {number}
|
|
1782
|
-
* @param {number}
|
|
1807
|
+
* @param {Object} options - Initialisation options
|
|
1808
|
+
* @param {number} options.xCoordinate - The distance downwind from the release source to the centre of a circle describing the frustum base or tip. [m]
|
|
1809
|
+
* @param {number} options.zCoordinate - The height above the ground of the centre of a circle describing the frustum base or tip. [m]
|
|
1810
|
+
* @param {number} options.rCoordinate - The radius of the frustum base or tip. [m]
|
|
1811
|
+
* @param {number} options.phiCoordinate - Inclination of the frustum base or tip from the vertical. [rad]
|
|
1783
1812
|
*/
|
|
1784
1813
|
constructor(options?: {
|
|
1785
1814
|
id?: string;
|
|
@@ -1837,11 +1866,12 @@ export class FlameResult extends EntityBase {
|
|
|
1837
1866
|
/**
|
|
1838
1867
|
* A set of flame results.
|
|
1839
1868
|
*
|
|
1840
|
-
* @param {
|
|
1841
|
-
* @param {number}
|
|
1842
|
-
* @param {number}
|
|
1843
|
-
* @param {number}
|
|
1844
|
-
* @param {
|
|
1869
|
+
* @param {Object} options - Initialisation options
|
|
1870
|
+
* @param {number} options.time - Time of interest for time varying releases, or duration for initial rate releases. [s]
|
|
1871
|
+
* @param {number} options.surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area. [W/m2]
|
|
1872
|
+
* @param {number} options.flameLength - Length of the flame. [m]
|
|
1873
|
+
* @param {number} options.flameDiameter - Diameter of the flame. [m]
|
|
1874
|
+
* @param {Enums.FireType} options.fireType - Type of fire. (default value is Enums.FireType.NO_FIRE)
|
|
1845
1875
|
*/
|
|
1846
1876
|
constructor(options?: {
|
|
1847
1877
|
id?: string;
|
|
@@ -1911,8 +1941,9 @@ export class Transect extends EntityBase {
|
|
|
1911
1941
|
/**
|
|
1912
1942
|
* A line segment, along which results are provided.
|
|
1913
1943
|
*
|
|
1914
|
-
* @param {
|
|
1915
|
-
* @param {LocalPosition}
|
|
1944
|
+
* @param {Object} options - Initialisation options
|
|
1945
|
+
* @param {LocalPosition} options.transectStartPoint - Cartesian coordinates of the start point of the transect.
|
|
1946
|
+
* @param {LocalPosition} options.transectEndPoint - Cartesian coordinates of the end point of the transect.
|
|
1916
1947
|
*/
|
|
1917
1948
|
constructor(options?: {
|
|
1918
1949
|
id?: string;
|
|
@@ -1965,16 +1996,17 @@ export class FlammableOutputConfig extends EntityBase {
|
|
|
1965
1996
|
/**
|
|
1966
1997
|
* Fire and radiation plotting and reporting parameters.
|
|
1967
1998
|
*
|
|
1968
|
-
* @param {
|
|
1969
|
-
* @param {
|
|
1970
|
-
* @param {
|
|
1971
|
-
* @param {Enums.
|
|
1972
|
-
* @param {
|
|
1973
|
-
* @param {
|
|
1974
|
-
* @param {
|
|
1975
|
-
* @param {number}
|
|
1976
|
-
* @param {number}
|
|
1977
|
-
* @param {number}
|
|
1999
|
+
* @param {Object} options - Initialisation options
|
|
2000
|
+
* @param {LocalPosition} options.position - Position used for radiation calculations (except Transect).
|
|
2001
|
+
* @param {Transect} options.transect - A line segment, along which results are provided.
|
|
2002
|
+
* @param {Enums.RadiationType} options.radiationType - The type of radiation result of interest. (default value is Enums.RadiationType.INTENSITY)
|
|
2003
|
+
* @param {Enums.ContourType} options.contourType - The type of contour plot. (default value is Enums.ContourType.FOOTPRINT_ELLIPSE)
|
|
2004
|
+
* @param {number} options.radiationLevel - The radiation level of interest for the RadiationType. (default value is 4000)
|
|
2005
|
+
* @param {Enums.Resolution} options.radiationResolution - Spatial resolution for radiation calculations. (default value is Enums.Resolution.MEDIUM)
|
|
2006
|
+
* @param {number} options.fixedOrientation - Whether to specify the orientation of a flat surface on which an observer lies with respect to the flame. (default value is 0)
|
|
2007
|
+
* @param {number} options.orientation - Angle between the projection of the observer normal onto the horizontal plane and the y axis. [rad] (default value is 0)
|
|
2008
|
+
* @param {number} options.fixedInclination - Whether to specify the inclination of a flat surface on which an observer lies with respect to the flame. (default value is 0)
|
|
2009
|
+
* @param {number} options.inclination - Angle between the observer normal and the horizontal plane. (default value is 0)
|
|
1978
2010
|
*/
|
|
1979
2011
|
constructor(options?: {
|
|
1980
2012
|
id?: string;
|
|
@@ -2080,12 +2112,13 @@ export class FlammableParameters extends EntityBase {
|
|
|
2080
2112
|
/**
|
|
2081
2113
|
* A set of parameters used in fire and radiation calculations.
|
|
2082
2114
|
*
|
|
2083
|
-
* @param {
|
|
2084
|
-
* @param {number}
|
|
2085
|
-
* @param {
|
|
2086
|
-
* @param {
|
|
2087
|
-
* @param {boolean}
|
|
2088
|
-
* @param {
|
|
2115
|
+
* @param {Object} options - Initialisation options
|
|
2116
|
+
* @param {number} options.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)
|
|
2117
|
+
* @param {number} options.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)
|
|
2118
|
+
* @param {Enums.PoolFireType} options.poolFireType - Type of pool fire modelling. (default value is Enums.PoolFireType.LATE)
|
|
2119
|
+
* @param {boolean} options.jetFireAutoSelect - Whether to have the calculations automatically select the type of jet fire modelling. (default value is false)
|
|
2120
|
+
* @param {boolean} options.timeAveraging - Whether to base the jet fire calculations on a discharge rate averaged between 0 seconds and a TimeOfInterest. (default value is true)
|
|
2121
|
+
* @param {number} options.timeOfInterest - The time of interest in the jet fire calculations. The jet fire will be based on the discharge results either at the TimeOfInterest or averaged between 0 seconds and the TimeOfInterest, depending on the TimeAveraging option. (default value is 20)
|
|
2089
2122
|
*/
|
|
2090
2123
|
constructor(options?: {
|
|
2091
2124
|
id?: string;
|
|
@@ -2175,22 +2208,23 @@ export class FlashResult extends EntityBase {
|
|
|
2175
2208
|
/**
|
|
2176
2209
|
* Physical properties for a material generated at a particular pressure and temperature.
|
|
2177
2210
|
*
|
|
2178
|
-
* @param {
|
|
2179
|
-
* @param {number}
|
|
2180
|
-
* @param {number}
|
|
2181
|
-
* @param {number}
|
|
2182
|
-
* @param {number}
|
|
2183
|
-
* @param {number}
|
|
2184
|
-
* @param {number}
|
|
2185
|
-
* @param {number}
|
|
2186
|
-
* @param {number}
|
|
2187
|
-
* @param {number}
|
|
2188
|
-
* @param {number}
|
|
2189
|
-
* @param {number}
|
|
2190
|
-
* @param {number}
|
|
2191
|
-
* @param {number}
|
|
2192
|
-
* @param {number}
|
|
2193
|
-
* @param {
|
|
2211
|
+
* @param {Object} options - Initialisation options
|
|
2212
|
+
* @param {number} options.pressure - Pressure. [N/m2]
|
|
2213
|
+
* @param {number} options.temperature - Temperature. [K]
|
|
2214
|
+
* @param {number} options.liquidMoleFraction - Liquid fraction (mole). [fraction]
|
|
2215
|
+
* @param {number} options.liquidDensity - Density of liquid phase. [kg/m3]
|
|
2216
|
+
* @param {number} options.vapourDensity - Density of vapour phase. [kg/m3]
|
|
2217
|
+
* @param {number} options.liquidEntropy - Entropy of liquid phase. [J/kg.K]
|
|
2218
|
+
* @param {number} options.vapourEntropy - Entropy of vapour phase. [J/kg.K]
|
|
2219
|
+
* @param {number} options.liquidEnthalpy - Enthalpy of liquid phase.
|
|
2220
|
+
* @param {number} options.vapourEnthalpy - Enthalpy of vapour phase.
|
|
2221
|
+
* @param {number} options.bubblePointPressure - Mixture bubble point pressure at given temperature. [N/m2]
|
|
2222
|
+
* @param {number} options.bubblePointTemperature - Mixture bubble point temperature at given pressure. [K]
|
|
2223
|
+
* @param {number} options.dewPointPressure - Mixture dew point pressure at given temperature. [N/m2]
|
|
2224
|
+
* @param {number} options.dewPointTemperature - Mixture dew point temperature at given pressure. [K]
|
|
2225
|
+
* @param {number} options.totalFluidDensity - Total fluid density (mass-based). [kg/m3]
|
|
2226
|
+
* @param {number} options.liquidMassFraction - Liquid mass fraction. [fraction]
|
|
2227
|
+
* @param {Enums.Phase} options.fluidPhase - Vapour, liquid or two-phase. (default value is Enums.Phase.UNSET)
|
|
2194
2228
|
*/
|
|
2195
2229
|
constructor(options?: {
|
|
2196
2230
|
id?: string;
|
|
@@ -2327,11 +2361,12 @@ export class Leak extends ReleaseOverTime {
|
|
|
2327
2361
|
/**
|
|
2328
2362
|
* A storage scenario which models a release of material through a hole in a vessel or pipe.
|
|
2329
2363
|
*
|
|
2330
|
-
* @param {
|
|
2331
|
-
* @param {number}
|
|
2332
|
-
* @param {
|
|
2333
|
-
* @param {
|
|
2334
|
-
* @param {number}
|
|
2364
|
+
* @param {Object} options - Initialisation options
|
|
2365
|
+
* @param {number} options.holeDiameter - The diameter of the equivalent circular orifice with the same area as the area of the leak. [m]
|
|
2366
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2367
|
+
* @param {Enums.TimeVaryingOption} options.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)
|
|
2368
|
+
* @param {number} options.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)
|
|
2369
|
+
* @param {number} options.releaseElevation - The elevation of the release. [m] (default value is 1)
|
|
2335
2370
|
*/
|
|
2336
2371
|
constructor(options?: {
|
|
2337
2372
|
id?: string;
|
|
@@ -2386,12 +2421,13 @@ export class LineRupture extends ReleaseOverTime {
|
|
|
2386
2421
|
/**
|
|
2387
2422
|
* 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
2423
|
*
|
|
2389
|
-
* @param {
|
|
2390
|
-
* @param {number}
|
|
2391
|
-
* @param {number}
|
|
2392
|
-
* @param {
|
|
2393
|
-
* @param {
|
|
2394
|
-
* @param {number}
|
|
2424
|
+
* @param {Object} options - Initialisation options
|
|
2425
|
+
* @param {number} options.pipeDiameter - Internal diameter of the short pipe. [m]
|
|
2426
|
+
* @param {number} options.pipeLength - Length of the short pipe. [m]
|
|
2427
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2428
|
+
* @param {Enums.TimeVaryingOption} options.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)
|
|
2429
|
+
* @param {number} options.pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
2430
|
+
* @param {number} options.pipeHeightFraction - Height of the pipe connection measured from the base of the vessel. [fraction] (default value is 0.5)
|
|
2395
2431
|
*/
|
|
2396
2432
|
constructor(options?: {
|
|
2397
2433
|
id?: string;
|
|
@@ -2455,13 +2491,14 @@ export class MaterialComponentDataItem extends EntityBase {
|
|
|
2455
2491
|
/**
|
|
2456
2492
|
* Material component data item.
|
|
2457
2493
|
*
|
|
2458
|
-
* @param {
|
|
2459
|
-
* @param {
|
|
2460
|
-
* @param {
|
|
2461
|
-
* @param {
|
|
2462
|
-
* @param {number[]}
|
|
2463
|
-
* @param {number}
|
|
2464
|
-
* @param {number}
|
|
2494
|
+
* @param {Object} options - Initialisation options
|
|
2495
|
+
* @param {string} options.description - Material component data item description.
|
|
2496
|
+
* @param {number} options.equationNumber - Equation number.
|
|
2497
|
+
* @param {string} options.equationString - Equation string.
|
|
2498
|
+
* @param {number[]} options.equationCoefficients - Equation coefficients.
|
|
2499
|
+
* @param {number[]} options.calculationLimits - Calculation limits.
|
|
2500
|
+
* @param {number} options.supercriticalExtrapolation - Super critical extrapolation flag. (default value is 0)
|
|
2501
|
+
* @param {number} options.fractionTc - Fraction of critical temperature. (default value is 1)
|
|
2465
2502
|
*/
|
|
2466
2503
|
constructor(options?: {
|
|
2467
2504
|
id?: string;
|
|
@@ -2536,10 +2573,11 @@ export class MaterialComponentData extends EntityBase {
|
|
|
2536
2573
|
/**
|
|
2537
2574
|
* Data related to a MaterialComponent.
|
|
2538
2575
|
*
|
|
2539
|
-
* @param {
|
|
2540
|
-
* @param {
|
|
2541
|
-
* @param {number}
|
|
2542
|
-
* @param {
|
|
2576
|
+
* @param {Object} options - Initialisation options
|
|
2577
|
+
* @param {string} options.name - Name of the material component data.
|
|
2578
|
+
* @param {number} options.dipprVersion - DIPPR version number.
|
|
2579
|
+
* @param {number} options.casId - CAS id.
|
|
2580
|
+
* @param {MaterialComponentDataItem[]} options.dataItem - List of data items defining the material component data.
|
|
2543
2581
|
*/
|
|
2544
2582
|
constructor(options?: {
|
|
2545
2583
|
id?: string;
|
|
@@ -2614,22 +2652,23 @@ export class MixtureConstantPropertiesResult extends EntityBase {
|
|
|
2614
2652
|
/**
|
|
2615
2653
|
* Constant properties of a mixture.
|
|
2616
2654
|
*
|
|
2617
|
-
* @param {
|
|
2618
|
-
* @param {number}
|
|
2619
|
-
* @param {number}
|
|
2620
|
-
* @param {number}
|
|
2621
|
-
* @param {number}
|
|
2622
|
-
* @param {number}
|
|
2623
|
-
* @param {number}
|
|
2624
|
-
* @param {number}
|
|
2625
|
-
* @param {number}
|
|
2626
|
-
* @param {number}
|
|
2627
|
-
* @param {number}
|
|
2628
|
-
* @param {number}
|
|
2629
|
-
* @param {number}
|
|
2630
|
-
* @param {number}
|
|
2631
|
-
* @param {
|
|
2632
|
-
* @param {Enums.
|
|
2655
|
+
* @param {Object} options - Initialisation options
|
|
2656
|
+
* @param {number} options.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]
|
|
2657
|
+
* @param {number} options.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]
|
|
2658
|
+
* @param {number} options.criticalPressure - The pressure above which liquid and gas cannot coexist at any temperature. [N/m2]
|
|
2659
|
+
* @param {number} options.criticalTemperature - The temperature above which the gas cannot become liquid, regardless of the applied pressure. [K]
|
|
2660
|
+
* @param {number} options.flashPoint - The lowest temperature at which a liquid can create enough vapour to ignite when exposed to an external heat source. [K]
|
|
2661
|
+
* @param {number} options.heatCombustion - The amount of energy released in the form of heat when one mole of a substance is burned.
|
|
2662
|
+
* @param {number} options.maximumBurnRate - The maximum mass rate at which a material burns per unit area, used in pool fire modelling.
|
|
2663
|
+
* @param {number} options.maximumSEP - The maximum surface emissive power of a material.
|
|
2664
|
+
* @param {number} options.molecularWeight - The sum of the atomic masses of all atoms in a molecule. [kg/kmol]
|
|
2665
|
+
* @param {number} options.bubblePoint - The temperature where the first bubble of vapor is formed when heating a liquid at atmospheric pressure. [K]
|
|
2666
|
+
* @param {number} options.poolFireBurnRateLength - A characteristic pool fire burn rate length. [m]
|
|
2667
|
+
* @param {number} options.dewPoint - The temperature at which the first liquid drop will form when cooling a gas at atmospheric pressure. [K]
|
|
2668
|
+
* @param {number} options.emissivePowerLengthScale - Used in pool fire modelling for calculating the emissive power for a fire with a given diameter. [m]
|
|
2669
|
+
* @param {number} options.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]
|
|
2670
|
+
* @param {Enums.FlammableToxic} options.flammableToxicFlag - Whether a material is flammable, toxic, both or inert. (default value is Enums.FlammableToxic.INERT)
|
|
2671
|
+
* @param {Enums.LuminousSmokyFlame} options.luminousSmokyFlame - A flag to indicate whether a flame is luminous or smoky. (default value is Enums.LuminousSmokyFlame.GENERAL)
|
|
2633
2672
|
*/
|
|
2634
2673
|
constructor(options?: {
|
|
2635
2674
|
id?: string;
|
|
@@ -2770,14 +2809,15 @@ export class Pipe extends Asset {
|
|
|
2770
2809
|
/**
|
|
2771
2810
|
* An asset to model events that involve releases from pressurised pipelines.
|
|
2772
2811
|
*
|
|
2773
|
-
* @param {
|
|
2774
|
-
* @param {LocalPosition
|
|
2775
|
-
* @param {
|
|
2776
|
-
* @param {number}
|
|
2777
|
-
* @param {
|
|
2778
|
-
* @param {
|
|
2779
|
-
* @param {
|
|
2780
|
-
* @param {number}
|
|
2812
|
+
* @param {Object} options - Initialisation options
|
|
2813
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
2814
|
+
* @param {LocalPosition[]} options.nodes - A set of points along the pipe.
|
|
2815
|
+
* @param {number} options.nodeCount - The number of nodes along the pipe.
|
|
2816
|
+
* @param {number} options.diameter - Diameter of the pipe. [m]
|
|
2817
|
+
* @param {Material} options.material - Material.
|
|
2818
|
+
* @param {State} options.state - Fluid state in the pipe.
|
|
2819
|
+
* @param {number} options.roughness - A measure of the roughness of internal surfaces of the pipe. [m] (default value is 4.5e-5)
|
|
2820
|
+
* @param {number} options.pumpedInflow - Flowrate along the pipeline under normal operating conditions. [kg/s] (default value is 0)
|
|
2781
2821
|
*/
|
|
2782
2822
|
constructor(options?: {
|
|
2783
2823
|
id?: string;
|
|
@@ -2860,10 +2900,11 @@ export class PipeBreach extends ReleaseOverTime {
|
|
|
2860
2900
|
/**
|
|
2861
2901
|
* A storage scenario which models a time-dependent release of material from its process or transport conditions in a pipeline.
|
|
2862
2902
|
*
|
|
2863
|
-
* @param {
|
|
2864
|
-
* @param {number}
|
|
2865
|
-
* @param {
|
|
2866
|
-
* @param {
|
|
2903
|
+
* @param {Object} options - Initialisation options
|
|
2904
|
+
* @param {number} options.distanceDownstream - The distance of the pipe breach, measured along the pipeline from the upstream end. [m]
|
|
2905
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
2906
|
+
* @param {Enums.TimeVaryingOption} options.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)
|
|
2907
|
+
* @param {number} options.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
2908
|
*/
|
|
2868
2909
|
constructor(options?: {
|
|
2869
2910
|
id?: string;
|
|
@@ -2909,12 +2950,13 @@ export class PoolFireFlameResult extends FlameResult {
|
|
|
2909
2950
|
/**
|
|
2910
2951
|
* Flame results for a pool fire.
|
|
2911
2952
|
*
|
|
2912
|
-
* @param {
|
|
2913
|
-
* @param {number}
|
|
2914
|
-
* @param {number}
|
|
2915
|
-
* @param {number}
|
|
2916
|
-
* @param {number
|
|
2917
|
-
* @param {
|
|
2953
|
+
* @param {Object} options - Initialisation options
|
|
2954
|
+
* @param {number} options.time - Time of interest for time varying releases, or duration for initial rate releases. [s]
|
|
2955
|
+
* @param {number} options.surfaceEmissivePower - The rate at which thermal radiation is emitted from the surface of a flame per unit area. [W/m2]
|
|
2956
|
+
* @param {number} options.flameLength - Length of the flame. [m]
|
|
2957
|
+
* @param {number} options.flameDiameter - Diameter of the flame. [m]
|
|
2958
|
+
* @param {number[]} options.poolZoneSEP - Surface emissive power from each of the two pool fire zones. [W/m2]
|
|
2959
|
+
* @param {Enums.FireType} options.fireType - Type of fire. (default value is Enums.FireType.NO_FIRE)
|
|
2918
2960
|
*/
|
|
2919
2961
|
constructor(options?: {
|
|
2920
2962
|
id?: string;
|
|
@@ -2972,19 +3014,20 @@ export class PoolRecord extends EntityBase {
|
|
|
2972
3014
|
/**
|
|
2973
3015
|
* A record containing pool results at a given time.
|
|
2974
3016
|
*
|
|
2975
|
-
* @param {
|
|
2976
|
-
* @param {number}
|
|
2977
|
-
* @param {number}
|
|
2978
|
-
* @param {number}
|
|
2979
|
-
* @param {number}
|
|
2980
|
-
* @param {number}
|
|
2981
|
-
* @param {number}
|
|
2982
|
-
* @param {number}
|
|
2983
|
-
* @param {number}
|
|
2984
|
-
* @param {number}
|
|
2985
|
-
* @param {number}
|
|
2986
|
-
* @param {number}
|
|
2987
|
-
* @param {number}
|
|
3017
|
+
* @param {Object} options - Initialisation options
|
|
3018
|
+
* @param {number} options.time - Time since rainout occurred. [s]
|
|
3019
|
+
* @param {number} options.massSpilt - The mass that rains out and forms a pool. [kg]
|
|
3020
|
+
* @param {number} options.massVaporised - Mass vaporised from the pool. [kg]
|
|
3021
|
+
* @param {number} options.massDissolved - The mass of the pool dissolved in water. [kg]
|
|
3022
|
+
* @param {number} options.massRemaining - Mass remaining in the pool. [kg]
|
|
3023
|
+
* @param {number} options.vapourisationRate - The rate of vapourisation from the pool. [kg/s]
|
|
3024
|
+
* @param {number} options.solutionRate - The rate at which the pool will dissolve in water. [kg/s]
|
|
3025
|
+
* @param {number} options.effectiveRadius - The radius of the area of the pool which is taking into account the amount of mass re-evaporated into the cloud. [m]
|
|
3026
|
+
* @param {number} options.depth - Depth of the pool. [m]
|
|
3027
|
+
* @param {number} options.temperature - Temperature of the material in the pool. [K]
|
|
3028
|
+
* @param {number} options.spillRate - The mass rate at which the cloud is raining out and forming a pool. [kg/s]
|
|
3029
|
+
* @param {number} options.actualRadius - The radius of the pool formed. [m]
|
|
3030
|
+
* @param {number} options.poolCentre - The downwind distance at which rainout occurs and a pool is formed. [m]
|
|
2988
3031
|
*/
|
|
2989
3032
|
constructor(options?: {
|
|
2990
3033
|
id?: string;
|
|
@@ -3094,9 +3137,10 @@ export class PoolVapourisationParameters extends EntityBase {
|
|
|
3094
3137
|
/**
|
|
3095
3138
|
* Pool vapourisation parameters.
|
|
3096
3139
|
*
|
|
3097
|
-
* @param {
|
|
3098
|
-
* @param {number}
|
|
3099
|
-
* @param {number}
|
|
3140
|
+
* @param {Object} options - Initialisation options
|
|
3141
|
+
* @param {number} options.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)
|
|
3142
|
+
* @param {number} options.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)
|
|
3143
|
+
* @param {number} options.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
3144
|
*/
|
|
3101
3145
|
constructor(options?: {
|
|
3102
3146
|
id?: string;
|
|
@@ -3146,9 +3190,10 @@ export class RadiationRecord extends EntityBase {
|
|
|
3146
3190
|
/**
|
|
3147
3191
|
* A record of the radiation type and level at a specific point (x,y,z).
|
|
3148
3192
|
*
|
|
3149
|
-
* @param {
|
|
3150
|
-
* @param {
|
|
3151
|
-
* @param {
|
|
3193
|
+
* @param {Object} options - Initialisation options
|
|
3194
|
+
* @param {LocalPosition} options.position - Cartesian coordinates of a point of interest.
|
|
3195
|
+
* @param {number} options.radiationResult - The value for the RadiationType at the specified position.
|
|
3196
|
+
* @param {Enums.RadiationType} options.radiationType - The type of radiation result of interest. (default value is Enums.RadiationType.UNSET)
|
|
3152
3197
|
*/
|
|
3153
3198
|
constructor(options?: {
|
|
3154
3199
|
id?: string;
|
|
@@ -3210,13 +3255,14 @@ export class ReliefValve extends ReleaseOverTime {
|
|
|
3210
3255
|
/**
|
|
3211
3256
|
* 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
3257
|
*
|
|
3213
|
-
* @param {
|
|
3214
|
-
* @param {number}
|
|
3215
|
-
* @param {number}
|
|
3216
|
-
* @param {number}
|
|
3217
|
-
* @param {
|
|
3218
|
-
* @param {
|
|
3219
|
-
* @param {number}
|
|
3258
|
+
* @param {Object} options - Initialisation options
|
|
3259
|
+
* @param {number} options.reliefValveConstrictionDiameter - Constriction at the upstream end of the pipe. [m]
|
|
3260
|
+
* @param {number} options.pipeDiameter - Internal diameter of the short pipe. [m]
|
|
3261
|
+
* @param {number} options.pipeLength - Length of the short pipe. [m]
|
|
3262
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
3263
|
+
* @param {Enums.TimeVaryingOption} options.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)
|
|
3264
|
+
* @param {number} options.pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
3265
|
+
* @param {number} options.pipeHeightFraction - Location of the pipe connection above the base of the vessel. [fraction] (default value is 0.5)
|
|
3220
3266
|
*/
|
|
3221
3267
|
constructor(options?: {
|
|
3222
3268
|
id?: string;
|
|
@@ -3285,12 +3331,13 @@ export class SafetySystem extends EntityBase {
|
|
|
3285
3331
|
/**
|
|
3286
3332
|
* A safety system entity which defines isolation and blowdown settings for a pressurised vessel.
|
|
3287
3333
|
*
|
|
3288
|
-
* @param {
|
|
3289
|
-
* @param {
|
|
3290
|
-
* @param {
|
|
3291
|
-
* @param {number}
|
|
3292
|
-
* @param {
|
|
3293
|
-
* @param {
|
|
3334
|
+
* @param {Object} options - Initialisation options
|
|
3335
|
+
* @param {number} options.isolationTime - Time from start of release to failed or successful isolation. [s] (default value is 0.0)
|
|
3336
|
+
* @param {boolean} options.isolationSuccess - Does isolation succeed?. (default value is true)
|
|
3337
|
+
* @param {number} options.massAddedIsolationFailure - Upstream mass to add in case of isolation failure. [kg] (default value is 0.0)
|
|
3338
|
+
* @param {number} options.blowdownTime - Time from start of release to failed or successful blowdown. [s] (default value is 0.0)
|
|
3339
|
+
* @param {boolean} options.blowdownSuccess - Does blowdown succeed?. (default value is false)
|
|
3340
|
+
* @param {number} options.blowdownValveSize - Diameter of blowdown valve. [m] (default value is 0.025)
|
|
3294
3341
|
*/
|
|
3295
3342
|
constructor(options?: {
|
|
3296
3343
|
id?: string;
|
|
@@ -3362,13 +3409,14 @@ export class ScalarUdmOutputs extends EntityBase {
|
|
|
3362
3409
|
/**
|
|
3363
3410
|
* Scalar UDM output values required for post processing dispersion results.
|
|
3364
3411
|
*
|
|
3365
|
-
* @param {
|
|
3366
|
-
* @param {number}
|
|
3367
|
-
* @param {number}
|
|
3368
|
-
* @param {number}
|
|
3369
|
-
* @param {number}
|
|
3370
|
-
* @param {number}
|
|
3371
|
-
* @param {
|
|
3412
|
+
* @param {Object} options - Initialisation options
|
|
3413
|
+
* @param {number} options.observerCount - Number of observers either from the release or from the pool.
|
|
3414
|
+
* @param {number} options.recordCount - Number of total dispersion records from all observers.
|
|
3415
|
+
* @param {number} options.minimumConcentration - Minimum concentration to which dispersion calculations have been performed. [fraction]
|
|
3416
|
+
* @param {number} options.windPower - A wind profile exponent describing how wind changes with height.
|
|
3417
|
+
* @param {number} options.frictionVelocity - The shear stress between the air and the ground. [m/s]
|
|
3418
|
+
* @param {number} options.dispersionReleaseDuration - The time at which the last observer is released. [s]
|
|
3419
|
+
* @param {Enums.DynamicType} options.cloudType - Type of release or cloud. (default value is Enums.DynamicType.UNSET)
|
|
3372
3420
|
*/
|
|
3373
3421
|
constructor(options?: {
|
|
3374
3422
|
id?: string;
|
|
@@ -3452,12 +3500,13 @@ export class ShortPipeRupture extends ReleaseOverTime {
|
|
|
3452
3500
|
/**
|
|
3453
3501
|
* Short pipe rupture scenario.
|
|
3454
3502
|
*
|
|
3455
|
-
* @param {
|
|
3456
|
-
* @param {number}
|
|
3457
|
-
* @param {number}
|
|
3458
|
-
* @param {
|
|
3459
|
-
* @param {
|
|
3460
|
-
* @param {number}
|
|
3503
|
+
* @param {Object} options - Initialisation options
|
|
3504
|
+
* @param {number} options.pipeLength - Length of short pipe. [m]
|
|
3505
|
+
* @param {number} options.pipeDiameter - Inner diameter of the short pipe. [m]
|
|
3506
|
+
* @param {number} options.releaseAngle - Angle of release above a horizontal plane. [rad] (default value is 0.0)
|
|
3507
|
+
* @param {Enums.TimeVaryingOption} options.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)
|
|
3508
|
+
* @param {number} options.pipeRoughness - Roughness of the short pipe. [m] (default value is 0.000045)
|
|
3509
|
+
* @param {number} options.pipeHeightFraction - Location of the pipe connection above the base of the vessel. [fraction] (default value is 0.5)
|
|
3461
3510
|
*/
|
|
3462
3511
|
constructor(options?: {
|
|
3463
3512
|
id?: string;
|
|
@@ -3516,8 +3565,9 @@ export class Structure extends EntityBase {
|
|
|
3516
3565
|
/**
|
|
3517
3566
|
* A building or process plant structure.
|
|
3518
3567
|
*
|
|
3519
|
-
* @param {
|
|
3520
|
-
* @param {
|
|
3568
|
+
* @param {Object} options - Initialisation options
|
|
3569
|
+
* @param {ExplosionConfinedVolume} options.explosionConfinedVolume - Confined explosion volume data.
|
|
3570
|
+
* @param {LocalPosition} options.location - Location of the structure.
|
|
3521
3571
|
*/
|
|
3522
3572
|
constructor(options?: {
|
|
3523
3573
|
id?: string;
|
|
@@ -3564,10 +3614,11 @@ export class Substrate extends EntityBase {
|
|
|
3564
3614
|
/**
|
|
3565
3615
|
* The ground over which a release is taking place.
|
|
3566
3616
|
*
|
|
3567
|
-
* @param {
|
|
3568
|
-
* @param {
|
|
3569
|
-
* @param {
|
|
3570
|
-
* @param {Enums.
|
|
3617
|
+
* @param {Object} options - Initialisation options
|
|
3618
|
+
* @param {Bund} options.bund - A bund entity used in the modelling of pool spreading and vaporisation.
|
|
3619
|
+
* @param {number} options.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)
|
|
3620
|
+
* @param {Enums.SurfaceType} options.surfaceType - Surface over which the dispersion occurs. (default value is Enums.SurfaceType.LAND)
|
|
3621
|
+
* @param {Enums.PoolSurfaceType} options.poolSurfaceType - Surface onto which the liquid which rains out will spread. (default value is Enums.PoolSurfaceType.CONCRETE)
|
|
3571
3622
|
*/
|
|
3572
3623
|
constructor(options?: {
|
|
3573
3624
|
id?: string;
|
|
@@ -3633,9 +3684,10 @@ export class ToxicRecord extends EntityBase {
|
|
|
3633
3684
|
/**
|
|
3634
3685
|
* A record of the toxic result type and level at a specific point (x,y,z).
|
|
3635
3686
|
*
|
|
3636
|
-
* @param {
|
|
3637
|
-
* @param {
|
|
3638
|
-
* @param {
|
|
3687
|
+
* @param {Object} options - Initialisation options
|
|
3688
|
+
* @param {LocalPosition} options.position - Cartesian coordinates of a point of interest.
|
|
3689
|
+
* @param {number} options.toxicResult - The value for the ToxicResultType at the specified position.
|
|
3690
|
+
* @param {Enums.ToxicResultType} options.toxicResultType - The type of toxic result. (default value is Enums.ToxicResultType.UNSET)
|
|
3639
3691
|
*/
|
|
3640
3692
|
constructor(options?: {
|
|
3641
3693
|
id?: string;
|
|
@@ -3702,17 +3754,18 @@ export class Vessel extends Asset {
|
|
|
3702
3754
|
/**
|
|
3703
3755
|
* A pressue vessel asset to represent pressurised containment.
|
|
3704
3756
|
*
|
|
3705
|
-
* @param {
|
|
3706
|
-
* @param {
|
|
3707
|
-
* @param {
|
|
3708
|
-
* @param {
|
|
3709
|
-
* @param {
|
|
3710
|
-
* @param {number}
|
|
3711
|
-
* @param {number}
|
|
3712
|
-
* @param {number}
|
|
3713
|
-
* @param {
|
|
3714
|
-
* @param {Enums.
|
|
3715
|
-
* @param {
|
|
3757
|
+
* @param {Object} options - Initialisation options
|
|
3758
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
3759
|
+
* @param {State} options.state - Fluid state in the vessel.
|
|
3760
|
+
* @param {Material} options.material - Material in the vessel.
|
|
3761
|
+
* @param {SafetySystem} options.safetySystem - A safety system entity which defines isolation and blowdown settings for a pressurised vessel.
|
|
3762
|
+
* @param {number} options.diameter - Internal diameter of the vessel. [m] (default value is 2)
|
|
3763
|
+
* @param {number} options.height - Internal height of a VerticalCylinder or VesselCuboid. [m] (default value is 4)
|
|
3764
|
+
* @param {number} options.length - Internal length of HorizontalCylinder or VesselCuboid. [m] (default value is 4)
|
|
3765
|
+
* @param {number} options.width - Internal width of a VesselCuboid. [m] (default value is 2.0)
|
|
3766
|
+
* @param {Enums.VesselShape} options.shape - Shape of the vessel. (default value is Enums.VesselShape.HORIZONTAL_CYLINDER)
|
|
3767
|
+
* @param {Enums.VesselConditions} options.vesselConditions - The conditions inside the vessel. (default value is Enums.VesselConditions.UNSET)
|
|
3768
|
+
* @param {number} options.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
3769
|
*/
|
|
3717
3770
|
constructor(options?: {
|
|
3718
3771
|
id?: string;
|
|
@@ -3821,12 +3874,13 @@ export class VesselLeakMaxFlammableCloudResults extends EntityBase {
|
|
|
3821
3874
|
/**
|
|
3822
3875
|
* Results for a linked run of vessel leak followed by dispersion and views from the cloud.
|
|
3823
3876
|
*
|
|
3824
|
-
* @param {
|
|
3825
|
-
* @param {number}
|
|
3826
|
-
* @param {number}
|
|
3827
|
-
* @param {number}
|
|
3828
|
-
* @param {number}
|
|
3829
|
-
* @param {
|
|
3877
|
+
* @param {Object} options - Initialisation options
|
|
3878
|
+
* @param {number} options.dischargeRate - Mass flow rate from the leak. [kg/s]
|
|
3879
|
+
* @param {number} options.expandedTemperature - Post atmospheric expansion temperature. [K]
|
|
3880
|
+
* @param {number} options.lflExtent - Maximum downwind distance to LFL. [m]
|
|
3881
|
+
* @param {number} options.lflArea - Horizontal area of the LFL envelope. [m2]
|
|
3882
|
+
* @param {number} options.lflHeight - Height of the maximum LFL extent. [m]
|
|
3883
|
+
* @param {Enums.Phase} options.phase - Post atmospheric expansion fluid phase. (default value is Enums.Phase.UNSET)
|
|
3830
3884
|
*/
|
|
3831
3885
|
constructor(options?: {
|
|
3832
3886
|
id?: string;
|
|
@@ -3903,10 +3957,11 @@ export class VesselSphere extends Asset {
|
|
|
3903
3957
|
/**
|
|
3904
3958
|
* A spherical pressue vessel asset to represent pressurised containment.
|
|
3905
3959
|
*
|
|
3906
|
-
* @param {
|
|
3907
|
-
* @param {
|
|
3908
|
-
* @param {
|
|
3909
|
-
* @param {
|
|
3960
|
+
* @param {Object} options - Initialisation options
|
|
3961
|
+
* @param {LocalPosition} options.location - Location of the asset.
|
|
3962
|
+
* @param {State} options.state - Fluid state in the vessel.
|
|
3963
|
+
* @param {Material} options.material - Material in the vessel.
|
|
3964
|
+
* @param {number} options.massInventory - Mass of the material in the vessel. [kg]
|
|
3910
3965
|
*/
|
|
3911
3966
|
constructor(options?: {
|
|
3912
3967
|
id?: string;
|
|
@@ -3964,13 +4019,14 @@ export class Weather extends EntityBase {
|
|
|
3964
4019
|
/**
|
|
3965
4020
|
* A set of weather conditions for use in the modelling of a release and its effects.
|
|
3966
4021
|
*
|
|
3967
|
-
* @param {
|
|
3968
|
-
* @param {
|
|
3969
|
-
* @param {
|
|
3970
|
-
* @param {number}
|
|
3971
|
-
* @param {number}
|
|
3972
|
-
* @param {number}
|
|
3973
|
-
* @param {
|
|
4022
|
+
* @param {Object} options - Initialisation options
|
|
4023
|
+
* @param {number} options.windSpeed - Wind speed at a reference height. [m/s] (default value is 5)
|
|
4024
|
+
* @param {Enums.AtmosphericStabilityClass} options.stabilityClass - The Pasquill atmospheric stability class. (default value is Enums.AtmosphericStabilityClass.STABILITY_D)
|
|
4025
|
+
* @param {number} options.temperature - The atmospheric temperature. [K] (default value is 283)
|
|
4026
|
+
* @param {number} options.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)
|
|
4027
|
+
* @param {number} options.mixingLayerHeight - The height of the atmospheric boundary layer which caps the centreline of the plume. [m] (default value is 800)
|
|
4028
|
+
* @param {number} options.solarRadiation - The radiation received from the sun, which contributes to pool evaporation. [W/m2] (default value is 500)
|
|
4029
|
+
* @param {Enums.WindProfileFlag} options.windProfileFlag - Wind profile flag. (default value is Enums.WindProfileFlag.POWER_LAW_PROFILE)
|
|
3974
4030
|
*/
|
|
3975
4031
|
constructor(options?: {
|
|
3976
4032
|
id?: string;
|