Irregular Weir Data Fields

Irregular Weir data can be edited on either the Irregular Weir Grid Window of the Links Grid or the Irregular Weir Property Sheet.

To view and edit all irregular weir data, use the Property Sheet.

This table describes all the irregular weir specific data which can be used to define an irregular weir. For details of results fields, see the Link Results Data Fields topic.

Common Data Fields

Fields that are common to the majority of objects can be found in the Common Fields topic.

Irregular Weir Data

Database Table Name: hw_irregular_weir

Show Columns

Database Names

Size, Type and Units

Defaults and Error Limits

Field Name

Help Text

Database Field

Data Type

Size

Units

Precision

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit
US node ID Type in a node reference or choose an existing node reference from the drop down list. This makes up the first part of the link reference. us_node_id Text 64   0          
DS node ID Type in a node reference, or choose an existing node reference from the drop down list. ds_node_id Text 64   0          
Link suffix A single character between A and Z or 0 and 9 which completes the link reference. This allows a node to have up to 36 downstream links. The suffix is automatically allocated by the software. link_suffix Text 1   0 1        
Link type Type of link object, IRWeir. There are no additional options. The field is hidden on the grid, and read-only on the property sheet. link_type Text 6   0 IRWEIR        
Asset ID For reference only. Designed as a reference to an asset database, but could be used for anything. asset_id Text 64   0          
Sewer reference An optional reference to identify the sewer of which this ancillary is a part. sewer_reference Text 80   0          
System type Choose the system type from the dropdown list. See System Type for more information. system_type Text 10   0 Other        
Branch ID

Numeric field used to identify to which long section the link is associated.

Can be set manually or automatically (see Defining Branches topic for more information).

 branch_id Long Integer     0          

US settlement efficiency (%)

Closed

Water Quality

This section is relevant only to Water Quality Simulations. If the icon is at the start of a paragraph, then that paragraph is only relevant to water quality simulations. If the icon is at the top of a topic, or a section (underneath a section title), or a row in a table, then the complete topic, section or row is only relevant to water quality simulations.

The settlement efficiency fields allow you to set the effectiveness of an overflow for trapping out sediment. The overflow is a link (normally a pipe) attached to a node acting as a storage tank (storage node or manhole).

Normally the upstream end of the link will be attached to the node and act as the overflow.

The upstream settlement efficiency determines the efficiency for the overflow.

In some circumstances the link may be reversed (storage tank at the downstream end) and the downstream settlement efficiency will be used.

In many cases an overflow will attach to an outfall from the system.

It would be very unusual to have both upstream settlement efficiency and downstream settlement efficiency set to non-zero values.

The valid range is 0-100%. 0% means the overflow acts as a normal continuation link. 100% means that the overflow traps out as much sediment as possible.

us_settlement_eff

Long Integer

 

 

0

0

0

100

 

 

DS settlement efficiency (%)

Closed

Water Quality

This section is relevant only to Water Quality Simulations. If the icon is at the start of a paragraph, then that paragraph is only relevant to water quality simulations. If the icon is at the top of a topic, or a section (underneath a section title), or a row in a table, then the complete topic, section or row is only relevant to water quality simulations.

See US settlement efficiency.

ds_settlement_eff

Long Integer

 

 

0

0

0

100

 
Discharge coefficient Coefficient of discharge for irregular weir flow equations. discharge_coeff Double     2 1.7 0.01      
Modular limit Modular limit for weir. modular_limit Double     2 0.9 0 1    
Chainage elevation

Irregular weir elevation data is stored in the Elevation grid containing an entry for each change of elevation in the weir.

Database Table Name: hw_spill_ch_elev

Show Columns

Database Names

Size, Type and Units

Defaults and Error Limits

Position in Data Structure

Field Name

Help Text

Database Field

Data Type

Size

Units

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit
1 Offset Distance along the weir at which the corresponding elevation occurs chainage Double   L          
2 Elevation Elevation of weir at corresponding chainage elevation Double   Z   0   0  
chainage_elevation Array     0          
Crest

Level above datum of inline bank.

Default value is the lowest Elevation specified in the Chainage elevation data.

 Crest Double   Z 3          
Points

This field defines the geometry of the link. The underlying data consists of a series of (x,y) pairs defining the vertices of the link. Each link is made up of a series of straight lines between the defined (x,y) points.

This data is not displayed on the grid or property sheet.

Link Vertice Export

Link vertices are included when you export link data to CSV files. There are two options available for exporting link vertices. These are selected on the Select CSV Export Options Dialog using the Coordinate Arrays Format dropdown list. The options are:

  • Packed - The data is exported as a series of x,y pairs.

  • Separately - the data is appended to the end of the row containing the link data. Each x and y value is in a separate (comma separated) field.

 point_array Array   XY 0          

Irregular Weir

Links Grid

Property Sheets