Enter Global Input Data
Summary
Enter Global Input Data enables you to populate the global inputs table in the project geodatabase (that you created with the Initialize Database tool) with the necessary pipeline operating conditions, product properties, ambient conditions, and spatial constraints data needed to support the liquids high consequence area (HCA) analysis workflows.
To learn more about the Liquids HCA Tool in general, please see Liquids HCA Tool Frequently Asked Questions.
To learn more about the structure of the Liquids HCA Tool project geodatabase, please see the Liquids HCA Tool Data Dictionary.
Usage
Enter Global Input Data tool parameters are divided into six sections, as described below. You run this tool on a route-by-route basis. This means that you will need to run this tool once for each route in the centerline route features data set you provided as input to the Initialize Database tool. If you would prefer to import all of your global inputs data at once, you may do so using the Import Global Input Data tool.
1) Route Parameters
- Input Project Database – This is the project file geodatabase you created with the Initialize Database tool. The Liquids HCA Tool project geodatabase is intended to store all data inputs and outputs generated during the analysis process.
- Input Global Inputs Table – The global inputs table stores important attribution used by other tools throughout the Liquids HCA Analysis workflow. You will specify the values for these data attributes using this tool. The global inputs table was created and initialized by the Initialize Database tool. The global inputs table is named GLOBAL_INPUTS by default; this tool searches the input project geodatabase for that name and populates this parameter with it, if found.
- Route Identifier Field – When you ran Initialize Database, that tool copied basic route information into the global inputs table, creating one row in the table for each of your centerline route features. Select the route identifier field you will use to identify the route for which you wish to input data. The default value is the ORIGINAL_ROUTE_ID column in the global inputs table, as this field stores the original route identifier values in your routes.
- Route Identifier Value – The pull-down list of route identifier values is populated from the values for your selected route identifier field. Select the route identifier value for the route for which you wish to enter global inputs data.
- Release Point Interval (m) – The release point interval is the spacing between release points along the centerline route feature, expressed in meters. This value is used in the creation of your release points in the Create Release Points tool. In general, the release point interval should be small enough that you don’t have any major gaps between the overland plumes for adjacent release points. Under no circumstances should you specify a release point interval smaller than the horizontal resolution (cell size) of your digital elevation data. The default value for this is 30 meters. (This value is stored in the SPL_PT_INT column in the global inputs table.)
2) Pipeline Properties/Operating Conditions
- Pipe Internal Diameter (in.) – The internal diameter of the pipeline is used in the drain down calculation for each release point (in the Calculate Draindown tool). The actual internal diameter of the pipeline varies with the wall thickness of the pipe; the value captured here at the route level is therefore a rough approximation of internal pipeline diameter. You will have an opportunity to provide detailed internal diameter data when you specify the pipe segment layer for the Calculate Draindown tool. If you do not have detailed pipe segment data available, you must enter a value here; the value you enter here will be used to calculate drain down volumes. If you do have detailed pipe segment data, it will be used preferentially to calculate drain down volumes, regardless of whether you enter a value here. Pipeline internal diameter at the centerline route level is stored in the N_INT_DIAM column of the global inputs table.
For 14-inch nominal pipe diameter and larger, the actual outside diameter of the pipe is equal to the nominal pipe diameter. For 14-inch nominal diameter pipe and larger, internal diameter is therefore equal to the nominal/outside diameter minus twice the wall thickness. For 12-inch nominal pipe diameter and smaller, nominal diameter is not equal to actual outside pipe diameter. For example, the actual outside diameter of 12-inch nominal diameter pipe is 12.75 inches.
In general, you should specify the internal pipeline diameter for a given route based on the most common wall thickness for the pipe in that route. If you do not have wall thickness information, simply specify the nominal diameter of the pipe. This will result in drain down volumes for each release point that are a little larger than the true drain down volume. This conservative approach ensures that you do not underestimate drain down volumes.
- Pipe Roughness (m) – Pipe roughness is used in the calculation of maximum gravity drain rate in the drain down calculation for each release point (in the Calculate Draindown tool using Bernoulli’s equation for incompressible flow in pipes). The roughness of the internal pipe surface introduces friction that impedes product flow; friction losses contribute to increasing pressure head loss with increasing distance from a pumping station. Pipe roughness is stored in the PIPE_ROUGH column in the global inputs table.
Roughness values for steel pipe vary considerably with pipe condition. Some common values are:
Material | Roughness (m) |
Steel, welded, new | 0.00005 – 0.0001 |
Steel, used, cleaned | 0.00015 – 0.0002 |
Steel, lightly corroded | 0.0001 – 0.0004 |
Steel, severely corroded | 0.0004 – 0.003 |
Steel, light scaling | 0.001 – 0.0015 |
Steel, heavy scaling | 0.0015 – 0.004 |
Bear in mind that lower pipe roughness values result in higher drain rates. Higher drain rates lead to increase in overland plume spread and, therefore, more conservative results.
- Product Flow in Increasing Measure Direction – Product flow direction is used to delineate upstream vs. downstream flow in the pipeline in drain down calculations (in the Calculate Draindown tool). If the product flow is in the same direction as increasing measure on the centerline route, enter a value of 1. Otherwise, enter a value of 0. This flag value is stored in the FLOWEQSTN column in the global inputs table.
- Pumping Flow Rate (BBL/hr.) – Pumping flow rate is used in drain down calculation for each release point (in the Calculate Draindown tool). This value is stored in the FLOW_RATE column in the global inputs table.
- Pipeline Operating Temperature (deg. C) – Pipeline operating temperature is needed to adjust product viscosity in the drain down calculation for each release point (in the Calculate Draindown tool using Bernoulli’s equation for incompressible flow in pipes). This value is stored in the P_OP_TEMP column in the global inputs table.
- Time Required to Shutdown Pumps & ROVs (min.) – The total time to shut down the pipeline, including pumps and remotely operated valves (ROVs), is used in the drain down calculation for each release point (in the Calculate Draindown tool). This value is stored in the P_SD_TIME column in the global inputs table.
- Overland Flow Response Time (min.) – This is the nominal response time for the entire centerline route for an emergency response crew to achieve containment of a land-based hazardous liquids release. This value is copied into the release point feature class (OSPOINTM, by default, in the project geodatabase) for each release point when you run the Create Release Points tool. Note that response time can vary along the length of the centerline route feature. You can alter the response times for individual release points (or groups of release points) if desired. The response time you enter should not be the best response time but, rather, a reasonable worst-case response time. This value is stored in the OFRES_TIME column in the global inputs table.
- Hydrographic Transport Response Time (min.) – This is the nominal response time for the entire centerline route for an emergency response team to achieve containment of a hazardous liquids release that enters a waterway. Plume transport in a waterway is typically more rapid than for an overland plume, and water containment requires the staging and deployment of specialized equipment (booms, skimmers, etc.) Because of this, response time for a water-based release may vary from that of a land-based release. This value is copied into the release point feature class (OSPOINTM, by default, in the project geodatabase) for each release point when you run the Create Release Points tool. Note that response time can vary along the length of the centerline route feature. You can alter the response times for individual release points (or groups of release points) if desired. The response time you enter should not be the best response time but, rather, a reasonable worst-case response time. This value is stored in the HTRES_TIME column in the global inputs table.
3) Product Properties
- Input Product Properties Lookup Table – The Initialize Database tool creates a lookup table called PRODUCT_PROPERTIES_LOOKUP that stores physical properties data for over 100 crude oils and refined products. This table provides you with a handy source of data for product properties. Note that when you enter data for custom products, that data is appended to the product properties lookup table for future use. The default value for this parameter is the PRODUCT_PROPERTIES_LOOKUP table; you typically shouldn’t need to alter this value.
- Product Type – The product type pulldown allows you to select any of the products stored in the specified product properties lookup table by name, and you should do so if the product your pipeline is carrying is in the list. If you select a product from the product type pulldown, the physical property values for the product properties parameters are automatically populated. If your product is not in the product type pulldown list, choose the value, ‘Custom,’ which is the default. If you select ‘Custom,’ you will need to specify values for the product properties parameters yourself. The value you select (or enter in the Custom Product Type parameter) is stored in the M_PROD_TYP column in the global inputs table.
- Custom Product Type – This parameter is only visible when you select ‘Custom’ as the product type. When you select ‘Custom’ as the product type, enter the name of your product here. The product properties data you enter for your custom product is appended to the product properties lookup table and is available for future use.
- Product Density (g/cc) – Product density is used both in drain down drain rate calculations (in the Calculate Draindown tool) and by GeoClaw (in the Run Cases on Azure tool) in modeling the overland spread product plume. The value you enter is stored in the PROD_DNSTY column in the global inputs table. Because API gravity is a function of density, if you enter a value for product density, the Product API Gravity parameter value is automatically populated.
- Product API Gravity – Product API gravity is a function of product density:
API gravity = (141.5/Product Density) – 131.5
As you can see by inspection, a heavy crude with an API gravity of 10 has a product density of 1.0, the same as water. Any product with an API gravity higher than 10 is less dense than water. If you know the API gravity of your product, enter it here and the Product Density (g/cc) parameter value is automatically populated. The API gravity value is stored in the API_GRAV column in the global inputs table.
- Product C5+ Volume Fraction (%) – Crude oils and many refined products are complex mixtures of many different types of pure hydrocarbon substances. The carbon number of a hydrocarbon substance is indicative of the number of carbon atoms in a single molecule of that substance. For instance, normal pentane has a carbon number (Cn) of 5. The isomers of pentane (n-pentane, methylbutane, and dimethylpropane) are all C5 Normal alkane hydrocarbons with carbon number of 5 or higher are liquids at room temperature and are amenable of overland flow plume modeling. Normal butane (C4), the butane isomer with the highest boiling point, boils at 30.2 °F. Except for n-butane at temperatures below freezing (which is a special case), hydrocarbons with a carbon number of less than or equal to 4 are not amenable to liquid overland flow plume modeling because these substances flash to vapor immediately on exposure to atmospheric temperature and pressure. For most products modeled with the Liquids HCA Tool, the C5+ volume fraction is 100%, which is the default value for this parameter.
Some products, such as natural gas liquids (NGLs), may consist of hydrocarbon mixtures in which only a portion of the product consists of C5+ hydrocarbons. For the purposes of liquid overland flow plume modeling, only the C5+ volume fraction of such products is considered in liquids overland flow plume modeling. (In fact, the rupture of an NGL product line results in some complex processes relative to product fate, and much of the C5+ volume fraction may be initially and permanently entrained in the vapor phase of the release. Assuming that the entire C5+ volume fraction is subject to liquid overland flow is conservative in the sense that it maximizes the extent of the overland flow plume.)
The value you enter for this parameter is stored in the C5_VOL_PCT column of the global inputs table.
- Product Kinematic Viscosity (cSt) – Viscosity is a measure of a fluid’s resistance to shearing stress. Product viscosity is used both in drain down drain rate calculations (in the Calculate Draindown tool) and by GeoClaw (in the Run Cases on Azure tool) in modeling the overland spread product plume. Water has a dynamic/kinematic viscosity of 1.0, by definition. Hydrocarbon product viscosity in generally a function of carbon number; the higher the average carbon number of the product, the higher the viscosity. Gasoline has a kinematic viscosity slightly less than that of water; most hydrocarbon products are more viscous than water, in some cases by multiple orders of magnitude. Heavy crudes can have kinematic viscosities approaching 50,000 centistokes (cSt). Please note that dynamic viscosity (units of centipascals (cP)) is not the same as kinematic viscosity (units of cSt). You may obtain kinematic viscosity by dividing dynamic viscosity by product density. The value you enter for this parameter is stored in the KIN_VISC column in the global inputs table.
- Product Kinematic Viscosity Reference Temperature (deg. C) – Hydrocarbon product viscosity is highly dependent on temperature; hydrocarbon product viscosity increases with decreasing temperature. Because of this, you must specify the temperature at which the product kinematic viscosity value was determined. Product viscosity can then be adjusted to the pipeline operating temperature and ambient temperature for drain rate and overland flow rate calculations, respectively. The value you enter for this parameter is stored in the KVISC_TEMP column in the global inputs table.
- Evaporation Equation Method – Evaporation is the primary product loss mechanism for the release plume. The Liquids HCA Tool uses an evaporation calculation methodology in which evaporation is a function of temperature and exposure time. This methodology was developed by an oil properties project consortium consisting of the Canadian Environmental Technology Centre (now Environment and Climate Change Canada), the U.S. Environmental Protection Agency, and the U.S. Minerals Management Service (now Bureau of Ocean Energy Management) in the late 1990s based on the research of Dr. Merv F. Fingas. Laboratory-determined coefficients for the Fingas evaporation equations may be found in the PRODUCT_PROPERTIES_LOOKUP table in your project geodatabase for many of the products studied by the aforementioned consortium. When the laboratory determined Fingas evaporation equation coefficients are known, specify the evaporation equation method as, ‘Fingas.’ (This is done automatically when you select a known product from the Product Type pull-down.)
In many cases, you will be modeling products not found in the PRODUCT_PROPERTIES_LOOKUP table. To accommodate this, G2-IS performed a regression analysis of all the hydrocarbon products for which Fingas evaporation coefficients are known, enabling the approximation of Fingas evaporation coefficients as a function of product API gravity (product density). If you do not know the laboratory determined Fingas evaporation equation coefficients for your product, specify the evaporation equation method as ‘G2-IS,’ and the Fingas evaporation equation coefficients are automatically calculated based on product API gravity.
‘G2-IS’ is the default evaporation equation method. The value you enter for this parameter is stored in the EQ_TYPE column in the global inputs table.
- Evaporation Equation Form – The Fingas evaporation equation takes one of two forms:
- Logarithmic: Percent Evaporated = (C1 + C2T)ln(t)
- Square Root: Percent Evaporated = (C1 + C2T)(t)5
Where: C1 is Fingas coefficient 1; C2 is Fingas coefficient 2; T is ambient temperature; and, t is elapsed time from the start of the release in minutes.
The logarithmic form of the equation is primarily applicable to crude oils; the square root form is primarily applicable to refined products. You must know which form of the equation is applicable to your evaporation coefficients. If you select a known product from the Product Type pull-down, this parameter is automatically populated. When the equation method is ‘G2-IS,’ you should select the equation form based on the general product type. Appropriate evaporation equation coefficients are calculated regardless of which type you select. ‘Logarithmic’ is the default evaporation equation form. The value for this parameter is stored in the EQ_FORM column of the global inputs table.
- Fingas Coefficient 1 – Fingas coefficient 1 is populated automatically when you select a known product from the Product Type pull-down, or you specify Evaporation Equation Method as ‘G2-IS’ (and have specified Product API Gravity). This value is stored in the FINGAS_1 column in the global inputs table.
- Fingas Coefficient 2 – Fingas coefficient 2 is populated automatically when you select a known product from the Product Type pull-down, or you specify Evaporation Equation Method as ‘G2-IS’ (and have specified Product API Gravity). This value is stored in the FINGAS_2 column in the global inputs table.
- Product Vapor Pressure at Operating Temperature (PSI) – Product vapor pressure is used in the drain down calculation for each release point (in the Calculate Draindown tool). When gravity drain down is complete, the evacuated portions of the line not open to air are subject to the product vapor pressure. For the first filled segment open to air, the product column elevation rises higher than the elevation of the release point due to atmospheric pressure acting on the product column in the pipe. This difference in elevation may be expressed mathematically as:
Δh = (atmospheric pressure – product vapor pressure) / (product density * g)
Where: Δh is the difference in elevation; and, g is the acceleration of gravity.
The default value for the product vapor pressure is 0 psi. The value you enter for this parameter is stored in the P_VAPOR column in the global inputs table.
- Product Distillation Temperature (deg. C) – Distillation temperature is an important variable in the collection of boiling point distribution data for complex hydrocarbon mixtures. Boiling point distribution data was used in the derivation of the G2-IS evaporation equation and is an important adjunct to API gravity in performing the regression analysis of known crudes for the G2-IS evaporation equation method. Because the G2-IS evaporation equation is dependent only on API gravity, distillation data is optional. The G2-IS evaporation equation utilized a distillation temperature of 180 °C for regression; therefore, if you have boiling point distribution data, please provide data at 180 °C, if available. Distillation temperature is stored in the T_DIST column in the global inputs table.
- Product Distillation Volume (%) – The volume percent distilled at a given distillation temperature provides information about the carbon number distribution of the product and is related in a general fashion to the API gravity of the product. Like the product distillation temperature, this parameter is optional. Distillation volume is stored in the PCT_VDIST column in the global inputs table.
4) Ambient Conditions
- Ambient Temperature (deg. C) – Ambient temperature is a controlling factor for both evaporation and product viscosity. In general, higher ambient temperature results in higher evaporation rates. This effect is more pronounced for light (low carbon number) products than it is for heavier (high carbon number) products. Low carbon number products, such as gasoline, will evaporate completely in time, and evaporate more quickly at higher ambient temperatures. Heavy crudes, conversely, evaporate slowly and, within the context of typical model time constraints, never evaporate completely.
Viscosity of hydrocarbon products increases with decreasing temperature. This effect is far more pronounced for heavy products than for light products. The viscosity of gasoline, for instance, varies little over typical winter-summer temperature ranges. Heavy crudes, in contrast, become extremely viscous at low winter temperatures.
Given that you should attempt to model reasonable worst-case scenarios, G2-IS best practice is to model light products (e.g., gasoline) at low, winter ambient temperatures, and heavy products (e.g., heavy crude oil) at high, summer ambient temperatures. Low ambient temperature has little effect on the viscosity of light products but significantly retards evaporation. Low ambient temperatures enable light product plumes to persist longer in the environment, producing more conservative results for ‘could affect’ segments. High ambient temperatures significantly reduce the viscosity of heavy products and result in only moderately increased evaporation rates. High ambient temperatures enable heavy product plumes to travel farther overland, producing more conservative results for ‘could affect’ segments. The default value is 13.5 °C (~60 °F). Your ambient temperature value is stored in the T_AMB column in the global inputs table.
- Wind Velocity (m/s) – Wind velocity is used in the calculation of shoreline wave run-up in support of product loss calculations on small waterbodies (in the Hydro Trace tool). Higher wind velocities result in larger product losses. The Beaufort scale provides a handy reference for wind velocities; a moderate breeze on the Beaufort scale ranges from 5.5 to 7.9 meters per second (m/s). The default wind velocity value is 6.7 m/s (~15 mph). Wind velocity values are stored in the WIND_VEL column in the global inputs table.
5) Default Values
- Large Waterbody Slick Thickness (m) – Large waterbody slick thickness is used in product loss calculations for large waterbodies (in the Hydro Trace tool). The default value is 0.004 m. This parameter value is stored in the SLICK_THK column in the global inputs table.
- Small Waterbody Slick Thickness Factor (m) – Small waterbody slick thickness is used in product loss calculations for small waterbodies (in the Hydro Trace tool). The default value is 0.0005 m. This parameter value is stored in the SLKTHKSMWB column in the global inputs table.
- Waterbody Threshold Size (m˄2) – The Hydro Trace tool models flow through small waterbodies and transitions to a radial slick spread mode in large water bodies. The waterbody threshold size marks the boundary of this transition. The default waterbody threshold size is 40,489 m2 (10 acres). This parameter value is stored in the MAXWBAREA column in the global inputs table.
- Shoreline Product Adhesion (g/m˄2) – Shoreline product adhesion is used in shoreline product loss calculations for small waterbodies (in the Hydro Trace tool). The default value is 15 g/m2, which is a reasonable adhesion value for a light, sweet crude oil on steel. This default results in a conservative shoreline product loss value; actual shoreline loss values could easily be higher by an order of magnitude. This parameter value is stored in the WB_ADHSN column in the global inputs table.
- Waterbody Depth (m) – Average waterbody depth is used in shoreline product loss calculations for small waterbodies (in the Hydro Trace tool). The default waterbody depth is 3.05 m (10 feet). This parameter value is stored in the DEPTH_H2O column in the global inputs table.
- Waterbody Bank Inclination Angle (degrees) – Bank inclination angle is used in shoreline product loss calculations for small waterbodies (in the Hydro Trace tool). The default bank inclination angle is 14.1 degrees. This parameter value is stored in the BANK_ANGLE column in the global inputs table.
- Product Adhesion Rate (g/m˄2) – The ground surface product adhesion rate is a measure of how much product is left behind after the release plume passes. The default value is 0 g/m2, which is applicable to a reasonable worst-case scenario involving a release during a rain event, in which case there is no product adhesion to the ground surface. This parameter value is stored in the ADHSN_RT column in the global inputs table.
- Product Infiltration Rate (BBL/m˄2/hr.) – The ground surface product infiltration rate is a measure of how much product infiltrates into the underlying soil as a function of time. Units are expressed in terms of Darcy flux units (volume per unit area per unit time, or BBL/m2/hr.), which is common to reservoir engineering, rather than in the mm/hr. units more common to hydrography. (Note, however, that the unit dimensions are the same.) Infiltration rate is determined by the porosity of the surface and its permeability relative to the product, and the product hydraulic head (product column height or flow depth). Given these variables, infiltration rate can be calculated by application of Darcy’s Law. Because of the lack of detailed soils data on a large scale, and the lack of published permeability data for common petroleum products in common soils, infiltration rate is treated as a constant in the current version of the G2-IS Liquids HCA Tool. The default value is zero, which results in maximum propagation of the release plume. This parameter value is stored in the INFIL_RT column in the global inputs table.
- Draindown Calculation Z Tolerance (m) – When the Calculate Draindown tool performs its calculations, it uses the release points to establish the elevation profile for the centerline route. Often, there are more points than needed to establish a sufficiently accurate elevation profile. The Z tolerance parameter specifies the elevation tolerance that is used to depopulate the elevation profile. In general, the value you enter here should be equal to the centerline route nominal diameter. Release points that are significant in Z are retained for the drain down calculation. This parameter value is stored in the Z_TOL column in the global inputs table.
- Draindown Calculation X/Y Tolerance (m) – When the Calculate Draindown tool performs its calculations, it uses the release points to establish the X/Y profile for the centerline route. Often, there are more points than needed to sufficiently define the shape of the centerline route in X and Y. The X/Y tolerance parameter specifies the X/Y tolerance that is used to depopulate the X/Y profile (shape) of the route. In general, the value you enter here should be equal to the spacing of your release points. Release points that are significant in X and Y are retained for the drain down calculation. This parameter value is stored in the XY_TOL column in the global inputs table.
6) Used by Calculate HCA Intersections
Some operators choose to buffer HCA polygons for the purpose of calculating indirect ‘could affects’ on HCAs. The Liquids HCA Tool accommodates this by allowing you to specify buffer values by HCA type and by intersection type (centerline direct, overland spread, and/or hydrographic transport).
- Centerline Drinking Water Buffer Distance (m) – This parameter stores the buffer distance for direct centerline intersections of drinking water resource unusually sensitive areas, a.k.a. drinking water areas (DWAs). This parameter value is stored in the CENTERLINE_DW_BUF column in the global inputs table.
- Centerline Ecologically Sensitive Area Buffer Distance (m) – This parameter stores the buffer distance for direct centerline intersections of ecological resource unusually sensitive areas, a.k.a. ecologically sensitive areas (ESAs). This parameter value is stored in the CENTERLINE_EC_BUF column in the global inputs table.
- Centerline Highly Populated Area Buffer Distance (m) – This parameter stores the buffer distance for direct centerline intersections of high population areas (HPAs). This parameter value is stored in the CENTERLINE_HPA_BUF column in the global inputs table.
- Centerline Navigable Waterway Buffer Distance (m) – This parameter stores the buffer distance for direct centerline intersections of commercially navigable waterways (CNWs). This parameter value is stored in the CENTERLINE_NW_BUF column in the global inputs table.
- Centerline Other Populated Area Buffer Distance (m) – This parameter stores the buffer distance for direct centerline intersections of other populated areas (OPAs). This parameter value is stored in the CENTERLINE_OPA_BUF column in the global inputs table.
- Overland Flow Drinking Water Buffer Distance (m) – This parameter stores the buffer distance for overland flow plume intersections of DWAs. This parameter value is stored in the OF_DW_BUF column in the global inputs table.
- Overland Flow Ecologically Sensitive Area Buffer Distance (m) – This parameter stores the buffer distance for overland flow plume intersections of ESAs. This parameter value is stored in the OF_EC_BUF column in the global inputs table.
- Overland Flow Highly Populated Area Buffer Distance (m) – This parameter stores the buffer distance for overland flow plume intersections of HPAs. This parameter value is stored in the OF_HPA_BUF column in the global inputs table.
- Overland Flow Navigable Water Waterways Buffer Distance (m) – This parameter stores the buffer distance for overland flow plume intersections of CNWs. This parameter value is stored in the OF_NW_BUF column in the global inputs table.
- Overland Flow Other Populated Area Buffer Distance (m) – This parameter stores the buffer distance for overland flow plume intersections of OPAs. This parameter value is stored in the OF_OPA_BUF column in the global inputs table.
- Hydro Trace Drinking Water Buffer Distance (m) – This parameter stores the buffer distance for hydrographic transport plume intersections of DWAs. This parameter value is stored in the HT_DW_BUF column in the global inputs table.
- Hydro Trace Ecologically Sensitive Area Buffer Distance (m) – This parameter stores the buffer distance for hydrographic transport plume intersections of ESAs. This parameter value is stored in the HT_EC_BUF column in the global inputs table.
- Hydro Trace Highly Populated Area Buffer Distance (m) – This parameter stores the buffer distance for hydrographic transport plume intersections of HPAs. This parameter value is stored in the HT_HPA_BUF column in the global inputs table.
- Hydro Trace Navigable Water Waterways Buffer Distance (m) – This parameter stores the buffer distance for hydrographic transport plume intersections of CNWs. This parameter value is stored in the HT_NW_BUF column in the global inputs table.
- Hydro Trace Other Populated Area Buffer Distance (m) – This parameter stores the buffer distance for hydrographic transport plume intersections of OPAs. This parameter value is stored in the HT_OPA_BUF column in the global inputs table.
In a typical liquids HCA analysis workflow, Enter Global Inputs Data is run after Initialize Database.
For visual reference on Liquids HCA Tool execution order, see Liquids HCA Tool Process Flow Diagrams.
Syntax
EnterGlobalInputData_ (in_workspace, in_global_inputs, in_route_id_field, in_route_id_value, in_spl_pt_int, in_n_int_diam, in_pipe_rough, in_floweqstn, in_flow_rate, in_p_op_temp, in_p_sd_time, in_ofres_time, in_htres_time, in_m_prod_typ, in_prod_dnsty, in_api_grav, in_c5_vol_pct, in_kin_visc, in_kvisc_temp, in_eq_type, in_eq_form, in_fingas_1, in_fingas_2, in_p_vapor, in_t_dist, in_pct_vdist, in_t_amb, in_wind_vel, in_slick_thk, in_slkthksmwb, in_maxwbarea, in_wb_adhsn, in_depth_h2o, in_bank_angle, in_adhsn_rt, in_infil_rt, in_z_tol, in_xy_tol, {in_cl_dw_buf}, {in_cl_ec_buf}, {in_cl_hpa_buf}, {in_cl_nw_buf}, {in_cl_opa_buf}, {in_of_dw_buf}, {in_of_ec_buf}, {in_of_hpa_buf}, {in_of_nw_buf}, {in_of_opa_buf}, {in_ht_dw_buf}, {in_ht_ec_buf}, {in_ht_hpa_buf}, {in_ht_nw_buf}, {in_ht_opa_buf})
Parameter | Explanation | Data Type |
in_workspace |
Dialog Reference Specify your input project database. There is no Python reference for this parameter |
Workspace |
in_global_inputs |
Dialog Reference Specify the input global inputs table. There is no Python reference for this parameter. |
Table View |
in_route_id_field |
Dialog Reference Specify a field that uniquely identifies each of your input centerline route features. There is no Python reference for this parameter. |
Double |
in_route_id_value |
Dialog Reference Select the route identifier value for the route for which you will specify global input data values. There is no Python reference for this parameter. |
Long |
in_spl_pt_int |
Dialog Reference Specify the release point sampling interval value for the selected route. There is no Python reference for this parameter. |
Long |
in_n_int_diam |
Dialog Reference Specify the nominal interior diameter of the selected route (in inches). There is no Python reference for this parameter. |
Double |
in_pipe_rough |
Dialog Reference Specify the pipe roughness (in meters). There is no Python reference for this parameter. |
Double |
in_floweqstn |
Dialog Reference Specify the product flow direction; a value of 1 indicates flow in the direction of increasing measure values on the route. There is no Python reference for this parameter. |
Long |
in_flow_rate |
Dialog Reference Specify the pumping flow rate (in barrels per hour). There is no Python reference for this parameter. |
Long |
in_p_op_temp |
Dialog Reference Specify the pipeline operating temperature (in degrees Centigrade). There is no Python reference for this parameter. |
Double |
in_p_sd_time |
Dialog Reference Specify the time required to shut down the pumps and remotely operated valves (in minutes). There is no Python reference for this parameter. |
Long |
in_ofres_time |
Dialog Reference Specify your response time to contain a release on land (in minutes). There is no Python reference for this parameter. |
Long |
in_htres_time |
Dialog Reference Specify your response time to contain a release in water (in minutes). There is no Python reference for this parameter. |
Long |
in_prod_properties |
Dialog Reference Specify your input product properties lookup table. There is no Python reference for this parameter. |
Table View |
in_m_prod_typ |
Dialog Reference Specify your product type. There is no Python reference for this parameter. |
String |
in_custom_product |
Dialog Reference Specify the name of your custom product. There is no Python reference for this parameter. |
String |
in_prod_dnsty |
Dialog Reference Specify your product density (in grams per cubic centimeter). There is no Python reference for this parameter. |
Double |
in_api_grav |
Dialog Reference Specify your product API gravity. There is no Python reference for this parameter. |
Double |
in_c5_vol_pct |
Dialog Reference Specify the percent of C5+ components in your product by volume. There is no Python reference for this parameter. |
Double |
in_kin_visc |
Dialog Reference Specify the kinematic viscosity of your product (in centistokes). There is no Python reference for this parameter. |
Double |
in_kvisc_temp |
Dialog Reference Specify the temperature at which your kinematic viscosity was determined (in degrees Centigrade). There is no Python reference for this parameter. |
Double |
in_eq_type |
Dialog Reference Specify the evaporation equation method. There is no Python reference for this parameter. |
String |
in_eq_form |
Dialog Reference Specify the form of the evaporation equation. There is no python reference for this parameter. |
String |
in_fingas_1 |
Dialog Reference Specify the Fingas coefficient 1 value. There is no Python reference for this parameter. |
Double |
in_fingas_2 |
Dialog Reference Specify the Fingas coefficient 2 value. There is no Python reference for this parameter. |
Double |
in_p_vapor |
Dialog Reference Specify the pipeline product vapor pressure at your operating temperature (in psi). There is no Python reference for this parameter. |
Double |
in_t_dist |
Dialog Reference Specify the distillation temperature (in degrees Centigrade). There is no Python reference for this parameter. |
Double |
in_pct_vdist |
Dialog Reference Specify the percent volume distilled at your distillation temperature. There is no Python reference for this parameter. |
Double |
in_t_amb |
Dialog Reference Specify the ambient temperature (in degrees Centigrade). There is no Python reference for this parameter. |
Double |
in_wind_vel |
Dialog Reference Specify the wind velocity (in meters per second). There is no Python reference for this parameter. |
Double |
in_slick_thk |
Dialog Reference Specify the large waterbody slick thickness (in meters). There is no Python reference for this parameter. |
Double |
in_slkthksmwb |
Dialog Reference Specify the small waterbody slick thickness (in meters). There is no Python reference for this parameter. |
Double |
in_maxwbarea |
Dialog Reference Specify the cutoff size for small waterbodies (in square meters). There is no Python reference for this parameter. |
Double |
in_wb_adhsn |
Dialog Reference Specify the waterbody shoreline product adhesion rate (in grams per square meter). There is no Python reference for this parameter. |
Double |
in_depth_h2o |
Dialog Reference Specify the waterbody depth (in meters). There is no Python reference for this parameter. |
Double |
in_bank_angle |
Dialog Reference Specify the waterbody bank inclination angle (in degrees). There is no Python reference for this parameter. |
Double |
in_adhsn_rt |
Dialog Reference Specify the ground product adhesion rate (in grams per square meter). There is no Python reference for this parameter. |
Double |
in_infil_rt |
Dialog Reference Specify the product infiltration rate (in barrels per square meter per hour). There is no Python reference for this parameter. |
Double |
in_z_tol |
Dialog Reference Specify the Z tolerance for the drain down calculation (in meters). There is no Python reference for this parameter. |
Double |
in_xy_tol |
Dialog Reference Specify the X/Y tolerance for the drain down calculation (in meters). There is no Python reference for this parameter. |
Double |
in_cl_dw_buf (Optional) |
Dialog Reference Specify the centerline – DWA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_cl_ec_buf (Optional) |
Dialog Reference Specify the centerline – ESA buffer distance (in meters). There is no python reference for this parameter. |
Long |
in_cl_hpa_buf (Optional) |
Dialog Reference Specify the centerline – HPA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_cl_nw_buf (Optional) |
Dialog Reference Specify the centerline – CNW buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_cl_opa_buf (Optional) |
Dialog Reference Specify the centerline – OPA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_of_dw_buf (Optional) |
Dialog Reference Specify the overland flow – DWA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_of_ec_buf (Optional) |
Dialog Reference Specify the overland flow – ESA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_of_hpa_buf (Optional) |
Dialog Reference Specify the overland flow – HPA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_of_nw_buf (Optional) |
Dialog Reference Specify the overland flow – CNW buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_of_opa_buf (Optional) |
Dialog Reference Specify the overland flow – OPA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_ht_dw_buf (Optional) |
Dialog Reference Specify the hydro trace – DWA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_ht_ec_buf (Optional) |
Dialog Reference Specify the hydro trace – ESA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_ht_hpa_buf (Optional) |
Dialog Reference Specify the hydro trace – HPA buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_ht_nw_buf (Optional) |
Dialog Reference Specify the hydro trace – navigable waterway buffer distance (in meters). There is no Python reference for this parameter. |
Long |
in_ht_opa_buf (Optional) |
Dialog Reference Specify the hydro trace – OPA distance (in meters). There is no Python reference for this parameter. |
Long |
Code sample
The following Python window script demonstrates how to use the Enter Global Input Data tool with a file Geodatabase:
import arcpy
arcpy.ImportToolbox(r”C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\Lib\site-packages\liquidshca\esri\toolboxes\LiquidsHCA.pyt”)
in_workspace = r”C:\data\test0.gdb”
in_global_inputs = r”C:\data\test0.gdb\GLOBAL_INPUTS”
route_id = 2010
line_id = 1
route_fm = 0
route_tm = 12146.34
spl_pt_int = 30
pos_acc = 0
n_int_diam = 7.981
pipe_rough = 4.572E-05
floweqstn = 1
flow_rate = 944
p_op_temp = 11
p_sd_time = 38
ofres_time = 120
htres_time = 120
m_prod_typ = “AmmoniaHydroxide”
prod_dnst = 880
api_grav = 39.81
c5_vol_pct = 0
kin_visc = 0.3
kvisc_temp = 11
eq_form = “Logarithmic”
eq_type = “Fingas”
fingas_1 = 1.56
fingas_2 = 0.045
p_vapor = 8.5
t_dist = 0
pct_vdist = 0
t_amb = 48.89
stream_vel = 3.13
wind_vel = 6.4
slick_thk = 0.004
slkthksmwb = 0.0005
maxwbarea = 10
wb_adhsn = 15
depth_h2o = 4.48
bank_angle = 14.1
adhsn_rt = 15
infil_rt = 0
z_tol = 0.254
xy_tol = 30
arcpy.liquidshca.EnterGlobalInputData(in_workspace, in_global_inputs, route_id, line_id, route_fm, route_tm, spl_pt_int, pos_acc, n_int_diam, pipe_rough, floweqstn, flow_rate, p_op_temp, p_sd_time, ofres_time, htres_time, m_prod_typ, prod_dnst, api_grav, c5_vol_pct, kin_visc, kvisc_temp, eq_form, eq_type, fingas_1, fingas_2, p_vapor, t_dist, pct_vdist, t_amb, stream_vel, wind_vel , slick_thk, slkthksmwb, maxwbarea , wb_adhsn, depth_h2o, bank_angle, adhsn_rt, infil_rt, z_tol, xy_tol)
Environments
Current Workspace, Scratch Workspace, Default Output Z Value, M Resolution, M Tolerance, Output M Domain, Output XY Domain, Output Z Domain, Output Coordinate System, Extent, Geographic Transformations, Output has M values, Output has Z values, XY Resolution, XY Tolerance, Z Resolution, Z Tolerance
Licensing information
This tool requires a valid Liquids HCA Tool user license or subscription. Please see the Request License and Register License tool help topics for details on obtaining and registering a Liquids HCA Tool software license.
Related topics
- An overview of the Liquids HCA Analysis toolbox
- Liquids HCA Tool Data Dictionary
- Initialize Database
- Import Global Input Data
- Create Release Points
- Calculate Draindown
- Run Cases on Azure
- Hydro Trace
Tags
Pipeline, hazardous liquids, high consequence area, HCA, high population area, HPA, other populated area, OPA, ecologically sensitive area, ESA, drinking water area, DWA, commercially navigable waterway, CNW, could affect.
Credits
Copyright © 2016-2020 by G2 Integrated Solutions, LLC. All Rights Reserved.
Use limitations
There are no access and use limitations for this item.