XPSWMM Conversion TUFLOW Control File (TCF)

TUFLOW Control File (TCF)

The TCF file references all the control files we have worked on in the previous steps. It also defines the model time and output controls.

In the Convert XPSWMM Model to Recommended TUFLOW Structure section, the Convert TUFLOW Model GIS Format processing tool utilized the TUFLOW control files generated by XPSWMM to construct the TUFLOW SWMM model control files. During this process, the tool updates the commands within the TUFLOW control files to align with the requirements of a TUFLOW SWMM model. However, since the original control files were intended for use with XPSWMM, they lack the commands required to execute a TUFLOW simulation. Additionally, these files often contain unnecessary and/or outdated default parameter commands that we recommend removing.

1. In Windows File Explorer, navigate to the TUFLOW\runs folder and open the TCF into a Text Editor (Notepad++ is recommended).
2. Remove or comment out the following commands using a ! . They are either irrelevant to the model or represent an out-of-date default setting in TUFLOW, thus rendering them unnecessary.

   Check MI Save Date ==	Mass Balance Output Interval (s) ==
   MI Projection ==	CSV Time == HOURS
   MI Projection Check ==	Viscosity Formulation == SMAGORINSKY
   Timestep (s) ==	Viscosity Coefficient == 0.500, 0.050
   Cell Wet/Dry Depth == 0.002000	SX ZC Check ==
   Read GIS XP Nodes ==	SX Storage Approach ==
   Simulations Log Folder ==	HX ZC Check ==
   Store Maximums and Minimums ==	Mass Balance Corrector ==
   Mass Balance Output ==

3. Make the following updates:

   Original Command	Updated Command
   Write Check Files == OFF	Write Check Files == ..\check\
   Output Folder == ..\results\Output	Output Folder == ..\results\
   Log Folder == log\Log	Output Folder == log
   Map Output Format == XMDF	Map Output Format == XMDF TIF

4. Add the following commands:
   GIS Format == GPKG  ! Specify GPKG as the output format for all GIS files
   Solution Scheme == HPC  ! Heavily Parallelised Compute, uses adaptive timestepping
   Hardware == CPU  ! Replace with "Hardware == GPU" if GPU available
   Start Time == 0  ! Specifies the simulation start time (0 hours)
   End Time == 3  ! Specifies the simulation end time (3 hours)
   NetCDF Output Start Date == 2014-01-01 00:00 ! SWMM start time unit
   TIF Map Output Interval == 0  ! Outputs only maximums for grids
   
5. Add the following command to reference the TUFLOW SWMM Control File (TSCF):
   SWMM Control File == ..\model\1D2D_Urban_001.tscf
6. If you are using our XPSWMM conversion dataset, add the following command so the TUFLOW model can run without requiring a license. This command is not recommended if you are converting any other XPSWMM model.
   Tutorial Model == ON  ! Required command to run this tutorial model licence free
7. Save the TCF.
   
   Video
   

Up
Back to XPSWMM to TUFLOW Conversion Page