View source for Flood Modeller Tutorial Module01

=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. <br>

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. <br>
<br>
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.<br>
[[file:Poor_2d_rep.png|400px]]<br>
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:<br>
* 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.<br>
<br>
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.<br>
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.<br>

=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.<br>
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.<br>
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.<br>
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.<br>
The model data has been arranged in the following folder structure: 
*<b>DAT</b>: Contains the Flood Modeller 1D network file.
*<b>IED</b>: Contains event data of the model. 
*<b>IEF</b>: A blank folder in which to store Flood Modeller Event Files used to simulate the model. 
*<b>RES</b>: 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].<br>
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.<br>
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.
<br>
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\model folder, save a copy of <b>M01_5m_002.tgc</b> as <b>FMT_M01_001.tgc</b>. </li>
<li> Open <b>FMT_M01_001.tgc</b><br>

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

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

<li> Topography amendments should be added in a new section. These are: </li>
'''Mapinfo'''<br>
:<font color="green"><tt> ! Read GIS Z Shape == mi\2d_zsh_M03_thalweg_001.MIF ! This GIS layer is commented out / removed from the model as the creek channel has been modelled in 1D </tt></font>
:<font color="blue"><tt>Read GIS Z Shape </tt></font> <font color="red"><tt>==</tt></font> mi\2d_zsh_M03_Rd_Crest_001.MIF<font color="green"><tt> ! GIS layer used to define the road crest </tt></font>
:<font color="blue"><tt>Read GIS Z HX Line MAX </tt></font> <font color="red"><tt>==</tt></font> mi\2d_bc_FMT_M01_HX_001.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <font color="green"><tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt></font>

'''Other GIS'''<br>
:<font color="green"><tt> ! Read GIS Z Shape </tt></font> <font color="red"><tt>==</tt></font> gis\2d_zsh_M03_thalweg_001.shp <font color="green"><tt> ! This GIS layer is commented out / removed from the model as the creek channel has been modelled in 1D </tt></font>
:<font color="blue"><tt>Read GIS Z Shape </tt></font> <font color="red"><tt>==</tt></font> gis\2d_zsh_M03_Rd_Crest_001_L.shp | gis\2d_zsh_M03_Rd_Crest_001_P.shp <font color="green"><tt> ! GIS layer used to define the road crest </tt></font>
:<font color="blue"><tt>Read GIS Z HX Line MAX </tt></font> <font color="red"><tt>==</tt></font> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_p.shp <font color="green"><tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt></font>

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

==TBC File==
<li> Open '''FMT_M01_001.tbc''' or navigate to the correct tab.</li>


<li> We need to add the internal 1D/2D boundaries. We need to update the culvert boundaries and include the HX boundaries for the open channel sections. </li>

* The 1D/2D boundaries we need to add are
'''Mapinfo'''
:<font color="blue"><tt>Read GIS BC</tt></font> <font color="red"><tt>== </tt></font> mi\2d_bc_M04_culverts_001.MIF <font color="green"><tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt></font>
:<font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> mi\2d_bc_FMT_M01_HX_001.MIF <font color="green"><tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt></font>

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

<li> Save the file. The boundary file is now ready to be used.
==TCF File==
<ol>
<li> Firstly, 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 <b>remove</b> 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 soon. <br> 

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

<li> We need to add the Flood modeller commands, these are: <br> </li>
'''Mapinfo'''<br>
:<font color="blue"><tt>Read GIS X1D Nodes</tt></font>  <font color="red"><tt>== </tt></font>..\model\mi\1d_x1d_FMT_M01_nodes_001.MIF	<font color="green"><tt>! GIS layer referencing node IDs from Flood Modeller </tt></font>
:<font color="blue"><tt>Read GIS X1D Network</tt></font> <font color="red"><tt>== </tt></font>..\model\mi\1d_x1d_FMT_M01_nwk_001.MIF	<font color="green"><tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt></font>
:<font color="blue"><tt>Read GIS X1D WLL</tt></font> <font color="red"><tt>== </tt></font> ..\model\mi\1d_x1d_WLL_FMT_M01_001.MIF <font color="green"><tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt></font>


'''Other GIS'''<br>
:<font color="blue"><tt>Read GIS X1D Nodes</tt></font>  <font color="red"><tt>== </tt></font>..\model\gis\1d_x1d_FMT_M01_nodes_001_p.shp	<font color="green"><tt>! GIS layer referencing node IDs from Flood Modeller </tt></font>
:<font color="blue"><tt>Read GIS X1D Network</tt></font> <font color="red"><tt>== </tt></font>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp	<font color="green"><tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt></font>
:<font color="blue"><tt>Read GIS X1D WLL</tt></font> <font color="red"><tt>== </tt></font> ..\model\gis\1d_x1d_WLL_FMT_M01_001_p.shp		<font color="green"><tt>! GIS layer containing WLLs for visualising 1D results in 2D</tt></font>

<li> This concludes the changes that we need to make to the .tcf</li>

==Flood Modeller Simulation Files==
==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. <br>

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