View source for Flood Modeller Tutorial Module01 Provisional

=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 uni-directional. A 2D scheme is suited to the representation of floodplains where more complex flow patterns may occur. <br>
<br>
The main watercourse channel is not very well represented using the 5m 2D cell size. In parts, the watercourse is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the watercourse topography.<br>
[[file:Poor_2d_rep.png|400px]]<br>
Using a cell size that is coarse relative to the width of the watercourse channel may reduce the accuracy of the conveyance in the channel.  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 this module we will adopt the second approach of modelling the creek as 1D elements using Flood Modeller.<br>

TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller, 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, to allow for progressing 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_M01 |Module 1]] and [[Tutorial_M02 |Module 2]] of the TUFLOW Tutorial Model.<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 added to the Flood Modeller model.<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 areas for the assignment of roughness values 
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in QGIS using SHP and GPKG formats. If you would like to view instructions for the tutorial in ArcGIS or MapInfo these can be found on the archive page for [[Flood_Modeller_Tutorial_Module01_Archive | Tutorial Module 01]]. 

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

* [[FM Tute M01_QGIS_SHP_x1D_Nodes  | QGIS - SHP]]
* [[FM Tute M01_QGIS_GPKG_x1D_Nodes  | QGIS - GPKG]]

==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 format. 
* [[FM Tute M01_QGIS_SHP_1D2D_Links  | QGIS - SHP]]
* [[FM Tute M01_QGIS_GPKG_1D2D_Links  | QGIS - GPKG]]

==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 format. 
* [[FM Tute M01_QGIS_SHP_Banks | QGIS - SHP]]
* [[FM Tute M01_QGIS_GPKG_Banks | QGIS - GPKG]]

==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 format.
* [[FM Tute M01_QGIS_SHP_1D2D_Code  | QGIS – SHP ]]
* [[FM Tute M01_QGIS_GPKG_1D2D_Code  | QGIS - GPKG]]


=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 deactivated the cells along the watercourse which are represented in the 1D Flood Modeller component of the model
* We have enforced bank elevations along the watercourse.
<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></li>

<br><u>'''QGIS - SHP'''</u><br>

<br>Add an extra command line after <font color="blue"><tt> Read GIS Code </tt></font><font color="red"><tt>==</tt></font>..\model\gis\2d_code_FMT_M01_001_R.shp<br>

:<br><font color="blue"><tt>Read GIS Code BC </tt></font> <font color="red"><tt>== </tt></font> gis\2d_bc_FMT_M01_HX_001_R.shp <font color="green"><tt> ! Deactivates the cells where the watercourse has been modelled in 1D </tt></font><br>

<br>Note that the order of the commands is important. The layer '''2d_code_FMT_M01_001_R.shp''' first activates cells within the modelled area then the layer '''2d_bc_FMT_M01_HX_001_R.shp''' deactivates selected cells along the watercourse. <br>

<br><u>'''QGIS - GPKG'''</u><br>

<br>Add an extra command line after <font color="blue"><tt> Read GIS Code </tt></font><font color="red"><tt>==</tt></font> 2d_code_FMT_M01_001_R.shp <br>

:<br><font color="blue"><tt>Read GIS Code BC </tt></font> <font color="red"><tt>== </tt></font> 2d_bc_FMT_M01_HX_001_R.shp <font color="green"><tt> ! Deactivates the cells where the watercourse has been modelled in 1D </tt></font><br>

<br>Note that the order of the commands is important. The layer '''2d_code_FMT_M01_001_R''' first activates cells within the modelled area then the layer '''2d_bc_FMT_M01_HX_001_R''' deactivates selected cells along the watercourse. <br> 

<br> <li> Topography amendments should be added in a new section at the bottom of the TGC. These are: </li>

<br><u>'''QGIS - SHP'''</u><br>

:<br><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><br>

<br>The two GIS layers must be read in together on the same command line. This tells TUFLOW to associate the points within the '''2d_bc_FMT_M01_HX_001_P.shp''' layer (defining elevation) with the polylines within the '''2d_bc_FMT_M01_HX_001_L.shp''' layer (defining bank location). <br>

<br><u>'''QGIS - GPKG'''</u><br>

:<br><font color="blue"><tt>Read GIS Z HX Line MAX </tt></font> <font color="red"><tt>==</tt></font> 2d_bc_FMT_M01_HX_001_L | gis\2d_bc_FMT_M01_HX_001_P  <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><br>

<br>The two GIS layers must be read in together on the same command line. This tells TUFLOW to associate the points within the '''2d_bc_FMT_M01_HX_001_P''' layer (defining elevation) with the polylines within the '''2d_bc_FMT_M01_HX_001_L''' layer (defining bank location) <br>. 

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

==TUFLOW Boundary Condition Control File==
<br>We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps. <br>
<li> Add the 1D/2D boundaries that link the Flood Modeller open channel to the 2D floodplain</li>
<li> Update the 1D/2D boundaries which link the ESTRY culverts to the 2D floodplain, as some of these culverts are now modelled in Flood Modeller</li>
<li> Remove the external inflows applied to the TUFLOW model, as these are now applied 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:<br>

<br><u>'''QGIS - SHP'''</u><br>

<br>Put an exclamation mark before the line reading:<br>
:<br><font color="blue"><tt>Read GIS BC</tt></font> <font color="red"><tt>== </tt></font> gis\2d_bc_M01_002_L.SHP<br>


<br><li> Update the 1D/2D boundary links at the ESTRY culverts  with the new layer:</li>

:<br><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><br>

<br><li> Add reference to the 1D/2D boundary links that connect Flood Modeller to the 2D floodplain:</li>
:<br><font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> gis\2d_bc_FMT_M01_HX_001_p.shp | gis\2d_bc_FMT_M01_HX_001_L.shp <font color="green"><tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt></font><br>

<br><u>'''QGIS - GPKG'''</u><br>
:<br>Put an exclamation mark before the line reading:<br>
:<br><font color="blue"><tt>Read GIS BC</tt></font> <font color="red"><tt>== </tt></font> 2d_bc_M01_002_L<br>

<br><li> Update the 1D/2D boundary links at the ESTRY culverts with the new layer:</li>

:<br><font color="blue"><tt>Read GIS BC</tt></font> <font color="red"><tt>== </tt></font> 2d_bc_M04_culverts_001_L	<font color="green"><tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt></font><br>

<br><li> Add reference to the 1D/2D boundary links that connect Flood Modeller to the 2D floodplain:</li>
:<br><font color="blue"><tt>Read GIS BC </tt></font> <font color="red"><tt>== </tt></font> 2d_bc_FMT_M01_HX_001_P | 2d_bc_FMT_M01_HX_001_L <font color="green"><tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt></font><br>

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

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (.tcf). We will:
<li> Remove reference to model parameters that will be read in from Flood Modeller</li>
<li> Read in the GIS layer of the Flood Modeller Nodes </li>
<li> Read in the GIS layers to create Water Level Lines along the Flood Modeller component of the model (optional) </li>
<li> Add a reference to the ESTRY Control File
<li> Update reference to the boundary control file (.tbc) and geometry control file </li>
<br>
<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> In a linked Flood Modeller - TUFLOW model, the Start Time, End Time and 2D Timestep are read from the Flood Modeller .ief file. It is best practice to therefore remove these parameters from the tcf. And an exclamation mark in front of each of the below commands.<br> 

:<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><br>
:<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><br>
:<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><br>

<br><li> We need to read in the GIS layers of the Flood Modeller Nodes. Place the below command line anywhere in the .tcf. It is good practice to create a section within the .tcf to reference all 1D commands: <br> </li>

<br> <u>'''QGIS - SHP'''</u><br>

:<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><br>

<br> <u>'''QGIS - GPKG'''</u><br>

:<br> <font color="blue"><tt>Read GIS X1D Nodes</tt></font>  <font color="red"><tt>== </tt></font> 1d_x1d_FMT_M01_nodes_001_P <font color="green"><tt>! GIS layer referencing node IDs from Flood Modeller </tt></font><br>

<br><li> Add commands to read in the GIS layers referencing Water Level Lines drawn along the Flood Modeller component of the model: <br> </li>
<br> <u>'''QGIS - SHP'''</u><br>
:<br> <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><br>
:<br> <font color="blue"><tt>Read GIS X1D WLL</tt></font> <font color="red"><tt>== </tt></font> ..\model\gis\1d_x1d_WLL_FMT_M01_001_L.shp <font color="green"><tt>! GIS layer containing WLLs for visualising 1D results in 2D (optional)</tt></font><br>

<br> <u>'''QGIS - GPKG'''</u><br>

:<br> <font color="blue"><tt>Read GIS X1D Network</tt></font> <font color="red"><tt>== </tt></font> 1d_x1d_FMT_M01_nwk_001_L  <font color="green"><tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt></font><br>
:<br> <font color="blue"><tt>Read GIS X1D WLL</tt></font> <font color="red"><tt>== </tt></font>  1d_x1d_WLL_FMT_M01_001_L <font color="green"><tt>! GIS layer containing WLLs for visualising 1D results in 2D (optional)</tt></font><br>
<br><li>The addition of TUFLOW Water Level Lines (WLL) allows the Flood Modeller 1D results to be visualised within the TUFLOW 2D map outputs. They provide a means by which to remove the gaps in the map outputs where the 1D Flood Modeller domains are located and the 2D cells are deactivated. To do this, TUFLOW requires a 1D_WLL layer to define the cross sections locations, and a 1d_nwk layer that defines the river centre line. The layers are not used in the hydraulic calculations and their inclusion is not always required. <br> </li>

<br><li>The Dist_for_Add_Points determines the intervals in metres at which interpolation points are inserted along each WLL. </li>
<li> Add commands to read in the an Esty Control File which contains references to some of the culverts present on the floodplain: <br> </li>
:<br> <font color="blue"><tt>ESTRY Control File</tt></font>  <font color="red"><tt>== </tt></font>..\model\FMT_M01_001.ecf <font color="green"><tt>!Reference the ESTRY Control File </tt></font><br>

<br><li> Finally, update the links to the Geometry control file, the Boundary Condition control file and the bc_dbase file:</li>
:<br> <font color="blue"><tt>Geometry Control File</tt></font>  <font color="red"><tt>== </tt></font>..\model\FMT_M01_001.tgc <br>
:<br> <font color="blue"><tt>BC Control File</tt></font>  <font color="red"><tt>== </tt></font>..\model\FMT_M01_001.tbc <br>
:<br> <font color="blue"><tt>BC Database</tt></font>  <font color="red"><tt>== </tt></font>..\bc_dbase\bc_dbase_FMT_M01.csv <br>

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

==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.<br>
The DAT and IED files are complete and will not require any modification to link to TUFLOW.<br>
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.<br>
The instructions below have been written for the Flood Modeller Interface version 7.2.<br>

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

<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the '''\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_Inflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>

<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
*Finish Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300

<li> Add the 'Links' tab by clicking View> Tabs > Links. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*Check the box for ‘Perform corrective 1D timestep’ 
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder

<li> Save the Scenario Data. </li>

<br>{{Video|name=Setting up FMP IEF Simulation File.mp4 |width=1123}}<br>


</ol>

=Review the Results=

<li> Instructions for viewing the TUFLOW mesh (XMDF) and 1D time series (.tpc) outputs specified for this tutorial are provided in [[Tutorial_M01_Results_QGIS | Module 1]] and [[Tutorial_M03_Results_QGIS | Module 3]]. </li>

<li>It can be useful to view 1D Flood Modeller results side by side with the 2D TUFLOW map outputs. The Flood Modeller results can be opened in conjunction with the TUFLOW mesh results in QGIS via the TUFLOW Viewer plugin. Likewise, it is also possible to load the TUFLOW mesh results into the Flood Modeller Pro interface. The methods by which to load the Flood Modeller results using QGIS TUFLOW viewer plugin, and the TUFLOW mesh results in Flood Modeller Pro are shown in the video below. </li>
<br>{{Video|name=Viewing Results in Flood Modeller and TUFLOW.mp4.mp4 |width=1123}}<br>


==TUFLOW HPC==

To run the linked TUFLOW-Flood Modeller Pro model using HPC we simply need to add a single line to the Tuflow Control File.  The HPC solver will only speed up the 2D calculations within the linked 1D-2D model, it will not speed up the 1D calculations that take place in the Flood Modeller Engine. 
The relatively small nature of this specific model means that use of HPC on multiple CPU cores may not lead to significant improvements to model run times.  However, should the machine have an NVIDIA GPU card present then it is possible to run the HPC solver on the GPU to significantly improve model runs times.  The larger the 2D domain, the more significant the improvements to model run times through the use of the HPC solver.
To utilise the HPC solver:-

<ol>
<li> Save the TUFLOW runfile ( <b>FMT_M01_001.tcf</b>) as <b>FMT_M01_002.tcf</b>.</li>

<li> Add the following command to the TCF file:
:<font color="blue"><tt> Solution Scheme </tt></font> <font color="red"><tt>== </tt></font>HPC	<font color="green"><tt>! Use HPC solver to run the simulation</tt></font>
<li>	If you have a CUDA enabled NVIDIA GPU device, you can also add the following command to run the HPC solver using GPU hardware:
:<font color="blue"><tt> Hardware </tt></font> <font color="red"><tt>== </tt></font>GPU	<font color="green"><tt>! Run HPC solver on GPU</tt></font>
<li>	Save the TCF file and run the model.Troubleshooting for GPU Simulation
</ol>
===Troubleshooting for GPU Simulation===
If you receive the following error when trying to run the TUFLOW HPC model using GPU hardware: 
<pre>TUFLOW GPU: Interrogating CUDA enabled GPUs … 
TUFLOW GPU: Error: Non-CUDA Success Code returned 
</pre>
or
<pre>ERROR 2785 - No GPU devices found, enabled or compatible.
</pre>

Please try the following steps: 
<ol>
<li> Check if your GPU card is an NVIDIA GPU card. Currently, TUFLOW does not run on AMD type GPU.
<li> Check if your NVIDIA GPU card is CUDA enabled and whether the latest drivers are installed. Please see <u>[[GPU_Setup | GPU Setup]]</u>.
</ol>
<br>
If you experience an issue that is not detailed above please send an email to [mailto:support@tuflow.com support@tuflow.com]<br>