River Reach Data Fields

River Reach data can be edited on either the River Reach Grid Window of the Links Grid or the River Reach Property Sheet.

To view and edit all river reach data, use the Property Sheet.

This table describes all the river reach specific data which can be used to define a river reach.

Common Data Fields

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

River Reach Data

Database Table Name: hw_river_reach

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, (RReach).

There are no additional options. The field is hidden on the grid, and read-only on the property sheet.

 link_type Text 6   0 RReach        
Asset ID For reference only. Designed as a reference to an asset database, but could be used for anything. asset_id Text 64   0          
System type

Choose the system type from the dropdown list. See System Type for more information.

Database Value

Description

 Help Text

STORM

 Storm Rainfall collection system

FOUL

 Foul Wastewater collection system (UK terminology)
SANITARY Sanitary Wastewater collection system (US terminology)
COMBINED Combined Rainfall and wastewater collection system
OVERLAND Overland Overland floodwater collection system
OTHER Other Other system type
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      

River sections

River reach cross section data can be specified or viewed in the River sections editor which is displayed by clicking the button.

Note

River section data is uneditable by default. To make the data editable, tick the Allow editing of river reach data option in the General page of the Options dialog. Use this option with care as edits may be overwritten if the reach is subsequently re-built or updated.

Database Table Name: hw_reach_section

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 Key Name of river section key Text 64     0 0 0

0
2 X Coordinate X coordinate of section vertex X Double   L        

 
3 Y Coordinate Y coordinate of section vertex Y Double   L        

 
4 Bed level Elevation of section vertex Z Double   Z   0   0

6000
5 Rougness Manning's n

Roughness value - enter the n value for the Manning's equation.

The roughness value applies between the point at which it is defined and the next point along the section. This means that the last value of Manning's n will have no effect, but it still needs to be defined.

 roughness_Manning Double       0   0

 
7 New Panel Check to denote the start of a new panel new_panel Boolean            

 

 

Select a section on the left of the tab and check the Use specified section spacing box to enter a user defined distance to the next river section in the Distance to next section box. If this box is left unchecked, the default distance calculated from link geometry will be used.

Tip

The Use specified section spacing option is available regardless of whether river section parameters are editable or not.

Database Table Name hw_sect_spacing

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 Key Name of river section key Text 64     0 0 0

0
2 Spacing Distance to next section spacing Double   L   0    

 

sections

Array

 

 

0

 

0

0

0

0
Conveyance data

Click the button to view or edit conveyancing data in the Conveyance Data Editor. The editor displays a list of all the cross-sections which comprise the river reach as well as a graph and the database tables for the conveyance data as calculated by InfoWorks ICM, and if defined, the user-defined conveyance data.

 

Database Table Name hw_reach_conv

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

Precision

Default

Error Lower Limit

Error Upper Limit

Warning Lower Limit

Warning Upper Limit
1 Depth The calculated depth of this section of the river reach. depth Double   Y 3        

 
2 Conveyance The calculated conveyance (carrying capacity) of the river reach section conveyance Double   Q 3        

 
3 Area The calculated area of the river reach section. area Double   NA 3        

 
4 Width The calculated width of this section of the river reach. width Double   L 3        

 
5 Perimeter The calculated perimeter of the river reach section. perimeter Double   L 3        

 
conveyance Array     0          
Sediment depth

You can define a depth of sediment in the invert of the link. This sediment reduces the capacity of the link by obstructing the flow. The maximum value for the sediment depth is 80% of conduit height.

The sediment depth represents permanent, consolidated sediment deposits. The system assumes that the sediment is constant; it does not allow for the erosion or deposition of sediment. The transport of sediment through the system is not modelled.

The default value for an individual conduit is the global value specified in the User Defined Defaults (which has a default value of zero).

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.

When running water quality simulations, you can choose whether the sediment transport calculations carried out by the water quality engine feed back to the hydraulic engine. If they do not, the hydraulic calculations continue to use the fixed Sediment Depth value.

 sediment_depth Double   PS 0   0      
Length Length of the reach (calculated along reach centre line) length Double   L 1   1      
Inflow

If the Inflow is lateral simulation parameter is checked, the simulation engine applies this inflow value laterally along the link.

If the Inflow is lateral parameter is not checked, the simulation engine applies this inflow value to the node at the end of the link with the highest invert level. In the case of equal invert levels, the flow is assigned to the upstream node.

There is a default figure for inflow in the user-defined defaults.

 inflow Double   Q 5   0   0  
US headloss type

This defines the headloss conditions at the upstream end of the link. InfoWorks ICM provides four built-in headloss curves, or you can define your own headloss curves.

The four built-in curves are:

High

for example badly benched manholes

None

no headloss

Normal

well constructed manholes

Fixed

the headloss coefficient represents the k value in the headloss equation. Unlike normal and high headloss types the k value remains the same regardless of surcharge ratio and flow direction

Select the curve you want from the dropdown list.

The default value is set from User Defined Defaults.

For more information on headloss, and how to define your own headloss curves, see Headloss Curves.

 us_headloss_type Text 64   0          
DS headloss type See US headloss type. ds_headloss_type Text 64   0          
US headloss coefficient

This is a multiplying factor for the selected headloss curve to represent additional losses due to:

  • angle of approach of a conduit to a manhole

  • headloss at additional intermediate manholes not included in the model

  • bends

  • bad construction

The default is a value of 1.0, unless overridden by a user-defined default. The list below shows recommended values for angle of approach.

Angle

Bend Value

30

3.3

60

6.0

90

6.6

>90

8.0

See Headloss Curves for more information.

 us_headloss_coeff Double     2   0      
DS headloss coefficient See US headloss coefficient. ds_headloss_coeff Double     2   0      
US invert level

Read-only field.

Invert level for the upstream end of the link. Value is set to the lowest bed level of the most upstream river section.

 us_invert Double   Z 3   -9999 9999   6000
DS invert level

Read-only field.

Invert level for the downstream end of the link. Value is set to the lowest bed level of the most downstream river section.

 ds_invert Double   Z 3   -9999 9000   6000
US sediment grading

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.

When running water quality simulations, you can choose whether the sediment transport calculations carried out by the water quality engine feed back to the hydraulic engine. If they do not, the hydraulic calculations continue to use the fixed Sediment Depth value.

Defines the bed material distribution at the upstream end of the link.

Select a Sediment Grading from the dropdown list.

InfoWorks ICM provides a default Sediment Grading, or user defined gradings may be added in the Sediment Grading Window of the Links Grid.

 us_sediment_grading Text 64   0 Default        
DS sediment grading

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.

Defines the bed material distribution at the downstream end of the link.

Select a Sediment Grading from the dropdown list.

InfoWorks ICM provides a default Sediment Grading, or user defined gradings may be added in the Sediment Grading Window of the Links Grid.

 ds_sediment_grading Text 64   0 Default        
Limit erosion by

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.

Select method to be used to specify bed level at which erosion will be prevented from occurring:

Database Value

Description
Depth Specify depth relative to original river section invert level in the Erosion depth limit field
Level Specify level above datum in the Erosion level limit field
Depth and level Specify both Erosion depth limit and Erosion level limit values
Unlimited Erosion will not be limited

erosion_limit_type Text 20   0 Depth        
Erosion depth limit

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.

Erosion will be prevented from occurring below the depth specified, where depth is measured relative to river section invert level.

Enabled when Limit erosion by is set to Depth or Depth and level.

If Bed updating set to Invert, Erosion depth limit must be set to zero.

 erosion_depth_limit Double   Y 3 0 0      
Erosion level limit

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.

Erosion will be prevented from occurring below the level specified.

A value of zero or null specifies that erosion will not occur below the original bed level.

Enabled when Limit erosion by is set to Level or Depth and level.

 erosion_level_limit Double   Z 3 0        
Limit deposition depth

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.

Check this option to impose an upper limit on depth of sediment that can be deposited above the original section depth.

 limit_deposit_depth Boolean                
Deposition limit

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.

Maximum allowable depth of deposition above the original section depth.

Enabled when Limit deposition depth is checked.

 deposit_limit Double   Y 3 0 0      
Bed updating

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.

Select the method to be used to update bed level:

Database Value

Description
Invert

Sediment is deposited and eroded from the invert of the channel.

Erosion of the original section will not occur.

Note that erodible depth (set in Erosion depth limit field) must be zero when using this method.
Uniform Deposition and erosion will be modelled uniformly across the section.

bed_updating Text 20   0 Invert        
Active layer depth

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.

Active layer thickness.

Applicable when Active layer depth method in Water Quality and Sediment Parameters is set to Explicit.

 aldepth Double   Y 0 User Defined Default 0      
Active layer depth factor

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.

Multiplying factor for calculating active layer thickness.

Applicable when Active layer depth method in Water Quality and Sediment Parameters is set to D50 or D90.

 aldepth_factor Double     0 User Defined Default 0      
Limit erosion rate

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.

Check this option to impose an upper limit on rate of erosion when modelling sediment transport.

 limit_erosion_rate Boolean                
Max erosion rate

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.

Enabled if Limit erosion rate is checked.

The maximum rate of erosion that will be applied when modelling sediment transport.

 max_erosion_rate Double   ERODERATE   User Defined Default 0      
Limit deposition rate

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.

Check this option to impose an upper limit on rate of deposition when modelling sediment transport.

 limit_deposit_rate Boolean                
Max deposition rate

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.

Enabled if Limit deposition rate is checked.

The maximum rate of deposition that will be applied when modelling sediment transport.

 max_deposition_rate Double   ERODERATE 0 User Defined Default 0      

Base height

Height above invert of link.

Indicates where the nominal base is with regards to the use of the two (side and base) infiltration coefficients.

base_height

Double

 

PS

0

0.0

0

 

0

 

Base infiltration loss coefficient

The rate of infiltration from the base of the river reach into the ground. Applicable between the invert and the Base height of the river reach.

infiltration_coeff_base

Double

 

I

2

0

0

 

0

36000

Side infiltration loss coefficient

The rate of infiltration from the side of the river reach into the ground. Applicable above the Base height of the river reach.

infiltration_coeff_side

Double

 

I

2

0

0

 

0

36000

1D diffusion type

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 type 1D diffusion can be set to River or Estuary. The default is Estuary unless overridden by a user-defined default.

Set to Estuary to calculate a diffusion coefficient that varies with tidal discharge and/or the longitudinal salinity gradient, or set to River to calculate a diffusion coefficient that is related to shear velocity.

Used for 1D diffusion water quality simulations only.

diff1_type

Text

 

 

8

User Defined Defaults

 

 

 

 

1D diffusion d0

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.

If 1D diffusion type is set to Estuary, then d0 is a constant which is used to prevent unrealistically low values of dispersion from arising.

If 1D diffusion type is set to River, then d0 is the minimum diffusion coefficient.

The value of d0 must be ≥0 m2/s. The default is 0 m2/s unless overridden by a user-defined default.

Used for 1D diffusion water quality simulations only.

diff1_d0

Double

 

DC

2

User Defined Defaults

 

 

 

 

1D diffusion d1

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.

If 1D diffusion type is set to Estuary, then d1 is a constant which represents the amount of dispersion caused by tidal mixing in the estuary.

If 1D diffusion type is set to River, then d1 is the shear velocity factor.

The value of d1 must be ≥0 m2/s. The default is 0 m2/s unless overridden by a user-defined default.

Note

If the values d1 and d2 are zero, the diffusion coefficient is constant (the value of d0).

Used for 1D diffusion water quality simulations only.

diff1_d1

Double

 

DC

2

User Defined Defaults

 

 

 

 

1D diffusion d2

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.

This field is only enabled when 1D diffusion type is set to Estuary.

d2 is a constant which determines the effect of salinity gradient on dispersion. The value of d2 must be ≥0 m2/s. The default is 0 m2/s unless overridden by a user-defined default.

Note

If the value of d2 is non-zero then you should ensure that SAL (salt) is specified as a determinant in the QM parameters dialog. If the values d1 and d2 are zero the diffusion coefficient is constant (the value of d0).

Used for 1D diffusion water quality simulations only.

diff1_d2

 Double   DC 2

User Defined Defaults

 

 

 

 
Left river bank

Left river bank profile information can be specified or viewed in the river bank sections editor which is displayed by clicking the button.

Offset (cross chainage) values are automatically calculated from X and Y coordinates, but are not exported or imported when exporting to / importing from external files.

See the River Reach - Bank Flows topic for information about how the profile information is used when calculating flow over the bank.

Note

River bank data is uneditable by default. To make the data editable, tick the Allow editing of river reach data option in the General page of the Options dialog. Use this option with care as edits may be overwritten if the reach is subsequently re-built or updated.

Database Table Name: hw_river_bank

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 X Coordinate X coordinate of bank vertex X Double   L        

 
2 Y Coordinate Y coordinate of bank vertex Y Double   L        

 
3 Bank Level Elevation at bank vertex Z Double   L   0   0

6000
4 Discharge Coeff- Cd

Discharge coefficient at bank vertex.

The discharge coefficient applies between the point at which it is defined and the next point along the section. This means that the last value of discharge coefficient will have no effect, but it still needs to be defined.

 discharge_coeff Double            

 
5 Modular Limit

Modular limit at bank vertex.

The ratio (downstream depth above crest) / (upstream depth above crest) over which the bank is assumed to be drowned.

The Modular Limit value applies between the point at which it is defined and the next point along the section. This means that the last value of Modular Limit will have no effect, but it still needs to be defined.

 modular_ratio Double       0 0.99  

 
6 Section Marker Check this field to insert a section marker at this vertex section_marker Text 40     0   0

 
7 RTC Definition

Name of the RTC Table or Variable that defines vertical movement of the vertex. Used to model breaching of the bank.

 rtc_definition Text 10            
left_bank Array     0   0 0 0 0
Left reach node ID

Defines bank connection object.

US node ID of connecting River Reach object that overlaps / touches left bank of this River Reach. Flow may spill from this River Reach to the connecting River Reach.

left_reach_node_id

 Text 64   3          

Left reach link suffix

Defines bank connection object.

Link suffix of connecting River Reach object that overlaps /.touches left bank of this River Reach.

left_reach_link_suffix

 Text 1   3          
Left storage node ID

Defines bank connection object.

ID of Storage Node with associated Storage Area that overlaps / touches left bank of the River Reach. Flow may spill from the River Reach to the connected Storage Area.

(Only one object can be connected to each bank. If a River Reach connection has already been defined, the storage node connection will be ignored.)

 left_node_id Text 64   3          
Left 2D zone ID

Defines bank connection object.

ID of 2D Zone that overlaps / touches left bank of the River Reach. Flow may spill from River Reach to the connected 2D Zone.

(Only one object can be connected to each bank. If a River Reach or Storage Node connection has already been defined, the 2D Zone connection will be ignored.)

 left_2d_zone_id Text 64   3          
Right river bank

Right river bank profile can be specified or viewed in the river bank sections editor which is displayed by clicking the button.

Offset (cross chainage) values are automatically calculated from X and Y coordinates, but are not exported or imported when exporting to / importing from external files.

See the River Reach - Bank Flows topic for information about how the profile information is used when calculating flow over the bank.

Note

River bank data is uneditable by default. To make the data editable, tick the Allow editing of river reach data option in the General page of the Options dialog. Use this option with care as edits may be overwritten if the reach is subsequently re-built or updated.

Database Table Name: hw_river_bank

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 X Coordinate X coordinate of bank vertex X Double   L        

 
2 Y Coordinate Y coordinate of bank vertex Y Double   L        

 
3 Bank Level Elevation at bank vertex Z Double   L   0   0

6000
4 Discharge Coeff- Cd

Discharge coefficient at vertex.

The discharge coefficient applies between the point at which it is defined and the next point along the section. This means that the last value of discharge coefficient will have no effect, but it still needs to be defined.

 discharge_coeff Double            

 
5 Modular Limit

Modular limit at vertex.

The ratio (downstream depth above crest) / (upstream depth above crest) over which the bank is assumed to be drowned.

The Modular Limit value applies between the point at which it is defined and the next point along the section. This means that the last value of Modular Limit will have no effect, but it still needs to be defined.

 modular_ratio Double       0 0.99  

 
6 Section Marker Check this field to insert a section marker at this vertex section_marker Text 40     0   0

 
7 RTC Definition Name of the RTC Table or Variable that defines vertical movement of the vertex. Used to model breaching of the bank. rtc_definition Text 10            
right_bank Array     0   0 0 0 0

Right reach node ID

Defines bank connection object.

US node ID of connecting River Reach object that overlaps / touches right bank of this River Reach. Flow may spill from this River Reach to the connecting River Reach.

 right_reach_node_id Text 64   0          

Right reach link suffix

Defines bank connection object.

Link suffix of connecting River Reach object that overlaps /.touches right bank of this River Reach.

 right_reach_link_suffix Text 1   0          
Right storage node ID

Defines bank connection object.

ID of Storage Node with associated Storage Area that overlaps / touches right bank of the River Reach. Flow may spill from the River Reach to the connected Storage Area.

(Only one object can be connected to each bank. If a River Reach connection has already been defined, the storage node connection will be ignored.)

 right_node_id Text 64   3          
Right 2D Zone ID

Defines bank connection object.

ID of 2D Zone that overlaps / touches right bank of the River Reach. Flow may spill from River Reach to the connected 2D Zone.

(Only one object can be connected to each bank. If a River Reach or Storage Node connection has already been defined, the 2D Zone connection will be ignored.)

 right_2d_zone_id Text 64   0          

River Reaches

River Sections Editor

River Reach - Bank Flows

Links Grid

Property Sheets

Validation Messages