User-Defined Control Data Fields
User-defined controls in InfoWorks ICM can be either a compound weir/orifice
or a vortex control.
To view and edit all user-defined control data, use the Property Sheet.
This table describes all the User Control specific data which can be used to define a User Control. 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.
User Control Data
Database Table Name: hw_user_control
|
Field Name |
Help Text |
Database Field |
Size |
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 |
The sub-type for this user defined control. Select from the dropdown list. The parameters required for both types of structure are the same.
|
link_type |
Text |
6 |
|
0 |
COMPND |
|
|
|
|
|||||||||
|
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:
|
point_array |
Array |
|
XY |
0 |
|
|
|
|
|
|||||||||
|
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 conduit 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 |
|
0 |
|
|
|
|||||||||
|
DS settlement efficiency (%) |
See Upstream Settlement Efficiency |
ds_settlement_eff |
Long Integer |
|
|
0 |
0 |
0 |
100 |
|
|
|||||||||
|
US settlement efficiency (%) |
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 |
|
|
|||||||||
|
Initial level |
There is no default value for this field; the valid range is -99.9 to 999.9 |
start_level |
Double |
|
Z |
3 |
|
-9999 |
9999 |
|
6000 |
|||||||||
|
Head discharge table |
The head discharge table defines the actual behaviour of the control, with the level defined above acting as the base level for the head discharge relationship. This means that you can model any unusual or complex control if you know it's head discharge relationship. A head discharge table can be associated with more than one user defined control if needed. |
head_discharge_id |
Text |
64 |
|
0 |
|
|
|
|
|
|||||||||
| Modular limit |
Modular limit for the user defined control. If set to greater than 0, the upstream depth is used to determine the flow from the specified head discharge table; a drowning factor is applied to the flow if the ratio of downsteam depth to upstream depth exceeds the modular limit. If set to 0, the flow is based on head difference when drowned. Drowning occurs once the downstream level is above the crest. |
modular_limit | Double | 2 | 0.9 | 0 | 0.99 | |||||||||||||
|
InfoAsset unique ID |
Unique ID associated with the corresponding object in an InfoAsset Manager database. When importing from InfoAsset Manager, the InfoAsset ID can be copied from the InfoAsset database in order to maintain links between the two networks. |
asset_uid |
GUID |
|
|
0 |
|
0 |
0 |
0 |
0 |
|||||||||
| InfoAsset ID |
Used to store the ID of the corresponding InfoAsset object when Importing from a Collection Network. |
infonet_id | Text | 40 | 0 |
Water Quality
