View source for XPSWMM Conversion TUFLOW Control File (TCF) Archive

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

In the <u>[[XPSWMM_Conversion_TUFLOW_Structure_Archive | Convert XPSWMM Model to Recommended TUFLOW Structure]]</u> section, the <u>[[Convert_TUFLOW_Model_GIS_Format |Convert TUFLOW Model GIS Format]]</u> 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.<br>
<ol>
<li> 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).
<li> Remove or comment out the following commands using a '<font color="green"><tt>!</tt></font>' symbol. These commands are either default settings that don't need to be specified or outdated defaults that aren't recommended.
{|
|style="width: 50%"| <font color="blue"><tt>Check MI Save Date </tt></font> <font color="red"><tt>== </tt></font> 
|<font color="blue"><tt>Mass Balance Output Interval (s) </tt></font> <font color="red"><tt>== </tt></font>
|-
|<font color="blue"><tt>MI Projection </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>CSV Time </tt></font> <font color="red"><tt>== </tt></font>
|-
|<font color="blue"><tt>MI Projection Check </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>Viscosity Formulation </tt></font> <font color="red"><tt>== </tt></font> 
|-
|<font color="blue"><tt>Timestep (s) </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>Viscosity Coefficient </tt></font> <font color="red"><tt>== </tt></font> 
|-
|<font color="blue"><tt>Cell Wet/Dry Depth </tt></font> <font color="red"><tt>== </tt></font> 
|<font color="blue"><tt>SX ZC Check </tt></font> <font color="red"><tt>== </tt></font> 
|-
|<font color="blue"><tt>Read GIS XP Nodes </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>SX Storage Approach </tt></font> <font color="red"><tt>== </tt></font>
|-
|<font color="blue"><tt>Simulations Log Folder </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>HX ZC Check </tt></font> <font color="red"><tt>== </tt></font>
|-
|<font color="blue"><tt>Store Maximums and Minimums </tt></font> <font color="red"><tt>== </tt></font>
|<font color="blue"><tt>Mass Balance Corrector </tt></font> <font color="red"><tt>== </tt></font>
|-
|<font color="blue"><tt>Mass Balance Output </tt></font> <font color="red"><tt>== </tt></font> 
|}
<li> Make the following updates:
{|class="wikitable" style="width: 50%;"
! Original Command
! Updated Command
|-
|<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>OFF</tt></font>
|<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\check\</tt></font>
|-
| <font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\results\Output </tt></font>
|<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\results\</tt></font>
|-
| <font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>log\Log </tt></font>
|<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>log</tt></font>
|-
| <font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>XMDF </tt></font>
|<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>XMDF TIF</tt></font>
|}
<li> Add the following simulation time and output commands:<br>
<font color="blue"><tt>GIS Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>GPKG </tt></font> <font color="green"><tt> ! Specify GPKG as the output format for all GIS files</tt></font><br>
<font color="blue"><tt>Start Time </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>0 </tt></font> <font color="green"><tt> ! Specifies the simulation start time (0 hours) </tt></font><br>
<font color="blue"><tt>End Time </tt></font> <font color="red"><tt>== </tt></font> 2  <font color="green"><tt> ! Specifies the simulation end time (2 hours)</tt></font><br>
<font color="blue"><tt>NetCDF Output Start Date </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> 2014-01-01 00:00  </tt></font> <font color="green"><tt>! SWMM start date / time</tt></font><br>
<font color="blue"><tt>TIF Map Output Interval </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>0 </tt></font> <font color="green"><tt> ! Outputs only maximums for grids</tt></font><br>

<li> Add the following command to reference the TUFLOW SWMM Control File (TSCF):<br>
<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\1D2D_Urban_001.tscf</tt></font> <font color="green"><tt>! Reference the SWMM (1D) Control File</tt></font>
<li> 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).<br>
<font color="blue"><tt>Solution Scheme </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>HPC </tt></font> <font color="green"><tt> ! Heavily Parallelized Compute, uses adaptive timestepping</tt></font><br>
<font color="blue"><tt>Hardware </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>GPU </tt></font> <font color="green"><tt> ! Use NVIDIA GPU card for accelerated compute. Set to CPU if GPU is not available </tt></font><br> 

<li> 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.<br>
<font color="blue"><tt>Tutorial Model </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>ON </tt></font> <font color="green"><tt> ! Required command to run this tutorial model licence free</tt></font>

<li> Save the TCF. 
{|class="wikitable" 
! Original TCF
! Updated TCF
|- style="vertical-align:top; width: 90%;" 
| style="text-align:right;" | [[File: XPSWMM_to_TUFLOW_original_TCF_01a.png]]
| style="text-align:left;" | [[File: XPSWMM_to_TUFLOW_updated_TCF_01b.png]]
|}
</ol>
<br>


{{Tips Navigation
|uplink=[[XPSWMM_Conversion_TUFLOW_Control_File_Formatting_Archive | Continue to Next Step: "Format TUFLOW Control Files"]]</u>
}}
{{Tips Navigation
|uplink=[[XPSWMM_to_TUFLOW-SWMM_Archive#TUFLOW_Control_File_Updates| Back to Main XPSWMM to TUFLOW Conversion Page]]
}}