HYDX Conversion Notes

HYDX network data can be imported from csv files to InfoWorks networks.

The following sections contain conversion details regarding the import of the files.

Nodes

The following HYDX csv files are imported to objects on the ICM Nodes grid.

Knooppunt

The following HYDX data is imported from the Knooppunt.csv file into the following fields in an ICM Node object.

HYDX Code

InfoWorks ICM Data Field

Notes
UNI_IDE Node ID  
CMP_IDE

If CMP_IDE contains a formatted value <group id/compartment id>, and KN1_IDE and KN2_IDE in Verbinding.csv do not have the same PUT_IDE, the nodes in Knooppunt.csv with the same group ID are combined into a single node and are given the Node ID of the first node's KNP_IDE in the group. The rest will be discarded and any conduits which were connected to the discarded nodes, when imported, will be connected to the first compartment node in the group.

 

If CMP_IDE contains a formatted value <group id/compartment id>, and KN1_IDE and KN2_IDE in Verbinding.csv have the same PUT_IDE, the nodes in Knooppunt.csv are imported as individual nodes with the UNI_IDE value determining their Node ID in ICM. Any links connected to these nodes are imported as described in the Verbinding section.

KNP_TYP Node type

If KNP_TYP = CMP, ITP or INS, then Node type is set to Manhole in ICM.

If KNP_TYP= UIT, then Node type is set to Outfall in ICM.

CMP_IDE

Any nodes in the same group in CMP_IDE which are combined into a single node in ICMhave their Node type is set to Storage

  System type Set to Storm
PUT_IDE Asset ID

 

KNP_XCO X  
KNP_YCO Y  
MVD_NIV Ground level  
MVD_SCH Flood type

If MVD_SCH = KNV, then Flood type is set to Sealed

If MVD_SCH = RES, then Flood type is set to Stored

If MVD_SCH = VRL, then Flood type is set to Lost

WOS_OPP Floodable area Imported value is divided by 10000 to provide the ICM native unit in hectares (ha) for the floodable area.
KNP_BOK Chamber floor level  
KNP_BRE Chamber plan area

If KNP_VRM = RHK, the breadth from KNP_BRE and the length from KNP_LEN are multiplied and divided by 1000000 to provide the area.

If KNP_VRM = RND, the breath from KNP_BRE is squared, multiplied by Pi, and divided by 1000000 to find the area.

KNP_LEN
KWA_RIO Infiltration loss coefficient The value for this field is calculated as KWA_RIO multiplied by 41.6667
KNP_VRM Perimeter

If KNP_VRM = RHK, the breadth from KNP_BRE and the length from KNP_LEN are added and multiplied by 2 (to provide the values of all 4 sides) and then divided by 1000 to provide the perimeter in mm

If KNP_VRM = RND, the breadth from KNP_BRE is multiplied by Pi and divided by 1000 to provide the perimeter in mm

CMP_IDE Storage array

The Ground level (MVD_NIV) and Chamber floor level (KNP_BOK) for each compartment node within a group is imported to the Level field in the storage array.

Each node also contributes the Area. See the description of the Chamber plan area for details of how the area for each compartment node is calculated.

KWA_CUN User number 3  
KWA_GRW User number 4  
STD_GRW User number 5  
INI_NIV User number 6  
RST_IDE User text 1  
CMP_IDE User text 2  
KNP_MAT User text 3  
KNP_VRM User text 4  
KNP_TYP User text 5  
ITO_IDE User text 6  
STA_OBJ User text 7  
ALG_TOE User text 8  
AAN_MVD User text 10  

ItObject

If ITO_IDE = FK Knooppunt , the following HYDX data is imported from the ItObject.csv file into the following fields in an ICM Node object.

HYDX Code

InfoWorks ICM Data Field

Notes
KWA_RIO Infiltration loss coefficient The imported value is multiplied by 41.6667
KWA_CUN

User number 3

 
KWA_GRW User number 4  
STD_GRW User number 5  
ALG_TOE Notes  

 

Links

The following HYDX csv files are imported to objects on the ICM Links grid.

Verbinding

The value of VRB_TYP determines which type of link objects the HYDX data in the Verbinding.csv file is imported to in ICM. If VRB_TYP is set to:

If Verbinding.csv contains KN1_IDE and KN2_IDE (any upstream and downstream nodes) that share the same PUT_IDE entry in knooppunt.csv

Details of the conversions are contained in the following sections.

Conduit

If VRB_TYP = GSL, ITR or OPL, the following HYDX data is imported from the Verbinding.csv file into the following fields in an ICM Conduit object.

HYDX Code

InfoWorks ICM Data Field

Notes
KN1_IDE US node ID  
KN2_IDE DS node ID  
LEI_IDE Asset ID  
INZ_TYP System type

 

PRO_BRE Width  
PRO_HGT Opening height  
INI_NIV User number 6  
UNI_IDE User text 1  
VRB_TYP User text 2  
STR_RCH User text 3  
STR_OBJ User text 4  
PRO_VRM User text 6  
AAN_PRO User text 7  

Pump

If VRB_TYP = PMP, HYDX data is imported from the Verbinding.csv file into the following fields in an ICM Pump object.

HYDX Code

InfoWorks ICM Data Field

Notes
KN1_IDE US node ID  
KN2_IDE DS node ID  
LEI_IDE Asset ID  
INZ_TYP System type

 

INI_NIV User number 6  
UNI_IDE User text 1  
VRB_TYP User text 2  
STR_RCH User text 3  
STR_OBJ User text 4  
VRB_LEN User number 4  

Orifice

If VRB_TYP = DRL, and PRO in the Profiel.csv file is RND, HYDX data is imported from the Verbinding.csv file into following fields in an ICM Orifice object.

HYDX Code

InfoWorks ICM Data Field

Notes
KN1_IDE US node ID  
KN2_IDE DS node ID  
Link type Set to Orifice
LEI_IDE Asset ID  
INZ_TYP System type

 

  Secondary discharge coefficient Set to 0.435
INI_NIV User number 6  
UNI_IDE User text 1  
VRB_TYP User text 2  
STR_RCH User text 3  
STR_OBJ User text 4  
AAN_PRO User text 7  

 

Sluice

If VRB_TYP = DRL, and PRO in the Profiel.csv file is RHK, HYDX data is imported from the Verbinding.csv file into following fields in an ICM Sluice object.

HYDX Code

InfoWorks ICM Data Field

Notes
KN1_IDE US node ID  
KN2_IDE DS node ID  
Link type Set to Sluice
LEI_IDE Asset ID  
INZ_TYP System type

 

  Secondary discharge coefficient Set to 0.435
UNI_IDE User text 1  
VRB_TYP User text 2  
STR_RCH User text 3  
STR_OBJ User text 4  
AAN_PRO User text 7  

 

Weir

If VRB_TYP = OVS, HYDX data is imported from the Verbinding.csv file into the following fields in an ICM Weir object.

 

HYDX Code

InfoWorks ICM Data Field

Notes
KN1_IDE US node ID  
KN2_IDE DS node ID  
LEI_IDE Asset ID  
INZ_TYP System type  
INI_NIV User number 6  
UNI_IDE User text 1  
VRB_TYP User text 2  
STR_RCH User text 3  
STR_OBJ User text 4  
VRB_LEN User text 10  

 

Kunstwerk

Node

If KNP_TYP= UIT in the Knooppunt.csv file, the following HYDX data is imported from the Kunstwerk.csv file into the following fields in an ICM Node object.

HYDX Code

InfoWorks ICM Data Field

Notes
BWS_NIV User number 1  
ALG_TOE User text 9  

Orifice

If VRB_TYP = DRL in the Verbinding.csv file, and PRO in the Profiel.csv file is RND, the following HYDX data is imported from the Kunstwerk.csv file into the following fields in an ICM Orifice object.

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_BOK Invert level  
DRL_CAP Limiting discharge Value is divided by 3600 when imported.
DRL_COE User number 3  
ALG_TOE User text 9  

Sluice

If VRB_TYP = DRL in the Verbinding.csv file, and PRO in the Profiel.csv file is RHK, the following HYDX data is imported from the Kunstwerk.csv file into the following fields in an ICM Sluice object.

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_BOK Invert level  
DRL_COE User number 3  
ALG_TOE User text 9  

Pump

If VRB_TYP = PMP in the Verbinding.csv file, the following HYDX data is imported from the Kunstwerk.csv file into the following fields in an ICM Pump object.

HYDX Code

InfoWorks ICM Data Field

Notes
PMP_CAP Discharge Value is divided by 3600 when imported.
PMP_AN2 Switch on level If PMP_AN2 is not emprty, the value is imported as the Switch on level. If PMP_AN2 is empty, the value of PMP_AN1 is imported as the Switch on level
PMP_AN1
PMP_AF2 Switch off level If PMP_AF2 is not emprty, the value is imported as the Switch off level. If PMP_AF2 is empty, the value of PMP_AF1 is imported as the Switch off level.
PMP_AN1
PMP_AF1 Switch off level  
UNI_IDE

Head discharge ID

If UNI_IDE in Kunstwerk.csv matches UNI_IDE in Verbinding.csv
VRB_TYP User text 2  
AAN_CAP User text 5  
AAN_ANS User text 6  
AAN_AFS User text 7  
ALG_TOE User text 9  
Head Discharge Table

For pumps and user-defined ancillary objects, the following data may also be imported to an ICM Head Discharge Table:

HYDX Code

InfoWorks ICM Data Field

Notes
QDH_NIV Head Imported into the Head discharge power table grid. Discharge value is divided by 3600 when imported.
QDH_DEB Discharge
ALG_TOE User text 9  

Weir

If VRB_TYP = OVS in the Verbinding.csv file, the following HYDX data is imported from the Kunstwerk.csv file into the following fields in an ICM Weir object.

HYDX Code

InfoWorks ICM Data Field

Notes
OVS_BRE Width  
OVS_NIV Crest  
OVS_VOH Roof height Value is divided by 1000 when imported.
OVE_COE Discharge Coefficient

The following calculation is applied to the imported value:

OVE_COE * 2/3 * √2/3

AAN_OVN User text 5  
AAN_OVB User text 6  
ALG_TOE User text 9  

ItObject

If ITO_IDE = FK Verbinding, the following HYDX data is imported from the ItObject.csv file into the following fields in an ICM Conduit object.

HYDX Code

InfoWorks ICM Data Field

Notes
KWA_RIO Base infiltration loss coefficient The imported value is multiplied by 41.6667
KWA_RIO Side infiltration loss coefficient The imported value is multiplied by 41.6667
KWA_CUN

User number 3

 
KWA_GRW User number 4  
STD_GRW User number 5  
ALG_TOE User text 8  
ITO_IDE User text 9  

Profiel

The following HYDX data is imported from the Profiel.csv file into the shape-related fields in the following ICM objects:

Conduit

The value or setting of PRO_VRM determines if the shape of a Conduit object is a pre-set or a user-defined one.

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_MAT Conduit material  
PRO_VRM Shape ID

The value of PRO_VRM determines the setting of the Shape ID:

PRO_VRM Shape ID
EIV EGG
RHK RECT
RND CIRC

For all other values of PRO_VRM, a user-defined shape is created. See the Shape section below.

PRO_BRE

Width  
PRO_HGT

Height

 
AAN_PRO User text 5  
PRO_MAT User text 9  
ALG_TOE User text 10  
Shape

For all other values of PRO_VRM except EIV, RHK and RND, a user-defined shape will be created on import:

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_VRM Shape ID

The setting of PRO_VRM determines the setting of the Shape ID:

PRO_VRM Shape ID
HEU HEU
OVA OVA
MVR MVR
TAB TAB
TPY TPY
TPZ TPZ
UVR UVR
YZP YZP
  Shape type

If the Shape ID is MVR, Shape type is set to Symmetric

For all other types of Shape ID, Shape type is set to Asymmetric

  Geometry

For asymmetric shape types:

The height and width (PRO_HGT and PRO_BRE) values that define the height-width relationships of the shape are imported to the appropriate Height, Left hand side(width) and Right hand side (width) columns in the Geometry grid.

 

For MVR symmetric shape types:

Each height and width (PRO_HGT and PRO_BRE) value that define the symmetric MVR shape are multiplied using the height and width ratios shown in the following table:

Height Ratio Width Ratio
0 0
0.02 0.32
0.05 0.504
0.075 0.615
0.125 0.788
0.175 0.924
0.207 1
0.4 0.97
0.5 0.929
0.65 0.829
0.75 0.729
0.85 0.585
0.925 0.425
0.95 0.349
1 0

The resulting height-width relationship values are imported to the appropriate Height and Width columns in the Geometry grid.

 

The user-defined shapes are imported as non-normalised, therefore the Normalised option is unchecked.

See User-defined shape for further information.

Orifice

The following HYDX data is imported from the Profiel.csv file into the following fields in an ICM Orifice object if PRO in the Profiel.csv file is RND:

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_BRE Diameter

If PRO_VRM is RND, then the value of PRO_BRE divided by 1000 is imported as the diameter.

If PRO_VRM is RHK, the diameter is calculated as:
√(PRO_BRE * PRO_HGT / Pi * 4) divided by 1000

PRO_HGT

Height

 
AAN_PRO User text 5  
PRO_VRM User text 6  
PRO_HGT User text 8  
PRO_MAT User text 9  
ALG_TOE User text 10  
PRO_BRE User number 1  
PRO_HGT User number 2  

 

Sluice

If PRO in the Profiel.csv file is RHK, the following HYDX data is imported from the Profiel.csv file into following fields in an ICM Sluice object.

HYDX Code

InfoWorks ICM Data Field

Notes
PRO_VRM User text 6  
ALG_TOE User text 10  
PRO_BRE User number 1  
PRO_HGT User number 2  

 

Subcatchments

Oppervlak

The following HYDX data is imported from the Oppervlak.csv file into the following fields in an ICM Subcatchment object.

HYDX Code

InfoWorks ICM Data Field

Notes
UNI_IDE Subcatchment ID If not already present, a new subcatchment is created and given the same name as the UNI_IDE code.
  System type Set to Storm
UNI_IDE Drains to

Set to Node when UNI_IDE is present in an HYDX Node.

Set to Link when UNI_IDE is present in an HYDX Link.

KNP_XCO Node ID If UNI_IDE is found in a node.
KN1_IDE If KN1_IDE is found in a link.
  Link suffix If UNI_IDE is found in a link, this field is set to the related link's link_suffix.
AFV_OPP Contributing area Total of AFV_OPP divided by 10000
NSL_STA Rainfall profile  
  Connectivity Set to 100
  Waste water profile Set to 0
AFV_DEF Land use ID If value is 'nwrw.csv', then Land use ID=1.
AFV_IDE Runoff area 1 absolute to Runoff area 12 absolute

The values of AFV_IDE determine which absolute runoff areas are set:

AFV_IDE value

Runoff area absolute field
GVH_HEL Runoff area 1 absolute
GVH_VLA

Runoff area 2 absolute

GVH_VLU Runoff area 3 absolute
OVH_HEL Runoff area 4 absolute
OVH_VLA Runoff area 5 absolute
OVH_VLU Runoff area 6 absolute
DAK_HEL Runoff area 7 absolute
DAK_VLA Runoff area 8 absolute
DAK_VLU Runoff area 9 absolute
ONV_HEL Runoff area 10 absolute
ONV_VLA Runoff area 11 absolute
ONV_VLU Runoff area 12 absolute

The actual value assigned to the relevant Runoff area absolute field in ICM is determined by AFV_OPP / 10000

ALG_TOE Notes  

Debiet

The following HYDX data is imported from the Debiet.csv file into the following fields in an ICM Subcatchment object.

HYDX Code

InfoWorks ICM Data Field

Notes
UNI_IDE Subcatchment ID If not already present, a new subcatchment is created and given the same name as the UNI_IDE code.
  System type Set to Storm
UNI_IDE Drains to

Set to Node when UNI_IDE is present in an HYDX Node.

Set to Link when UNI_IDE is present in an HYDX Link.

  Node ID If UNI_IDE is found in a node, this field is set to the related node's ID.
  Link suffix If UNI_IDE is found in a link, this field is set to the related link's link_suffix.
AVV_ENH Population  
AFV_OPP User number 1  
DEB_TYP User text 1  
VER_IDE User text 2  
ALG_TOE User text 3  

Verloop

The following HYDX data is imported from the Verloop.csv file into the following fields in an ICM Subcatchment object if VER_TYP=CST and VER_DAG is empty:

HYDX Code

InfoWorks ICM Data Field

Notes
VER_VOL Trade flow

For inflows of the type LAT.

The imported value is divided by 86400.

  Trade profile

Not set initially but will link this subcatchment to the relevant Waste water event when the event is imported.

  User text 1

When a waste water event is imported, this field is set to VWD. See the Waste water event section below for further information.

VER_IDE User text 2  

NWRW

The following HYDX data is imported from the NWRW.csv file into the following fields in an ICM Land use or Runoff surface object.

Land use

HYDX Code

InfoWorks ICM Data Field

Notes
Land use ID Imported as 1 if AFV_DEF is present in the Oppervlak.csv file.
  Population density

Imported as 0

  Waste water profile Imported as 0
  Connectivity Imported as 100
  Pollution index Set to 1
  Runoff surface 1 to Runoff surface 12

Set according to the value of AFV_IDE:

AFV_IDE value

Runoff surface field
GVH_HEL Runoff surface 1
GVH_VLA Runoff surface 2
GVH_VLU Runoff surface 3
OVH_HEL Runoff surface 4
OVH_VLA Runoff surface 5
OVH_VLU Runoff surface 6
DAK_HEL Runoff surface 7
DAK_VLA Runoff surface 8
DAK_VLU Runoff surface 9
ONV_HEL Runoff surface 10
ONV_VLA Runoff surface 11
ONV_VLU Runoff surface 12

Runoff surfaces

HYDX Code

InfoWorks ICM Data Field

Notes
  Runoff surface ID  
AFV_IDE Description

 

  Routing model Set to Desbordes
  Runoff routing type Set to Abs
AFV_AFS Runoff routing value Value is set to 60/AFV_AFS when imported.
  Ground slope Set to 0
AFV_IFX Runoff volume type

Set to Fixed if AFV_IFX = 0

Set to Horton if AFV_IFX ≠ 0

AFV_IFX Surface type

Set to Impervious if AFV_IFX = 0

Set to Pervious if AFV_IFX ≠ 0

  Initial loss type Set to Abs
AFV_BRG Initial loss value Value of AFV_BRG is divided by 1000 when imported.
AFV_IFX Fixed runoff coefficient Set to 1 if AFV_IFX = 0
AFV_IFX Initial infiltration  
AFV_IFN Limiting infiltration  
AFV_IFA Decay factor  
AFV_IFH Recovery factor  
ALG_TOE Notes  

Network properties

Meta

The following HYDX codes are imported from the Meta.csv file to the Description tab on the Properties dialog:

Waste water event

Verloop

The name of the waste water event is imported from the first occurrence of ALG_TOE in the Verloop.csv file.

The following HYDX data is also imported from the Verloop.csv file into the following pages in an ICM Waste water event profile if:

Common Page

HYDX Code

Waste water Profile Item

Notes
VER_IDE Description Profile name and ID are imported from VER_IDE.
VER_VOL Per Capita flow

 

Profile Page

HYDX Code

Waste water Profile Item

Notes
VER_IDE Description See the Common Page section above.
VER_TYP=DAG Calibration/Design Profile

For both Calibration Weekday and Calibration Weekend, the values of U00_DAG to U23_DAG are imported to the Factor column on the profile grid.

Common Page

HYDX Code

Waste water Profile Item

Notes

VER_IDE

VER_DAG

Description Profile name and ID consist of the imported VER_IDE and VER_DAG values.
VER_VOL Per Capita flow

 

Profile Page

HYDX Code

Waste water Profile Item

Notes
VER_IDE Description See the Common Page section above.
VER_DAG Calibration/Design Profile / Configure Specific days of the week are imported to the Configure Calibration Profiles dialog according to the day of the week indicated by VER_DAG.
VER_TYPE=VAR Calibration/Design Profile / Grid

The values of U00_DAG to U23_DAG are imported to the Factor column for the appropriate hour (00:00 to 23:00) on the profile grid.

VER_TYP=CST VER_DAG=value A value of 4.166 is assigned to the Factor column for every hour (00:00 to 23:00) on the profile grid.

 

Importing HYDX Network Data