4/28/24, 7:26 PM River Reach Data Fields

You are here: Database Items | Networks | Network Objects | Links | River Reach Data Fields

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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

Field Da
Help Text Database Field
Name Ty

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
US node ID us_node_id Text
reference.

DS node ID Type in a node reference, or choose an existing node reference from the drop down list. ds_node_id Text

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
Link suffix link_suffix Text
downstream links. The suffix is automatically allocated by the software.

Type of link object, (RReach).

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

Asset ID For reference only. Designed as a reference to an asset database, but could be used for anything. asset_id Text

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

Database Value Description Help Text

STORM Storm Rainfall collection system

System
FOUL Foul Wastewater collection system (UK terminology) system_type Text
type
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

Numeric field used to identify to which long section the link is associated. Can be set manually or automatically (see Defining Long
Branch ID branch_id
Branches topic for more information). Inte

River River reach cross section data can be specified or viewed in the River sections editor which is displayed by clicking the sections Arra
sections 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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

Position Error Error Warning Warning

Field Help Data
in Data Database Field Size Units Default Lower Upper Lower Upper
Name Text Type
Structure Limit Limit Limit Limit

Name of
1 Key river key Text 64 0 0 0 0
section

X
X coordinate
2 X Double L
Coordinate of section
vertex

Y
Y coordinate
3 Y Double L
Coordinate of section
vertex

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

5 Rougness Roughness roughness_Manning Double 0 0

Manning's value -
n enter the
n value for
the

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 1/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

Position Error Error Warning Warning

Field Help Data
in Data Database Field Size Units Default Lower Upper Lower Upper
Name Text Type
Structure Limit Limit Limit Limit

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.

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

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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

Position in Error Error Warning Warning

Field Help Database Data
Data Size Units Default Lower Upper Lower Upper
Name Text Field Type
Structure Limit Limit Limit Limit

Name of
1 Key river key Text 64 0 0 0 0
section

Distance
2 Spacing to next spacing Double L 0
section

Conveyance conveyance Arra

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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

Position Error Error Warning Warning

Field Database Data
in Data Help Text Size Units Precision Default Lower Upper Lower Upper
Name Field Type
Structure Limit Limit Limit Limit

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

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

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

4 Width The width Double L 3

calculated
width of this

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 2/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

Position Error Error Warning Warning

Field Database Data
in Data Help Text Size Units Precision Default Lower Upper Lower Upper
Name Field Type
Structure Limit Limit Limit Limit

section of
the river
reach.

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

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.
Sediment The default value for an individual conduit is the global value specified in the User Defined Defaults (which has a default value sediment_depth Dou
depth of zero).

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.

Length Length of the reach (calculated along reach centre line) length Dou

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
Inflow inflow Dou
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.

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
US
headloss us_headloss_type Text
Normal well constructed manholes
type

the headloss coefficient represents the k value in the headloss equation. Unlike normal and high headloss types the k value
Fixed
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.

DS
headloss See US headloss type. ds_headloss_type Text
type

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.

US Angle Bend Value

headloss us_headloss_coeff Dou
coefficient
30 3.3

60 6.0

90 6.6

>90 8.0

See Headloss Curves for more information.

DS
headloss See US headloss coefficient. ds_headloss_coeff Dou
coefficient

US invert Read-only field.

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

DS invert Read-only field.

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

US us_sediment_grading Text
sediment
grading 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.

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 3/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

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

DS Defines the bed material distribution at the downstream end of the link.
sediment Select a Sediment Grading from the dropdown list. ds_sediment_grading Text
grading
InfoWorks ICM provides a default Sediment Grading, or user defined gradings may be added in the Sediment Grading Window
of the Links Grid.

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

Database Value Description

Limit
Depth Specify depth relative to original river section invert level in the Erosion depth limit field
erosion_limit_type Text
erosion by
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 will be prevented from occurring below the depth specified, where depth is measured relative to river section invert
Erosion
level. erosion_depth_limit Dou
depth limit
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 Erosion will be prevented from occurring below the level specified.
erosion_level_limit Dou
level limit 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.

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

Deposition
Maximum allowable depth of deposition above the original section depth. deposit_limit Dou
limit
Enabled when Limit deposition depth is checked.

Select the method to be used to update bed level:

Database Value Description

Bed
bed_updating Text
updating Sediment is deposited and eroded from the invert of the channel.
Invert 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.

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

Active layer
depth Multiplying factor for calculating active layer thickness. aldepth_factor Dou
factor
Applicable when Active layer depth method in Water Quality and Sediment Parameters is set to D50 or D90.

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

Max
max_erosion_rate Dou
erosion rate Enabled if Limit erosion rate is checked.
The maximum rate of erosion that will be applied when modelling sediment transport.

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

Max
deposition Enabled if Limit deposition rate is checked. max_deposition_rate Dou
rate
The maximum rate of deposition that will be applied when modelling sediment transport.

Height above invert of link.

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

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

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 4/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

Side
infiltration
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 Dou
loss
coefficient

The type 1D diffusion can be set to River or Estuary. The default is Estuary unless overridden by a user-defined default.
1D diffusion
Set to Estuary to calculate a diffusion coefficient that varies with tidal discharge and/or the longitudinal salinity gradient, or diff1_type Text
type
set to River to calculate a diffusion coefficient that is related to shear velocity.
Used for 1D diffusion water quality simulations only.

If 1D diffusion type is set to Estuary, then d0 is a constant which is used to prevent unrealistically low values of dispersion
1D diffusion from arising.
diff1_d0 Dou
d0 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.

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.
1D diffusion
diff1_d1 Dou
d1
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.

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.

1D diffusion Note diff1_d2 Dou

d2
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.

Left river left_bank Arra

Left river bank profile information can be specified or viewed in the river bank sections editor which is displayed by clicking
bank
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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

Position Error Error Warning Warning

Field Database Data
in Data Help Text Size Units Default Lower Upper Lower Upper
Name Field Type
Structure Limit Limit Limit Limit

X X coordinate of
1 X Double L
Coordinate bank vertex

Y Y coordinate of
2 Y Double L
Coordinate bank vertex

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

4 Discharge discharge_coeff Double

Discharge
Coeff- Cd
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

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 5/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

Position Error Error Warning Warning

Field Database Data
in Data Help Text Size Units Default Lower Upper Lower Upper
Name Field Type
Structure Limit Limit Limit Limit

the last value

of discharge
coefficient will
have no effect,
but it still
needs to be
defined.

Modular limit
at bank
vertex.
The ratio
(downstream
depth above
crest) /
(upstream
depth above
crest) over
which the
bank is
assumed to be
drowned.
Modular
5 The Modular modular_ratio Double 0 0.99
Limit
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.

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

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

Defines bank connection object.

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

Left reach Defines bank connection object.

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

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
Left storage
River Reach to the connected Storage Area. left_node_id Text
node ID
(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.)

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
Left 2D
Zone. left_2d_zone_id Text
zone ID
(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 river right_bank Arra

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

Database Names

Show Columns Size, Type and Units

Defaults and Error Limits

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 6/7
4/28/24, 7:26 PM River Reach Data Fields

Field Da
Help Text Database Field
Name Ty

Position Error Error Warning Warning

Field Database Data
in Data Help Text Size Units Default Lower Upper Lower Upper
Name Field Type
Structure Limit Limit Limit Limit

X X coordinate of bank
1 X Double L
Coordinate vertex

Y Y coordinate of bank
2 Y Double L
Coordinate vertex

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

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

Modular limit at
vertex.
The ratio
(downstream depth
above crest) /
(upstream depth
above crest) over
which the bank is
assumed to be
drowned.
Modular
5 modular_ratio Double 0 0.99
Limit 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.

Check this field to

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

Name of the RTC

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

Defines bank connection object.

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

Right reach Defines bank connection object.

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

Defines bank connection object.

Right ID of Storage Node with associated Storage Area that overlaps / touches right bank of the River Reach. Flow may spill from
storage the River Reach to the connected Storage Area. right_node_id Text
node ID (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.)

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
Right 2D
Zone. right_2d_zone_id Text
Zone ID
(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.)

Copyright © Innovyze 2022. All rights reserved

InfoWorks® ICM version 2023.2 - Issued 22 May 2023

Open topic with navigation

https://help2.innovyze.com/infoworksicm/Content/HTML/ICM_IL/River_Reach_Data_Fields.htm 7/7