XPSWMM Conversion TUFLOW Control File (TCF)

TUFLOW Control File (TCF)

The TCF file references all the control files, specifies time and output controls.

In the Convert XPSWMM Model to Recommended TUFLOW Structure section, the Convert TUFLOW Model GIS Format processing tool utilizes 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 commands.

In the prior section, the TBC was edited to reflect the model updates implemented during the conversion process, while no updates were necessary for the TGC. However, the TCF requires updating to ensure the TUFLOW SWMM model runs smoothly.

1. Remove or comment out the commands listed below.

   Check MI Save Date ==	Mass Balance Output Interval (s) ==
   MI Projection ==	CSV Time ==
   MI Projection Check ==	Viscosity Formulation ==
   Timestep (s) ==	Viscosity Coefficient ==
   Cell Wet/Dry Depth ==	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 ==

2. Make the following updates:

   Original Command	Updated Command
   GPKG Projection == 1D2D_Urban_001_proj	GPKG Projection == ??
   Write Check Files == OFF	Write Check Files == ..\check\
   Output Folder == ..\results\Output	Output Folder == ..\results\
   Log Folder == log\Log	Output Folder == log
   Map Output Data Types == qVdhZ0	Map Output Data Types == q V d h Z0
   Map Output Format == XMDF	Map Output Format == XMDF TIF

3. Add the following commands:
   Tutorial Model == ON  ! Required command to run this tutorial model licence free
   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)
   TIF Map Output Interval == 0  ! Outputs only maximums for grids
   
4. Add the following command to reference the TUFLOW SWMM Control File (TSCF):
   SWMM Control File == ..\model\1D2D_Urban_001.tscf
5. Save the TCF.
   
   Video
   

Up
Back to XPSWMM to TUFLOW Conversion Page