TUFLOW 1D Flood Modeller Connectivity - Revision history

Anne.Kolega: /* Introduction */ e.g.

2026-04-01T22:26:36Z

Introduction: e.g.

← Older revision		Revision as of 08:26, 2 April 2026
Line 7:		Line 7:
	* A "'''X1DQ'''" link where a Flood Modeller inflow/outflow is being applied at the ESTRY node (i.e. Flood Modeller sends ESTRY a discharge and ESTRY sends back a water level).		* A "'''X1DQ'''" link where a Flood Modeller inflow/outflow is being applied at the ESTRY node (i.e. Flood Modeller sends ESTRY a discharge and ESTRY sends back a water level).

	An ESTRY X1DH (the default) would be used for most Flood Modeller ESTRY links where TUFLOW is discharging into Flood Modeller. The discharge will be applied to the Flood Modeller 1D model as a lateral inflow. The Flood Modeller 1D node on the receiving end of an X1DH connection must be a channel unit (~~eg,~~ River, Interpolate, Replicate or Conduit) and must not be the end node of a reach (i.e., distance to next cross section of zero). This is commonly used when representing a pipe network within ESTRY which discharges to an open channel represented in Flood Modeller as per Figure 1.		An ESTRY X1DH (the default) would be used for most Flood Modeller ESTRY links where TUFLOW is discharging into Flood Modeller. The discharge will be applied to the Flood Modeller 1D model as a lateral inflow. The Flood Modeller 1D node on the receiving end of an X1DH connection must be a channel unit (e.g. River, Interpolate, Replicate or Conduit) and must not be the end node of a reach (i.e., distance to next cross section of zero). This is commonly used when representing a pipe network within ESTRY which discharges to an open channel represented in Flood Modeller as per Figure 1.

	[[File:X1DH Link.png\|thumb\|Border\|none\|700px\|Figure 1: TUFLOW Pipe Network Discharging to a Flood Modeller Representation of an Open Channel]]		[[File:X1DH Link.png\|thumb\|Border\|none\|700px\|Figure 1: TUFLOW Pipe Network Discharging to a Flood Modeller Representation of an Open Channel]]

Pavlina Monhartova at 03:53, 20 January 2025

2025-01-20T03:53:08Z

← Older revision		Revision as of 13:53, 20 January 2025
Line 18:		Line 18:

	=Building an ESTRY-Flood Modeller 1D-1D Connection=		=Building an ESTRY-Flood Modeller 1D-1D Connection=
	Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS ~~ISIS~~ Nodes or Read GIS ~~ISIS~~ Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.		Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS X1D Nodes or Read GIS X1D Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.

	[[File:Estry Link.png\|thumb\|Border\|none\|400px\|Figure 3-The ESTRY 1d_nwk node layer (in blue) snapped to a Flood Modeller node (in a 1d_x1d Flood Modeller layer in orange).]]<br>		[[File:Estry Link.png\|thumb\|Border\|none\|400px\|Figure 3-The ESTRY 1d_nwk node layer (in blue) snapped to a Flood Modeller node (in a 1d_x1d Flood Modeller layer in orange).]]<br>

Pavlina Monhartova at 02:58, 17 January 2025

2025-01-17T02:58:11Z

← Older revision		Revision as of 12:58, 17 January 2025
Line 7:		Line 7:
	* A "'''X1DQ'''" link where a Flood Modeller inflow/outflow is being applied at the ESTRY node (i.e. Flood Modeller sends ESTRY a discharge and ESTRY sends back a water level).		* A "'''X1DQ'''" link where a Flood Modeller inflow/outflow is being applied at the ESTRY node (i.e. Flood Modeller sends ESTRY a discharge and ESTRY sends back a water level).

	An ESTRY X1DH (the default) would be used for most Flood Modeller ESTRY links where TUFLOW is discharging into Flood Modeller. The discharge will be applied to the Flood Modeller 1D model as a lateral inflow. The Flood Modeller 1D node on the receiving end of an X1DH connection must be a channel unit (eg, River, Interpolate, Replicate or Conduit) and must not be the end node of a reach (ie, distance to next cross section of zero). This is commonly used when representing a pipe network within ESTRY which discharges to an open channel represented in Flood Modeller as per Figure 1.		An ESTRY X1DH (the default) would be used for most Flood Modeller ESTRY links where TUFLOW is discharging into Flood Modeller. The discharge will be applied to the Flood Modeller 1D model as a lateral inflow. The Flood Modeller 1D node on the receiving end of an X1DH connection must be a channel unit (eg, River, Interpolate, Replicate or Conduit) and must not be the end node of a reach (i.e., distance to next cross section of zero). This is commonly used when representing a pipe network within ESTRY which discharges to an open channel represented in Flood Modeller as per Figure 1.

	[[File:X1DH Link.png\|thumb\|Border\|none\|700px\|Figure 1: TUFLOW Pipe Network Discharging to a Flood Modeller Representation of an Open Channel]]		[[File:X1DH Link.png\|thumb\|Border\|none\|700px\|Figure 1: TUFLOW Pipe Network Discharging to a Flood Modeller Representation of an Open Channel]]
Line 24:		Line 24:
	[[File:Estry Properties.png\|thumb\|Border\|none\|700px\|Figure 4-1d_nwk_nodes attributes for the ESTRY node snapped to the Flood Modeller node.]]<br>		[[File:Estry Properties.png\|thumb\|Border\|none\|700px\|Figure 4-1d_nwk_nodes attributes for the ESTRY node snapped to the Flood Modeller node.]]<br>

	A connector "X" channel type can be used to connect the end of the linked ESTRY channel to the ESTRY node snapped to the Flood Modeller node if the end of the ESTRY channel and the snapped Flood Modeller /ESTRY nodes are not in the same location. In this case it is important that the X-connector is drawn from the ESTRY channel (ie, the first vertex on the polyline) to the ESTRY node which is snapped to the Flood Modeller node (see Figure 5). The Flood Modeller node label in the 1d_x1d Flood Modeller layer should match that within the Flood Modeller network.		A connector "X" channel type can be used to connect the end of the linked ESTRY channel to the ESTRY node snapped to the Flood Modeller node if the end of the ESTRY channel and the snapped Flood Modeller /ESTRY nodes are not in the same location. In this case it is important that the X-connector is drawn from the ESTRY channel (i.e., the first vertex on the polyline) to the ESTRY node which is snapped to the Flood Modeller node (see Figure 5). The Flood Modeller node label in the 1d_x1d Flood Modeller layer should match that within the Flood Modeller network.

	[[File:X Connector.png\|thumb\|Border\|none\|700px\|Figure 5-X-Connector connected the ESTRY channel DARL_OC_1 to the ESTRY Node DB_2436 which is snapped to the Flood Modeller node DB_2436. Note the direction of the X-Connector between the ESTRY channel and the ESTRY/Flood Modeller node location.]]		[[File:X Connector.png\|thumb\|Border\|none\|700px\|Figure 5-X-Connector connected the ESTRY channel DARL_OC_1 to the ESTRY Node DB_2436 which is snapped to the Flood Modeller node DB_2436. Note the direction of the X-Connector between the ESTRY channel and the ESTRY/Flood Modeller node location.]]

Pavlina Monhartova at 02:57, 17 January 2025

2025-01-17T02:57:00Z

← Older revision		Revision as of 12:57, 17 January 2025
Line 20:		Line 20:
	Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS ISIS Nodes or Read GIS ISIS Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.		Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS ISIS Nodes or Read GIS ISIS Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.

	[[File:Estry Link.png\|thumb\|Border\|none\|400px\|Figure 3-The ESTRY 1d_nwk node layer (in blue) snapped to a Flood Modeller node (in a ~~1d_x1d_isis~~ layer in orange).]]<br>		[[File:Estry Link.png\|thumb\|Border\|none\|400px\|Figure 3-The ESTRY 1d_nwk node layer (in blue) snapped to a Flood Modeller node (in a 1d_x1d Flood Modeller layer in orange).]]<br>

	[[File:Estry Properties.png\|thumb\|Border\|none\|700px\|Figure 4-1d_nwk_nodes attributes for the ESTRY node snapped to the Flood Modeller node.]]<br>		[[File:Estry Properties.png\|thumb\|Border\|none\|700px\|Figure 4-1d_nwk_nodes attributes for the ESTRY node snapped to the Flood Modeller node.]]<br>

	A connector "X" channel type can be used to connect the end of the linked ESTRY channel to the ESTRY node snapped to the Flood Modeller node if the end of the ESTRY channel and the snapped Flood Modeller /ESTRY nodes are not in the same location. In this case it is important that the X-connector is drawn from the ESTRY channel (ie, the first vertex on the polyline) to the ESTRY node which is snapped to the Flood Modeller node (see Figure 5). The Flood Modeller node label in the ~~1d_x1d_isis~~ layer should match that within the Flood Modeller network.		A connector "X" channel type can be used to connect the end of the linked ESTRY channel to the ESTRY node snapped to the Flood Modeller node if the end of the ESTRY channel and the snapped Flood Modeller /ESTRY nodes are not in the same location. In this case it is important that the X-connector is drawn from the ESTRY channel (ie, the first vertex on the polyline) to the ESTRY node which is snapped to the Flood Modeller node (see Figure 5). The Flood Modeller node label in the 1d_x1d Flood Modeller layer should match that within the Flood Modeller network.

	[[File:X Connector.png\|thumb\|Border\|none\|700px\|Figure 5-X-Connector connected the ESTRY channel DARL_OC_1 to the ESTRY Node DB_2436 which is snapped to the Flood Modeller node DB_2436. Note the direction of the X-Connector between the ESTRY channel and the ESTRY/Flood Modeller node location.]]		[[File:X Connector.png\|thumb\|Border\|none\|700px\|Figure 5-X-Connector connected the ESTRY channel DARL_OC_1 to the ESTRY Node DB_2436 which is snapped to the Flood Modeller node DB_2436. Note the direction of the X-Connector between the ESTRY channel and the ESTRY/Flood Modeller node location.]]

Tuflowduncan: /* Introduction */

2024-09-04T15:57:01Z

Introduction

← Older revision		Revision as of 01:57, 5 September 2024
Line 30:		Line 30:
	It is not possible to have a HX connection to ESTRY and a X1DQ connection at the same node. This is because the X1DQ connection node is snapped to the Flood Modeller node and the model thinks it's trying to connect a HX and X1DQ to the same Flood Modeller node. In this situation it would be necessary to insert a small dummy channel between the X1DQ node and the node connected to the HX boundary.		It is not possible to have a HX connection to ESTRY and a X1DQ connection at the same node. This is because the X1DQ connection node is snapped to the Flood Modeller node and the model thinks it's trying to connect a HX and X1DQ to the same Flood Modeller node. In this situation it would be necessary to insert a small dummy channel between the X1DQ node and the node connected to the HX boundary.

	An example model containing both X1DH and X1DQ connection is available from [~~mailto~~:~~support@tuflow~~.com ~~support@~~tuflow~~.com~~]. This is available as 2 models, one with direct snapping between nodes and the ESTRY channel and other which uses X-connectors.		An example model containing both X1DH and X1DQ connection is available from the [https://gitlab.com/tuflow-user-group/third-party-tools/other/flood-modeller-tuflow-linked-examples TUFLOW User Group Gitlab Page]. This is available as 2 models, one with direct snapping between nodes and the ESTRY channel and other which uses X-connectors.

	==Checking whether a X1DH or X1DQ Setup has been Successful==		==Checking whether a X1DH or X1DQ Setup has been Successful==

Tuflowduncan at 14:47, 5 June 2020

2020-06-05T14:47:43Z

← Older revision		Revision as of 00:47, 6 June 2020
Line 30:		Line 30:
	It is not possible to have a HX connection to ESTRY and a X1DQ connection at the same node. This is because the X1DQ connection node is snapped to the Flood Modeller node and the model thinks it's trying to connect a HX and X1DQ to the same Flood Modeller node. In this situation it would be necessary to insert a small dummy channel between the X1DQ node and the node connected to the HX boundary.		It is not possible to have a HX connection to ESTRY and a X1DQ connection at the same node. This is because the X1DQ connection node is snapped to the Flood Modeller node and the model thinks it's trying to connect a HX and X1DQ to the same Flood Modeller node. In this situation it would be necessary to insert a small dummy channel between the X1DQ node and the node connected to the HX boundary.

	An example model containing both X1DH and X1DQ connection is available from [mailto:~~sales~~@tuflow.com ~~sales~~@tuflow.com]. This is available as 2 models, one with direct snapping between nodes and the ESTRY channel and other which uses X-connectors.		An example model containing both X1DH and X1DQ connection is available from [mailto:support@tuflow.com support@tuflow.com]. This is available as 2 models, one with direct snapping between nodes and the ESTRY channel and other which uses X-connectors.

	==Checking whether a X1DH or X1DQ Setup has been Successful==		==Checking whether a X1DH or X1DQ Setup has been Successful==

Tuflowduncan at 15:33, 30 September 2019

2019-09-30T15:33:57Z

← Older revision		Revision as of 01:33, 1 October 2019
Line 1:		Line 1:
	<font size = 18>Page Under Construction</font>
	<br>
	<br>		<br>
	=Introduction=		=Introduction=
	TUFLOW models can be configured with Flood Modeller to allow dynamically linked models comprising 1D pipe networks, represented in TUFLOW 1D, open channels represented in Flood Modeller Pro and/or ~~TUFLOW 1D~~ and the 2D representation of surface flow represented in TUFLOW 2D. This allows full integrated catchment modelling.		TUFLOW models can be configured with Flood Modeller to allow dynamically linked models comprising 1D pipe networks, represented in ESTRY (aka TUFLOW 1D), open channels represented in Flood Modeller Pro and/or ESTRY and the 2D representation of surface flow represented in TUFLOW 2D. This allows full integrated catchment modelling.
	There are two types of linking:-		There are two types of linking:-

Line 15:		Line 13:
	An X1DQ might be more appropriate where a Flood Modeller model stops and flows into an ESTRY model. The water level calculated by TUFLOW is applied as a time-varying head boundary in Flood Modeller. The Flood Modeller 1D node on the end of an X1DQ connection must be an HTBDY unit. This does not need to contain any boundary data as this data will be overridden by the water levels provided by TUFLOW.		An X1DQ might be more appropriate where a Flood Modeller model stops and flows into an ESTRY model. The water level calculated by TUFLOW is applied as a time-varying head boundary in Flood Modeller. The Flood Modeller 1D node on the end of an X1DQ connection must be an HTBDY unit. This does not need to contain any boundary data as this data will be overridden by the water levels provided by TUFLOW.

	[[File:X1DQ Example.PNG\|thumb\|Border\|none\|700px\|Figure 2: Flood Modeller Open Channel Discharging into a ~~TUFLOW~~ 1D Open Channel, the green node, DSBDY, is the location of the 'X1DQ' node.]]		[[File:X1DQ Example.PNG\|thumb\|Border\|none\|700px\|Figure 2: Flood Modeller Open Channel Discharging into an ESTRY 1D Open Channel, the green node, DSBDY, is the location of the 'X1DQ' node.]]

	'''NOTE: Remember that the Flood Modeller node ID is Case Sensitive.'''		'''NOTE: Remember that the Flood Modeller node ID is Case Sensitive.'''

Tuflowduncan: /* Interrogating Results for a Flood Modeller-TUFLOW 1D Link */

2019-09-30T15:32:15Z

Interrogating Results for a Flood Modeller-TUFLOW 1D Link

← Older revision		Revision as of 01:32, 1 October 2019
Line 51:		Line 51:
	[[File:Messages x1DH.PNG\|thumb\|border\|none\|700px\|Figure 9: _messages layer showing successful activation of X1DH connection between ESTRY and Flood Modeller.]]		[[File:Messages x1DH.PNG\|thumb\|border\|none\|700px\|Figure 9: _messages layer showing successful activation of X1DH connection between ESTRY and Flood Modeller.]]

	=Interrogating Results for a Flood Modeller~~-TUFLOW~~ 1D Link=		=Interrogating Results for an ESTRY-Flood Modeller 1D Link=

	Generally, an ESTRY timestep will be smaller than the Flood Modeller timestep. In these cases, the total volume is accumulated over all ESTRY timesteps within a Flood Modeller timestep, and applied to the Flood Modeller model as a discharge by dividing the volume by the Flood Modeller timestep.		Generally, an ESTRY timestep will be smaller than the Flood Modeller timestep. In these cases, the total volume is accumulated over all ESTRY timesteps within a Flood Modeller timestep, and applied to the Flood Modeller model as a discharge by dividing the volume by the Flood Modeller timestep.

Tuflowduncan: /* Building a TUFLOW-Flood Modeller 1D-1D Connection */

2019-09-30T15:31:42Z

Building a TUFLOW-Flood Modeller 1D-1D Connection

← Older revision		Revision as of 01:31, 1 October 2019
Line 19:		Line 19:
	'''NOTE: Remember that the Flood Modeller node ID is Case Sensitive.'''		'''NOTE: Remember that the Flood Modeller node ID is Case Sensitive.'''

	=Building a ~~TUFLOW~~-Flood Modeller 1D-1D Connection=		=Building an ESTRY-Flood Modeller 1D-1D Connection=
	Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS ISIS Nodes or Read GIS ISIS Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.		Flood Modeller and TUFLOW will be considered linked if an ESTRY node in a 1D_nwk layer and a Flood Modeller node in a Read GIS ISIS Nodes or Read GIS ISIS Network layer are snapped together (see Figure 3). Ensure that the 2 nodes are snapped, or that a snap tolerance is being used. The ESTRY node should have a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ". If Conn_1D_2D field is blank then “X1DH” is assumed (see Figure 4). Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.

Tuflowduncan: /* Summary */

2019-09-30T15:31:00Z

Summary

← Older revision		Revision as of 01:31, 1 October 2019
Line 73:		Line 73:
	=Summary=		=Summary=

	Flood Modeller and ESTRY (TUFLOW 1D) models can be dynamically coupled to enable a bi-directional connection between the two software using either a X1DH link or a X1DQ link. The ~~links~~ take place when an ESTRY node and Flood Modeller node are snapped together. Where an ESTRY channel is also attached flow is transferred at this interface. When an ESTRY channel is not connecting, an X-connector is required to connect the snapped ESTRY/Flood Modeller node to the ESTRY channel. The dynamic coupling allows full integrated catchment modelling with open channels being represented in Flood Modeller, Pipe networks being modelled in ~~TUFLOW 1D~~ and the urban surface and floodplain being modelled in TUFLOW 2D. From Flood Modeller 4.5, there is also the capability to run linked Flood Modeller-ESTRY models with TUFLOW HPC. This allows models to be run on multiple processors and on GPU cards for significant speed gains for the integrated catchment model. Further details can be found in the following [[Flood_Modeller-TUFLOW_Benchmarking\|page]].		Flood Modeller and ESTRY (TUFLOW 1D) models can be dynamically coupled to enable a bi-directional connection between the two software using either a X1DH link or a X1DQ link. The linkage take place when an ESTRY node and Flood Modeller node are snapped together. Where an ESTRY channel is also attached flow is transferred at this interface. When an ESTRY channel is not connecting, an X-connector is required to connect the snapped ESTRY/Flood Modeller node to the ESTRY channel. The dynamic coupling allows full integrated catchment modelling with open channels being represented in Flood Modeller, Pipe networks being modelled in ESTRY and the urban surface and floodplain being modelled in TUFLOW 2D. From Flood Modeller 4.5, there is also the capability to run linked Flood Modeller-ESTRY models with TUFLOW HPC. This allows models to be run on multiple processors and on GPU cards for significant speed gains for the integrated catchment model. Further details can be found in the following [[Flood_Modeller-TUFLOW_Benchmarking\|page]].