Flood Modeller Tutorial Model Provisional: Difference between revisions

Content deleted Content added
 
(2 intermediate revisions by 2 users not shown)
Line 1:
=Introduction=
The objective of the Flood Modeller - TUFLOW modules is to demonstrate how TUFLOW links to anthe external Flood Modeller 1D scheme and the methods available to create this link. They are designed to supplement existing documentation and assume prior knowledge of both Flood Modeller and TUFLOW software packages.
 
These modules were developed by BMT in collaboration with Jacobs. Comments, requests and feedback can be sent to [mailto:support@tuflow.com support@tuflow.com].
 
=Requirements and Downloads=
Both TUFLOW and Flood Modeller have relatively modest system requirements for small models such as thethose tutorialused modelin these modules. However, largerLarger and more complex models, however, may haverequire higher hardware requirements - inspecifications, particularparticularly memory (RAM). Both software are available in 32 and 64 bit versions. The tutorial modelmodels isare designed to beintentionally small, to allow forensure quick simulation and load times., The tutorial modeland should run on any modern PC or laptop that is capable of running Windows 7 or later.
 
TUFLOW models typically require access to a GIS package, a text editor, Microsoft Excel and a results viewer to build, review and visualise a model. ReferA tolist theof followingcompatible Wikipackages pageis toavailable viewon athe listTUFLOW of compatible packagesWiki. Alternatively, Flood Modeller maycan also be used as a GUIgraphical user interface for creating and editing GIS layers in a TUFLOW model, andas alsowell as for visualising the results. Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS file formats:
 
Instructions for Flood Modeller - TUFLOW modules are provided using the following GIS file formats:
QGIS - SHP
 
* '''<u>QGIS - SHP</u>'''
 
* '''<u>QGIS - GPKG</u>'''
 
QGIS - GPKG
{| class="wikitable" width="75%"
 
Line 27 ⟶ 30:
This tutorial model does not require a TUFLOW licence.<br>
 
This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be usedspecfied inwithin the hardware[https://docs.tuflow.com/classic-hpc/manual/2025.2/TCFCommands-1.html#tcfHardware Hardware] command. <br>
||The TUFLOW executable is provided within the <u>[https://wiki.tuflow.com/Tutorial_Introduction#Module_Data Tutorial Dataset]</u>.
|-
 
|'''Flood Modeller'''|| Flood Modeller (previously known as ISIS) is a commercial flood modelling package developed by Jacobs for simulating depth-averaged one and two dimensional free surface flows. It is primarily used for the simulation of river channels and is widely used within the UK and Ireland. This tutorial model will only leverage Flood Modeller’s 1D Solver. <br>
TUFLOW 1D and 2D domains can be dynamically linked to the 1D domain of Flood Modeller Pro. Flood Modeller is not included within the TUFLOW executable and must be downloaded separately. <br>
 
Unlike TUFLOW Flood Modeller has a standalone Graphical User Interface which can be used to build networks, run models, and visualise results.
 
It is recommended that TUFLOW 2020-10-AD or later is used in conjunction with Flood Modeller Version 5 or later. [https://docs.tuflow.com/classic-hpc/manual/2025.2/OneD2DLinkingFM-2.html#fig:fig-FMTUFLOWVersionCompatability Figure 10.1215] of the [https://docs.tuflow.com/classic-hpc/manual/2025.2/ 2025 TUFLOW manual] provides a list of compatibility between recent Flood Modeller and TUFLOW versions. <br>
 
For Flood Modeller Version 5 or later a Standard, Professional, or Unlimited Edition of Flood Modeller Pro is required to open and run the tutorial model.
Line 52 ⟶ 55:
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. <br><br>
TUFLOW colour coding can be enabled using syntax highlighting.
|| <u>[https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]</u>. <br><br>
 
<u>[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]</u>.<br><br>For instructions on configuring Notepad++ for TUFLOW modelling, see <u>[[NotepadPlusPlus_Tips |Notepad++ tips]]</u>.
 
For instructions on configuring Notepad++ for TUFLOW modelling, see <u>[[NotepadPlusPlus_Tips |Notepad++ tips]]</u>.
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||
Line 70 ⟶ 71:
=Recommended Reading=
The aim of this tutorial is to demonstrate the steps undertaken to build, review and visualise the results of a linked Flood Modeller – TUFLOW model. It assumes that the user has a good understanding of both the 1D component of Flood Modeller and the 1D and 2D components of TUFLOW. The following resources may be of use:
*[[Tutorial_Introduction | TUFLOW Tutorial Model]]
*[https://docs.tuflow.com/classic-hpc/manual/2025.1/ TUFLOW Classic / HPC User Manual]
*[https://help.floodmodeller.com/docs/getting-started-with-1d-river-modelling Flood Modeller 1D Quick Start Guide]
Line 78 ⟶ 79:
The tutorial is presented over a series of modules, with each module offering the opportunity to run the model and review the results. Each of the modules builds upon the previous iteration with models developed in the previous module made available.
 
New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest. Results and check files are not included to keep the size of the download file manageable, but can be generated through the running of the simulations. The folder should be placed in a location with write permissions. The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to link Flood Modeller and TUFLOW.
 
The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to link Flood Modeller and TUFLOW.
 
:*<u>[[ Flood_Modeller_Tutorial_Module01_Provisional | Flood Modeller Module 1]]</u> - Linking Flood Modeller to TUFLOW
 
The second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of the first tutorial. The second tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
 
The second tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
:*<u>[[ Flood_Modeller_Tutorial_Module02_Provisional | Flood Modeller Module 2]]</u> - Linking Flood Modeller to ESTRY