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 and 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 (e.g. 1D2D_Urban_001.tcf) into a Text Editor (Notepad++ is recommended).
2. Remove or comment out the following commands using a '!' symbol. These commands are either default settings that don't need to be specified or outdated defaults that aren't recommended.

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

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	Log Folder == log
   Map Output Format == XMDF	Map Output Format == XMDF TIF

4. Add the following simulation time and output commands:
   GIS Format == GPKG  ! Specify GPKG as the output format for all GIS files
   Start Time == 0  ! Specifies the simulation start time (0 hours)
   End Time == 2  ! Specifies the simulation end time (2 hours)
   NetCDF Output Start Date == 2014-01-01 00:00 ! SWMM start date / time
   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 ! Reference the SWMM (1D) Control File
6. The following commands are recommended, though optional solver commands. They will convert your CPU Classic model from TUFLOW Classic to TUFLOW HPC and run the simulation using an NVIDIA GPU card. TUFLOW HPC has superior stability compared to TUFLOW Classic. Using the GPU card instead of CPU will typically increase the simulation speed by a factor of between 10 and 50 (depending on the model and computer hardware).
   Solution Scheme == HPC  ! Heavily Parallelized Compute, uses adaptive timestepping
   Hardware == GPU  ! Use NVIDIA GPU card for accelerated compute. Set to CPU if GPU is not available
   
7. 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
8. Save the TCF.

   Original TCF	Updated TCF

Up
Continue to Next Step: "Format TUFLOW Control Files"

Up
Back to Main XPSWMM to TUFLOW Conversion Page