Tuflow - User contributions [en]

Check Files 2d sh obj

2018-11-02T14:25:20Z

Rachel:

This file contains the breaklines and triangulation that have been used by TUFLOW in applying Z Shape layers. 
The breaklines and triangulations are written for each Z shape, provided TUFLOW has not read the object directly from an XF file. If you cannot find the object you are checking in the 2d_sh_obj check layer, it is recommended to re-initalise the model with the XF Files == OFF command. 
This file can be very useful if there is an issue in the way the Z shape has been applied, this file is written sequentially and the final object written can be used to find the culprit area. 
 '''Attributes of sh_obj''' 
{| align="center" class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| Source||The input Z shape (2d_zsh) or variable Z Shape (2d_vzsh) layer
|}

For example if an [[TUFLOW_Message_2232 | ERROR 2232]] has occurred, the suggested diagnoses is to import the sh_obj check file. This file is written sequentially and the last entry is the final abject TUFLOW was able to process. The final triangle is shown in red below: 
 
[[File:Error 2232 01.jpg|600px]]
 
This highlights that the issue is in the polygon in the 2d_zsh layer highlighted in green: 
[[File:Error 2232 02.jpg]]

See [[TUFLOW_Message_2232 | ERROR 2232]] for a more detailed discussion on this error.

TUFLOW Message 2142

2017-11-13T16:20:29Z

Rachel:

{{TUFLOW_Message
|tuflow_message=ERROR 2142 - Reading data for command below, or command is ambiguous.
|alt_msg=NA
|type=[[ERROR]]
|message_desc=Reading data for command below, or command is ambiguous.
|suggestions=This error typically occurs when the command is incorrectly entered. This could be due to a spelling mistake or putting a command into the wrong control file. Recommended course of action is to review the command. Check the TUFLOW manual appendices for correct syntax and which control file the command should be in.
|discussion_page=* [[Talk:TUFLOW Message 2142|Discuss Message 2142]]
|link3=''
|link4=''
|prelink=[[TUFLOW_Message_2141|Message 2141]]
|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
|nextlink=[[TUFLOW_Message_2143|Message 2143]]
}}

TUFLOW Message 2012

2017-09-06T16:12:06Z

Rachel:

{{TUFLOW_Message
|tuflow_message=ERROR 2012 - Material ID not found in the .tmf file.
|alt_msg=NA
|type=[[ERROR]]
|message_desc=2D cell has a Material ID not specified in the material properties (.tmf) file.
|suggestions=Ensure that each Material ID used is included in the material properties file. This file(.tmf) links the Material ID to roughness coefficient (either Manning's N, Manning's M or Chezy). roughness coefficient can be fixed or depth varying. Check that Material ID in GIS layer (2d_mat) is correct. 
As an example from the TUFLOW tutorial: The 2d_mat_M01_002_R.shp layer is loaded in GIS to check the material ID of objects in this layer. In the below example, there is information shown for a polygon over some water and the material ID is 4. Then check the materials file (either a .tmf or .csv) to check that the material ID is in this file and that there is a manning's n value assigned to it. 
[[File:ERROR2012 Check Mats.png|500px]]
|discussion_page=* [[Talk:TUFLOW Message 2012|Discuss Message 2012]]
|link3=''
|link4=''
|prelink=[[TUFLOW_Message_2010|Message 2010]]
|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
|nextlink=[[TUFLOW_Message_2013|Message 2013]]
}}

File:ERROR2012 Check Mats.png

2017-09-06T16:09:28Z

Rachel:

TUFLOW Message 2373

2017-01-25T11:35:45Z

Rachel:

{{TUFLOW_Message
|tuflow_message=ERROR 2373 - Invalid infiltration parameters entry for Material ",a,".
|alt_msg=NA
|type=[[ERROR]]
|message_desc=The infiltration value for the specified material cannot be read. The value must be numeric and greater than 0.
|suggestions=Review the materials file (.tmf or csv) and check the infiltration and loss values. If NO losses are to be applied, instead of 0, remove all entries (i.e.; a blank space).
|discussion_page=* [[Talk:TUFLOW Message 2373|Discuss Message 2373]]
|link3=''
|link4=''
|prelink=[[TUFLOW_Message_2372|Message 2372]]
|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
|nextlink=[[TUFLOW_Message_2374|Message 2374]]
}}

FM Tute M01 QGIS 1D2D Links

2016-11-21T15:52:14Z

Rachel: /* Method */

<ol>

=Introduction=
In this section we will create the 1D/2D links to join the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided. 
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty_L.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links_L.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. 
To digitise the CN lines, make the 2d_bc_FMT_M01_HX_001_L.shp layer editable. For each node in the 1d_x1d_FMT_M01_nodes_001_P.shp layer, draw a line in your GIS pack from the node to the HX line. The line must snap to both the node and the HX line. Draw two lines for each node, one to the left bank and one to the right bank. In the 'Type' attribute of each line, type 'CN'. 
 The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

Flood Modeller Tutorial Module01

2016-11-17T15:54:51Z

Rachel: /* TUFLOW Geometry Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> ..\model\gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup. 
 
=Review the Results=
Modelled results can be processed, reviewed and visualised in many different packages. 
For a complete introduction to the different options, [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Viewing_Results refer to Tutorial Module 1].

Flood Modeller Tutorial Module01

2016-11-16T16:59:59Z

Rachel: /* Review the Results */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup. 
 
=Review the Results=
Modelled results can be processed, reviewed and visualised in many different packages. 
For a complete introduction to the different options, [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Viewing_Results refer to Tutorial Module 1].

Flood Modeller Tutorial Module01

2016-11-16T16:32:00Z

Rachel:

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup. 
 
=Review the Results=
Modelled results can be processed, reviewed and visualised in many different pacakges.

Flood Modeller Tutorial Module01

2016-11-16T16:30:45Z

Rachel:

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup. 
 
==Review the Results==

Flood Modeller Tutorial Module01

2016-11-16T11:12:27Z

Rachel: /* Run the Simulation */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup.

=Review the Results=

Flood Modeller Tutorial Module01

2016-11-16T11:11:10Z

Rachel: /* Run the Simulation */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]] 
The simulation will take a few minutes depending on the hardware setup.

Flood Modeller Tutorial Module01

2016-11-16T10:48:04Z

Rachel: /* Run the Simulation */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a black TUFLOW DOS window. 
[[file:FMT DOS window.JPG|500px]]

Flood Modeller Tutorial Module01

2016-11-16T10:41:14Z

Rachel: /* Run the Simulation */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [http://wiki.tuflow.com/index.php?title=Running_linked_Flood_Modeller_-_TUFLOW_Models#Batch_File set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file

Flood Modeller Tutorial Module01

2016-11-16T10:31:15Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page.

Flood Modeller Tutorial Module01

2016-11-16T10:30:30Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Lniks. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page.

FM Tute M01 ARC Banks

2016-11-16T10:27:33Z

Rachel: /* Method */

<ol>

=Introduction=
In this section we will define the bank elevations of the watercourse. These are the elevations of the 1D/2D boundary cells that link the 1D Flood Modeller watercourse to the 2D TUFLOW floodplain. Note that it is these cell elevations that determine whether out of bank flooding occurs and not the left/right bank elevations with the Flood Modeller 1D cross-sections.

=Method=
<li>Import in an empty 2d_bc_empty_P.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder.</li>
<li>Save the layer as 2d_bc_hxi_FMT_001_P.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder. </li>
<li>Open the 1D_2D_Points.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_hxi_FMT_001_P.shp. </li>
<li>Interrogate one of the digitised points and inspect the attributes. The ‘type’ attribute is ‘ZP’ to denote that it is a z-point. The ‘f’ attribute is the elevation of the bank link in mAOD. </li>

[[File:FMT_1D2D_Banks.JPG|600px]]

<li>Save the file in preparation for reading in TUFLOW.</li>

Please return to the [[Flood_Modeller_Tutorial_Module01#Deactivate_2D_cells|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 QGIS 1D2D Banks

2016-11-16T10:27:16Z

Rachel: /* Method */

<ol>
=Introduction=
In this section we will define the bank elevations of the watercourse. These are the elevations of the 1D/2D boundary cells that link the 1D Flood Modeller watercourse to the 2D TUFLOW floodplain. 
Note that it is these cell elevations that determine whether water spills from the 1D Flood Modeller domain into the 2D TUFLOW domain. The bank elevations of the Flood Modeller 1D cross-sections do not control the spill.

=Method=
<li>Import in an empty 2d_bc_empty_P.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder.</li>
<li>Save the layer as 2d_bc_hxi_FMT_001_P.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder. </li>
<li>Open the 1D_2D_Points_P.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_hxi_FMT_001_P.shp. </li>
<li>Interrogate one of the digitised points and inspect the attributes. The ‘type’ attribute is ‘ZP’ to denote that it is a z-point which will define the elevation on the banks. The ‘f’ attribute is the elevation of the bank link in mAOD. </li>
<li>Save the file.</li>

[[File:FMT_1D2D_Banks.JPG|600px]]

Please return to the [[Flood_Modeller_Tutorial_Module01#Deactivate_2D_cells|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 MI 1D2D Links

2016-11-16T10:26:35Z

Rachel: /* Method */

<ol>
=Introduction=
In this section we will create the 1D/2D links to link the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided.
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty.TAB layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\mi\empty folder. </li>
<li>Save the layer as 2d_bc_FMT_M01_HX_001.TAB in the FMT_tutorial\FMT_M01\TUFLOW\model\mi folder. </li>
<li>Open the 1D_2D_HX_Links.TAB GIS layer from Module_Data\Module_01\mi folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001.TAB.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the ZC elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. 
To digitise the CN lines, make the 2d_bc_FMT_M01_HX_001.TAB layer editable. For each node in the 1d_x1d_FMT_M01_nodes_001.TAB layer, draw a line in your GIS pack from the node to the HX line. The line must snap to both the node and the HX line. Draw two lines for each node, one to the left bank and one to the right bank. In the 'Type' attribute of each line, type 'CN'. 
 The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 ARC 1D2D Links

2016-11-16T10:26:10Z

Rachel: /* Method */

<ol>
=Introduction=
In this section we will create the 1D/2D links to link the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided.
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty_L.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the ZC elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. 
To digitise the CN lines, make the 2d_bc_FMT_M01_HX_001_L.shp layer editable. For each node in the 1d_x1d_FMT_M01_nodes_001_P.shp layer, draw a line in your GIS pack from the node to the HX line. The line must snap to both the node and the HX line. Draw two lines for each node, one to the left bank and one to the right bank. In the 'Type' attribute of each line, type 'CN'. 
 The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 MI 1D2D Links

2016-11-16T10:25:10Z

Rachel: /* Introduction */

<ol>
=Introduction=
In this section we will create the 1D/2D links to link the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided.
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty.TAB layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\mi\empty folder. </li>
<li>Save the layer as 2d_bc_FMT_M01_HX_001.TAB in the FMT_tutorial\FMT_M01\TUFLOW\model\mi folder. </li>
<li>Open the 1D_2D_HX_Links.TAB GIS layer from Module_Data\Module_01\mi folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001.TAB.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the ZC elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 ARC 1D2D Links

2016-11-16T10:25:03Z

Rachel: /* Introduction */

<ol>
=Introduction=
In this section we will create the 1D/2D links to link the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided.
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the ZC elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 QGIS 1D2D Links

2016-11-16T10:23:44Z

Rachel: /* Method */

<ol>

=Introduction=
In this section we will create the 1D/2D links to join the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided. 
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty_L.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. 
To digitise the CN lines, make the 2d_bc_FMT_M01_HX_001_L.shp layer editable. For each node in the 1d_x1d_FMT_M01_nodes_001_P.shp layer, draw a line in your GIS pack from the node to the HX line. The line must snap to both the node and the HX line. Draw two lines for each node, one to the left bank and one to the right bank. In the 'Type' attribute of each line, type 'CN'. 
 The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 QGIS 1D2D Links

2016-11-16T10:01:07Z

Rachel: /* Method */

<ol>

=Introduction=
In this section we will create the 1D/2D links to join the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided. 
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty_L.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 QGIS 1D2D Links

2016-11-16T10:00:24Z

Rachel: /* Introduction */

<ol>

=Introduction=
In this section we will create the 1D/2D links to join the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided. 
 
The empty GIS files used in this tutorial are the same as those created in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 QGIS 1D2D Links

2016-11-16T10:00:07Z

Rachel: /* Introduction */

<ol>

=Introduction=
In this section we will create the 1D/2D links to join the Flood Modeller 1D component to the TUFLOW 2D domain. 
As described on the previous page, this consists of a boundary line with type "HX" and a series of connection lines that connect the 1D computation points to the HX line. 
The HS line is how flow is transfered between the 2D TUFLOW domain and the 1D Flood Modeller Domain. 
For this tutorial the HX lines and a sample of the "CN" lines have been provided. 
 
The empty GIS files used in this tutorial are the same as those creased in [http://wiki.tuflow.com/index.php?title=Tutorial_Module01#Set_GIS_Projection_and_Create_Empty_.28Template.29_Files step 4 of tutorial module 1]. 
These template files set up how to enter the GIS data for TUFLOW to read.

=Method=
<li>Import in an empty 2d_bc_empty.shp layer from within the FMT_tutorial\FMT_M01\TUFLOW\model\gis\empty folder. </li>
<li>Save the empty layer as 2d_bc_FMT_M01_HX_001_L.shp in the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder.</li>
<li>Open the 1D_2D_HX_Links.shp GIS layer from Module_Data\Module_01\gis folder. Select all objects from within this layer, copy and paste into 2d_bc_FMT_M01_HX_001_L.shp.</li>
<li>Interrogate one of the lines running along the banks of the watercourse. These lines are the 1D/2D boundary links and have been assigned a type ‘HX’.</li>
<li>Interrogate one of the lines connecting the x1D node to the HX line. These are the connection or ‘CN’ lines that read the water level from Flood Modeller and transfers this to the HX line. </li>
In the figure below, the water level is calculated in Flood Modeller at the nodes FC01.16, FC01.15 and FC01.14. These water levels are linearly interpolated along the lengths of the HX line on both left and right banks of the watercourse. When the water level exceeds the elevation of the boundary cell, water is able to flow on the the TUFLOW 2D floodplain. 
 
[[File:FMT 1D-2D Linking.JPG|600px]]

 
Note that where there are junctions within the Flood Modeller 1D model (i.e. at structures), both the upstream and downstream nodes are connected to TUFLOW. Refer to the below figure, the Junction nodes are highlighted in red and the upstream and downstream nodes are highlighted in green. 
The HX lines must be broken between the nodes. This is a requirement of a linked Flood Modeller – TUFLOW model.
In the figure below, the HX lines are broken between FC01.35 and FC01.34 as a culvert is located between these nodes.
 
[[File:FMT 1D-2D Broken HX FM.JPG|900px]] [[File:FMT 1D-2D Broken HX.JPG|900px]]

<li>The CN and HX lines between nodes FC02.06 and FC02.01d along the tributary have not been digitised. Digitise these lines to connect the nodes to the 2D domain. The figure below shows how the nodes are connected at the confluence. Note that all Flood Modeller nodes at the junction are present within the 1d_x1D_nodes layer, and are connected to the 2D domain. The HX lines are broken around the junction. </li>
 
[[File:FMT 1D-2D Linking Junction.JPG|900px]]

<li>Once all the CN and HX lines have been digitised along the tributary, save the file.</li>

<div style="background-color: #D6E9E0; margin: 20px; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The digitised direction of the HX and CN lines is not important. The CN lines however should be digitised approximately perpendicular to the direction of flow. Two CN lines are digitised for each node and connected to the HX boundary lines along the left and right banks. The HX boundary lines should be digitised along the top of each bank such that the width between the lines approximately correlates to the width of the 1D channel.
</div>

Please return to the [[Flood_Modeller_Tutorial_Module01#Define_Bank_Elevations|Flood Modeller Tutorial Model]].

</ol>

FM Tute M01 MI x1D Nodes

2016-11-16T09:57:36Z

Rachel: /* Introduction */

<ol>
=Introduction=
We will now create TUFLOW GIS layers to reference the nodes within the Flood Modeller model. 
These node layers are the primary way that TUFLOW references the Flood Modeller sections. 
 
The Aerial imagery shown in this has also been provided. It is located in the module_data\Aerial_Photos\ folder. 
It is optional to add it to your GIS package for the duration of the tutorial. 

=Method=
<li> Open the FloodModeller_Nodes.TAB layer from Module_Data\Module_01\mi folder.</li>
<li> Save as 1d_x1d_FMT_M01_nodes_001.TAB within the FMT_tutorial\FMT_M01\TUFLOW\model\mi folder. </li>
<li> Open the GIS layer 1d_x1d_FMT_M01_nodes_001.TAB within MapInfo.</li>
<li> Interrogate one of the digitised points and inspect the attributes. Note that each point has a unique name which correlates to a RIVER, INTERPOLATE or REPLICATE unit within the Flood Modeller model. At junctions, both the upstream and downstream nodes must be digitised within this layer.</li>

[[File:FMT_QGISx1D_Nodes_MI.PNG|600px]]

<li> Save and export the file to MID/MIF format.

<div style="background-color: #D6E9E0; width: 50%; margin: 20px; auto; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The node IDs are case-sensitive as this is a requirement of Flood
Modeller.
</div>

You have now created the links to Flood Modeller for reading into TUFLOW. Return to the [[Flood_Modeller_Tutorial_Module01#Define_the_1D.2F2D_Boundary_Links|Flood Modeller Tutorial Model]].

FM Tute M01 ARC x1D Nodes

2016-11-16T09:57:20Z

Rachel: /* Introduction */

<ol>
=Introduction=
We will now create TUFLOW GIS layers to reference the nodes within the Flood Modeller model. 
These node layers are the primary way that TUFLOW references the Flood Modeller sections. 
 
The Aerial imagery shown in this has also been provided. It is located in the module_data\Aerial_Photos\ folder. 
It is optional to add it to your GIS package for the duration of the tutorial. 

=Method=
<li> Open the FloodModeller_Nodes.shp layer from Module_Data\Module_01\shp folder.</li>
<li> Save as 1d_x1d_FMT_M01_nodes_001_P.shp within the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder. </li>
<li> Open the GIS layer 1d_x1d_FMT_M01_nodes_001_P.shp within ArcGIS.</li>
<li> Interrogate one of the digitised points and inspect the attributes. Note that each point has a unique name which correlates to a RIVER, INTERPOLATE or REPLICATE unit within the Flood Modeller model. At junctions, both the upstream and downstream nodes must be digitised within this layer.</li>

[[File:FMT_QGISx1D_Nodes.JPG|600px]]

<li> Save the file.

<div style="background-color: #D6E9E0; width: 50%; margin: 20px; auto; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The node IDs are case-sensitive as this is a requirement of Flood
Modeller.
</div>

You have now created the links to Flood Modeller for reading into TUFLOW. Return to the [[Flood_Modeller_Tutorial_Module01#Define_the_1D.2F2D_Boundary_Links|Flood Modeller Tutorial Model]].

FM Tute M01 QGIS x1D Nodes

2016-11-16T09:56:35Z

Rachel: /* Introduction */

<ol>

=Introduction=
We will now create TUFLOW GIS layers to reference the nodes within the Flood Modeller model. 
These node layers are the primary way that TUFLOW references the Flood Modeller sections. 
 
The Aerial imagery shown in this has also been provided. It is located in the module_data\Aerial_Photos\ folder. 
It is optional to add it to your GIS package for the duration of the tutorial. 

=Method=
<li> Open the FloodModeller_Nodes.shp layer from Module_Data\Module_01\shp folder.</li>
<li> Save as 1d_x1d_FMT_M01_nodes_001_P.shp within the FMT_tutorial\FMT_M01\TUFLOW\model\gis folder. </li>
<li> Open the GIS layer 1d_x1d_FMT_M01_nodes_001_P.shp within QGIS.</li>
<li> Interrogate one of the digitised points and inspect the attributes. Note that each point has a unique name which correlates to a RIVER, INTERPOLATE or REPLICATE unit within the Flood Modeller model. At junctions, both the upstream and downstream nodes must be digitised within this layer.</li>

[[File:FMT_QGISx1D_Nodes.JPG|600px]]

<li> Save the file.

<div style="background-color: #D6E9E0; width: 50%; margin: 20px; auto; text-align: center;
border: 5px solid #1ABDC9">
Key Tip!
 The node IDs are case-sensitive as this is a requirement of Flood
Modeller.
</div>

You have now created the links to Flood Modeller for reading into TUFLOW. Return to the [[Flood_Modeller_Tutorial_Module01#Define_the_1D.2F2D_Boundary_Links|Flood Modeller Tutorial Model]].

Flood Modeller Tutorial Module01

2016-11-15T15:04:47Z

Rachel: /* Run the Simulation */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page.

Flood Modeller Tutorial Module01

2016-11-15T15:00:28Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data </li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T14:57:05Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

File:FMT Simulation links.JPG

2016-11-15T14:54:47Z

Rachel:

Flood Modeller Tutorial Module01

2016-11-15T14:53:09Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the as '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Indflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*End Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

File:FMT Simulation times.JPG

2016-11-15T14:45:01Z

Rachel:

File:FMT Simulation files.JPG

2016-11-15T14:41:52Z

Rachel:

File:FMT Load1Dnwk.JPG

2016-11-15T14:28:59Z

Rachel:

Flood Modeller Tutorial Module01

2016-11-15T14:13:16Z

Rachel: /* IEF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:32:24Z

Rachel: /* TUFLOW Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li>
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:31:12Z

Rachel: /* TUFLOW Boundary Condition Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:30:05Z

Rachel: /* TUFLOW Geometry Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section at the bottom of the file. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:29:47Z

Rachel: /* TUFLOW Geometry Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:27:52Z

Rachel: /* TUFLOW Geometry Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:07:37Z

Rachel: /* TUFLOW Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
This concludes the changes that we need to make to the .tcf

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:07:16Z

Rachel: /* TUFLOW Boundary Condition Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:06:25Z

Rachel: /* =TUFLOW Control File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:06:10Z

Rachel: /* TCF File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TUFLOW Control File=
Finally, we need to edit the TUFLOW control file (tcf). 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:05:45Z

Rachel: /* Modify Simulation Control Files */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TCF File==
Finally, we need to edit the TUFLOW control file. 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-15T12:05:04Z

Rachel: /* TGC File */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TBC File==
We will now reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TCF File==
Finally, we need to edit the TUFLOW control file. 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.

Flood Modeller Tutorial Module01

2016-11-14T19:44:29Z

Rachel: /* Flood Modeller Simulation Files */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially one-directional. A 2D scheme is suited to the representation of floodplains where a more detailed flow patterns may occur. 
 
As [[Tutorial_Module01#Reviewing_Model_Performance | discussed in Module 1]], the main creek channel is not very well represented using the 5m 2D cell size. In parts, the creek is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the creek topography. Refer to the below figure. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the creek channel may reduce the accuracy of the conveyance in the channel and introduce a source of mass error to the model. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01#Advanced_.28Optional.29 | optional section of module 1]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements in Flood Modeller. 
 
TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller (previously ISIS), XP-SWMM and 12D Solutions’ Dynamic Drainage. 
Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, so you can progress through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]] of the TUFLOW Tutorial Models. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be changed to Flood Modeller. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

If you need more information on these elements, we recommend that you work through [[Tutorial Module01|Module 1]] and [[Tutorial Module02|Module 2]].

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [http://help.floodmodeller.com/floodmodeller/ Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF 1D simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TGC File==
We will first update the TUFLOW geometry Control (TGC) file. 
The following changes have been changes made to the geometry:
* We have turned off the cells in the channel (as these are now modelled in Flood Modeller)
* We have added the bank lines as topography amendments.
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_M01_002.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_001_HX_001.MIF<tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

'''Other GIS''' 
Add an extra line in after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_M01_002.shp </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_001_HX_001_R.shp <tt> ! Deactivates the cells where the creek channel has been modelled in 1D </tt>

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>

<li> Save the file. The geometry file is now ready to be used.
</ol>

==TBC File==
We will now reference the model boundary files created in previous steps.
<li> Update the 1D/2D boundaries to reference the HX lines created</li>
<li> Remove the external inflows applied to the TUFLOW model, these are now applied in Flood Modeller</li>
<li> Update the ESTRY culverts layer, some of these culverts are now modelled in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002.SHP

<li> Add the Boundaries for the culverts and to link to Flood Modeller:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001.MIF <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | 2d_bc_FMT_M01_HX_001_P_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary file is now ready to be used.
</ol>

==TCF File==
Finally, we need to edit the TUFLOW control file. 
We will:
<li> Reference the Flood Modeller Nodes to directly link the models</li>
<li> Update the links to the boundary control file and geometry control file</li
<li> Update the 1D domain contols, as these are now controlled by Flood Modeller</li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> We need to remove the simulation time control commands (shown below) which specify timestep, start time and end time from the tcf. These will be moved to the Flood Modeller IEF file. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to add the Flood modeller commands, these are: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt>
 
<li> Now update the culverts currently included in the model: 
'''Mapinfo''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\mi\1d_nwk_FMT_M01_culverts_001.MIF
'''Other GIS''' 
:<tt>Read GIS Network</tt> <tt>== </tt>..\model\gis\1d_nwk_FMT_M01_culverts_001.SHP
 
<li> Finally, update the links to the Geometry control file and Boundary Condition control file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
 
<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for Flood Modeller Interface verison 4.2. 

==IEF File==

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods.
Using your preferred method, start the model FMT_0100F_001.ief. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 

 
Click [[Flood_Modeller_Tutorial_Model | here]] to return back to the main Flood Modeller - TUFLOW Tutorial page.