Difference between revisions of "XPSWMM Conversion TUFLOW Control File (TCF)"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
The TCF file references all the control files, specifies time and output controls.<br> | The TCF file references all the control files, specifies time and output controls.<br> | ||
| − | In the <u>[[ | + | In the <u>[[XPSWMM_Conversion_TUFLOW_Structure | Convert XPSWMM Model to Recommended TUFLOW Structure]]</u> section, the <u>[[Convert_TUFLOW_Model_GIS_Format |Convert TUFLOW Model GIS Format]]</u> 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.<br> |
| − | In the prior | + | In the prior sections, 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. |
<ol> | <ol> | ||
| − | <li> Remove or comment out the commands | + | <li> In Windows File Explorer, navigate to the '''TUFLOW\runs''' folder and open the TCF into a Text Editor (Notepad++ is recommended). |
| + | <li> Remove or comment out the following commands. They are either irrelevant to the model or represent default settings in TUFLOW, thus rendering them unnecessary. | ||
{| | {| | ||
| − | |style="width: 50%"| <font color="blue"><tt>Check MI Save Date </tt></font> <font color="red"><tt>== </tt></font> | + | |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>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>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>CSV Time </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>HOURS </tt></font> |
|- | |- | ||
|<font color="blue"><tt>MI Projection Check </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>Viscosity Formulation </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>SMAGORINSKY </tt></font> |
|- | |- | ||
|<font color="blue"><tt>Timestep (s) </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>Viscosity Coefficient </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>0.500, 0.050 </tt></font> |
|- | |- | ||
| − | |<font color="blue"><tt>Cell Wet/Dry Depth </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="black"><tt>0.002000 </tt></font> |
| − | |<font color="blue"><tt>SX ZC Check </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>Read GIS XP Nodes </tt></font> <font color="red"><tt>== </tt></font> | ||
| Line 35: | Line 36: | ||
|} | |} | ||
<li> Make the following updates: | <li> Make the following updates: | ||
| − | {|class="wikitable" | + | {|class="wikitable" style="width: 50%;" |
! Original Command | ! Original Command | ||
! Updated Command | ! Updated Command | ||
|- | |- | ||
| − | |<font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1D2D_Urban_001_proj</tt></font> | + | | style="width: 50%" | <font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1D2D_Urban_001_proj</tt></font> |
| − | |<font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>??</tt></font> | + | | style="width: 50%" | <font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>??</tt></font> |
|- | |- | ||
|<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>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>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\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>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="black"><tt>log\Log </tt></font> |
|<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>log</tt></font> | |<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>log</tt></font> | ||
|- | |- | ||
| − | |<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>qVdhZ0 </tt></font> | + | | <font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>qVdhZ0 </tt></font> |
|<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>q V d h Z0</tt></font> | |<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>q V d h Z0</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 </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> | |<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>XMDF TIF</tt></font> | ||
|} | |} | ||
Revision as of 14:12, 15 February 2024
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 sections, 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.
- In Windows File Explorer, navigate to the TUFLOW\runs folder and open the TCF into a Text Editor (Notepad++ is recommended).
- Remove or comment out the following commands. They are either irrelevant to the model or represent default settings 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 == - 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 - 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
- Add the following command to reference the TUFLOW SWMM Control File (TSCF):
SWMM Control File == ..\model\1D2D_Urban_001.tscf - Save the TCF.
Video
| Up |
|---|
 Back to XPSWMM to TUFLOW Conversion Page
|