Tutorial M05

From Tuflow
Jump to navigation Jump to search


In this module, an integrated urban drainage network is represented.
The GIS layers are:

  • TGC layers:
    1. 2d_zsh: A layer used to modify Zpt elevations using points, lines and polygons.
    2. 2d_mat: A layer used to define the land use (material) types within the developmental area.
  • ECF layers:
    1. 1d_nwk: A layer used to define pipes and pits in 1D.
  • TBC layers:
    1. 2d_sa: A layer to define internal 2D flow boundaries.
    2. 2d_bc: A layer defining the locations of external 2D boundaries.

Module 5 builds from the model created in Module 2. The completed Module 2 model is provided in the Module_05\TUFLOW folder.

GIS Inputs

Create, import and view input data:

Boundary Condition Database (bc_dbase)

Update the bc_dbase with a reference of the new 2d_sa regions:

  1. Navigate to the Module_05\Tutorial_Data folder. Copy the 01p2hr_loc.csv and paste it in the Module_05\TUFLOW\bc_dbase folder. This file contains the inflow data applied to each of the 2d_sa regions.
  2. Open the file, there are 4 columns labelled ‘Loc_001’ to ‘Loc_004’. These correspond to the names of the 2d_sa regions.
  3. Save a copy of the bc_dbase.csv as bc_dbase_M05_001.csv.
  4. Open the file and add the additional inflows:

    M05 bc dbase 01a.png

  5. Save the bc_dbase.

Note: Direct rainfall can be applied to the model instead of the 2d_sa regions. The pits gather overland flow and convey it into the pipe network. Direct rainfall is covered in Module 6.

Pit Inlet Database (pit_dbase)

The pit inlet database assigns a depth discharge relationship to pit inlet types:

  1. Create a new folder called ‘pit_dbase’ in the Module_05\TUFLOW folder.
  2. Navigate to the Module_05\Tutorial_Data, copy and paste the following csv files into the Module_05\TUFLOW\pit_dbase folder:
    • pit_inlet_curves.csv
    • pit_inet_dbase.csv
  3. Open the pit_inlet_dbase. The three different names are user defined inlet types matching the attribute in 1d_nwk pits file. They define the inflow into the pit depending on the above ground water depth and are derived based on the geometry of the pits. These can be unique to every model. From the pit_inlet_dbase, ‘AB’ inlet type has an area of 0.54m2 and width of 3.6m and references the ‘Type AB’ in the flow column from the pit_inlet_curves file.

    M05 pit inlet dbase 01.png

  4. Open the pit_inlet_curves, it defines the depth discharge relationship for each pit inlet type.
  5. Plot the depth against flow for each pit type to view the relationship. The curves are the limiting factor for the amount of flow entering the pits.

    M05 pit inlet curves 01.png

Note: A spreadsheet InletCurves_SI_Units_001.xls located in the Module_05\Tutorial Dataset folder can be used to derive unique depth discharge curve relationships based on input geometry.

Simulation Control Files

TUFLOW Geometry Control File (TGC)

  1. Save a copy of M02_001.tgc as M05_001.tgc in the Module_05\TUFLOW\model folder.
  2. Open the file M05_001.tgc in a text editor and add the additional lines below the Read GIS Z Shape == gis\2d_zsh_M02_rd_crest_001_L.shp | gis\2d_zsh_M02_rd_crest_001_P.shp command:
    Create TIN Zpts == gis\2d_zsh_M02_landscape_002_R.shp | gis\2d_zsh_M02_landscape_002_L.shp | gis\2d_zsh_M02_landscape_002_P.shp ! Defines areas of complex landscaping
  3. Add in the following line after the 'Read GIS Mat == gis\2d_mat_M01_001_R.shp' command.
    Read GIS Mat == gis\2d_mat_M02_landscape_002_R.shp ! Sets the material values according to attributes in the GIS layer
    Assigns the updated materials values due to the development.
  4. Save the TGC.

The three Z shapes that form the TIN are from Module 2, this is the foundation of the development.

TUFLOW Boundary Control File (TBC)

  1. Save a copy of M01_001.tbc as M05_001.tbc in the Module_05\TUFLOW\model folder.
  2. Open the file M05_001.tbc in a text editor and add the following two commands:
    Read GIS SA PITS == gis\2d_sa_M05_001_R.shp ! Reads in 2D boundaries directly to 1D pits
    Read GIS BC == gis\2d_bc_M05_outlet_001_L.shp ! Reads in 2D boundaries from 1D network
  3. Save the TBC.

The command ‘Read GIS SA PITS’ directs the inflow to 2D cells connected to the 1D pits with 'SX' as 'Conn_1D_2D' attribute and it spreads the inflow equally over the cells containing pits. The ‘Read GIS BC’ command defines the outlet of the pipe network.

ESTRY Control File (ECF)

  1. Create a new text file called M05_001.ecf and save it in the Module_05\TUFLOW\model folder.
  2. Add the following command lines:
    Timestep == 0.5 ! Specifies a 1D computational timestep as 0.5 seconds
    Read GIS Network == gis\1d_nwk_M05_pipes_001_L.shp ! Defines pipes
    Read GIS Network == gis\1d_nwk_M05_pits_001_P.shp  ! Defines pits
    Pit Inlet Database == ..\pit_dbase\pit_inlet_dbase.csv  ! Pit inlet database defining depth-discharge curves
  3. Save the ECF.

The above sets a 1D computational timestep of 0.5 seconds, reads in both the pipes and the pits 1d_nwk files and links these to the pit inlet database.

TUFLOW Control File (TCF)

  1. Save a copy of M02_5m_001.tcf as M05_5m_001.tcf in the Module_05\TUFLOW\runs folder.
  2. Open the file M05_5m_001.tcf in a text editor and add the following line:
    ESTRY Control File == ..\model\M05_001.ecf  ! Reference the ESTRY (1D) Control File
  3. Update the reference of the TGC and TBC files in the 'Model Inputs' section:
    Geometry Control File == ..\model\M05_001.tgc  ! Reference the TUFLOW Geometry Control File
    BC Control File == ..\model\M05_001.tbc  ! Reference the TUFLOW Boundary Conditions Control File
  4. Update the reference to the bc database:
    BC Database == ..\bc_dbase\bc_dbase_M05_001.csv  ! Reference the Boundary Conditions Database
  5. Save the TCF.

Running the Simulation

  1. Save a copy of _run_M02_HPC.bat as _run_M05_HPC.bat in the Module_05\TUFLOW\runs folder.
  2. Update the batch file to reference the M05_5m_001.tcf :
    set exe="..\..\..\exe\2023-03-AA\TUFLOW_iSP_w64.exe"
    set run=start "TUFLOW" /wait %exe% -b
    %run% M05_5m_001.tcf
  3. Save the batch file and double click it in file explorer to run the simulation.


See tips on common mistakes and troubleshooting steps if the model doesn't run:

Check Files

While the model is running, review the added features are specified correctly:


When the model is finished, review the results:


  • 1D underground pipes and pits were provided and added to the model discharging into the 2D domain.
  • Check files were used to review the connection between the pipe network and the 2D domain.
  • Results were viewed to assess the amount of water in the pipe network.

1D Integrity Tool (Optional)

The 1D Integrity Tool is a suite of tools designed to help modellers find and fix potential errors in 1D networks prior to running TUFLOW. It is a free tool that comes as part of the TUFLOW plugin:

Go-up.png Back to Tutorial Introduction Main Page