Tuflow - User contributions [en]

TUFLOW Version Backward Compatibility

2026-03-31T02:23:35Z

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

=Backward Compatibility Change Register=

For backward compatibility and release notes, please see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] 

=Frequently Asked Questions (FAQ)=
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the [[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]] page in addition to this answer. 
In addition to the above, there are reasons why model results would be different between different TUFLOW releases, whether it is the Classic or HPC solver, as follows:
* General improvements and fine-tuning of the solution scheme, especially for the more complex hydraulic physical terms and situations such as: sub-grid turbulence representation; treatment of shocks (e.g. hydraulic jumps); and transitioning between sub-critical and super-critical flow on steep slopes.
* Some new functionality can cause a significant change in results. For example:
** Sub-Grid Sampling (SGS) applied to an existing model that used a too coarse cell resolution in high flow areas of highly variable topography (relative to the 2D cell size). SGS will greatly improve the model's ability to convey water accurately in these situations with vastly improved results.
** New default sub-grid turbulence scheme in the 2020 release of TUFLOW HPC that is cell size independent and allows modellers to use cell sizes much smaller than the flow depth across all scales from flume to large rivers. For more information on differences between Smagorinsky scheme (HPC releases up to 2020) and the Wu turbulence scheme (2020 onwards) see [[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]].
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
**improved data pre-processing approaches such as sampling materials on cell mid-sides instead of cell centres,
** and many others.
** For backward compatibility the <tt>Defaults</tt> <tt>== </tt> command is available to run old models on new releases to replicate past results (note, sometimes full backward compatibility cannot be catered for due to different code compiler and updates that can't be reverted, especially for several releases earlier).
* New features that use GIS attributes previously reserved (i.e. unused). If these attributes were not populated with the recommended “reserved” value (usually 0 or blank), then they can cause unpredictable results in later releases.
* Bug fixes noting that most bug fixes are input/output related and rarely affect the model's hydraulic calculations.
* Change in timestepping can also produce a small change in results. HPC uses the Runge-Kutta 4th order integrator, which is usually fairly insensitive to time step provided the model is running stably. However when a region is filled by flow that only just overtops an embankment, a 10 mm difference in water levels upstream of the embankment can create a much larger difference in levels downstream. Hence, small differences in time-stepping (along with many other aspects of model setup) can trigger local differences in model results.
* Model orientation (if changed) could also mean slight change in results. This is mostly given by interpolating values from different calculation points. Every cell has nine calculation points. Based on the model origin, all or most of the calculation points would have different topography elevation sampled, which translates to slightly different results.
* If using 1D channel, possibly different cells have been selected as HX boundary and might have different elevations. This can be reviewed in [[Check_Files_1d_to_2d_bc | 1d_to_2d check file]].

Generally, there should not be substantial differences as the fundamental equations being solved are unchanged and TUFLOW Classic and HPC solvers have always solved all the physical terms using a 2nd order spatial approach. The one exception is the turbulence (eddy viscosity) representation, which is the most complex and challenging to solve of all the physical terms (many 2D schemes simply omit this term). If significant differences (>10% of depth change across the whole model) are observed then it’s most likely due to the first four dot points above. To identify in which release(s) the significant changes occurred, the model can be run with the latest build and for past releases. The changes for each release are documented in their release notes. Past releases and release notes are all available [https://www.tuflow.com/downloads/tuflow-classichpc-archive/. here]. Once the exact release where the changes occurred is tracked down, individual features can be turned off to narrow down the cause. 

The recommendation is usually for new or reworked models to use the newest build to take advantage of the latest features and enhancements, some level of calibration might be required for reworked models. The new TUFLOW executable is not different from the previous ones in the meaning that any existing model should be re-calibrated if there are available calibration data. However, particularly if a model is already calibrated, using prior builds of TUFLOW or winding back default settings using <tt>Defaults</tt> <tt>== </tt> command is considered reasonable for established models that are to be used for minor tasks where an update of the model would not be cost effective. 

== How can differences in model results between TUFLOW builds be investigated? ==
Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in [[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F | Why are model results developed in an older release different to a newer release?]].

The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable build, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original build that would have been used to initially produce results.
* This may be particularly relevant when a model has been externally supplied, for example from a government body.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer build, along with a relevant <tt>Defaults</tt> <tt>== </tt> command (e.g. <tt>Defaults</tt> <tt>== </tt> Pre 2011 when the original build was 2010-10).
* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
<li> Run the original model with the newer build, and without the <tt>Defaults</tt> <tt>== </tt> command.
* This is more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
<li> Iteratively run the original model with the newer build, stepping through the different release version options for <tt>Defaults</tt> <tt>== </tt> command.
* This will allow the modeller to investigate and isolate what changes to TUFLOW builds may be affecting results, and when changes appear.
* Then, individually reverting settings that make up a Default group (see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]).
* This can help isolate the primary drivers for any differences in results.
* The [https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog] accompanying build releases are also a key reference.
<li> Develop new improved or updated model version, with the newer build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later build, a good quality assurance check that changes are behaving as expected.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW Version Backward Compatibility

2026-03-31T02:19:23Z

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

=Backward Compatibility Change Register=

For backward compatibility and release notes, please see Section 18 of the TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html] 

=Frequently Asked Questions (FAQ)=
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the [[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]] page in addition to this answer. 
In addition to the above, there are reasons why model results would be different between different TUFLOW releases, whether it is the Classic or HPC solver, as follows:
* General improvements and fine-tuning of the solution scheme, especially for the more complex hydraulic physical terms and situations such as: sub-grid turbulence representation; treatment of shocks (e.g. hydraulic jumps); and transitioning between sub-critical and super-critical flow on steep slopes.
* Some new functionality can cause a significant change in results. For example:
** Sub-Grid Sampling (SGS) applied to an existing model that used a too coarse cell resolution in high flow areas of highly variable topography (relative to the 2D cell size). SGS will greatly improve the model's ability to convey water accurately in these situations with vastly improved results.
** New default sub-grid turbulence scheme in the 2020 release of TUFLOW HPC that is cell size independent and allows modellers to use cell sizes much smaller than the flow depth across all scales from flume to large rivers. For more information on differences between Smagorinsky scheme (HPC releases up to 2020) and the Wu turbulence scheme (2020 onwards) see [[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]].
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
**improved data pre-processing approaches such as sampling materials on cell mid-sides instead of cell centres,
** and many others.
** For backward compatibility the <tt>Defaults</tt> <tt>== </tt> command is available to run old models on new releases to replicate past results (note, sometimes full backward compatibility cannot be catered for due to different code compiler and updates that can't be reverted, especially for several releases earlier).
* New features that use GIS attributes previously reserved (i.e. unused). If these attributes were not populated with the recommended “reserved” value (usually 0 or blank), then they can cause unpredictable results in later releases.
* Bug fixes noting that most bug fixes are input/output related and rarely affect the model's hydraulic calculations.
* Change in timestepping can also produce a small change in results. HPC uses the Runge-Kutta 4th order integrator, which is usually fairly insensitive to time step provided the model is running stably. However when a region is filled by flow that only just overtops an embankment, a 10 mm difference in water levels upstream of the embankment can create a much larger difference in levels downstream. Hence, small differences in time-stepping (along with many other aspects of model setup) can trigger local differences in model results.
* Model orientation (if changed) could also mean slight change in results. This is mostly given by interpolating values from different calculation points. Every cell has nine calculation points. Based on the model origin, all or most of the calculation points would have different topography elevation sampled, which translates to slightly different results.
* If using 1D channel, possibly different cells have been selected as HX boundary and might have different elevations. This can be reviewed in [[Check_Files_1d_to_2d_bc | 1d_to_2d check file]].

Generally, there should not be substantial differences as the fundamental equations being solved are unchanged and TUFLOW Classic and HPC solvers have always solved all the physical terms using a 2nd order spatial approach. The one exception is the turbulence (eddy viscosity) representation, which is the most complex and challenging to solve of all the physical terms (many 2D schemes simply omit this term). If significant differences (>10% of depth change across the whole model) are observed then it’s most likely due to the first four dot points above. To identify in which release(s) the significant changes occurred, the model can be run with the latest build and for past releases. The changes for each release are documented in their release notes. Past releases and release notes are all available [https://www.tuflow.com/downloads/tuflow-classichpc-archive/. here]. Once the exact release where the changes occurred is tracked down, individual features can be turned off to narrow down the cause. 

The recommendation is usually for new or reworked models to use the newest build to take advantage of the latest features and enhancements, some level of calibration might be required for reworked models. The new TUFLOW executable is not different from the previous ones in the meaning that any existing model should be re-calibrated if there are available calibration data. However, particularly if a model is already calibrated, using prior builds of TUFLOW or winding back default settings using <tt>Defaults</tt> <tt>== </tt> command is considered reasonable for established models that are to be used for minor tasks where an update of the model would not be cost effective. 

== How can differences in model results between TUFLOW builds be investigated? ==
Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in [[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F | Why are model results developed in an older release different to a newer release?]].

The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable build, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original build that would have been used to initially produce results.
* This may be particularly relevant when a model has been externally supplied, for example from a government body.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer build, along with a relevant <tt>Defaults</tt> <tt>== </tt> command (e.g. <tt>Defaults</tt> <tt>== </tt> Pre 2011 when the original build was 2010-10).
* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
<li> Run the original model with the newer build, and without the <tt>Defaults</tt> <tt>== </tt> command.
* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
<li> Iteratively run the original model with the newer build, stepping through the different release version options for <tt>Defaults</tt> <tt>== </tt> command.
* This will allow the modeller to investigate and isolate what changes to TUFLOW builds may be affecting results, and when changes appear.
* Then, individually reverting settings that make up a Default group (see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]).
* This can help isolate the primary drivers for any differences in results.
* The [https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog] that accompanying build releases are also a key reference.
<li> Develop new improved or updated model version, with the newer build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later build, a good quality assurance check that changes are behaving as expected.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW Version Backward Compatibility

2026-03-31T02:18:45Z

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

=Backward Compatibility Change Register=

For backward compatibility and release notes, please see Section 18 of the TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html] 

=Frequently Asked Questions (FAQ)=
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the [[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]] page in addition to this answer. 
In addition to the above, there are reasons why model results would be different between different TUFLOW releases, whether it is the Classic or HPC solver, as follows:
* General improvements and fine-tuning of the solution scheme, especially for the more complex hydraulic physical terms and situations such as: sub-grid turbulence representation; treatment of shocks (e.g. hydraulic jumps); and transitioning between sub-critical and super-critical flow on steep slopes.
* Some new functionality can cause a significant change in results. For example:
** Sub-Grid Sampling (SGS) applied to an existing model that used a too coarse cell resolution in high flow areas of highly variable topography (relative to the 2D cell size). SGS will greatly improve the model's ability to convey water accurately in these situations with vastly improved results.
** New default sub-grid turbulence scheme in the 2020 release of TUFLOW HPC that is cell size independent and allows modellers to use cell sizes much smaller than the flow depth across all scales from flume to large rivers. For more information on differences between Smagorinsky scheme (HPC releases up to 2020) and the Wu turbulence scheme (2020 onwards) see [[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]].
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
**improved data pre-processing approaches such as sampling materials on cell mid-sides instead of cell centres,
** and many others.
** For backward compatibility the <tt>Defaults</tt> <tt>== </tt> command is available to run old models on new releases to replicate past results (note, sometimes full backward compatibility cannot be catered for due to different code compiler and updates that can't be reverted, especially for several releases earlier).
* New features that use GIS attributes previously reserved (i.e. unused). If these attributes were not populated with the recommended “reserved” value (usually 0 or blank), then they can cause unpredictable results in later releases.
* Bug fixes noting that most bug fixes are input/output related and rarely affect the model's hydraulic calculations.
* Change in timestepping can also produce a small change in results. HPC uses the Runge-Kutta 4th order integrator, which is usually fairly insensitive to time step provided the model is running stably. However when a region is filled by flow that only just overtops an embankment, a 10 mm difference in water levels upstream of the embankment can create a much larger difference in levels downstream. Hence, small differences in time-stepping (along with many other aspects of model setup) can trigger local differences in model results.
* Model orientation (if changed) could also mean slight change in results. This is mostly given by interpolating values from different calculation points. Every cell has nine calculation points. Based on the model origin, all or most of the calculation points would have different topography elevation sampled, which translates to slightly different results.
* If using 1D channel, possibly different cells have been selected as HX boundary and might have different elevations. This can be reviewed in [[Check_Files_1d_to_2d_bc | 1d_to_2d check file]].

Generally, there should not be substantial differences as the fundamental equations being solved are unchanged and TUFLOW Classic and HPC solvers have always solved all the physical terms using a 2nd order spatial approach. The one exception is the turbulence (eddy viscosity) representation, which is the most complex and challenging to solve of all the physical terms (many 2D schemes simply omit this term). If significant differences (>10% of depth change across the whole model) are observed then it’s most likely due to the first four dot points above. To identify in which release(s) the significant changes occurred, the model can be run with the latest build and for past releases. The changes for each release are documented in their release notes. Past releases and release notes are all available [https://www.tuflow.com/downloads/tuflow-classichpc-archive/. here]. Once the exact release where the changes occurred is tracked down, individual features can be turned off to narrow down the cause. 

The recommendation is usually for new or reworked models to use the newest build to take advantage of the latest features and enhancements, some level of calibration might be required for reworked models. The new TUFLOW executable is not different from the previous ones in the meaning that any existing model should be re-calibrated if there are available calibration data. However, particularly if a model is already calibrated, using prior builds of TUFLOW or winding back default settings using <tt>Defaults</tt> <tt>== </tt> command is considered reasonable for established models that are to be used for minor tasks where an update of the model would not be cost effective. 

== How can differences in model results between TUFLOW builds be investigated? ==
Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in [[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F | Why are model results developed in an older release different to a newer release?]].

The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable Build, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original Build that would have been used to initially produce results.
* This may be particularly relevant when a model has been externally supplied, for example from a government body.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer Build, along with a relevant <tt>Defaults</tt> <tt>== </tt> command (e.g. <tt>Defaults</tt> <tt>== </tt> Pre 2011 when the original Build was 2010-10).
* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
<li> Run the original model with the newer Build, and without the <tt>Defaults</tt> <tt>== </tt> command.
* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
<li> Iteratively run the original model with the newer Build, stepping through the different release version options for <tt>Defaults</tt> <tt>== </tt> command.
* This will allow the modeller to investigate and isolate what changes to TUFLOW Builds may be affecting results, and when changes appear.
* Then, individually reverting settings that make up a Default group (see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]).
* This can help isolate the primary drivers for any differences in results.
* The [https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog] that accompanying Build releases are also a key reference.
<li> Develop new improved or updated model version, with the newer Build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later Build, a good quality assurance check that changes are behaving as expected.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW Version Backward Compatibility

2026-03-27T02:33:12Z

Pavlina Monhartova: /* How can differences in model results between TUFLOW Builds be investigated? */

=Backward Compatibility Change Register=

==Default changes post 2017-09 Build==
 
'''For changes in defaults post the 2017-09 build, see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].'''
 
==Default changes pre 2017-09 Build==
 

{|class="wikitable"

|-
|colspan="3"|'''2017-09-XX Builds'''
|-

| rowspan=6|2017-09-AA
| New SX boundaries defaults.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2017</tt> if similar results are required to the 2016-03-AE release. 
|-
| XF files are now being processed for boundaries.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2017</tt> or use <tt>XF Files Boundaries</tt> <tt>== </tt><tt>OFF</tt> if similar results are required to the 2016-03-AE release. 
|-
|Regions in 2d_bc layers now applied as regions (previously only cell over region centroid selected).
|No backward compatible workaround provided. 
|-
|Material IL and CL now applied to gridded rainfall (previously not applied).
|No backward compatible workaround provided.
|-
|SA regions now always select a 2D cell even if there are no cell centres falling within the region (previously a SA region would not select any cell if no cell centres fell within the region).
|No backward compatible workaround provided. 
|-
|If using “<tt>Reveal 1D Nodes</tt> <tt>==</tt><tt> ON</tt>”, “<tt>Time Series Output Interval</tt> <tt>==</tt> ” must be specified.
|No backward compatible workaround provided. 
|-

|-
|colspan="3"|'''2016-03-XX Builds'''
|-

| rowspan=7|2016-03-AA
| New operational 1D structure defaults.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| Primary upstream and downstream 1D channels now correctly take into account bed slope.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| A new layered 2D FC calculation method has been implemented.
| Set <tt>Layered FLC Default Approach </tt> <tt>== </tt><tt>CUMULATE</tt> or use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| The SX Flow Distribution Cutoff Depth has been raised to 0.005m from 0.0m.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> or use <tt>SX Flow Distribution Cutoff Depth </tt> <tt>== </tt><tt>0.0</tt> if similar results are required to the 2013-12-AC release. 
|-
|The End After Maximum tolerance has been increased to 0.001m from 0.0m.
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
|A new ERROR message has been added to cross-check the 1D timestep is a multiple of the timestep for all 2D domains.
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
|WARNING 2460 has been escalated to an ERROR and stricter command line syntax rules have been introduced ("=" will now return an ERROR message if TUFLOW is expecting "<tt>==</tt>")
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-

| rowspan=1|2016-03-AD
| The treatment of the eddy viscosity term in the GPU Solver has been enhanced with slightly improved results in areas of rapidly changing velocity patterns.
| Set <tt>GPU Viscosity Method </tt> <tt>== </tt><tt>Method A</tt> or use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> to achieve the same results as Build 2013-12-AC and prior.
|-

|-
|colspan="3"|'''2013-12-XX Builds'''
|-

| rowspan=1|2013-12-AA
| New default settings – see <tt>Defaults </tt> <tt>==</tt><tt> PRE 2013-12</tt> in the user manual for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2013-12</tt> if similar results are required to the 2012-05 release.
|-

| rowspan=1|2013-12-AC
| The default setting for Link 2D2D Approach has changed.
| Set <tt>Link 2D2D Approach </tt> <tt>== </tt><tt>METHOD B</tt> to achieve the same results as Builds 2013-12-AA and 2013-12-AB. See Link 2D2D Approach for more information.

|-
|colspan="3"| '''2011-09-XX and 2012-05-XX Builds'''
|-

| rowspan=2| 2012-05-AA
| New default settings – see <tt>Defaults </tt> <tt>== </tt><tt>PRE 2012-05</tt> for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2012-05</tt> if similar results are required to the 2011-09 or 2010-10 releases.
|-
| The approach to the sizing of automatic manholes and the application of losses has been enhanced.
| Set <tt>Manhole Approach </tt> <tt>== </tt><tt>Method A</tt> to achieve the same results as Build 2011-09-AA.
|-

| rowspan=1| 2011-09-AA
| The optimised compiler code is treated differently for Single Precision builds producing slightly different results (fractions of a mm) for some models.
| No workaround.
|-

|-
|colspan="3"| '''2010-10-XX Builds'''
|-

| rowspan=4| 2010-10-AA
| New Intel Fortran Compiler version produces slightly different results (usually fractions of a mm).
| No workaround.
|-
| w32 and w64 versions will give slightly different results for the same simulation.
| No workaround. Use the same platform (w32 or w64) for all simulations. Use Model Platform to force which platform should be used.
|-
| New default settings – see <tt>Defaults </tt> <tt>== </tt><tt> PRE 2010-10</tt> for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2010-10</tt> if similar results are required to the 2008-08 or 2009 07 releases.
|-
| Generation of TINs for polygons in Read GIS Shape layers is more robust and uses an improved approach. In rare cases, the TIN would fail and TUFLOW would abort the start-up.
| No workaround.
|-

|-
|colspan="3"| '''2008-08-XX and 2009-07-XX Builds'''
|-

| rowspan=1| 2008-08-AC
| The default setting for Shallow Depth Stability Factor has changed.
| Set <tt>Shallow Depth Stability Factor </tt> <tt>== </tt><tt> 3</tt> for models without direct rainfall to achieve the same results as Builds 2008-08-AA and 2008-08-AB. See Shallow Depth Stability Factor for more information.
|-

| rowspan=8| 2008-08-AA
|-
| Uses a new set of defaults for a number of commands (see Defaults ).
| The new defaults produce slightly different results, and very slight differences also occur between the three versions offered. For established models run using the 2007-07-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2008-08</tt> to use the default settings used by the 2007-07-XX builds. Testing of a range of models has shown zero change in results if <tt>Defaults </tt> <tt>== </tt><tt> PRE 2008-08</tt> switch is set, and the Compaq Fortran compiled version (cSP) is used. Each of the new default settings and their effects are discussed in the rows below.
|-
| The method for interpolating n values where the 2D Manning’s n varies with depth has been enhanced from a linear interpolation of the M (1/n) value to a spline interpolation of the n value. See Bed Resistance Depth Interpolation.
| Generally has little effect other than when the flow is predominantly in the depth range that the n value is varying. The new approach offers a smoother transition in n values from one depth to the other.
|-
| The default viscosity coefficient is now a combination of a 0.2 Smagorinsky and 0.1 constant coefficient, and there are some enhancements to the application of the viscosity term. See Viscosity Coefficient.
| This has slight effect for the majority of models. For fine grid models (<2m cell size) with low bed resistance and significant variations in velocity vectors the effect is more pronounced but is still slight.
|-
| Inertia and viscosity terms are now not transferred across dry cell sides when constructing the coefficients for the solution arrays. This was having the effect of generating a circulation on the other side of the wall (albeit a very weak one), which of course shouldn’t happen!
| Generally little effect, but can have some minor influence for urban models where buildings and fences are modelled as solid thin Z lines.
|-
| 1D weir flow has been improved as the water level difference across the weir approaches zero. The new method is more stable. See Weir Flow.
| Very little difference other than improved stability.
|-
| Incorporates minor improvements for transitioning between Regimes A and B, and between inlet and outlet controlled regimes, for circular culverts.
| Very little difference other than improved stability.
|-
| The new automatic selection of cells for 2D SX connections using the 1d_nwk Conn_1D_2D attribute may choose more than one 2D cell.
| Very little difference other than improved stability at the pit 2D connections.
|-

|-
|colspan="3"| '''2007-07-XX Builds'''
|-

| rowspan=12| 2007-07-AA
|-
| Uses a new set of defaults for a number of commands (see Defaults).
| The new defaults may produce slightly different results. For established models run using the 2006-06-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2007-07-AA</tt> to use the default settings used by the 2006-06-XX builds. Each of the new default settings and their affects are discussed in the rows below.
|-
| Change <tt>Zero Material Values to One </tt> <tt>== </tt><tt> OFF</tt> (previously ON)
| Will not cause different results if a <tt>Set Mat </tt> <tt>== </tt><tt> 1</tt> is specified before other material settings in the .tgc file, or if every cell has been assigned a material value.
|-
| <tt>Inside Region </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Testing thus far has not shown any difference between the two methods (other than the substantial gains in processing time of polygons).
|-
| <tt>Line Cell Selection </tt> <tt>== </tt><tt> Method D</tt> (previously Method C)
| May change results slightly, but improved stability and a smoother water levels along HX lines result.
|-
| <tt>VG Z Adjustment </tt> <tt>== </tt><tt> MAX ZC</tt> (previously ZC)
| May change results slightly, but stability should be significantly enhanced in some situations.
|-
| <tt>Bed Resistance Cell Sides </tt> <tt>== </tt><tt> INTERROGATE</tt> (previously AVERAGE M)
| Will influence results, usually slightly, but more pronounced where there are sudden changes in Manning’s n values such as in the urban environment.
|-
| <tt>Culvert Flow </tt> <tt>== </tt><tt> Method D</tt> (previously Method C)
<tt>Culvert Critical H/D </tt> <tt>== </tt><tt> OFF</tt> (previously <tt>Culvert Critical H/D </tt> <tt>== </tt><tt> 1.5</tt>)
| The most significant influences are the selection of upstream or downstream controlled regimes depending on the H/D ratio, and the bug fix relating to Regime E if <tt>Structure Losses </tt> <tt>== </tt><tt> ADJUST</tt>. Offers improved stability, better convergence for Regime C and smoother transitioning between some regimes.
|-
| Changed the setting of the default width (if eN1 < 0.001) of automatic weirs over R and C channels (i.e. RW and CW) to be the diameter/width multiplied by the number of culverts (previously, the width was not multiplied by the number of culverts).
| For backward compatibility, original weir width can be set by manually setting the eN1 attribute to the Diameter_or_Width attribute value of the culvert.
|-
| Bug fix that when using a restart file TUFLOW occasionally set the 2D FC bridge deck additional loss value incorrectly.
| No backward compatible workaround provided.
|-
| Bug fix that incorrectly set the water levels on dried VG cells (only applies to simulations with source inflows, e.g. SA or RF, somewhere within in the model).
| May cause slight changes in results. Backward compatibility provided if <tt>Defaults </tt> <tt>== </tt><tt> PRE 2007-07-AA</tt> is set (noting that setting this command reinstates the bug). This bug also causes the mass error calculations to falsely give a mass error that is not occurring.
|-
| Fixed bug that did not correctly apply the reduction in conveyance for a FC BD (bridge deck) of FD (floating deck) cell using the 2d_fc Mannings_n attribute.
| Backward compatibility applied if <tt>Defaults </tt> <tt>== </tt><tt>PRE 2007-07-AA</tt> is set, however, note that this reinstates the bug and the resistance to flow at FC BD and FD cells may need to be reviewed. Indications are that only minor changes in results occur. The flow area under 2D FC BD and FD cells is correctly calculated.

|-
|colspan="3"| '''2006-06-XX Builds'''
|-
| rowspan=16| 2006-06-AA
|-
| Uses a new set of defaults for a number of commands.
| The new defaults will produce different results. For established models run using the 2005-05-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt> PRE 2006-06-AA</tt> to use the previous default settings. Each of the new default settings and their affects are discussed in the rows below.
|-
| <tt>Cell Wet/Dry Depth </tt> <tt>== </tt><tt> 0.002</tt> (previously 0.05) and <tt>Cell Side Wet/Dry Depth </tt> <tt>== </tt><tt> 0.001</tt> (previously 0.03)
| The most pronounced effect of the shallower wet/dry depths is likely to occur in areas that are still filling at the flood peak, such as behind a levee that is only just overtopped. The shallower wet/dry depths provides a greater flow depth for a longer period over the levee.
|-
| <tt>Adjust Head at ESTRY Interface </tt> <tt>== </tt><tt> OFF</tt> (previously ON)
| Usually does not have a major influence on results except where very high velocities occur.
|-
| <tt>Boundary Cell Selection </tt> <tt>== </tt><tt> Method C</tt> (previously Method A) and <tt>Line Cell Selection </tt> <tt>== </tt><tt> Method C</tt> (previously Method A)
| May select slightly different cells along boundary/link lines. This may cause a difference where the line is along the top of levee, possibly creating a “hole” in embankment.
|-
| <tt>Viscosity Formulation </tt> <tt>== </tt><tt> Smagorinsky</tt> (previously Constant) and <tt>Viscosity Coefficient </tt> <tt>== </tt><tt> 0.2</tt> (previously 1.0)
| Can have a significant effect where the viscosity term is influential. This occurs where the friction term is less dominant (i.e. low Manning’s n and/or deeper water such as the lower, tidal, reaches of rivers).
|-
| <tt>Structure Losses </tt> <tt>== </tt><tt> ADJUST</tt> (previously FIX)
| Can have a significant affect in the vicinity of structures within a 1D network and for culvert networks. Does not affect 1D structures linked to a 2D domain or at the structure ends not connected to another 1D channel.
|-
| <tt>Storage Above Structure Obvert (%) </tt> <tt>== </tt><tt> 5</tt> (previously CHANNEL WIDTH)
| Usually negligible effect unless the model storage is predominantly within 1D closed sections (i.e. B, C and R channels). The 1D domain is likely to be more sensitive to instabilities due to the much smaller storage above the top of the closed sections, therefore, a smaller 1D timestep may be required and/or the Storage Above Structure Obvert (%) increased.
|-
| <tt>Depth Limit Factor </tt> <tt>== </tt><tt> 10</tt> (previously 1)
| No effect as previously the model would have become “unstable” as the trigger for an instability was the top of the channel/node.
|-
| <tt>Culvert Flow </tt> <tt>== </tt><tt> Method C</tt> (previously Method B)
| Usually only minor effects plus improved stability.
|-
| <tt>Culvert Add Dynamic Head </tt> <tt>== </tt><tt> ON</tt> (previously OFF)
| Minor influence.
|-
| <tt>Bridge Flow </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Negligible influence plus improved stability. However, note the different treatment of energy losses once the bridge deck obvert/soffit is submerged if a BG or LC table is specified.
|-
| <tt>WLL Approach </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Only affects the presentation of results. Note, that Method A is no longer recommended or supported.
|-
| <tt>Apply All Inverts </tt> <tt>== </tt><tt> ON</tt> (previously OFF)
Does not affect hydraulic calculations, however, if a Blank, B or W channel is now lowered/raised because the inverts are now used, this will affect results/stability - see note at end of Apply All Inverts).
|-
| <tt>Conveyance Calculation </tt> <tt>== </tt><tt> ALL PARALLEL</tt> (previously CHANGE IN RESISTANCE)
| Will affect results as ALL PARALLEL can be around 10% more “slippery” than CHANGE IN RESISTANCE. For calibrated or established models developed using build prior to Build 2006-06-AA , recommend setting to CHANGE IN RESISTANCE
|-
| <tt>Flow Calculation </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Negligible effect.

|-
|'''Builds prior to 2006-06-XX'''
| Contact [mailto:support@tuflow.com support@tuflow.com]
|
|}
 
=Frequently Asked Questions (FAQ)=
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the [[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]] page in addition to this answer. 
In addition to the above, there are reasons why model results would be different between different TUFLOW releases, whether it is the Classic or HPC solver, as follows:
* General improvements and fine-tuning of the solution scheme, especially for the more complex hydraulic physical terms and situations such as: sub-grid turbulence representation; treatment of shocks (e.g. hydraulic jumps); and transitioning between sub-critical and super-critical flow on steep slopes.
* Some new functionality can cause a significant change in results. For example:
** Sub-Grid Sampling (SGS) applied to an existing model that used a too coarse cell resolution in high flow areas of highly variable topography (relative to the 2D cell size). SGS will greatly improve the model's ability to convey water accurately in these situations with vastly improved results.
** New default sub-grid turbulence scheme in the 2020 release of TUFLOW HPC that is cell size independent and allows modellers to use cell sizes much smaller than the flow depth across all scales from flume to large rivers. For more information on differences between Smagorinsky scheme (HPC releases up to 2020) and the Wu turbulence scheme (2020 onwards) see [[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]].
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
**improved data pre-processing approaches such as sampling materials on cell mid-sides instead of cell centres,
** and many others.
** For backward compatibility the <tt>Defaults</tt> <tt>== </tt> command is available to run old models on new releases to replicate past results (note, sometimes full backward compatibility cannot be catered for due to different code compiler and updates that can't be reverted, especially for several releases earlier).
* New features that use GIS attributes previously reserved (i.e. unused). If these attributes were not populated with the recommended “reserved” value (usually 0 or blank), then they can cause unpredictable results in later releases.
* Bug fixes noting that most bug fixes are input/output related and rarely affect the model's hydraulic calculations.
* Change in timestepping can also produce a small change in results. HPC uses the Runge-Kutta 4th order integrator, which is usually fairly insensitive to time step provided the model is running stably. However when a region is filled by flow that only just overtops an embankment, a 10 mm difference in water levels upstream of the embankment can create a much larger difference in levels downstream. Hence, small differences in time-stepping (along with many other aspects of model setup) can trigger local differences in model results.
* Model orientation (if changed) could also mean slight change in results. This is mostly given by interpolating values from different calculation points. Every cell has nine calculation points. Based on the model origin, all or most of the calculation points would have different topography elevation sampled, which translates to slightly different results.
* If using 1D channel, possibly different cells have been selected as HX boundary and might have different elevations. This can be reviewed in [[Check_Files_1d_to_2d_bc | 1d_to_2d check file]].

Generally, there should not be substantial differences as the fundamental equations being solved are unchanged and TUFLOW Classic and HPC solvers have always solved all the physical terms using a 2nd order spatial approach. The one exception is the turbulence (eddy viscosity) representation, which is the most complex and challenging to solve of all the physical terms (many 2D schemes simply omit this term). If significant differences (>10% of depth change across the whole model) are observed then it’s most likely due to the first four dot points above. To identify in which release(s) the significant changes occurred, the model can be run with the latest build and for past releases. The changes for each release are documented in their release notes. Past releases and release notes are all available [https://www.tuflow.com/downloads/tuflow-classichpc-archive/. here]. Once the exact release where the changes occurred is tracked down, individual features can be turned off to narrow down the cause. 

The recommendation is usually for new or reworked models to use the newest build to take advantage of the latest features and enhancements, some level of calibration might be required for reworked models. The new TUFLOW executable is not different from the previous ones in the meaning that any existing model should be re-calibrated if there are available calibration data. However, particularly if a model is already calibrated, using prior builds of TUFLOW or winding back default settings using <tt>Defaults</tt> <tt>== </tt> command is considered reasonable for established models that are to be used for minor tasks where an update of the model would not be cost effective. 

== How can differences in model results between TUFLOW builds be investigated? ==
Running TUFLOW on a later Build from which it was originally calibrated will not necessarily produce the same results, as discussed in [[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F | Why are model results developed in an older release different to a newer release?]].

The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable Build, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original Build that would have been used to initially produce results.
* This may be particularly relevant when a model has been externally supplied, for example from a government body.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer Build, along with a relevant <tt>Defaults</tt> <tt>== </tt> command (e.g. <tt>Defaults</tt> <tt>== </tt> Pre 2011 when the original Build was 2010-10).
* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
<li> Run the original model with the newer Build, and without the <tt>Defaults</tt> <tt>== </tt> command.
* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
<li> Iteratively run the original model with the newer Build, stepping through the different release version options for <tt>Defaults</tt> <tt>== </tt> command.
* This will allow the modeller to investigate and isolate what changes to TUFLOW Builds may be affecting results, and when changes appear.
* Then, individually reverting settings that make up a Default group (see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]).
* This can help isolate the primary drivers for any differences in results.
* The [https://www.tuflow.com/downloads/tuflow-classichpc-archive/| archived release notes/change logs] that accompanying Build releases are also a key reference.
<li> Develop new improved or updated model version, with the newer Build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later Build, a good quality assurance check that changes are behaving as expected.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

TUFLOW Version Backward Compatibility

2026-03-27T02:32:49Z

Pavlina Monhartova: /* Frequently Asked Questions (FAQ) */

=Backward Compatibility Change Register=

==Default changes post 2017-09 Build==
 
'''For changes in defaults post the 2017-09 build, see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].'''
 
==Default changes pre 2017-09 Build==
 

{|class="wikitable"

|-
|colspan="3"|'''2017-09-XX Builds'''
|-

| rowspan=6|2017-09-AA
| New SX boundaries defaults.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2017</tt> if similar results are required to the 2016-03-AE release. 
|-
| XF files are now being processed for boundaries.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2017</tt> or use <tt>XF Files Boundaries</tt> <tt>== </tt><tt>OFF</tt> if similar results are required to the 2016-03-AE release. 
|-
|Regions in 2d_bc layers now applied as regions (previously only cell over region centroid selected).
|No backward compatible workaround provided. 
|-
|Material IL and CL now applied to gridded rainfall (previously not applied).
|No backward compatible workaround provided.
|-
|SA regions now always select a 2D cell even if there are no cell centres falling within the region (previously a SA region would not select any cell if no cell centres fell within the region).
|No backward compatible workaround provided. 
|-
|If using “<tt>Reveal 1D Nodes</tt> <tt>==</tt><tt> ON</tt>”, “<tt>Time Series Output Interval</tt> <tt>==</tt> ” must be specified.
|No backward compatible workaround provided. 
|-

|-
|colspan="3"|'''2016-03-XX Builds'''
|-

| rowspan=7|2016-03-AA
| New operational 1D structure defaults.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| Primary upstream and downstream 1D channels now correctly take into account bed slope.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| A new layered 2D FC calculation method has been implemented.
| Set <tt>Layered FLC Default Approach </tt> <tt>== </tt><tt>CUMULATE</tt> or use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
| The SX Flow Distribution Cutoff Depth has been raised to 0.005m from 0.0m.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> or use <tt>SX Flow Distribution Cutoff Depth </tt> <tt>== </tt><tt>0.0</tt> if similar results are required to the 2013-12-AC release. 
|-
|The End After Maximum tolerance has been increased to 0.001m from 0.0m.
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
|A new ERROR message has been added to cross-check the 1D timestep is a multiple of the timestep for all 2D domains.
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-
|WARNING 2460 has been escalated to an ERROR and stricter command line syntax rules have been introduced ("=" will now return an ERROR message if TUFLOW is expecting "<tt>==</tt>")
|Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release. 
|-

| rowspan=1|2016-03-AD
| The treatment of the eddy viscosity term in the GPU Solver has been enhanced with slightly improved results in areas of rapidly changing velocity patterns.
| Set <tt>GPU Viscosity Method </tt> <tt>== </tt><tt>Method A</tt> or use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2016</tt> to achieve the same results as Build 2013-12-AC and prior.
|-

|-
|colspan="3"|'''2013-12-XX Builds'''
|-

| rowspan=1|2013-12-AA
| New default settings – see <tt>Defaults </tt> <tt>==</tt><tt> PRE 2013-12</tt> in the user manual for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2013-12</tt> if similar results are required to the 2012-05 release.
|-

| rowspan=1|2013-12-AC
| The default setting for Link 2D2D Approach has changed.
| Set <tt>Link 2D2D Approach </tt> <tt>== </tt><tt>METHOD B</tt> to achieve the same results as Builds 2013-12-AA and 2013-12-AB. See Link 2D2D Approach for more information.

|-
|colspan="3"| '''2011-09-XX and 2012-05-XX Builds'''
|-

| rowspan=2| 2012-05-AA
| New default settings – see <tt>Defaults </tt> <tt>== </tt><tt>PRE 2012-05</tt> for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2012-05</tt> if similar results are required to the 2011-09 or 2010-10 releases.
|-
| The approach to the sizing of automatic manholes and the application of losses has been enhanced.
| Set <tt>Manhole Approach </tt> <tt>== </tt><tt>Method A</tt> to achieve the same results as Build 2011-09-AA.
|-

| rowspan=1| 2011-09-AA
| The optimised compiler code is treated differently for Single Precision builds producing slightly different results (fractions of a mm) for some models.
| No workaround.
|-

|-
|colspan="3"| '''2010-10-XX Builds'''
|-

| rowspan=4| 2010-10-AA
| New Intel Fortran Compiler version produces slightly different results (usually fractions of a mm).
| No workaround.
|-
| w32 and w64 versions will give slightly different results for the same simulation.
| No workaround. Use the same platform (w32 or w64) for all simulations. Use Model Platform to force which platform should be used.
|-
| New default settings – see <tt>Defaults </tt> <tt>== </tt><tt> PRE 2010-10</tt> for a list of the commands that have changed in their default setting.
| Set <tt>Defaults </tt> <tt>== </tt><tt>PRE 2010-10</tt> if similar results are required to the 2008-08 or 2009 07 releases.
|-
| Generation of TINs for polygons in Read GIS Shape layers is more robust and uses an improved approach. In rare cases, the TIN would fail and TUFLOW would abort the start-up.
| No workaround.
|-

|-
|colspan="3"| '''2008-08-XX and 2009-07-XX Builds'''
|-

| rowspan=1| 2008-08-AC
| The default setting for Shallow Depth Stability Factor has changed.
| Set <tt>Shallow Depth Stability Factor </tt> <tt>== </tt><tt> 3</tt> for models without direct rainfall to achieve the same results as Builds 2008-08-AA and 2008-08-AB. See Shallow Depth Stability Factor for more information.
|-

| rowspan=8| 2008-08-AA
|-
| Uses a new set of defaults for a number of commands (see Defaults ).
| The new defaults produce slightly different results, and very slight differences also occur between the three versions offered. For established models run using the 2007-07-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2008-08</tt> to use the default settings used by the 2007-07-XX builds. Testing of a range of models has shown zero change in results if <tt>Defaults </tt> <tt>== </tt><tt> PRE 2008-08</tt> switch is set, and the Compaq Fortran compiled version (cSP) is used. Each of the new default settings and their effects are discussed in the rows below.
|-
| The method for interpolating n values where the 2D Manning’s n varies with depth has been enhanced from a linear interpolation of the M (1/n) value to a spline interpolation of the n value. See Bed Resistance Depth Interpolation.
| Generally has little effect other than when the flow is predominantly in the depth range that the n value is varying. The new approach offers a smoother transition in n values from one depth to the other.
|-
| The default viscosity coefficient is now a combination of a 0.2 Smagorinsky and 0.1 constant coefficient, and there are some enhancements to the application of the viscosity term. See Viscosity Coefficient.
| This has slight effect for the majority of models. For fine grid models (<2m cell size) with low bed resistance and significant variations in velocity vectors the effect is more pronounced but is still slight.
|-
| Inertia and viscosity terms are now not transferred across dry cell sides when constructing the coefficients for the solution arrays. This was having the effect of generating a circulation on the other side of the wall (albeit a very weak one), which of course shouldn’t happen!
| Generally little effect, but can have some minor influence for urban models where buildings and fences are modelled as solid thin Z lines.
|-
| 1D weir flow has been improved as the water level difference across the weir approaches zero. The new method is more stable. See Weir Flow.
| Very little difference other than improved stability.
|-
| Incorporates minor improvements for transitioning between Regimes A and B, and between inlet and outlet controlled regimes, for circular culverts.
| Very little difference other than improved stability.
|-
| The new automatic selection of cells for 2D SX connections using the 1d_nwk Conn_1D_2D attribute may choose more than one 2D cell.
| Very little difference other than improved stability at the pit 2D connections.
|-

|-
|colspan="3"| '''2007-07-XX Builds'''
|-

| rowspan=12| 2007-07-AA
|-
| Uses a new set of defaults for a number of commands (see Defaults).
| The new defaults may produce slightly different results. For established models run using the 2006-06-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt>PRE 2007-07-AA</tt> to use the default settings used by the 2006-06-XX builds. Each of the new default settings and their affects are discussed in the rows below.
|-
| Change <tt>Zero Material Values to One </tt> <tt>== </tt><tt> OFF</tt> (previously ON)
| Will not cause different results if a <tt>Set Mat </tt> <tt>== </tt><tt> 1</tt> is specified before other material settings in the .tgc file, or if every cell has been assigned a material value.
|-
| <tt>Inside Region </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Testing thus far has not shown any difference between the two methods (other than the substantial gains in processing time of polygons).
|-
| <tt>Line Cell Selection </tt> <tt>== </tt><tt> Method D</tt> (previously Method C)
| May change results slightly, but improved stability and a smoother water levels along HX lines result.
|-
| <tt>VG Z Adjustment </tt> <tt>== </tt><tt> MAX ZC</tt> (previously ZC)
| May change results slightly, but stability should be significantly enhanced in some situations.
|-
| <tt>Bed Resistance Cell Sides </tt> <tt>== </tt><tt> INTERROGATE</tt> (previously AVERAGE M)
| Will influence results, usually slightly, but more pronounced where there are sudden changes in Manning’s n values such as in the urban environment.
|-
| <tt>Culvert Flow </tt> <tt>== </tt><tt> Method D</tt> (previously Method C)
<tt>Culvert Critical H/D </tt> <tt>== </tt><tt> OFF</tt> (previously <tt>Culvert Critical H/D </tt> <tt>== </tt><tt> 1.5</tt>)
| The most significant influences are the selection of upstream or downstream controlled regimes depending on the H/D ratio, and the bug fix relating to Regime E if <tt>Structure Losses </tt> <tt>== </tt><tt> ADJUST</tt>. Offers improved stability, better convergence for Regime C and smoother transitioning between some regimes.
|-
| Changed the setting of the default width (if eN1 < 0.001) of automatic weirs over R and C channels (i.e. RW and CW) to be the diameter/width multiplied by the number of culverts (previously, the width was not multiplied by the number of culverts).
| For backward compatibility, original weir width can be set by manually setting the eN1 attribute to the Diameter_or_Width attribute value of the culvert.
|-
| Bug fix that when using a restart file TUFLOW occasionally set the 2D FC bridge deck additional loss value incorrectly.
| No backward compatible workaround provided.
|-
| Bug fix that incorrectly set the water levels on dried VG cells (only applies to simulations with source inflows, e.g. SA or RF, somewhere within in the model).
| May cause slight changes in results. Backward compatibility provided if <tt>Defaults </tt> <tt>== </tt><tt> PRE 2007-07-AA</tt> is set (noting that setting this command reinstates the bug). This bug also causes the mass error calculations to falsely give a mass error that is not occurring.
|-
| Fixed bug that did not correctly apply the reduction in conveyance for a FC BD (bridge deck) of FD (floating deck) cell using the 2d_fc Mannings_n attribute.
| Backward compatibility applied if <tt>Defaults </tt> <tt>== </tt><tt>PRE 2007-07-AA</tt> is set, however, note that this reinstates the bug and the resistance to flow at FC BD and FD cells may need to be reviewed. Indications are that only minor changes in results occur. The flow area under 2D FC BD and FD cells is correctly calculated.

|-
|colspan="3"| '''2006-06-XX Builds'''
|-
| rowspan=16| 2006-06-AA
|-
| Uses a new set of defaults for a number of commands.
| The new defaults will produce different results. For established models run using the 2005-05-XX builds, use <tt>Defaults </tt> <tt>== </tt><tt> PRE 2006-06-AA</tt> to use the previous default settings. Each of the new default settings and their affects are discussed in the rows below.
|-
| <tt>Cell Wet/Dry Depth </tt> <tt>== </tt><tt> 0.002</tt> (previously 0.05) and <tt>Cell Side Wet/Dry Depth </tt> <tt>== </tt><tt> 0.001</tt> (previously 0.03)
| The most pronounced effect of the shallower wet/dry depths is likely to occur in areas that are still filling at the flood peak, such as behind a levee that is only just overtopped. The shallower wet/dry depths provides a greater flow depth for a longer period over the levee.
|-
| <tt>Adjust Head at ESTRY Interface </tt> <tt>== </tt><tt> OFF</tt> (previously ON)
| Usually does not have a major influence on results except where very high velocities occur.
|-
| <tt>Boundary Cell Selection </tt> <tt>== </tt><tt> Method C</tt> (previously Method A) and <tt>Line Cell Selection </tt> <tt>== </tt><tt> Method C</tt> (previously Method A)
| May select slightly different cells along boundary/link lines. This may cause a difference where the line is along the top of levee, possibly creating a “hole” in embankment.
|-
| <tt>Viscosity Formulation </tt> <tt>== </tt><tt> Smagorinsky</tt> (previously Constant) and <tt>Viscosity Coefficient </tt> <tt>== </tt><tt> 0.2</tt> (previously 1.0)
| Can have a significant effect where the viscosity term is influential. This occurs where the friction term is less dominant (i.e. low Manning’s n and/or deeper water such as the lower, tidal, reaches of rivers).
|-
| <tt>Structure Losses </tt> <tt>== </tt><tt> ADJUST</tt> (previously FIX)
| Can have a significant affect in the vicinity of structures within a 1D network and for culvert networks. Does not affect 1D structures linked to a 2D domain or at the structure ends not connected to another 1D channel.
|-
| <tt>Storage Above Structure Obvert (%) </tt> <tt>== </tt><tt> 5</tt> (previously CHANNEL WIDTH)
| Usually negligible effect unless the model storage is predominantly within 1D closed sections (i.e. B, C and R channels). The 1D domain is likely to be more sensitive to instabilities due to the much smaller storage above the top of the closed sections, therefore, a smaller 1D timestep may be required and/or the Storage Above Structure Obvert (%) increased.
|-
| <tt>Depth Limit Factor </tt> <tt>== </tt><tt> 10</tt> (previously 1)
| No effect as previously the model would have become “unstable” as the trigger for an instability was the top of the channel/node.
|-
| <tt>Culvert Flow </tt> <tt>== </tt><tt> Method C</tt> (previously Method B)
| Usually only minor effects plus improved stability.
|-
| <tt>Culvert Add Dynamic Head </tt> <tt>== </tt><tt> ON</tt> (previously OFF)
| Minor influence.
|-
| <tt>Bridge Flow </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Negligible influence plus improved stability. However, note the different treatment of energy losses once the bridge deck obvert/soffit is submerged if a BG or LC table is specified.
|-
| <tt>WLL Approach </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Only affects the presentation of results. Note, that Method A is no longer recommended or supported.
|-
| <tt>Apply All Inverts </tt> <tt>== </tt><tt> ON</tt> (previously OFF)
Does not affect hydraulic calculations, however, if a Blank, B or W channel is now lowered/raised because the inverts are now used, this will affect results/stability - see note at end of Apply All Inverts).
|-
| <tt>Conveyance Calculation </tt> <tt>== </tt><tt> ALL PARALLEL</tt> (previously CHANGE IN RESISTANCE)
| Will affect results as ALL PARALLEL can be around 10% more “slippery” than CHANGE IN RESISTANCE. For calibrated or established models developed using build prior to Build 2006-06-AA , recommend setting to CHANGE IN RESISTANCE
|-
| <tt>Flow Calculation </tt> <tt>== </tt><tt> Method B</tt> (previously Method A)
| Negligible effect.

|-
|'''Builds prior to 2006-06-XX'''
| Contact [mailto:support@tuflow.com support@tuflow.com]
|
|}
 
=Frequently Asked Questions (FAQ)=
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the [[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]] page in addition to this answer. 
In addition to the above, there are reasons why model results would be different between different TUFLOW releases, whether it is the Classic or HPC solver, as follows:
* General improvements and fine-tuning of the solution scheme, especially for the more complex hydraulic physical terms and situations such as: sub-grid turbulence representation; treatment of shocks (e.g. hydraulic jumps); and transitioning between sub-critical and super-critical flow on steep slopes.
* Some new functionality can cause a significant change in results. For example:
** Sub-Grid Sampling (SGS) applied to an existing model that used a too coarse cell resolution in high flow areas of highly variable topography (relative to the 2D cell size). SGS will greatly improve the model's ability to convey water accurately in these situations with vastly improved results.
** New default sub-grid turbulence scheme in the 2020 release of TUFLOW HPC that is cell size independent and allows modellers to use cell sizes much smaller than the flow depth across all scales from flume to large rivers. For more information on differences between Smagorinsky scheme (HPC releases up to 2020) and the Wu turbulence scheme (2020 onwards) see [[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]].
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
**improved data pre-processing approaches such as sampling materials on cell mid-sides instead of cell centres,
** and many others.
** For backward compatibility the <tt>Defaults</tt> <tt>== </tt> command is available to run old models on new releases to replicate past results (note, sometimes full backward compatibility cannot be catered for due to different code compiler and updates that can't be reverted, especially for several releases earlier).
* New features that use GIS attributes previously reserved (i.e. unused). If these attributes were not populated with the recommended “reserved” value (usually 0 or blank), then they can cause unpredictable results in later releases.
* Bug fixes noting that most bug fixes are input/output related and rarely affect the model's hydraulic calculations.
* Change in timestepping can also produce a small change in results. HPC uses the Runge-Kutta 4th order integrator, which is usually fairly insensitive to time step provided the model is running stably. However when a region is filled by flow that only just overtops an embankment, a 10 mm difference in water levels upstream of the embankment can create a much larger difference in levels downstream. Hence, small differences in time-stepping (along with many other aspects of model setup) can trigger local differences in model results.
* Model orientation (if changed) could also mean slight change in results. This is mostly given by interpolating values from different calculation points. Every cell has nine calculation points. Based on the model origin, all or most of the calculation points would have different topography elevation sampled, which translates to slightly different results.
* If using 1D channel, possibly different cells have been selected as HX boundary and might have different elevations. This can be reviewed in [[Check_Files_1d_to_2d_bc | 1d_to_2d check file]].

Generally, there should not be substantial differences as the fundamental equations being solved are unchanged and TUFLOW Classic and HPC solvers have always solved all the physical terms using a 2nd order spatial approach. The one exception is the turbulence (eddy viscosity) representation, which is the most complex and challenging to solve of all the physical terms (many 2D schemes simply omit this term). If significant differences (>10% of depth change across the whole model) are observed then it’s most likely due to the first four dot points above. To identify in which release(s) the significant changes occurred, the model can be run with the latest build and for past releases. The changes for each release are documented in their release notes. Past releases and release notes are all available [https://www.tuflow.com/downloads/tuflow-classichpc-archive/. here]. Once the exact release where the changes occurred is tracked down, individual features can be turned off to narrow down the cause. 

The recommendation is usually for new or reworked models to use the newest build to take advantage of the latest features and enhancements, some level of calibration might be required for reworked models. The new TUFLOW executable is not different from the previous ones in the meaning that any existing model should be re-calibrated if there are available calibration data. However, particularly if a model is already calibrated, using prior builds of TUFLOW or winding back default settings using <tt>Defaults</tt> <tt>== </tt> command is considered reasonable for established models that are to be used for minor tasks where an update of the model would not be cost effective. 

== How can differences in model results between TUFLOW Builds be investigated? ==
Running TUFLOW on a later Build from which it was originally calibrated will not necessarily produce the same results, as discussed in [[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F | Why are model results developed in an older release different to a newer release?]].

The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable Build, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original Build that would have been used to initially produce results.
* This may be particularly relevant when a model has been externally supplied, for example from a government body.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer Build, along with a relevant <tt>Defaults</tt> <tt>== </tt> command (e.g. <tt>Defaults</tt> <tt>== </tt> Pre 2011 when the original Build was 2010-10).
* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
<li> Run the original model with the newer Build, and without the <tt>Defaults</tt> <tt>== </tt> command.
* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
<li> Iteratively run the original model with the newer Build, stepping through the different release version options for <tt>Defaults</tt> <tt>== </tt> command.
* This will allow the modeller to investigate and isolate what changes to TUFLOW Builds may be affecting results, and when changes appear.
* Then, individually reverting settings that make up a Default group (see Chapter 18 of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]).
* This can help isolate the primary drivers for any differences in results.
* The [https://www.tuflow.com/downloads/tuflow-classichpc-archive/| archived release notes/change logs] that accompanying Build releases are also a key reference.
<li> Develop new improved or updated model version, with the newer Build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later Build, a good quality assurance check that changes are behaving as expected.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

Flood Modeller Tutorial Model

2026-03-26T05:15:53Z

Pavlina Monhartova: /* Requirements and Downloads */

=Introduction=
The objective of the Flood Modeller - TUFLOW modules is to demonstrate how TUFLOW links to the external Flood Modeller 1D scheme and the methods available to create this link. They are designed to supplement existing documentation and assume prior knowledge of both Flood Modeller and TUFLOW software packages.

These modules were developed by BMT in collaboration with Jacobs. Comments, requests and feedback can be sent to [mailto:support@tuflow.com support@tuflow.com].

=Requirements and Downloads=
Both TUFLOW and Flood Modeller have modest system requirements for small models such as those used in these modules. Larger and more complex models, however, may require higher hardware specifications, particularly memory (RAM). The tutorial models are intentionally small to ensure quick simulation and load times, and should run on any modern PC or laptop capable of running Windows 10 or later.

TUFLOW models typically require access to a GIS package, a text editor, Microsoft Excel and a results viewer to build, review and visualise a model. A list of compatible packages is available on the TUFLOW Wiki. Flood Modeller can also be used as a graphical user interface for creating and editing GIS layers in a TUFLOW model, as well as for visualising results.

Instructions for Flood Modeller - TUFLOW modules are provided using the following GIS file formats:

* '''QGIS - SHP'''

* '''QGIS - GPKG'''

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-

| '''TUFLOW''' || TUFLOW is a computer program for simulating depth-averaged, one dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid of square elements. 

It is commonly used in the UK and Ireland, Australia and the United States for the modelling of surface waters, river systems and pipe networks. 

It is recommended to always use the latest release version of TUFLOW. 

This tutorial model does not require a TUFLOW licence. 

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be specified within the [https://docs.tuflow.com/classic-hpc/manual/2025.2/TCFCommands-1.html#tcfHardware Hardware] command. 
||The TUFLOW executable is provided within the [[Flood_Modeller_Tutorial_Model#Module_Data | Tutorial Dataset]].
|-

|'''Flood Modeller'''|| Flood Modeller (previously known as ISIS) is a commercial flood modelling package developed by Jacobs for simulating depth-averaged one and two dimensional free surface flows. It is primarily used for the simulation of river channels and is widely used within the UK and Ireland. This tutorial model will only leverage Flood Modeller’s 1D Solver. 
TUFLOW 1D and 2D domains can be dynamically linked to the 1D domain of Flood Modeller. Flood Modeller is not included within the TUFLOW executable and must be downloaded separately. 

Unlike TUFLOW Flood Modeller has a standalone Graphical User Interface which can be used to build networks, run models, and visualise results.

It is recommended that TUFLOW 2023-03-AA or later is used in conjunction with Flood Modeller Version 5 or later. [https://docs.tuflow.com/classic-hpc/manual/2025.2/OneD2DLinkingFM-2.html#fig:fig-FMTUFLOWVersionCompatability Figure 10.15] of the [https://docs.tuflow.com/classic-hpc/manual/2025.2/ 2025 TUFLOW manual] provides a list of compatibility between recent Flood Modeller and TUFLOW versions. 

For Flood Modeller Version 5 or later a Standard, Professional, or Unlimited Edition of Flood Modeller Pro is required to open and run the tutorial model.
||[https://www.floodmodeller.com/downloads/ Latest 64-bit version of Flood Modeller]. 
|-
| '''QGIS''' QGIS TUFLOW plugin || A Geographic Information System (GIS) used to build models and view results. This tutorial was developed with QGIS 3.20. It is recommended to have QGIS 3.20 or later to ensure compatibility with TUFLOW plugin latest features. 

The TUFLOW plugin includes numerous tools to increase workflow efficiency. 

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]].
|-
| '''NotePad++''' Syntax Highlighting || A text editor is required for creation of the TUFLOW input files. This tutorial was developed with NotePad++. Ideally a text editor should be able to: 
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. 
TUFLOW colour coding can be enabled using syntax highlighting.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. For instructions on configuring Notepad++ for TUFLOW modelling, see [[NotepadPlusPlus_Tips |Notepad++ tips]].
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||
|}

=Module Data=
To build the tutorial model, download one of the datasets below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. There are two formats available, Shapefile and GeoPackage. The GeoPackage format has been supported since the TUFLOW 2023-03 Release, for tips on its use see [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].

*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/QGIS_SHP_FMP_Tut_Model.zip QGIS SHP Download]
*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/QGIS_GPKG_FMP_Tut_Model.zip QGIS GPKG Download]

If would you like to download the tutorial model datasets for ArcGIS or MapInfo, these can be found on the [[Flood_Modeller_Tutorial_Model_Archive | Archive Page]].

=Recommended Reading=
The aim of this tutorial is to demonstrate the steps undertaken to build, review and visualise the results of a linked Flood Modeller – TUFLOW model. It assumes that the user has a good understanding of both the 1D component of Flood Modeller and the 1D and 2D components of TUFLOW. The following resources may be of use:
*[[Tutorial_Introduction |TUFLOW Tutorial Model]]
*[https://docs.tuflow.com/classic-hpc/manual/2025.2/ TUFLOW Classic / HPC User Manual]
*[https://help.floodmodeller.com/docs/getting-started-with-1d-river-modelling Flood Modeller 1D Quick Start Guide]
*[https://help.floodmodeller.com/docs/technical-reference Flood Modeller Technical Reference]

=Modules=
The tutorial is presented over a series of modules, with each module offering the opportunity to run the model and review the results. Each of the modules builds upon the previous iteration with models developed in the previous module made available.

New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest. Results and check files are not included to keep the size of the download file manageable, but can be generated through the running of the simulations. The folder should be placed in a location with write permissions. The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to link Flood Modeller and TUFLOW.

:*[[ Flood_Modeller_Tutorial_Module01 | Flood Modeller Module 1]] - Linking Flood Modeller to TUFLOW

The second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of the first tutorial. The second tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
:*[[ Flood_Modeller_Tutorial_Module02 | Flood Modeller Module 2]] - Linking Flood Modeller to ESTRY

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

Flood Modeller Tutorial Model

2026-03-26T05:15:25Z

Pavlina Monhartova: /* Requirements and Downloads */

=Introduction=
The objective of the Flood Modeller - TUFLOW modules is to demonstrate how TUFLOW links to the external Flood Modeller 1D scheme and the methods available to create this link. They are designed to supplement existing documentation and assume prior knowledge of both Flood Modeller and TUFLOW software packages.

These modules were developed by BMT in collaboration with Jacobs. Comments, requests and feedback can be sent to [mailto:support@tuflow.com support@tuflow.com].

=Requirements and Downloads=
Both TUFLOW and Flood Modeller have modest system requirements for small models such as those used in these modules. Larger and more complex models, however, may require higher hardware specifications, particularly memory (RAM). The tutorial models are intentionally small to ensure quick simulation and load times, and should run on any modern PC or laptop capable of running Windows 10 or later.

TUFLOW models typically require access to a GIS package, a text editor, Microsoft Excel and a results viewer to build, review and visualise a model. A list of compatible packages is available on the TUFLOW Wiki. Flood Modeller can also be used as a graphical user interface for creating and editing GIS layers in a TUFLOW model, as well as for visualising results.

Instructions for Flood Modeller - TUFLOW modules are provided using the following GIS file formats:

* '''QGIS - SHP'''

* '''QGIS - GPKG'''

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-

| '''TUFLOW''' || TUFLOW is a computer program for simulating depth-averaged, one dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid of square elements. 

It is commonly used in the UK and Ireland, Australia and the United States for the modelling of surface waters, river systems and pipe networks. 

It is recommended to always use the latest release version of TUFLOW. 

This tutorial model does not require a TUFLOW licence. 

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be specified within the [https://docs.tuflow.com/classic-hpc/manual/2025.2/TCFCommands-1.html#tcfHardware Hardware] command. 
||The TUFLOW executable is provided within the [[Flood_Modeller_Tutorial_Model#Module_Data Tutorial Dataset]].
|-

|'''Flood Modeller'''|| Flood Modeller (previously known as ISIS) is a commercial flood modelling package developed by Jacobs for simulating depth-averaged one and two dimensional free surface flows. It is primarily used for the simulation of river channels and is widely used within the UK and Ireland. This tutorial model will only leverage Flood Modeller’s 1D Solver. 
TUFLOW 1D and 2D domains can be dynamically linked to the 1D domain of Flood Modeller. Flood Modeller is not included within the TUFLOW executable and must be downloaded separately. 

Unlike TUFLOW Flood Modeller has a standalone Graphical User Interface which can be used to build networks, run models, and visualise results.

It is recommended that TUFLOW 2023-03-AA or later is used in conjunction with Flood Modeller Version 5 or later. [https://docs.tuflow.com/classic-hpc/manual/2025.2/OneD2DLinkingFM-2.html#fig:fig-FMTUFLOWVersionCompatability Figure 10.15] of the [https://docs.tuflow.com/classic-hpc/manual/2025.2/ 2025 TUFLOW manual] provides a list of compatibility between recent Flood Modeller and TUFLOW versions. 

For Flood Modeller Version 5 or later a Standard, Professional, or Unlimited Edition of Flood Modeller Pro is required to open and run the tutorial model.
||[https://www.floodmodeller.com/downloads/ Latest 64-bit version of Flood Modeller]. 
|-
| '''QGIS''' QGIS TUFLOW plugin || A Geographic Information System (GIS) used to build models and view results. This tutorial was developed with QGIS 3.20. It is recommended to have QGIS 3.20 or later to ensure compatibility with TUFLOW plugin latest features. 

The TUFLOW plugin includes numerous tools to increase workflow efficiency. 

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]].
|-
| '''NotePad++''' Syntax Highlighting || A text editor is required for creation of the TUFLOW input files. This tutorial was developed with NotePad++. Ideally a text editor should be able to: 
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. 
TUFLOW colour coding can be enabled using syntax highlighting.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. For instructions on configuring Notepad++ for TUFLOW modelling, see [[NotepadPlusPlus_Tips |Notepad++ tips]].
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||
|}

=Module Data=
To build the tutorial model, download one of the datasets below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. There are two formats available, Shapefile and GeoPackage. The GeoPackage format has been supported since the TUFLOW 2023-03 Release, for tips on its use see [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].

*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/QGIS_SHP_FMP_Tut_Model.zip QGIS SHP Download]
*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/QGIS_GPKG_FMP_Tut_Model.zip QGIS GPKG Download]

If would you like to download the tutorial model datasets for ArcGIS or MapInfo, these can be found on the [[Flood_Modeller_Tutorial_Model_Archive | Archive Page]].

=Recommended Reading=
The aim of this tutorial is to demonstrate the steps undertaken to build, review and visualise the results of a linked Flood Modeller – TUFLOW model. It assumes that the user has a good understanding of both the 1D component of Flood Modeller and the 1D and 2D components of TUFLOW. The following resources may be of use:
*[[Tutorial_Introduction |TUFLOW Tutorial Model]]
*[https://docs.tuflow.com/classic-hpc/manual/2025.2/ TUFLOW Classic / HPC User Manual]
*[https://help.floodmodeller.com/docs/getting-started-with-1d-river-modelling Flood Modeller 1D Quick Start Guide]
*[https://help.floodmodeller.com/docs/technical-reference Flood Modeller Technical Reference]

=Modules=
The tutorial is presented over a series of modules, with each module offering the opportunity to run the model and review the results. Each of the modules builds upon the previous iteration with models developed in the previous module made available.

New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest. Results and check files are not included to keep the size of the download file manageable, but can be generated through the running of the simulations. The folder should be placed in a location with write permissions. The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. This tutorial is ideal for those starting to learn how to link Flood Modeller and TUFLOW.

:*[[ Flood_Modeller_Tutorial_Module01 | Flood Modeller Module 1]] - Linking Flood Modeller to TUFLOW

The second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of the first tutorial. The second tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.
:*[[ Flood_Modeller_Tutorial_Module02 | Flood Modeller Module 2]] - Linking Flood Modeller to ESTRY

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

HPC Introduction

2026-03-06T00:39:12Z

Pavlina Monhartova: /* Benefits of HPC */

=Introduction=
As of TUFLOW build 2017-09-AA, TUFLOW offers HPC (Heavily Parallelised Compute) as an alternate 2D Shallow Water Equation (SWE) solver to TUFLOW Classic. Whereas TUFLOW Classic is limited to running a simulation on a single CPU core, HPC provides parallelisation of the TUFLOW model allowing modellers to run a single TUFLOW model across multiple CPU cores or GPU graphics cards (which utilise thousands of smaller CUDA* cores). Simulations using GPU hardware has shown to provide significantly quicker model run times for TUFLOW users. 

In general, most of the functionality and features of TUFLOW Classic are available in HPC. Additionally, HPC offers several advanced features not supported in Classic, including:
* Quadtree and sub-grid sampling
* High resolution map output grids
* Groundwater infiltration and sub-surface flows
* Wu turbulence formulation
* TMR bridge inputs (2d_bg)

===Solution Scheme, Cell Discretisation and Parallelisation===
TUFLOW HPC is an explicit solver for the full 2D Shallow Water Equations (SWE), including a sub-grid scale eddy viscosity model. The scheme is both volume and momentum conserving, is 2nd order in space and 4th order in time, with adaptive or fixed timestepping. It is unconditionally stable. TUFLOW HPC's computational approach differs from TUFLOW Classic, which is a 2nd order (space) implicit finite difference solver. Both TUFLOW HPC and Classic solve the 2D SWE on the same uniform Cartesian grid configuration. Computationally each 2D cell includes 9 sub-grid points. 

[[File: HPC Cell Design.PNG |300px]] 

The ZC point:
* Defines the volume of active water (cell volume is based on a flat square cell that wets and dries at a height of ZC plus the Cell Wet/Dry Depth);
* Controls when a cell becomes wet and dry (note that cell sides can also wet and dry); and
* Determines the bed slope when testing for the upstream controlled flow regime.
The ZU and ZV points:
* Control how water is conveyed from one cell to another;
* Represent where the momentum equation terms are centred and where upstream controlled flow regimes are applied;
* Deactivate if the cell has dried (based on the ZC point) and cannot flow; and
* Wet and dry independently of the cell wetting or drying (see Cell Wet/Dry Depth). This allows for the modelling of “thin” obstructions such as fences and thin embankments relative to the cell size (eg. a concrete levee).
ZH points:
* Play no role hydraulically. This point location is used for output processing;
* The only elevations written to the SMS .2dm mesh file (by default, binary output is interpolated/extrapolated to the cell corners).

Within the above sub-grid framework, using TUFLOW HPC time derivatives of cell averaged water depth, u-velocity and v-velocity are computed on a cell-by-cell basis and the model evolved using an explicit ODE solver. Calculation of the cell based derivatives are highly independent of each other making it possible to run this solution scheme across multiple processors or GPU cards. Parallelisation is done by breaking up the model into vertical ribbons. Each ribbon of the model is run on a different processor (or GPU card) with boundary information shared between processors at each timestep. 

[[File: Mesh_Ribbon_Splitting.png |360px]] 

===Mass Conservation and Timestep===

The explicit finite volume solution scheme utilised in HPC is mass conserving by construction (0% mass error). This differs to TUFLOW Classic, which can continue to simulate a model with some volume error due to it being an implicit finite difference scheme. The stability of the explicit finite volume scheme used in TUFLOW HPC is linked to the timestep, flow velocities, water depth, and eddy viscosity. The maximum timestep that can be used while maintaining model stability changes as the model evolves. While it is possible to choose a fixed timestep ahead of time (similarly to TUFLOW Classic), shorter run times and guaranteed model stability from start to finish may be achieved through the use of adaptive timestepping where the solver continually modifies the timestep based on various stability criteria. This is explained in more detail in our [[HPC_Adaptive_Timestepping | Adaptive Timestepping]] page. 

===Compatible Graphic Cards (GPU) ===
TUFLOW HPC’s GPU hardware module is only compatible with NVIDIA architecture CUDA enabled GPU cards. AMD GPU cards are NOT compatible. A list of CUDA enabled GPUs can be found on the following website: http://developer.nvidia.com/cuda-gpus .
To check if your computer has an NVIDA GPU and if it is CUDA enabled:
* Right click on the Windows desktop;
* If you see “NVIDIA Control Panel” or “NVIDIA Display” in the pop up dialogue, the computer has an NVIDIA GPU;
* Click on “NVIDIA Control Panel” or “NVIDIA Display” in the pop up dialogue;
* The GPU model should be displayed in the graphics card information;
* Check to see if the graphics card is listed on the following website: http://developer.nvidia.com/cuda-gpus
On the NVIDA website each CUDA enabled graphics card has a “Compute Capability” listed. For cards with a compute capability of 1.2 or less, only the single precision version of the GPU Module can be utilised. However, benchmarking has indicated that the double precision version is NOT required and that the TUFLOW_iSP exe should be used for all TUFLOW HPC GPU simulations. Extensive GPU hardware benchmarking has been undertaken to assist users who are upgrading hardware for TUFLOW modelling. Over 50 different hardware options have been tested for their speed performance. The results are provided on the [[Hardware_Benchmarking | Hardware Benchmarking]] page.

===Benefits of HPC===
So what does this mean for modellers? 
By providing the ability to run models on Graphics Cards, we can achieve significantly shorter model run times, increasing our modelling capabilities to be able to run continuous hydraulic models, with higher cell resolution, across larger extents and more scenarios. Common TUFLOW HPC applications include:
* Monte Carlo design assessments
* Rainfall ensemble design assessments
* High resolution 1D underground / 2D above ground integrated urban drainage
* High resolution floodplain lumped hydrology / hydraulic modelling (either fully 2D or including nested 1D open channels and pipes)
* Whole of catchment direct rainfall
* Flood forecast modelling
* Long-term water resource management modelling

The unconditional stability and higher order accuracy of TUFLOW HPC also lends itself well to highly transient situations, such as dam break assessments, where other solvers would either become unstable, lose accuracy or experience impractical simulation slow-down due to the need to solve at an extremely small timestep. 
 
{{Tips Navigation
|uplink=[[ HPC_Modelling_Guidance | Back to HPC Modelling Guidance]]
}}

User Guide Free Demo

2026-02-23T23:01:51Z

Pavlina Monhartova:

This section is relevant for people who are trialing TUFLOW without a licence. Please refer to [[User_Guide_Local_Licences|Local Licence User Guide]] or [[New_User_Guide_Network_Software_Licences|Network Licence New User Guide]] if you have a licence.
<ol>
<li> Download the latest TUFLOW executable from the TUFLOW website: [http://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]. TUFLOW is a standalone console application. As such, it doesn't require installation to run.
<li> Download the TUFLOW Tutorial Dataset: [https://downloads.tuflow.com/Training/Wiki/Wiki_Tutorial_Models_QGIS.zip Tutorial Dataset]
<li> User documentation is available from the [[Tutorial_Introduction | Tutorial Model Introduction]] section of the Wiki. Learn how to use TUFLOW by following the user documentation.
<li> Run TUFLOW using any of the options listed in the [[Running_TUFLOW | Running TUFLOW ]] section of the Wiki.
<li> After gaining an understanding of TUFLOW through the tutorial model dataset you may be interested in developing some of your own models for testing. A free Demo option is included within the standard TUFLOW executable. The free Demo version is fully enabled, though has the following limits:
:*100,000 total cells and 30,000 active (potentially flooded) cells
:*100 1D channels
:*There can on be is only one 2D domain (multiple 2D domains are not supported)
:*A simulation time of 10 minutes.
The free Demo mode is called using the TUFLOW Control File (TCF) command: <tt>Demo Model </tt> <tt>== </tt><tt>ON</tt> 
<li> Over 60 example models demonstrating the most commonly used TUFLOW features are available from the [[TUFLOW_Example_Models | Example Models]] section of the Wiki. These models call the Demo mode mentioned above, and as such don't require a licence to run. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for further supporting information.
<li> Other useful information is contained in the Wiki. In particular new users often find the [[Main_Page | Tips and Tricks]] section on the right-hand side of the home page and the [[TUFLOW_Modelling_Guidance | Modelling Guidance]] sections particularly useful.
<li> If you're interested in becoming a part of the TUFLOW User Community please join the [http://www.linkedin.com/groups/1908583 LinkedIn User Group].
<li> Please email [mailto:support@tuflow.com support@tuflow.com] if you have any technical questions or [mailto:sales@tuflow.com sales@tuflow.com] if you would like to purchase a licence. Price information is available from the [https://www.tuflow.com/Prices.aspx TUFLOW Website]
</ol>

User Guide Local Licences

2026-02-23T23:01:33Z

Pavlina Monhartova:

This section is relevant for people with a Local TUFLOW licence. Please refer to [[User_Guide_Free_Demo|Free DEMO Version New User Guide]] if you don't have a licence or [[New_User_Guide_Network_Software_Licences|Network Licence New User Guide]] if you have a Network licence.

<ol>
<li> Download the latest TUFLOW executable from the TUFLOW website: [http://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]. TUFLOW is a standalone console application. As such, it doesn't require installation to run.
<li> Plug your new Local licence dongle into your computer.
<li> Download and install the Licencing Dongle Drivers (CodeMeter RunTime Kit): [[Wibu_Dongles|Installing Licensing Software]]
<li> Follow the steps listed in the [[WIBU_Licence_Update_Request | Licence Update Request]] section of the Wiki. You will need to email the licence file to [mailto:sales@tuflow.com sales@tuflow.com]. The sales team with email you an updated licence file containing your specific licence configuration.
<li> Import the updated licence file to accept the licence update ([[WIBU_Licence_Update_Import|Licence Update Import]]).
<li> After activating your licence, insert your Local licence dongle into your computer (if it isn't already). Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe). A console window should open. Review the licence information listed. Check the licence types and numbers. 
[[File:TUFLOW_DOS_Test1.JPG|600px]] 
Press enter to close the console window. 
''Note: Local TUFLOW licences are associated with the USB dongle. All computers running TUFLOW must have Licencing Dongle Drivers (CodeMeter RunTime Kit) installed and the USB dongle plugged in for a simulation to initialise. The Licence Update Request should only be required once annually to update the USB dongle licence and provide access to new updated versions of TUFLOW.''
<li> You are now ready to start TUFLOW modelling.
<li> Download the TUFLOW Tutorial Dataset: [https://downloads.tuflow.com/Training/Wiki/Wiki_Tutorial_Models_QGIS.zip Tutorial Dataset]
<li> User documentation is available from the [[Tutorial_Introduction | Tutorial Model Introduction]] section of the Wiki. Learn how to use TUFLOW by following the user documentation.
<li> Run TUFLOW using any of the options listed in the [[Running_TUFLOW | Running TUFLOW ]] section of the Wiki.
<li> Over 60 example models demonstrating the most commonly used TUFLOW features are available from the [[TUFLOW_Example_Models | Example Models]] section of the Wiki. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for further supporting information.
<li> Other useful information is contained in the Wiki. In particular new users often find the [[Main_Page | Tips and Tricks]] section on the right-hand side of the home page and the [[TUFLOW_Modelling_Guidance | Modelling Guidance]] sections particularly useful.
<li> If you're interested in becoming a part of the TUFLOW User Community please join the [http://www.linkedin.com/groups/1908583 LinkedIn User Group].
<li> Please email [mailto:support@tuflow.com support@tuflow.com] if you have any technical questions or [mailto:sales@tuflow.com sales@tuflow.com] if you would like to purchase additional licences or add-on modules. Price information is available from the [https://www.tuflow.com/Prices.aspx TUFLOW Website]
</ol>

Check Files 2d bcc check

2026-02-04T01:44:35Z

Pavlina Monhartova:

This GIS layer contains more information on the 2D boundaries in the TUFLOW simulation. 
This includes both external 2D boundaries (for example HT or QT boundaries) as well as 1D/2D boundaries (HX or SX). 
'''Note:''' The SA (source area) boundaries are not included in this check file. See the [[Check_Files_2d_sac | 2d_sac check file]] for these boundaries.
 
 
'''Attributes of bcc_check''' 
{| align="center" class="wikitable" width="75%"
! style="background-color:#005581; font-weight:bold; color:white;"| Attribute Name
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Attribute Description
|-
| Type||The boundary type as described in the 2D Boundaries section of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].
|-
| Flags||The boundary flags as described in the 2D Boundaries section of the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].
|-
| Domain_Name||The model domain, this is useful for multiple domain models. For single domain models this will be set to "Domain_001".
|-
| Source||The boundary number and GIS file. For example: 
<tt>BC000018: HX BC in "D:\Tutorial\TUFLOW\model\gis\2d_bc_M04_001_L.shp"</tt>
|}
 
In the image below, a 2d _bcc_check file is shown with different boundary types styled with different colours. 
 
[[File:Check files bcc check.JPG]] 
 

{{Tips Navigation
|uplink=[[TUFLOW_Check_Files | TUFLOW Check Files]]
}}

TUFLOW crashing

2026-01-21T23:25:58Z

Pavlina Monhartova: /* Console window lists all licences and model doesn't run */

=Introduction=
From time to time TUFLOW simulations can crash. There are multiple reasons why it could happen. This page can be used as a guide to find and rectify the cause of the crash. 
 

=Troubleshooting Tips=
* Use the latest TUFLOW release available at the [https://www.tuflow.com/downloads/ TUFLOW website].
* If using GPU, update the graphics card driver to the latest version from the [https://www.nvidia.com/Download/index.aspx Nvidia website].
* Restart the modelling machine.
* Check the end of .tlf file for an error message.
* Test running the model on a different machine.
* Save all outputs (checks, results and logs) to a local drive and use TUFLOW executable saved on a local drive to determine if network is causing the issue.
* Monitor if the issue is happening to a single model only or every model, at specific time during the simulation or randomly.
 

=How to keep simulation console window open=
The simulation console window can display errors not written to the .tlf file and often provides additional information useful for troubleshooting:

* To ensure the console window remains open, add pause at the end of the batch file and remove any Start "TUFLOW", -b, or -t switches. If the console window still closes, use a simplified batch file like the example below.

"C:\TUFLOW\Releases\2020-10-AD\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"
pause

:The simulation console window is the one that displays the TUFLOW build (e.g. "TUFLOW Build: 2025.0.3-iSP-w64") in the top-left corner of the window header, as shown in the image below.
:[[File:TUFLOW Simulation Console with Build Info Displayed.png|frameless|600x600px]]

:If start "TUFLOW" is included in the batch file, the console window will instead show "C:\WINDOWS\system32\cmd.exe" in the window header and will not display the desired simulation output, as shown below.
:[[File:Batch File Console Showing CMD Header Only.png|frameless|600x600px]]

* Or, let the console window be written to a text file. This will redirect console output messages as well as the standard error stream to the “dump.txt” file, and it will likely record more error information than the usual .tlf file.
<pre>"C:\TUFLOW\Releases\2020-10-AD\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf" > dump.txt</pre>

=Simulation console window flashes and disappears=
When batch file is double clicked and the simulation DOW window flashes and disappears the problem might be in the filepath of the TUFLOW executable or incorrect syntax. 
'''Suggestions''':
* Check the TUFLOW executable can be found with the specified filepath (absolute or relative).
* Double click the executable, this performs a licence check and console window appears. If it doesn't, move the executable to a location where it is permitted to run. Some locations on C drive might be restricted for some users preventing to execute the simulation.
* TUFLOW doesn't run from a batch file if the filepaths are specified as UNC paths. The folder with both, the executable and the model, must be opened with a mapped drive. Type "net use <drive>: \\server_name\share_name" in the command line to map the drives.
* If using environment variable 'set exe', confirm there are no spaces surrounding the equals sign (e.g. set exe="..\..\..\..\exe\2020-10-AD\TUFLOW_iSP_w64.exe").
* Write 'pause' at the end of the script, rerun the batch file and the console window should remain open providing more information
 

=TCF does not exist=
The .tcf name or the filepath is incorrect or not supported. 
'''Suggestions:'''
* Check the name of the .tcf file and filepath (absolute or relative) is correct.
* TUFLOW doesn't run from a batch file if the filepaths are specified as UNC paths. The folder with both, the executable and the model, must be opened with a mapped drive. Type "net use <drive>: \\server_name\share_name" in the command line to map the drives.
* If your TCF file reference contains any special characters (e.g. é, ë, ä, ö… etc) you may find that TUFLOW does not find the TCF path. The best way to fix this is to make sure the batch file content (the text) and the console are using the same encoding so that the correct characters are being passed to TUFLOW. This can be achieved by using a text editor like Notepad++ to make sure the text is encoded in a chosen format (e.g. UTF-8), then using the <code>chcp [code]</code> command in the batch file to set the encoding to be identical. An example using UTF-8 is shown below. In Windows, UTF-8 has the code page code = 65001, so at the top of the batch file, set the code page to 65001 to tell the console window what encoding to expect.
<ol><pre>
chcp 65001
TUFLOW.exe -b spëcial.tcf
</pre>
</ol>
 

=TUFLOW crashes during model initialisation=
'''Causes''':
*Erroneous input data or an error in the control files. It might be captured as standard TUFLOW error or as a Fortran compiler error leaving more information only in the console window.
*If multiple large models are initialising at the same time, this could cause a memory overload and stop the simulations.
'''Suggestions:'''
* Model input errors:
** Open the .tlf. The control file/GIS layer written just above the error should be the cause of the issue. Check the file/GIS layer for any unusual setup.
* Memory overload:
** Display "Peak working set (memory)" in the Task Manager to confirm memory overload, it is not displayed by default.
** Insert "timeout xxx" in the batch file between the runs to space out the model most memory demanding initialisation parts, where xxx is a number of seconds to wait for the next run to start.
* If you need further help, send the .tlf, .hpc.tlf and [[TUFLOW_crashing#How_to_keep_simulation_console_window_open | snapshot of the console window]] to [mailto:support@tuflow.com support@tuflow.com].
 

=TUFLOW crashes randomly at any time during simulation=
'''Causes''':
* The modelling machine loses connection to the network when writing any outputs to a network drive and/or using TUFLOW executable located on a network drive. There could be no message box when this happens or a message box stating that TUFLOW.exe has stopped working. Nothing error related will be written to the .tlf file. If multiple models were running simultaneously, all unfinished models would crash. This applies to Windows 10, 8, 7 operating system. With Windows XP, the simulation would only pause and restart itself when the access to the network drive is back on. The difference in the behaviour is unfortunately based on the operating system and as far as we are aware we are unable to do anything within the TUFLOW code to handle this situation.
* The output drive might not have enough free space seemingly crashing at random time (at any map output interval).
* Something might be preventing the simulation from writing to network drive such as scheduled backup, updates, restart, deduplication or other scheduled processes. This would often happen at the similar time during the day or week seemingly stopping TUFLOW simulations at random simulation time. TUFLOW is not releasing the licence at the end of the simulation, rather CodeMeter system is determining that the TUFLOW application is no longer running and is therefore releasing the licence. This would show as “Handle xxx automatically released. The application is no longer available.” in the [[WIBU_create_cmDust | cmDust file]].
'''Suggestions''':
* Unstable network:
** Use TUFLOW executable saved on a local drive.
** Set a local drive as the output drive for all checks, results and logs. This can be done using <tt>Output Drive</tt> command in the .tcf. All outputs can be copied back to the network drive at the simulation end if required. Robocopy can be added to the end of the .bat file, example [[TUFLOW_crashing#Robocopy_example_to_automatically_copy_outputs_on_network_drive_after_model_runs | here]]. 
* Insufficient storage:
** Ensure storage locations that outputs are written to have enough free space. Depending on the infrastructure, reported free space may not be accurate, or performance of storage may substantially degrade as it nears being full.

*Other processes:
** Check with IT whether such processes are occurring and if reasonable limits/preferences/priorities can be set to reduce resource use (disk/network), to allow other processes to run in parallel.
** Run models locally if it is known the runs will coincide with such processes.
* If you need further help, send the .tlf, .hpc.tlf and [[TUFLOW_crashing#How_to_keep_simulation_console_window_open | snapshot of the console window]] to [mailto:support@tuflow.com support@tuflow.com].
 

=TUFLOW crashes at the end of the simulation before writing out maximum results=
The output drive might not have enough free space to write out the full results. If multiple TUFLOW simulations run in parallel, the free space might be filling up faster than expected. There can also be other processes filling up the drive, e.g. other software, backups, other users copying data. The target drive should never be filled to the brim, as performance will suffer for all processes. 
'''Suggestions:'''
* Ensure storage locations that outputs are written to have enough free space. Depending on the infrastructure, reported free space may not be accurate, or performance of storage may substantially degrade as it nears being full.
* If you need further help, send the .tlf, .hpc.tlf and [[TUFLOW_crashing#How_to_keep_simulation_console_window_open | snapshot of the console window]] to [mailto:support@tuflow.com support@tuflow.com].
 

=TUFLOW crashes trying to open _ All TUFLOW Simulations.log file=
This crash is often incorrectly believed to be caused by a licence issue as the .tlf file ends soon after listing the licences. If the last line in the .tlf is as below, the simulation has stopped because the user doesn't have write permissions to the _ All TUFLOW Simulations.log file or the directory hasn't been created yet. 
<pre>"Trying to open (A) file C:\<<log_directory>>\_ All TUFLOW Simulations.log...OK. File Unit: 904"</pre>
'''Suggestions''':
* Gain write permission to write to the folder from your IT staff.
* Change the default log location to somewhere where you already have write permissions with TCF command <tt>Simulations Log Folder </tt> <tt>== </tt> <tt><<folder>></tt>.
 

=TUFLOW can't find a valid licence=
Confirmation that licence is the issue can be mostly found in the .tlf.

==Unmaintained dongle==
Once a year (usually after mid-year) a new TUFLOW release will need the licence to be updated. This will show in the .tlf file as "Unmaintained since <year>". Follow [[WIBU_Licence_Update_Request | WIBU Licence Update Request]] to get the licence updated.

==Console window lists all licences and model doesn't run==
If the console window appears as shown below and ends with the line "Press ENTER to Release WIBU Licences", this indicates a licence check was performed. When a licence check is run, the TUFLOW model does not execute, and a .tlf file is not produced.

During the licence check, one licence from each available module is temporarily reserved. These are released either immediately by pressing Enter, or automatically after a few minutes when the console window is closed.

Once the licences are released by pressing Enter, the console window displays "Not licenced or no local licence free". This confirms that the licences are no longer reserved by the licence check and are available for running TUFLOW models.<ol> [[File: Licence_Check_2.png | 600px]]</ol>
The licence check is performed in the following situations:
* Double clicking a TUFLOW executable.
* Running a batch file that only specifies the TUFLOW executable.
* Running TUFLOW from Notepad++ with only the TUFLOW executable inserted into the Run function text box.
Suggestions to run a TUFLOW model:
* Include the model .tcf name in the batch file. See [[Running_TUFLOW | Running TUFLOW model]] for further guidance.
* Insert the full required text (example line below) into Notepad++ Run function text box. See [[NotepadPlusPlus_Run_TUFLOW | Running TUFLOW from Notepad++]] for further guidance.
<ol> "C:\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)" </ol>
* See detailed steps on how to run a TUFLOW model in the [[Tutorial_M01#Running_the_Simulation | Tutorial model]].

==Running very old TUFLOW releases==
When using an old legacy model with the original TUFLOW release there might be an error "Could not find standalone or network dongle server". Such version of TUFLOW can only run with the old blue softlok licence dongle. If only the metal Wibu dongle is available, DB version of the same year release can be used. We do have some of the old dongles still in possession and can rent it out if required. 
More information on TUFLOW licence dongles and which releases are affected: [[TUFLOW_Licensing | TUFLOW Licensing]]

==No TUFLOW dongle and licence settings files found (.lcf and .dcf)==
Some users might mistake this sentence in the .tlf file as there is an issue with the licence. The "No TUFLOW licence settings files found" sentence is followed by "Default settings applied" and the default settings are listed on the next three lines, e.g. WIBU Retry Time, WIBU Retry Count, WIBU Dongles Only. Only if these settings are required to be different, the licence control file (.lcf) or dongle control file (.dcf) would be required. Not having these licence files doesn't prevent TUFLOW from running, it would automatically use the default licence settings. The .tlf should continue past these lines and if there is an error, it would be written as the bottom of the .tlf.

==Technical licence issues==
[[Wibu_Dongles#Troubleshooting | Wibu Dongles Troubleshooting]] 
 

=Robocopy example to automatically copy outputs on network drive after model runs=
<pre>@echo off

set TUFLOWEXE_iSP=O:\TUFLOW\Releases\2020-01\2020-10-AA\TUFLOW_iSP_w64.exe
set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -b

set A=5m 2.5m
set B=EXG DEV
set source_results=D:\TUFLOW\results
set source_log=D:\TUFLOW\runs
set destination_results=O:\TUFLOW\support\results
set destination_log=O:\TUFLOW\support\runs

FOR %%a in (%A%) do (
FOR %%b in (%B%) do (
:: Run model
echo Running Cell Size %%a Model Scenario %%b
%RUN_iSP% -s1 %%a -s2 %%b M10_~s1~_~s2~_003.tcf

:: Move results folder to different location
robocopy "%source_results%" "%destination_results%" /e /move

:: Move log folder to different location
robocopy "%source_log%" "%destination_log%" /e /move
timeout 5
)
)
pause</pre>

{{Tips Navigation
|uplink=[[TUFLOW_Modelling_Guidance | Back to TUFLOW Modelling Guidance]]
}}

Tutorial M09

2026-01-09T04:52:28Z

Pavlina Monhartova: /* Variables (Optional) */

= Introduction =
In this module, event management is introduced. This is a powerful functionality running multiple event combinations (e.g. magnitude, duration, temporal patterns, climate change) using a single set of control files rather than creating a new set of control files for every simulation. This makes the management of the model easier, ensures consistency between the simulations and better quality control. Without implementing event management, six TCFs and six bc_dbase files are required to run this module, using event management, only one each is needed:

 
[[File:M09 EventManagement 01a.png]] Events are set up using a define event block in TUFLOW Event File (TEF) - <tt>Define Event</tt> command terminated by <tt>End Define</tt>.

Note: If Event logic can be added into most of TUFLOW’s control files where model inputs or parameters may vary between events. The only control files not supporting event logic are the TUFLOW Rainfall Control File (.trcf), TUFLOW External Stress File (.tesf), Advection Control File (.adcf) and within a Define Control command inside a TUFLOW Operational Control (.toc) file.

The TUFLOW control files are:
:*TUFLOW Events File (TEF): A database of TCF and ECF commands for different events. 

'''Module 9 builds from the model created in [[Tutorial_M02 | Module 2]]. The completed Module 2 model is provided in the Module_09\TUFLOW folder.'''

= Simulation Control Files =
=== TUFLOW Event File (TEF) ===
<ol>
<li>Navigate to the '''Module_09\Tutorial_Data''' folder. Copy the '''Event_File.tef''' in to the ''' Module_09\TUFLOW\runs''' folder.
<li>Open the TEF in a text editor. There are three event magnitudes and two event durations listed:
:*Event Magnitudes: 5% AEP, 2% AEP and 1% AEP
:*Event Durations: 1hr and 2hr
<li>The event specific commands are contained between the <tt>Define Event</tt> and <tt>End Define</tt> commands.
<li>The <tt>BC Event Source</tt> command is linked to the bc_dbase file. In the below examples, any occurrence of '~AEP~' in the bc_dbase is replaced with '05p' and any occurrence of '~DUR~' in the bc_dbase is replaced with '1hr'. 
<tt>! EVENT MAGNITUDES</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>05p</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~AEP~ | 05p</tt>
</ol><tt>End Define</tt> 
<tt>! EVENT DURATIONS</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>1hr</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~DUR~ | 1hr</tt>
</ol><tt>End Define</tt>
Note: The 'AEP' and 'DUR' are user defined variables. The 'AEP' refers to an event magnitude (Annual Exceedance Probability) and 'DUR' refers to an event duration. 
<li>TUFLOW reads all of the defined events in the TEF and selects the ones specified in the batch file. 
</ol>

=== TUFLOW Boundary Condition Database (bc_dbase) ===
Update the bc_dbase with event magnitude and event duration placeholders:
<ol>
<li>Navigate to the '''Module_09\Tutorial_Data''' folder. Copy and paste the following files to the ''' Module_09\TUFLOW\bc_dbase''' folder. These files contains the inflows for each event magnitude and duration.
:*05p1hr.csv
:*05p2hr.csv
:*02p1hr.csv
:*02p2hr.csv
:*01p1hr.csv
:*01p2hr.csv
<li>Save a copy of the '''bc_dbase.csv''' as '''bc_dbase_M09_001.csv'''.
<li>Open the file and make the following updates to the 'Source' column: 
 
[[File:M09 bc dbase 02.png]] 
 
<li>Save the bc_dbase.
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Save a copy of '''M02_5m_001.tcf''' as '''M09_5m_~e1~_~e2~_001.tcf''' in the '''Module_09\TUFLOW\runs''' folder.
<li>Open the file '''M09_5m_~e1~_~e2~_001.tcf''' in a text editor.
<li>Update the reference to the bc_dbase: 
<tt>BC Database </tt> <tt>== </tt> <tt> ..\bc_dbase\bc_dbase_M09_001.csv </tt> <tt> ! Reference the Boundary Conditions Database</tt> 
<li>Add the following command to reference the TEF at the end of the TCF: 
<tt>! EVENTS</tt> 
<tt>Event File </tt> <tt>== </tt> <tt> Event_File.tef </tt> <tt> ! Reference the TUFLOW Event File</tt> 
<li>Save the TCF.
</ol>
 

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_M09_HPC.bat''' in the '''Module_09\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''M09_5m_~e1~_~e2~_001.tcf''' and include event switches (-e1, -e2) defining event magnitude and event duration: 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.1.0\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 1hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 2hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 1hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 2hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 1hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 2hr M09_5m_~e1~_~e2~_001.tcf </tt> 
<li>Save the batch file and double click it in file explorer to run the simulation. 
</ol>
 

= Troubleshooting =
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]
 

= Check Files =
While the model is running, review the added features are specified correctly:
<ol>
<li>Open the '''M09_5m_05p_1hr_001.tlf''' from the '''Module_09\TUFLOW\runs\log''' folder in a text editor.
<li>The name of the events replaced the placeholders in the TCF name.
<li>Confirm the specified events and event sources: 
{{Video|name=Animation_M09_Check_01c.mp4|width=928}}
 
</ol>

=Results=
When the model is finished, review the results:
:*[[Tutorial_M09_Results_QGIS | QGIS]]
 

= Conclusion =

* Multiple events were set up in the TUFLOW Event File (TEF) with define event blocks.

*TUFLOW Log Files (TLF) were reviewed.
*Multiple event results were inspected using the TUFLOW Viewer.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
*Alternatively, see the [[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]] to explore the full list of TUFLOW features.
=Looping Batch File (Optional)=
Looping batch file is a powerful tool running large number of simulations with the least amount of batch file text:
<ol>
<li>Save a copy of '''_run_M09_HPC.bat''' as '''_run_M09_HPC_loop.bat''' in the '''Module_09\TUFLOW\runs''' folder.
<li>Add the following commands. Indentation is important in batch files, insert tabs to match the below spacing: 
<tt>echo </tt> <tt>off</tt> 
<tt>set </tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2025.1.0\TUFLOW_iSP_w64.exe"</tt> 
<tt>set </tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait </tt><tt>%exe%</tt><tt> -b</tt> 
 
<tt>set</tt> <tt> AEP</tt><tt>=</tt><tt>05p 02p 01p</tt> 
<tt>set</tt> <tt> DUR</tt><tt>=</tt><tt>1hr 2hr</tt> 
 
<tt>for </tt><tt>%%a</tt><tt> in </tt><tt>(</tt><tt>%AEP%</tt><tt>)</tt><tt> do </tt><tt>(</tt> 
<ol><tt> for </tt><tt>%%b</tt><tt> in </tt><tt>(</tt><tt>%DUR%</tt><tt>)</tt><tt> do </tt><tt>( </tt> 
<ol><ol><tt> echo </tt><tt>Running </tt><tt>%%a %%b </tt> 
<tt> %run% </tt><tt>-e1 </tt><tt>%%a</tt><tt> -e2 </tt><tt>%%b </tt><tt>M09_5m_~e1~_~e2~_001.tcf</tt> 
</ol></ol> ) 
</ol>) 
Note: The 'AEP' and 'DUR' are user defined batch file variables. The 'AEP' refers to an event magnitude (Annual Exceedance Probability) and 'DUR' refers to an event duration.

<li>Save the batch file and double click it in file explorer to run the simulation.
</ol>

= Variables (Optional) =
Variables provide a way to define values once and reuse them across control files, which helps manage models with multiple scenarios and events.

Scenarios and events are automatically available as variables. Variables can also be defined using the <tt>Set Variable </tt>command as described in Section 13.2.3 Variables of the TUFLOW manual. They are referenced by enclosing the variable name within << and >>.

Note: The <tt>Set Variable </tt>command can only be specified in the .tcf or within a read file (.trd) referenced from the .tcf. The variables can then be used in all control files (.tcf, .tgc, .tbc, .ecf, etc).

Example models using variables are provided in the [[TUFLOW Example Models#Bulk Simulation Management|Bulk Simulation Management Example Model Dataset]] on the TUFLOW Wiki.

 

{{Tips Navigation
|uplink=[[Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

Hardware Benchmarking - Results

2025-12-23T03:57:55Z

Pavlina Monhartova: /* High End GPU Results */

=CPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m Classic and HPC CPU runtimes, with the fastest computers at the top of the table.
 
'''Runtimes for CPU benchmarks'''
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Processor Frequency (GHz)**
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM size (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM frequency (MHz)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Classic 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | HPC CPU 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Runtime Combined (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||128||5200||32.7||108.6||141.3||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||64||5600||36.7||114.2||150.9||TM1
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||2.0||128||4000||41.2||124.1||165.3||AW1
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs)||3.2||128||4800||38.5||127.0||165.5||SB1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz||4.5||64||4800||33.4||136.0||169.4||PSM
|-
|12th Gen Intel(R) Core(TM) i9-12900K||3.2||128||3200||40.7||129.9||170.6||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz||2.1||64||4800||41||137.2||178.2||RB1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs) @ ~4.2GHz||4.2||32||4800||35.5||162.8||198.3||LC1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs)||2.5||16||3200||48.4||170.5||218.9||TS1
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz||3.2||64||4800||53.3||169.1||222.4||CHR
|-
|Intel(R) Core(TM) i9-10900K CPU @ 3.70GHz||3.7||128||3200||56.9||173.8||230.7||CH1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz)||(5.1)||16||4000||58.2||179.9||238.1||RRB
|-
|AMD Ryzen 5 7600X 6-Core Processor||4.7||32||4800||39.0||175.7||214.7||HP1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||3000||55.7||186.2||241.9||RH1
|-
|AMD Ryzen 9 3900X 12-Core Processor||3.8||64||3200||45.9||203.1||249.0||CH3
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz||3.1||32||2666||61.7||190.0||251.7||CB1
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz||3.6||32||2133||61.4||190.4||251.8||RH2
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||3.6||64||2133||62.7||191.1||253.8||PA1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||32||2933||62.1||192.8||254.9||DS2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||71.2||184.3||255.5||ABA
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||62.1||193.7||255.8||MA2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|3.2
|450
|
|50.0
|211.6
|261.6
|YW1
|-
|AMD Ryzen Threadripper 3970X 32-Core Processor||3.7||256||2400||49.5||212.1||261.6||CH2
|-
|AMD Ryzen 9 3950X 16-Core Processor||3.5||128||2800||55.9||210.0||265.9||TRO
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||3.2||56||N/A||49.1||218.9||268||RBR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||2133||67.0||202.5||269.5||RL1
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz||3.5||128||2133||72.7||202.1||274.8||MBL
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||67.5||208.6||276.1||SKI
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||68.5||208.8||277.3||PM2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||66.8||211.6||278.1||MA1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz||3.2||16||2667||68.2||211.8||280.0||CR2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||68.0||216.0||284.0||RL3
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||32||2113||68.2||217.9||286.1||HP2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||67.7||219.1||286.8||RL2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||70.5||218.8||289.3||PM1
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||2.9||16||2667||77.5||212.6||290.1||KTC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||3.7||32||2933||75.2||219.8||295||BL-DT01001
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor||3.5||128||2666||67.9||230.8||298.7||JGR
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||3.5||128||2666||66.3||234.7||301||JG3
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||32||2400||80.5||221.9||302.4||JM1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz||3.6||16||2400||72.8||230.6||303.4||RSH
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||85.4||218.8||304.2||JPI
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||83.7||225.2||308.9||HNM
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|2.6
|32
|3200
|66.6
|243.3
|309.9
|SK1
|-
|Intel(R) Core(TM) i7-4790K CPU @ 4.00GHz||4.0||32||2400||91.2||223.3||314.5||BRD
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz||3.7||64||2400||84.5||236.6||321.2||DS1
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz||3.2||128||2133||83.4||243.1||326.5||BLK
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz||1.4||16||7467||173.8||152.8||326.6||AL1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||3.7||64||2933||95.4||231.3||326.7||JB2
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz||3.4||128||2400||85.3||247.7||332.9||615
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2400||106.3||226.7||333.0||MRT
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||16||2133||80.7||253.4||334.1||VHD
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz||2.1||64||2666||83.9||251.2||335.1||AR2
|-
|AMD EPYC 7V12 64-Core Processor (16 CPUs) ||2.4||57||NA||63.5||277.6||341.1||CS2
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor||3.4||16||2666||81.9||277.3||359.2||CEV
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz||3.0||32||2400||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||64||2133||82.3||289.8||372.1||JIW
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz||3.4||32||1666||108.9||270.0||378.9||AR1
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||3.8||64||3200||87.8||294.2||382||HDR-A2000
|-
|AMD Ryzen 9 5950X 16-Core Processor||3.4||32||3400||39.7||343.0||382.7||JG2
|-
|Intel(R) Core(TM) i7-4810MQ CPU @ 2.80GHz||2.8||32||1600||119.7||280.8||400.5||SBC
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz||3.3||64||2133||118.2||287.8||406.0||ZDO
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz||2.7||16||2133||90.4||321.7||412.1||EAS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||16||2133||84.8||336.9||421.7||JM2
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2133||100.3||323||423.3||MON
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz||3.4||32||1600||126.4||299.7||426.1||MAV
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz ||3.0||4||986||84.0||351.4||435.4||TJS
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||3.5||16||1333||125.9||320.5||446.4||EFC
|-
|Intel(R) Core(TM) i7-8650U CPU @ 1.90GHz||1.9||16||1800||100.1||347.0||447.1||SM1
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||2.9||16||2900||63.3||385.0||448.3||NCV
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||4.1||16||4104||62.7||386.6||449.3||GZH
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||2.4||128||2394||130.5||331.5||462||VDI
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||2.6||24||1600||100.5||378.6||479.1||CDH
|-
|Intel(R) Xeon(R) CPU E5-1650 0 @ 3.20GHz||3.2||32||1600||143.2||343.1||486.3||MPR
|-
|Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz||3.2||8||1600||142.0||349.4||491.4||CR1
|-
|Intel(R) Xeon(R) CPU E5-2667 v2 @ 3.30GHz||3.3||16||N/A||196.8||331.5||528.3||Private Cloud
|-
|Intel(R) Core(TM) i7-4712HQ CPU @ 2.30GHz (Laptop)||2.3||8||1600||145.2||414.4||559.6||MNG
|-
|Intel(R) Xeon(R) CPU X5680 @ 3.33GHz||3.33||72||1333||165.7||400.6||566.3||WTM
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||2.4||8||1600||137.8||795.0||932.8||HMM
|-
|}
=GPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m and 10m runtimes with the fastest computers at the top of the table.
 
The HPC GPU benchmark only uses a single GPU card. TUFLOW HPC GPU can be run across multiple NVIDIA GPU devices. However, the benefits of these are typically more noticeable for larger models with more than 1 million cells.
 
'''Runtimes for GPU benchmarks'''
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 10m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|2.5
|9.5
|12.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz ||NVIDIA GeForce RTX 4090||24||16384||2.4||11.6||14.0||JW1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4090||24||16384||2.5||12.1||14.6||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz ||NVIDIA GeForce RTX 4090||24||16384||2.7||12.7||15.4||TA1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||2.9||12.7||15.6||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||3.1||13.3||16.4||CR4
|-
|Intel(R) Core(TM) i9-14900K (32 CPUs) @ ~3.2GHz||NVIDIA GeForce RTX 4080 Super||16||10240||2.8||14.5||17.3||DF2
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||TM1
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||JM3
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||NVIDIA GeForce RTX 4080||16||9728||3.2||15.0||18.2||AW1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs)@ ~4.2GHz||NVIDIA GeForce RTX 4080 SUPER||16||10240||3.2||15.7||18.9||LC1
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||NVIDIA RTX 6000 Ada Generation||48||18176||4.9||14.2||19.1||JG3
|-
|Intel(R) Xeon(R) CPU E5-2697 v4 @ 2.30GHz (72 CPUs)||NVIDIA GeForce RTX 4090||24||16384||3.9||16.2||20.1||CS3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||3.4||18.5||21.9||FM-NODE: Tesla V100
|-
|AMD Ryzen 5 7600X 6-Core Processor ||NVIDIA GeForce RTX 4070 Ti||12||7680||3.4||19.2||22.6||HP1
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||3.8||19.2||23.0||RS1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||3.7||19.4||23.1||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700F
|NVIDIA GeForce RTX 3080 Ti
|12
|10240
|3.75
|19.57
|23.32
|AUBNE1PC6602
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||4.0||19.6||23.6||GP1
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA A40||48||10752||3.5||20.3||23.8||Lenovo SR650 V2
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.1||20.1||24.2||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.4||20.4||24.8||CH3
|-
|Intel(R) Core(TM) i9-10980XE CPU @ 3.00GHz (36 CPUs), ~3.0GHz
|NVIDIA RTX A6000
|48
|10752
|4.7
|22.7
|27.4
|CB2
|-
|13th Gen Intel(R) Core(TM) i5-13600HX (20 CPUs) @ ~2.6GHz ||NVIDIA GeForce RTX 4090 Laptop GPU||16||9728||5.3||22.2||27.5||LC2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz ||NVIDIA GeForce RTX 3080||10||8704||4.3||23.7||28||RB1
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||4.6||23.5||28.1||KW2
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs) ||NVIDIA RTX A5000||24||8192||4.4||24.1||28.5||SB1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 3080||10||8704||4.7||24.0||28.7||CPM
|-
|Intel(R) Xeon(R) W-2223 CPU @ 3.60GHz ||NVIDIA GeForce RTX 3090||24||10496||5.3||24.3||29.6||SSM2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||4.7||25.7||30.4||ACH
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||5.7||25.2||30.9||JGR
|-
|AMD Ryzen Threadripper 2920X 12-Core Processor (24 CPUs) @ 3.5GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.1||25.9||31||CR5
|-
|Intel(R) Xeon(R) W-2145 CPU @ 3.70GHz (16 CPUs), ~3.7GHz
|NVIDIA RTX A5000
|24
|8192
|5.2
|26.3
|31.5
|CB3
|-
|AMD Ryzen 9 3950X 16-Core Processor ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.3||26.4||31.7||TRO
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||27.4||32.8||PY2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||27.7||33.4||VLD
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||NVIDIA GeForce RTX 3070||8||5888||5.0||28.8||33.8||NCV
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.5||28.4||33.9||RL1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||5.5||28.7||34.2||RRB
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.9||28.4||34.3||HP2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.8||28.8||34.6||MA1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||29.2||34.9||MA2
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||5.5||29.7||35.2||JG2
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.6||29.9||35.5||MBL
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||6.4||29.5||35.9||JPI
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P100||16||3584||6.1||30.8||36.9||Google Cloud: Tesla P100
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||5.7||31.9||37.6||RH2
|-
|Intel(R) Xeon(R) Gold 6230R CPU @ 2.10GHz ||NVIDIA GRID RTX8000P-48Q||48||4608||6.8||31.0||37.8||VJ1
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs) ||NVIDIA RTX A4000||16||6144||5.8||32.0||37.8||JS2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080||8||2944||6.0||31.9||37.9||ANK
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||6.0||32.0||38.0||EFC
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|7.2
|31.4
|38.6
|YW1
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs) @ 3.2GHz ||NVIDIA A10-24Q||24||8192||7.2||31.4||38.6||CS1
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||33.3||38.7||PA1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce RTX 3060 Ti (LHR) ||8||4864||5.7||33.3||39.0||DF1
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||NVIDIA GeForce RTX 2060 SUPER (core 1647MHz, mem 1750MHz)||8||2176||5.6||33.4||39.1||GZH
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||5.6||34.3||40.7||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||6.9||34.6||41.6||FLC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||35.1||41.6||JB2
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.4||35.8||42.2||JS1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080||8||2944||6.5||36.0||42.5||ABA
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz ||NVIDIA RTX A4000||16||6144||7.2||35.3||42.5||CHR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.1||37.1||43.2||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||37.4||43.8||PM1
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA GeForce GTX 2070||8||2304||7.4||38.8||46.2||MMR
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz ||NVIDIA Quadro RTX 4000||8||2304||6.6||39.8||46.4||CB1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.8||39.1||46.9||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||8.0||39.3||47.3||RCD
|-
|AMD Ryzen 7 7840HS ||NVIDIA GeForce RTX 4060 Laptop GPU||8||3072||7.0||40.6||47.6||CH1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.6||41.1||48.7||HNM
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||NVIDIA GRID RTX6000P-4Q||24||4608||10.5||39.3||49.8||VDI
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz (Laptop) ||NVIDIA GeForce RTX 2070||8||2304||7.7||42.8||50.5||ERX
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA Tesla T4||16||2560||6.8||45.2||52.0||RJ1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz
|NVIDIA GeForce RTX 3060
|8
|3584
|7.68
|45.92
|53.6
|AUBNEW1DQ54G3
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||8.0||47.4||55.3||BLK
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla T4||16||2560||7.3||48.3||55.6||FM-NODE: Tesla T4
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz ||NVIDIA GeForce GTX 1080||8||2560||8.5||48.9||57.3||JM1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||8.2||51.9||60.0||SKI
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz ||NVIDIA Quadro P5000||16||2560||9.6||51.8||61.4||AR2
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||NVIDIA RTX A2000||6||3328||9.1||54.4||63.5||HDR-A2000
|-
|Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz ||NVIDIA GeForce GTX 1070||8||1920||8.9||54.9||63.8||PY1
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz ||NVIDIA GeForce RTX 4050 Laptop GPU||6||2560||7.9||59.4||67.3||AL1
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz ||NVIDIA GeForce GTX 1070||8||1920||10.3||59.3||69.5||DS1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA GeForce GTX 1660||6||1408||9.4||61.0||70.4||JFP
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA Quadro P4000||8||1792||10.0||62.3||72.3||DS2
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce GTX 1650 SUPER||4||1280||10.3||64.6||74.9||TS1
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P4||8||2560||10.4||69.0||79.4||Google Cloud: Tesla P4
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz ||NVIDIA GeForce GTX 980||4||2048||11.8||70.6||82.3||ZDO
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|NVIDIA RTX A2000 Laptop GPU
|4
|2560
|11.4
|72.6
|84.0
|SK1
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz ||NVIDIA GeForce GTX TITAN Black||6||2880||13.1||76.1||89.2||AR1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz ||NVIDIA GeForce GTX 1060||6||1280||13.0||77.1||90.1||RSH
|-
|Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz (64 CPUs), ~2.3GHz||NVIDIA Tesla M60||16||4096||12||82.7||94.7||SM2
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla K80||12||2496||11.3||83.5||94.8||Google Cloud: Tesla K80
|-
|Intel(R) Core(TM) i3-8100 CPU @ 3.60GHz ||NVIDIA Tesla K40c||12||2880||12.3||83.1||95.3||NWE
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA Quadro T2000||4||1024||13.3||85.2||95.5||SSM
|-
|Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz (Laptop) ||NVIDIA GeForce GTX 980||4||2048||17.5||84.2||101.7||MRT
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs), ~3.8GHz
|NVIDIA Quadro T1000
|4
|896
|13.6
|91.3
|104.9
|CB4
|-
|13th Gen Intel(R) Core(TM) i7-13800H (20 CPUs), ~2.5GHz
|NVIDIA RTX A500 Laptop GPU
|4
|2048
|14.8
|93.9
|108.7
|YB1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||NVIDIA Quadro P2000||5||1024||14.2||96||110.2||BL-DT01001
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA Quadro P2000||5||1024||15.8||100.1||115.9||CR2
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz ||NVIDIA GeForce GTX 690||2||3072||18.4||114.4||132.8||MAV
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor ||NVIDIA GeForce GTX 960||4||1024||18.6||123.3||141.6||CEV
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA GeForce GTX 960||4||1024||19.9||127.2||147.1||VHD
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz||NVIDIA GeForce GTX 1050 Ti||4||768||21.1||133.8||154.9||MJS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||NVIDIA GeForce GTX 1050||2||640||20.6||139.1||159.7||JM2
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||NVIDIA Quadro P2000||5||1024||22.1||142.5||164.6||KTC
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||NVIDIA Quadro P2000||5||1024||23.0||149.3||172.3||RL2
|-
|Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz||NVIDIA Quadro M2200||4||1024||23.2||198.7||222.0||GYB
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz||NVIDIA T500||4||986||29.3||197.5||226.8||TJS
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz ||NVIDIA Quadro P1000||4||640||30.3||203.7||234.0||RL3
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA Quadro K2200||4||640||32.5||211.3||243.8||JIW
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||NVIDIA A10-4Q||24||8192||44.5||212.6||257.1||RBR
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz ||NVIDIA Quadro M1200||4||640||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz ||NVIDIA GeForce GTX 940MX||2||384||65.6||479.0||544.6||EAS
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||NVIDIA GeForce 840M||2||384||70.6||526.3||595.9||CDH
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||NVIDIA GeForce GT 740M||2||384||102.3||694.0||796.3||HMM
|-
|}

=High End GPU Results=
A number of additional benchmarking tests have been completed on a 5m and 2.5m model on a single GPU card.

{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 2.5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|73.3
|568.7
|642.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||NVIDIA GeForce RTX 4090||24||16384||103.3||811.2||914.5||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz||NVIDIA GeForce RTX 4090||24||16384||105.9||813.7||919.6||TA1
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz||NVIDIA GeForce RTX 4090||24||16384||103.7||824.3||928.0||JW1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||108.2||821.5||929.7||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||106.8||875.5||982.3||CR4
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz ||NVIDIA RTX 6000 Ada Generation||48||18176||119.6||877.8||997.4||JG3
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||139.5||1115.1||1254.6||JM3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||155.2||1172.9||1328.1||FM-NODE: Tesla V100
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||155.5||1176.2||1331.7||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||158||1192.2||1350.2||CH3
|-
|Intel(R) Core(TM) i9-10900F CPU @ 3.70GHz ||NVIDIA GeForce RTX 3090||24||10496||162.3||1192.4||1354.7||LJA
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||159.7||1216.2||1375.9||GP1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||160.9||1240||1400.9||DD2
|-
|Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz ||NVIDIA GeForce RTX 3090||24||10496||172.9||1249.8||1422.7||SIP
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||178.9||1363.9||1542.8||KW2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||203.8||1523.9||1727.7||ACH
|-
|AMD Ryzen 5 7600X 6-Core Processor ||NVIDIA GeForce RTX 2080 Ti||12||7680||190.2||1493.2||1683.4||HP1
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||201.2||1548.1||1749.3||JGR
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||220.0||1634.5||1854.5||MA1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||222.2||1648.7||1870.9||JPI
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||215.9||1678.7||1894.6||PA2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||255.4||1691.7||1947.1||HP2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|242.3
|1856.5
|2098.8
|YW1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||241.2||1863.5||2104.7||RRB
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||248.7||1928.6||2177.3||JG2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||257.3||1957.7||2215.0||RH2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||275.1||2147.4||2422.5||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||296.0||2218.4||2514.4||FLC
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||298.9||2290.1||2589.0||JS1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.3||2345.1||2656.4||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||310.3||2377.2||2687.5||RCD
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||308.7||2384.7||2693.4||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.9||2404.9||2716.7||PM1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||324.8||2475.3||2800.1||HNM
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||439.0||3379.3||3818.2||BLK
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||475.5||3788.2||4263.7||SKI
|-
|}
<pre> * it is noted that the number of CUDA cores is not provided as an output from the '''dxdiag''' command and this information has been sourced from the nvidia website.
** The output cpu.txt only provides the 'out of the box' processor speed. If you have overclocked your cpu and/or gpu, please send these details to TUFLOW Support so we can add the overclocked data in brackets. </pre>

{{Tips Navigation
|uplink=[[Hardware_Benchmarking | Back to TUFLOW Benchmarking]]
}}

Hardware Benchmarking - Results

2025-12-23T03:54:51Z

Pavlina Monhartova: /* GPU Results */

=CPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m Classic and HPC CPU runtimes, with the fastest computers at the top of the table.
 
'''Runtimes for CPU benchmarks'''
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Processor Frequency (GHz)**
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM size (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM frequency (MHz)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Classic 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | HPC CPU 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Runtime Combined (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||128||5200||32.7||108.6||141.3||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||64||5600||36.7||114.2||150.9||TM1
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||2.0||128||4000||41.2||124.1||165.3||AW1
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs)||3.2||128||4800||38.5||127.0||165.5||SB1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz||4.5||64||4800||33.4||136.0||169.4||PSM
|-
|12th Gen Intel(R) Core(TM) i9-12900K||3.2||128||3200||40.7||129.9||170.6||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz||2.1||64||4800||41||137.2||178.2||RB1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs) @ ~4.2GHz||4.2||32||4800||35.5||162.8||198.3||LC1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs)||2.5||16||3200||48.4||170.5||218.9||TS1
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz||3.2||64||4800||53.3||169.1||222.4||CHR
|-
|Intel(R) Core(TM) i9-10900K CPU @ 3.70GHz||3.7||128||3200||56.9||173.8||230.7||CH1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz)||(5.1)||16||4000||58.2||179.9||238.1||RRB
|-
|AMD Ryzen 5 7600X 6-Core Processor||4.7||32||4800||39.0||175.7||214.7||HP1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||3000||55.7||186.2||241.9||RH1
|-
|AMD Ryzen 9 3900X 12-Core Processor||3.8||64||3200||45.9||203.1||249.0||CH3
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz||3.1||32||2666||61.7||190.0||251.7||CB1
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz||3.6||32||2133||61.4||190.4||251.8||RH2
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||3.6||64||2133||62.7||191.1||253.8||PA1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||32||2933||62.1||192.8||254.9||DS2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||71.2||184.3||255.5||ABA
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||62.1||193.7||255.8||MA2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|3.2
|450
|
|50.0
|211.6
|261.6
|YW1
|-
|AMD Ryzen Threadripper 3970X 32-Core Processor||3.7||256||2400||49.5||212.1||261.6||CH2
|-
|AMD Ryzen 9 3950X 16-Core Processor||3.5||128||2800||55.9||210.0||265.9||TRO
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||3.2||56||N/A||49.1||218.9||268||RBR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||2133||67.0||202.5||269.5||RL1
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz||3.5||128||2133||72.7||202.1||274.8||MBL
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||67.5||208.6||276.1||SKI
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||68.5||208.8||277.3||PM2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||66.8||211.6||278.1||MA1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz||3.2||16||2667||68.2||211.8||280.0||CR2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||68.0||216.0||284.0||RL3
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||32||2113||68.2||217.9||286.1||HP2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||67.7||219.1||286.8||RL2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||70.5||218.8||289.3||PM1
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||2.9||16||2667||77.5||212.6||290.1||KTC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||3.7||32||2933||75.2||219.8||295||BL-DT01001
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor||3.5||128||2666||67.9||230.8||298.7||JGR
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||3.5||128||2666||66.3||234.7||301||JG3
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||32||2400||80.5||221.9||302.4||JM1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz||3.6||16||2400||72.8||230.6||303.4||RSH
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||85.4||218.8||304.2||JPI
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||83.7||225.2||308.9||HNM
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|2.6
|32
|3200
|66.6
|243.3
|309.9
|SK1
|-
|Intel(R) Core(TM) i7-4790K CPU @ 4.00GHz||4.0||32||2400||91.2||223.3||314.5||BRD
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz||3.7||64||2400||84.5||236.6||321.2||DS1
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz||3.2||128||2133||83.4||243.1||326.5||BLK
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz||1.4||16||7467||173.8||152.8||326.6||AL1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||3.7||64||2933||95.4||231.3||326.7||JB2
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz||3.4||128||2400||85.3||247.7||332.9||615
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2400||106.3||226.7||333.0||MRT
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||16||2133||80.7||253.4||334.1||VHD
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz||2.1||64||2666||83.9||251.2||335.1||AR2
|-
|AMD EPYC 7V12 64-Core Processor (16 CPUs) ||2.4||57||NA||63.5||277.6||341.1||CS2
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor||3.4||16||2666||81.9||277.3||359.2||CEV
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz||3.0||32||2400||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||64||2133||82.3||289.8||372.1||JIW
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz||3.4||32||1666||108.9||270.0||378.9||AR1
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||3.8||64||3200||87.8||294.2||382||HDR-A2000
|-
|AMD Ryzen 9 5950X 16-Core Processor||3.4||32||3400||39.7||343.0||382.7||JG2
|-
|Intel(R) Core(TM) i7-4810MQ CPU @ 2.80GHz||2.8||32||1600||119.7||280.8||400.5||SBC
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz||3.3||64||2133||118.2||287.8||406.0||ZDO
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz||2.7||16||2133||90.4||321.7||412.1||EAS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||16||2133||84.8||336.9||421.7||JM2
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2133||100.3||323||423.3||MON
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz||3.4||32||1600||126.4||299.7||426.1||MAV
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz ||3.0||4||986||84.0||351.4||435.4||TJS
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||3.5||16||1333||125.9||320.5||446.4||EFC
|-
|Intel(R) Core(TM) i7-8650U CPU @ 1.90GHz||1.9||16||1800||100.1||347.0||447.1||SM1
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||2.9||16||2900||63.3||385.0||448.3||NCV
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||4.1||16||4104||62.7||386.6||449.3||GZH
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||2.4||128||2394||130.5||331.5||462||VDI
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||2.6||24||1600||100.5||378.6||479.1||CDH
|-
|Intel(R) Xeon(R) CPU E5-1650 0 @ 3.20GHz||3.2||32||1600||143.2||343.1||486.3||MPR
|-
|Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz||3.2||8||1600||142.0||349.4||491.4||CR1
|-
|Intel(R) Xeon(R) CPU E5-2667 v2 @ 3.30GHz||3.3||16||N/A||196.8||331.5||528.3||Private Cloud
|-
|Intel(R) Core(TM) i7-4712HQ CPU @ 2.30GHz (Laptop)||2.3||8||1600||145.2||414.4||559.6||MNG
|-
|Intel(R) Xeon(R) CPU X5680 @ 3.33GHz||3.33||72||1333||165.7||400.6||566.3||WTM
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||2.4||8||1600||137.8||795.0||932.8||HMM
|-
|}
=GPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m and 10m runtimes with the fastest computers at the top of the table.
 
The HPC GPU benchmark only uses a single GPU card. TUFLOW HPC GPU can be run across multiple NVIDIA GPU devices. However, the benefits of these are typically more noticeable for larger models with more than 1 million cells.
 
'''Runtimes for GPU benchmarks'''
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 10m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|2.5
|9.5
|12.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz ||NVIDIA GeForce RTX 4090||24||16384||2.4||11.6||14.0||JW1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4090||24||16384||2.5||12.1||14.6||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz ||NVIDIA GeForce RTX 4090||24||16384||2.7||12.7||15.4||TA1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||2.9||12.7||15.6||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||3.1||13.3||16.4||CR4
|-
|Intel(R) Core(TM) i9-14900K (32 CPUs) @ ~3.2GHz||NVIDIA GeForce RTX 4080 Super||16||10240||2.8||14.5||17.3||DF2
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||TM1
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||JM3
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||NVIDIA GeForce RTX 4080||16||9728||3.2||15.0||18.2||AW1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs)@ ~4.2GHz||NVIDIA GeForce RTX 4080 SUPER||16||10240||3.2||15.7||18.9||LC1
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||NVIDIA RTX 6000 Ada Generation||48||18176||4.9||14.2||19.1||JG3
|-
|Intel(R) Xeon(R) CPU E5-2697 v4 @ 2.30GHz (72 CPUs)||NVIDIA GeForce RTX 4090||24||16384||3.9||16.2||20.1||CS3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||3.4||18.5||21.9||FM-NODE: Tesla V100
|-
|AMD Ryzen 5 7600X 6-Core Processor ||NVIDIA GeForce RTX 4070 Ti||12||7680||3.4||19.2||22.6||HP1
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||3.8||19.2||23.0||RS1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||3.7||19.4||23.1||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700F
|NVIDIA GeForce RTX 3080 Ti
|12
|10240
|3.75
|19.57
|23.32
|AUBNE1PC6602
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||4.0||19.6||23.6||GP1
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA A40||48||10752||3.5||20.3||23.8||Lenovo SR650 V2
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.1||20.1||24.2||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.4||20.4||24.8||CH3
|-
|Intel(R) Core(TM) i9-10980XE CPU @ 3.00GHz (36 CPUs), ~3.0GHz
|NVIDIA RTX A6000
|48
|10752
|4.7
|22.7
|27.4
|CB2
|-
|13th Gen Intel(R) Core(TM) i5-13600HX (20 CPUs) @ ~2.6GHz ||NVIDIA GeForce RTX 4090 Laptop GPU||16||9728||5.3||22.2||27.5||LC2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz ||NVIDIA GeForce RTX 3080||10||8704||4.3||23.7||28||RB1
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||4.6||23.5||28.1||KW2
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs) ||NVIDIA RTX A5000||24||8192||4.4||24.1||28.5||SB1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 3080||10||8704||4.7||24.0||28.7||CPM
|-
|Intel(R) Xeon(R) W-2223 CPU @ 3.60GHz ||NVIDIA GeForce RTX 3090||24||10496||5.3||24.3||29.6||SSM2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||4.7||25.7||30.4||ACH
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||5.7||25.2||30.9||JGR
|-
|AMD Ryzen Threadripper 2920X 12-Core Processor (24 CPUs) @ 3.5GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.1||25.9||31||CR5
|-
|Intel(R) Xeon(R) W-2145 CPU @ 3.70GHz (16 CPUs), ~3.7GHz
|NVIDIA RTX A5000
|24
|8192
|5.2
|26.3
|31.5
|CB3
|-
|AMD Ryzen 9 3950X 16-Core Processor ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.3||26.4||31.7||TRO
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||27.4||32.8||PY2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||27.7||33.4||VLD
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||NVIDIA GeForce RTX 3070||8||5888||5.0||28.8||33.8||NCV
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.5||28.4||33.9||RL1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||5.5||28.7||34.2||RRB
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.9||28.4||34.3||HP2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.8||28.8||34.6||MA1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||29.2||34.9||MA2
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||5.5||29.7||35.2||JG2
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.6||29.9||35.5||MBL
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||6.4||29.5||35.9||JPI
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P100||16||3584||6.1||30.8||36.9||Google Cloud: Tesla P100
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||5.7||31.9||37.6||RH2
|-
|Intel(R) Xeon(R) Gold 6230R CPU @ 2.10GHz ||NVIDIA GRID RTX8000P-48Q||48||4608||6.8||31.0||37.8||VJ1
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs) ||NVIDIA RTX A4000||16||6144||5.8||32.0||37.8||JS2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080||8||2944||6.0||31.9||37.9||ANK
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||6.0||32.0||38.0||EFC
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|7.2
|31.4
|38.6
|YW1
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs) @ 3.2GHz ||NVIDIA A10-24Q||24||8192||7.2||31.4||38.6||CS1
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||33.3||38.7||PA1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce RTX 3060 Ti (LHR) ||8||4864||5.7||33.3||39.0||DF1
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||NVIDIA GeForce RTX 2060 SUPER (core 1647MHz, mem 1750MHz)||8||2176||5.6||33.4||39.1||GZH
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||5.6||34.3||40.7||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||6.9||34.6||41.6||FLC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||35.1||41.6||JB2
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.4||35.8||42.2||JS1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080||8||2944||6.5||36.0||42.5||ABA
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz ||NVIDIA RTX A4000||16||6144||7.2||35.3||42.5||CHR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.1||37.1||43.2||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||37.4||43.8||PM1
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA GeForce GTX 2070||8||2304||7.4||38.8||46.2||MMR
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz ||NVIDIA Quadro RTX 4000||8||2304||6.6||39.8||46.4||CB1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.8||39.1||46.9||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||8.0||39.3||47.3||RCD
|-
|AMD Ryzen 7 7840HS ||NVIDIA GeForce RTX 4060 Laptop GPU||8||3072||7.0||40.6||47.6||CH1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.6||41.1||48.7||HNM
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||NVIDIA GRID RTX6000P-4Q||24||4608||10.5||39.3||49.8||VDI
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz (Laptop) ||NVIDIA GeForce RTX 2070||8||2304||7.7||42.8||50.5||ERX
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA Tesla T4||16||2560||6.8||45.2||52.0||RJ1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz
|NVIDIA GeForce RTX 3060
|8
|3584
|7.68
|45.92
|53.6
|AUBNEW1DQ54G3
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||8.0||47.4||55.3||BLK
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla T4||16||2560||7.3||48.3||55.6||FM-NODE: Tesla T4
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz ||NVIDIA GeForce GTX 1080||8||2560||8.5||48.9||57.3||JM1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||8.2||51.9||60.0||SKI
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz ||NVIDIA Quadro P5000||16||2560||9.6||51.8||61.4||AR2
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||NVIDIA RTX A2000||6||3328||9.1||54.4||63.5||HDR-A2000
|-
|Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz ||NVIDIA GeForce GTX 1070||8||1920||8.9||54.9||63.8||PY1
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz ||NVIDIA GeForce RTX 4050 Laptop GPU||6||2560||7.9||59.4||67.3||AL1
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz ||NVIDIA GeForce GTX 1070||8||1920||10.3||59.3||69.5||DS1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA GeForce GTX 1660||6||1408||9.4||61.0||70.4||JFP
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA Quadro P4000||8||1792||10.0||62.3||72.3||DS2
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce GTX 1650 SUPER||4||1280||10.3||64.6||74.9||TS1
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P4||8||2560||10.4||69.0||79.4||Google Cloud: Tesla P4
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz ||NVIDIA GeForce GTX 980||4||2048||11.8||70.6||82.3||ZDO
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|NVIDIA RTX A2000 Laptop GPU
|4
|2560
|11.4
|72.6
|84.0
|SK1
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz ||NVIDIA GeForce GTX TITAN Black||6||2880||13.1||76.1||89.2||AR1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz ||NVIDIA GeForce GTX 1060||6||1280||13.0||77.1||90.1||RSH
|-
|Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz (64 CPUs), ~2.3GHz||NVIDIA Tesla M60||16||4096||12||82.7||94.7||SM2
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla K80||12||2496||11.3||83.5||94.8||Google Cloud: Tesla K80
|-
|Intel(R) Core(TM) i3-8100 CPU @ 3.60GHz ||NVIDIA Tesla K40c||12||2880||12.3||83.1||95.3||NWE
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA Quadro T2000||4||1024||13.3||85.2||95.5||SSM
|-
|Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz (Laptop) ||NVIDIA GeForce GTX 980||4||2048||17.5||84.2||101.7||MRT
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs), ~3.8GHz
|NVIDIA Quadro T1000
|4
|896
|13.6
|91.3
|104.9
|CB4
|-
|13th Gen Intel(R) Core(TM) i7-13800H (20 CPUs), ~2.5GHz
|NVIDIA RTX A500 Laptop GPU
|4
|2048
|14.8
|93.9
|108.7
|YB1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||NVIDIA Quadro P2000||5||1024||14.2||96||110.2||BL-DT01001
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA Quadro P2000||5||1024||15.8||100.1||115.9||CR2
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz ||NVIDIA GeForce GTX 690||2||3072||18.4||114.4||132.8||MAV
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor ||NVIDIA GeForce GTX 960||4||1024||18.6||123.3||141.6||CEV
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA GeForce GTX 960||4||1024||19.9||127.2||147.1||VHD
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz||NVIDIA GeForce GTX 1050 Ti||4||768||21.1||133.8||154.9||MJS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||NVIDIA GeForce GTX 1050||2||640||20.6||139.1||159.7||JM2
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||NVIDIA Quadro P2000||5||1024||22.1||142.5||164.6||KTC
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||NVIDIA Quadro P2000||5||1024||23.0||149.3||172.3||RL2
|-
|Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz||NVIDIA Quadro M2200||4||1024||23.2||198.7||222.0||GYB
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz||NVIDIA T500||4||986||29.3||197.5||226.8||TJS
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz ||NVIDIA Quadro P1000||4||640||30.3||203.7||234.0||RL3
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA Quadro K2200||4||640||32.5||211.3||243.8||JIW
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||NVIDIA A10-4Q||24||8192||44.5||212.6||257.1||RBR
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz ||NVIDIA Quadro M1200||4||640||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz ||NVIDIA GeForce GTX 940MX||2||384||65.6||479.0||544.6||EAS
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||NVIDIA GeForce 840M||2||384||70.6||526.3||595.9||CDH
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||NVIDIA GeForce GT 740M||2||384||102.3||694.0||796.3||HMM
|-
|}

=High End GPU Results=
A number of additional benchmarking tests have been completed on a 5m and 2.5m model on a single GPU card.

{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 2.5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|73.3
|568.7
|642.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||NVIDIA GeForce RTX 4090||24||16384||103.3||811.2||914.5||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz||NVIDIA GeForce RTX 4090||24||16384||105.9||813.7||919.6||TA1
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz||NVIDIA GeForce RTX 4090||24||16384||103.7||824.3||928.0||JW1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||108.2||821.5||929.7||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||106.8||875.5||982.3||CR4
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz ||NVIDIA RTX 6000 Ada Generation||48||18176||119.6||877.8||997.4||JG3
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||139.5||1115.1||1254.6||JM3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||155.2||1172.9||1328.1||FM-NODE: Tesla V100
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||155.5||1176.2||1331.7||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||158||1192.2||1350.2||CH3
|-
|Intel(R) Core(TM) i9-10900F CPU @ 3.70GHz ||NVIDIA GeForce RTX 3090||24||10496||162.3||1192.4||1354.7||LJA
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||159.7||1216.2||1375.9||GP1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||160.9||1240||1400.9||DD2
|-
|Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz ||NVIDIA GeForce RTX 3090||24||10496||172.9||1249.8||1422.7||SIP
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||178.9||1363.9||1542.8||KW2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||203.8||1523.9||1727.7||ACH
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||201.2||1548.1||1749.3||JGR
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||220.0||1634.5||1854.5||MA1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||222.2||1648.7||1870.9||JPI
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||215.9||1678.7||1894.6||PA2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|242.3
|1856.5
|2098.8
|YW1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||241.2||1863.5||2104.7||RRB
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||248.7||1928.6||2177.3||JG2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||257.3||1957.7||2215.0||RH2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||275.1||2147.4||2422.5||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||296.0||2218.4||2514.4||FLC
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||298.9||2290.1||2589.0||JS1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.3||2345.1||2656.4||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||310.3||2377.2||2687.5||RCD
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||308.7||2384.7||2693.4||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.9||2404.9||2716.7||PM1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||324.8||2475.3||2800.1||HNM
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||439.0||3379.3||3818.2||BLK
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||475.5||3788.2||4263.7||SKI
|-
|}
<pre> * it is noted that the number of CUDA cores is not provided as an output from the '''dxdiag''' command and this information has been sourced from the nvidia website.
** The output cpu.txt only provides the 'out of the box' processor speed. If you have overclocked your cpu and/or gpu, please send these details to TUFLOW Support so we can add the overclocked data in brackets. </pre>

{{Tips Navigation
|uplink=[[Hardware_Benchmarking | Back to TUFLOW Benchmarking]]
}}

Hardware Benchmarking - Results

2025-12-23T03:50:07Z

Pavlina Monhartova:

=CPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m Classic and HPC CPU runtimes, with the fastest computers at the top of the table.
 
'''Runtimes for CPU benchmarks'''
{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Processor Frequency (GHz)**
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM size (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | RAM frequency (MHz)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Classic 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | HPC CPU 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Runtime Combined (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||128||5200||32.7||108.6||141.3||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||3.2||64||5600||36.7||114.2||150.9||TM1
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||2.0||128||4000||41.2||124.1||165.3||AW1
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs)||3.2||128||4800||38.5||127.0||165.5||SB1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz||4.5||64||4800||33.4||136.0||169.4||PSM
|-
|12th Gen Intel(R) Core(TM) i9-12900K||3.2||128||3200||40.7||129.9||170.6||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz||2.1||64||4800||41||137.2||178.2||RB1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs) @ ~4.2GHz||4.2||32||4800||35.5||162.8||198.3||LC1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs)||2.5||16||3200||48.4||170.5||218.9||TS1
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz||3.2||64||4800||53.3||169.1||222.4||CHR
|-
|Intel(R) Core(TM) i9-10900K CPU @ 3.70GHz||3.7||128||3200||56.9||173.8||230.7||CH1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz)||(5.1)||16||4000||58.2||179.9||238.1||RRB
|-
|AMD Ryzen 5 7600X 6-Core Processor||4.7||32||4800||39.0||175.7||214.7||HP1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||3000||55.7||186.2||241.9||RH1
|-
|AMD Ryzen 9 3900X 12-Core Processor||3.8||64||3200||45.9||203.1||249.0||CH3
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz||3.1||32||2666||61.7||190.0||251.7||CB1
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz||3.6||32||2133||61.4||190.4||251.8||RH2
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||3.6||64||2133||62.7||191.1||253.8||PA1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||32||2933||62.1||192.8||254.9||DS2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||71.2||184.3||255.5||ABA
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||62.1||193.7||255.8||MA2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|3.2
|450
|
|50.0
|211.6
|261.6
|YW1
|-
|AMD Ryzen Threadripper 3970X 32-Core Processor||3.7||256||2400||49.5||212.1||261.6||CH2
|-
|AMD Ryzen 9 3950X 16-Core Processor||3.5||128||2800||55.9||210.0||265.9||TRO
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||3.2||56||N/A||49.1||218.9||268||RBR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz||3.7||64||2133||67.0||202.5||269.5||RL1
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz||3.5||128||2133||72.7||202.1||274.8||MBL
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||67.5||208.6||276.1||SKI
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||68.5||208.8||277.3||PM2
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz||3.6||32||2666||66.8||211.6||278.1||MA1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz||3.2||16||2667||68.2||211.8||280.0||CR2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||68.0||216.0||284.0||RL3
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||32||2113||68.2||217.9||286.1||HP2
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||2.7||32||2667||67.7||219.1||286.8||RL2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz||4.2||64||2133||70.5||218.8||289.3||PM1
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||2.9||16||2667||77.5||212.6||290.1||KTC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||3.7||32||2933||75.2||219.8||295||BL-DT01001
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor||3.5||128||2666||67.9||230.8||298.7||JGR
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||3.5||128||2666||66.3||234.7||301||JG3
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||32||2400||80.5||221.9||302.4||JM1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz||3.6||16||2400||72.8||230.6||303.4||RSH
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||85.4||218.8||304.2||JPI
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz||3.6||64||2666||83.7||225.2||308.9||HNM
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|2.6
|32
|3200
|66.6
|243.3
|309.9
|SK1
|-
|Intel(R) Core(TM) i7-4790K CPU @ 4.00GHz||4.0||32||2400||91.2||223.3||314.5||BRD
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz||3.7||64||2400||84.5||236.6||321.2||DS1
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz||3.2||128||2133||83.4||243.1||326.5||BLK
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz||1.4||16||7467||173.8||152.8||326.6||AL1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||3.7||64||2933||95.4||231.3||326.7||JB2
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz||3.4||128||2400||85.3||247.7||332.9||615
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2400||106.3||226.7||333.0||MRT
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||16||2133||80.7||253.4||334.1||VHD
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz||2.1||64||2666||83.9||251.2||335.1||AR2
|-
|AMD EPYC 7V12 64-Core Processor (16 CPUs) ||2.4||57||NA||63.5||277.6||341.1||CS2
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor||3.4||16||2666||81.9||277.3||359.2||CEV
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz||3.0||32||2400||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz||3.4||64||2133||82.3||289.8||372.1||JIW
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz||3.4||32||1666||108.9||270.0||378.9||AR1
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||3.8||64||3200||87.8||294.2||382||HDR-A2000
|-
|AMD Ryzen 9 5950X 16-Core Processor||3.4||32||3400||39.7||343.0||382.7||JG2
|-
|Intel(R) Core(TM) i7-4810MQ CPU @ 2.80GHz||2.8||32||1600||119.7||280.8||400.5||SBC
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz||3.3||64||2133||118.2||287.8||406.0||ZDO
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz||2.7||16||2133||90.4||321.7||412.1||EAS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||3.3||16||2133||84.8||336.9||421.7||JM2
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz||3.0||64||2133||100.3||323||423.3||MON
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz||3.4||32||1600||126.4||299.7||426.1||MAV
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz ||3.0||4||986||84.0||351.4||435.4||TJS
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||3.5||16||1333||125.9||320.5||446.4||EFC
|-
|Intel(R) Core(TM) i7-8650U CPU @ 1.90GHz||1.9||16||1800||100.1||347.0||447.1||SM1
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||2.9||16||2900||63.3||385.0||448.3||NCV
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||4.1||16||4104||62.7||386.6||449.3||GZH
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||2.4||128||2394||130.5||331.5||462||VDI
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||2.6||24||1600||100.5||378.6||479.1||CDH
|-
|Intel(R) Xeon(R) CPU E5-1650 0 @ 3.20GHz||3.2||32||1600||143.2||343.1||486.3||MPR
|-
|Intel(R) Core(TM) i5-3470 CPU @ 3.20GHz||3.2||8||1600||142.0||349.4||491.4||CR1
|-
|Intel(R) Xeon(R) CPU E5-2667 v2 @ 3.30GHz||3.3||16||N/A||196.8||331.5||528.3||Private Cloud
|-
|Intel(R) Core(TM) i7-4712HQ CPU @ 2.30GHz (Laptop)||2.3||8||1600||145.2||414.4||559.6||MNG
|-
|Intel(R) Xeon(R) CPU X5680 @ 3.33GHz||3.33||72||1333||165.7||400.6||566.3||WTM
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||2.4||8||1600||137.8||795.0||932.8||HMM
|-
|}
=GPU Results=
The following table summarises the runtimes for a range of computers. More will be added when additional results are obtained. The table is ordered based on the combined 20m and 10m runtimes with the fastest computers at the top of the table.
 
The HPC GPU benchmark only uses a single GPU card. TUFLOW HPC GPU can be run across multiple NVIDIA GPU devices. However, the benefits of these are typically more noticeable for larger models with more than 1 million cells.
 
'''Runtimes for GPU benchmarks'''
{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 20m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 10m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|2.5
|9.5
|12.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz ||NVIDIA GeForce RTX 4090||24||16384||2.4||11.6||14.0||JW1
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4090||24||16384||2.5||12.1||14.6||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz ||NVIDIA GeForce RTX 4090||24||16384||2.7||12.7||15.4||TA1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||2.9||12.7||15.6||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||3.1||13.3||16.4||CR4
|-
|Intel(R) Core(TM) i9-14900K (32 CPUs) @ ~3.2GHz||NVIDIA GeForce RTX 4080 Super||16||10240||2.8||14.5||17.3||DF2
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||TM1
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||2.8||14.7||17.5||JM3
|-
|13th Gen Intel(R) Core(TM) i9-13900F (32 CPUs) @ 2.0GHz ||NVIDIA GeForce RTX 4080||16||9728||3.2||15.0||18.2||AW1
|-
|AMD Ryzen 7 7800X3D 8-Core Processor (16 CPUs)@ ~4.2GHz||NVIDIA GeForce RTX 4080 SUPER||16||10240||3.2||15.7||18.9||LC1
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz||NVIDIA RTX 6000 Ada Generation||48||18176||4.9||14.2||19.1||JG3
|-
|Intel(R) Xeon(R) CPU E5-2697 v4 @ 2.30GHz (72 CPUs)||NVIDIA GeForce RTX 4090||24||16384||3.9||16.2||20.1||CS3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||3.4||18.5||21.9||FM-NODE: Tesla V100
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||3.8||19.2||23.0||RS1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||3.7||19.4||23.1||DD2
|-
|12th Gen Intel(R) Core(TM) i7-12700F
|NVIDIA GeForce RTX 3080 Ti
|12
|10240
|3.75
|19.57
|23.32
|AUBNE1PC6602
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||4.0||19.6||23.6||GP1
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA A40||48||10752||3.5||20.3||23.8||Lenovo SR650 V2
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.1||20.1||24.2||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||4.4||20.4||24.8||CH3
|-
|Intel(R) Core(TM) i9-10980XE CPU @ 3.00GHz (36 CPUs), ~3.0GHz
|NVIDIA RTX A6000
|48
|10752
|4.7
|22.7
|27.4
|CB2
|-
|13th Gen Intel(R) Core(TM) i5-13600HX (20 CPUs) @ ~2.6GHz ||NVIDIA GeForce RTX 4090 Laptop GPU||16||9728||5.3||22.2||27.5||LC2
|-
|12th Gen Intel(R) Core(TM) i7-12700 (20 CPUs) @ ~2.1GHz ||NVIDIA GeForce RTX 3080||10||8704||4.3||23.7||28||RB1
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||4.6||23.5||28.1||KW2
|-
|12th Gen Intel(R) Core(TM) i9-12900K (24 CPUs) ||NVIDIA RTX A5000||24||8192||4.4||24.1||28.5||SB1
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 3080||10||8704||4.7||24.0||28.7||CPM
|-
|Intel(R) Xeon(R) W-2223 CPU @ 3.60GHz ||NVIDIA GeForce RTX 3090||24||10496||5.3||24.3||29.6||SSM2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||4.7||25.7||30.4||ACH
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||5.7||25.2||30.9||JGR
|-
|AMD Ryzen Threadripper 2920X 12-Core Processor (24 CPUs) @ 3.5GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.1||25.9||31||CR5
|-
|Intel(R) Xeon(R) W-2145 CPU @ 3.70GHz (16 CPUs), ~3.7GHz
|NVIDIA RTX A5000
|24
|8192
|5.2
|26.3
|31.5
|CB3
|-
|AMD Ryzen 9 3950X 16-Core Processor ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.3||26.4||31.7||TRO
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||27.4||32.8||PY2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||27.7||33.4||VLD
|-
|Intel(R) Core(TM) i7-10700F CPU @ 2.90GHz ||NVIDIA GeForce RTX 3070||8||5888||5.0||28.8||33.8||NCV
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.5||28.4||33.9||RL1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||5.5||28.7||34.2||RRB
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.8||28.8||34.6||MA1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.7||29.2||34.9||MA2
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||5.5||29.7||35.2||JG2
|-
|Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||5.6||29.9||35.5||MBL
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||6.4||29.5||35.9||JPI
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P100||16||3584||6.1||30.8||36.9||Google Cloud: Tesla P100
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||5.7||31.9||37.6||RH2
|-
|Intel(R) Xeon(R) Gold 6230R CPU @ 2.10GHz ||NVIDIA GRID RTX8000P-48Q||48||4608||6.8||31.0||37.8||VJ1
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs) ||NVIDIA RTX A4000||16||6144||5.8||32.0||37.8||JS2
|-
|Intel(R) Core(TM) i7-6700k @ 4.00GHz ||NVIDIA GeForce RTX 2080||8||2944||6.0||31.9||37.9||ANK
|-
|Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||6.0||32.0||38.0||EFC
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|7.2
|31.4
|38.6
|YW1
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs) @ 3.2GHz ||NVIDIA A10-24Q||24||8192||7.2||31.4||38.6||CS1
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz||NVIDIA GeForce RTX 2080 Ti||11||4352||5.4||33.3||38.7||PA1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce RTX 3060 Ti (LHR) ||8||4864||5.7||33.3||39.0||DF1
|-
|Intel(R) Core(TM) i5-10600K CPU @ 4.10GHz ||NVIDIA GeForce RTX 2060 SUPER (core 1647MHz, mem 1750MHz)||8||2176||5.6||33.4||39.1||GZH
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||5.6||34.3||40.7||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||6.9||34.6||41.6||FLC
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz (20 CPUs)||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||35.1||41.6||JB2
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.4||35.8||42.2||JS1
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080||8||2944||6.5||36.0||42.5||ABA
|-
|Intel(R) Xeon(R) w5-2455X (24 CPUs) @ ~3.2GHz ||NVIDIA RTX A4000||16||6144||7.2||35.3||42.5||CHR
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.1||37.1||43.2||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||6.5||37.4||43.8||PM1
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA GeForce GTX 2070||8||2304||7.4||38.8||46.2||MMR
|-
|Intel(R) Core(TM) i9-9900 CPU @ 3.10GHz ||NVIDIA Quadro RTX 4000||8||2304||6.6||39.8||46.4||CB1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.8||39.1||46.9||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||8.0||39.3||47.3||RCD
|-
|AMD Ryzen 7 7840HS ||NVIDIA GeForce RTX 4060 Laptop GPU||8||3072||7.0||40.6||47.6||CH1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||7.6||41.1||48.7||HNM
|-
|Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz ||NVIDIA GRID RTX6000P-4Q||24||4608||10.5||39.3||49.8||VDI
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz (Laptop) ||NVIDIA GeForce RTX 2070||8||2304||7.7||42.8||50.5||ERX
|-
|Intel(R) Xeon(R) Gold 5317 CPU @ 3.00GHz (48 CPUs) ||NVIDIA Tesla T4||16||2560||6.8||45.2||52.0||RJ1
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz
|NVIDIA GeForce RTX 3060
|8
|3584
|7.68
|45.92
|53.6
|AUBNEW1DQ54G3
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||8.0||47.4||55.3||BLK
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla T4||16||2560||7.3||48.3||55.6||FM-NODE: Tesla T4
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz ||NVIDIA GeForce GTX 1080||8||2560||8.5||48.9||57.3||JM1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||8.2||51.9||60.0||SKI
|-
|Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz ||NVIDIA Quadro P5000||16||2560||9.6||51.8||61.4||AR2
|-
|Intel(R) Xeon(R) W-2235 CPU @ 3.80GHz (12 CPUs)||NVIDIA RTX A2000||6||3328||9.1||54.4||63.5||HDR-A2000
|-
|Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz ||NVIDIA GeForce GTX 1070||8||1920||8.9||54.9||63.8||PY1
|-
|Intel(R) Core(TM) Ultra 7 155H (22 CPUs) @ 1.4GHz ||NVIDIA GeForce RTX 4050 Laptop GPU||6||2560||7.9||59.4||67.3||AL1
|-
|Intel(R) Xeon(R) CPU E5-1630 v4 @ 3.70GHz ||NVIDIA GeForce GTX 1070||8||1920||10.3||59.3||69.5||DS1
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA GeForce GTX 1660||6||1408||9.4||61.0||70.4||JFP
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA Quadro P4000||8||1792||10.0||62.3||72.3||DS2
|-
|11th Gen Intel(R) Core(TM) i7-11700 @ 2.50GHz (16 CPUs) ||NVIDIA GeForce GTX 1650 SUPER||4||1280||10.3||64.6||74.9||TS1
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla P4||8||2560||10.4||69.0||79.4||Google Cloud: Tesla P4
|-
|Intel(R) Core(TM) i7-5820K CPU @ 3.30GHz ||NVIDIA GeForce GTX 980||4||2048||11.8||70.6||82.3||ZDO
|-
|11th Gen Intel(R) Core(TM) i9-11950H @ 2.60GHz (16 CPUs), ~2.6GHz
|NVIDIA RTX A2000 Laptop GPU
|4
|2560
|11.4
|72.6
|84.0
|SK1
|-
|Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz ||NVIDIA GeForce GTX TITAN Black||6||2880||13.1||76.1||89.2||AR1
|-
|Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz ||NVIDIA GeForce GTX 1060||6||1280||13.0||77.1||90.1||RSH
|-
|Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz (64 CPUs), ~2.3GHz||NVIDIA Tesla M60||16||4096||12||82.7||94.7||SM2
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla K80||12||2496||11.3||83.5||94.8||Google Cloud: Tesla K80
|-
|Intel(R) Core(TM) i3-8100 CPU @ 3.60GHz ||NVIDIA Tesla K40c||12||2880||12.3||83.1||95.3||NWE
|-
|Intel(R) Core(TM) i7-5960X CPU @ 3.00GHz ||NVIDIA Quadro T2000||4||1024||13.3||85.2||95.5||SSM
|-
|Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz (Laptop) ||NVIDIA GeForce GTX 980||4||2048||17.5||84.2||101.7||MRT
|-
|Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz (16 CPUs), ~3.8GHz
|NVIDIA Quadro T1000
|4
|896
|13.6
|91.3
|104.9
|CB4
|-
|13th Gen Intel(R) Core(TM) i7-13800H (20 CPUs), ~2.5GHz
|NVIDIA RTX A500 Laptop GPU
|4
|2048
|14.8
|93.9
|108.7
|YB1
|-
|Intel(R) Xeon(R) W-2255 CPU @ 3.70GHz||NVIDIA Quadro P2000||5||1024||14.2||96||110.2||BL-DT01001
|-
|Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz ||NVIDIA Quadro P2000||5||1024||15.8||100.1||115.9||CR2
|-
|Intel(R) Xeon(R) CPU E3-1240 V2 @ 3.40GHz ||NVIDIA GeForce GTX 690||2||3072||18.4||114.4||132.8||MAV
|-
|AMD Ryzen Threadripper 1950X 16-Core Processor ||NVIDIA GeForce GTX 960||4||1024||18.6||123.3||141.6||CEV
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA GeForce GTX 960||4||1024||19.9||127.2||147.1||VHD
|-
|Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz||NVIDIA GeForce GTX 1050 Ti||4||768||21.1||133.8||154.9||MJS
|-
|Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz||NVIDIA GeForce GTX 1050||2||640||20.6||139.1||159.7||JM2
|-
|Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz||NVIDIA Quadro P2000||5||1024||22.1||142.5||164.6||KTC
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz||NVIDIA Quadro P2000||5||1024||23.0||149.3||172.3||RL2
|-
|Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz||NVIDIA Quadro M2200||4||1024||23.2||198.7||222.0||GYB
|-
|Intel(R) Core(TM) i7-1185G7 @ 3.00GHz||NVIDIA T500||4||986||29.3||197.5||226.8||TJS
|-
|Intel(R) Xeon(R) E-2176M CPU @ 2.70GHz ||NVIDIA Quadro P1000||4||640||30.3||203.7||234.0||RL3
|-
|Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz ||NVIDIA Quadro K2200||4||640||32.5||211.3||243.8||JIW
|-
|AMD EPYC 74F3 24-Core Processor (6 CPUs) @ 3.2GHz||NVIDIA A10-4Q||24||8192||44.5||212.6||257.1||RBR
|-
|Intel(R) Xeon(R) CPU E3-1505M v6 @ 3.00GHz ||NVIDIA Quadro M1200||4||640||84.9||278.4||363.3||GHY
|-
|Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz ||NVIDIA GeForce GTX 940MX||2||384||65.6||479.0||544.6||EAS
|-
|Intel(R) Core(TM) i7-5600U CPU @ 2.60GHz||NVIDIA GeForce 840M||2||384||70.6||526.3||595.9||CDH
|-
|Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz (Laptop)||NVIDIA GeForce GT 740M||2||384||102.3||694.0||796.3||HMM
|-
|}

=High End GPU Results=
A number of additional benchmarking tests have been completed on a 5m and 2.5m model on a single GPU card.

{| align="center" class="wikitable"
! style="background-color:#005581; font-weight:bold; color:white;" | Processor Name
! style="background-color:#005581; font-weight:bold; color:white;" width=24% | Graphics Card**
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | GPU RAM (GB)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Number of CUDA Cores*
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Runtime 2.5m (mins)
! style="background-color:#005581; font-weight:bold; color:white;" width=8% | Combined Runtime (mins)
! style="background-color:#C5C5C5; font-weight:bold; color:white;" width=12% | System Name
|-
|AMD Ryzen 9 9950X3D 16-Core Processor (32 CPUs), ~4.3GHz
|NVIDIA GeForce RTX 5090
|32
|21760
|73.3
|568.7
|642.0
|JW3
|-
|13th Gen Intel(R) Core(TM) i9-13900KS (32 CPUs) @ 3.2GHz||NVIDIA GeForce RTX 4090||24||16384||103.3||811.2||914.5||JB1
|-
|13th Gen Intel(R) Core(TM) i9-13900K (32 CPUs) @ 3.0GHz||NVIDIA GeForce RTX 4090||24||16384||105.9||813.7||919.6||TA1
|-
|13th Gen Intel(R) Core(TM) i7-13700KF (24 CPUs), @ 3.4GHz||NVIDIA GeForce RTX 4090||24||16384||103.7||824.3||928.0||JW1
|-
|AMD Ryzen 9 7950X 16-Core Processor (32 CPUs) @ 4.5GHz ||NVIDIA GeForce RTX 4090||24||16384||108.2||821.5||929.7||PSM
|-
|AMD Ryzen 9 3900X 12-Core Processor (24 CPUs) @ 3.8GHz ||NVIDIA GeForce RTX 4090||24||16384||106.8||875.5||982.3||CR4
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor (32 CPUs) @ 3.5GHz ||NVIDIA RTX 6000 Ada Generation||48||18176||119.6||877.8||997.4||JG3
|-
|12th Gen Intel(R) Core(TM) i9-12900 (24 CPUs) @ 2.4GHz ||NVIDIA GeForce RTX 4080||16||9728||139.5||1115.1||1254.6||JM3
|-
|Intel(R) Xeon(R) CPU @ 2.30GHz ||NVIDIA Tesla V100||16||5120||155.2||1172.9||1328.1||FM-NODE: Tesla V100
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||155.5||1176.2||1331.7||JMM
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3090||24||10496||158||1192.2||1350.2||CH3
|-
|Intel(R) Core(TM) i9-10900F CPU @ 3.70GHz ||NVIDIA GeForce RTX 3090||24||10496||162.3||1192.4||1354.7||LJA
|-
|AMD Ryzen 9 5900X 12-Core Processor ||NVIDIA GeForce RTX 3080 Ti||12||10240||159.7||1216.2||1375.9||GP1
|-
|12th Gen Intel(R) Core(TM) i9-12900K ||NVIDIA GeForce RTX 3090||24||10496||160.9||1240||1400.9||DD2
|-
|Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz ||NVIDIA GeForce RTX 3090||24||10496||172.9||1249.8||1422.7||SIP
|-
|AMD Ryzen 9 3900X 12-Core Processor ||NVIDIA GeForce RTX 3080||10||8704||178.9||1363.9||1542.8||KW2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||203.8||1523.9||1727.7||ACH
|-
|AMD Ryzen Threadripper 2950X 16-Core Processor ||NVIDIA TITAN RTX||24||4608||201.2||1548.1||1749.3||JGR
|-
|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||220.0||1634.5||1854.5||MA1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||222.2||1648.7||1870.9||JPI
|-
|Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (8 CPUs), ~3.6GHz ||NVIDIA GeForce RTX 2080 Ti||11||4352||215.9||1678.7||1894.6||PA2
|-
|AMD EPYC 74F3 24-Core Processor (36 CPUs), ~3.2GHz
|NVIDIA A10-24Q
|22
|9216
|242.3
|1856.5
|2098.8
|YW1
|-
|Intel(R) Core(TM) i9-9900K CPU @ (5.10GHz) ||NVIDIA GeForce RTX 2080 (core 2100MHz, mem 8000MHz)||8||2944||241.2||1863.5||2104.7||RRB
|-
|AMD Ryzen 9 5950X 16-Core Processor ||NVIDIA GeForce RTX 3070||8||5888||248.7||1928.6||2177.3||JG2
|-
|Intel(R) Core(TM) i9-9900KF CPU @ 3.60GHz ||NVIDIA GeForce RTX 2080 SUPER||8||3072||257.3||1957.7||2215.0||RH2
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce RTX 2080||8||2944||275.1||2147.4||2422.5||PM2
|-
|AMD Ryzen Threadripper 2990WX 32-Core Processor ||NVIDIA TITAN Xp||12||3840||296.0||2218.4||2514.4||FLC
|-
|Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||298.9||2290.1||2589.0||JS1
|-
|Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.3||2345.1||2656.4||615
|-
|Intel(R) Core(TM) i7-6850K CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||310.3||2377.2||2687.5||RCD
|-
|Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||308.7||2384.7||2693.4||RH1
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||311.9||2404.9||2716.7||PM1
|-
|Intel(R) Core(TM) i7-7820X CPU @ 3.60GHz ||NVIDIA GeForce GTX 1080 Ti||11||3584||324.8||2475.3||2800.1||HNM
|-
|Intel(R) Core(TM) i7-6900K CPU @ 3.20GHz ||NVIDIA GeForce GTX 1080||8||2560||439.0||3379.3||3818.2||BLK
|-
|Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz ||NVIDIA GeForce GTX 1070||8||1920||475.5||3788.2||4263.7||SKI
|-
|}
<pre> * it is noted that the number of CUDA cores is not provided as an output from the '''dxdiag''' command and this information has been sourced from the nvidia website.
** The output cpu.txt only provides the 'out of the box' processor speed. If you have overclocked your cpu and/or gpu, please send these details to TUFLOW Support so we can add the overclocked data in brackets. </pre>

{{Tips Navigation
|uplink=[[Hardware_Benchmarking | Back to TUFLOW Benchmarking]]
}}

PyTuflow

2025-12-19T02:55:42Z

Pavlina Monhartova: /* Latest Documentation */

=Introduction=
PyTUFLOW is a library that acts as an API for your TUFLOW model. It allows easy interaction with the model results, contains a number of useful utilities for building TUFLOW models, and contains some useful parsers for files within the TUFLOW eco-system.

==Latest Documentation==
The PyTUFLOW documentation has moved to a new location: [https://docs.tuflow.com/pytuflow/ PyTUFLOW Documentation].

The previous PyTUFLOW API has been deprecated and the wiki documentation has been archived. However, if needed, the archived documentation can still be accessed via the link in the section below.

==Archive Documentation==
Guidance for earlier version of PyTuflow can be accessed via the following link: [[PyTuflow_Archive| PyTuflow_Archive]].

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

Tutorial M01

2025-12-18T23:50:27Z

Pavlina Monhartova: /* TUFLOW Control File (TCF) */

= Introduction =
Read the [[Tutorial_Introduction | Tutorial Model Introduction]] before starting this tutorial. It outlines programs requiring installation and provides the tutorial dataset download link. 

In this module, a fully two-dimensional (2D) model is built with a number of TUFLOW control files and Geographic Information System (GIS) layers. 

The TUFLOW control files are: 
:* TUFLOW Simulation Control File (TCF)
:* TUFLOW Geometry Control File (TGC)
:* TUFLOW Boundary Control File (TBC)
:* TUFLOW Boundary Condition Database (bc_dbase)
:* TUFLOW Materials File (materials) 

The GIS layers are: 
:*TGC layers:
<ol><ol><li> 2d_loc: A layer defining the origin and orientation of the 2D grid.
<li> 2d_code: A layer containing polygons that define the cell codes (active or inactive status).
<li> *.tif: A DEM dataset defining the ground elevations within the 2D study area.
<li> 2d_mat: A layer defining the land-use (material) types within the 2D study area.</ol></ol>
:*TBC layers:
<ol><ol><li> 2d_bc: A layer defining the locations of external 2D boundaries.
<li> 2d_sa: A layer to define internal 2D flow boundaries.
</ol></ol>
:*TCF layers:
<ol><ol><li>2d_po: A time series data output from 2D domains, for a range of hydraulic parameters.
</ol></ol>
This tutorial is setup with shapefiles (SHP) and geopackage (GPKG) layers. For more information on these formats, see [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual].
 

= Project Initialisation =
TUFLOW models are separated into a series of folders which contain the input and output files. The recommended set up for the model directory and sub-folders is shown below. For a more detailed description, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
<ol>
[[File:Tute M01 Directory Structure v3.png|left]]
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Sub-Folder
! style="background-color:#005581; font-weight:bold; color:white;" width=10%| Input / Output
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description
|-
| bc_dbase|| Input || Boundary condition database(s) and input time-series data.
|-
| check|| Output || GIS and other check files to carry out quality control checks (use Write Check Files).
|-
| model|| Input ||Geometry (TGC), Boundary (TBC) and other model control text files (i.e. no GIS files).
|-
| model\gis|| Input || GIS layers that are inputs to the 2D and 1D model domains are contained within this folder, model\gis is typically used for all QGIS and ArcGIS files.
|-
| model\mi|| Input || GIS layers that are inputs to the 2D and 1D model domains are contained within this folder, model\mi is typically used for MapInfo formatted GIS files.
|-
| results|| Output|| TUFLOW outputs the results to this folder in specified formats.
|-
| runs|| Input|| TUFLOW Control Files (TCF).
|-
| runs\log|| Output || TUFLOW log files (TLF) and messages layers.
|}
</ol>
The TUFLOW folders can be set up manually, automatically running TUFLOW model with <tt> Write Empty GIS Files </tt> command or automatically through GIS programs:
:*[[Tutorial_M01_Configure_TUFLOW_Project_QGIS | QGIS - SHP]]
:*[[Tutorial_M01_Configure_TUFLOW_Project_QGIS_GPKG | QGIS - GPKG]]
:*SMS - the folder structure listed above is automatically created before running the model using the 'Export TUFLOW files' command (see [[Run TUFLOW from within SMS | Run TUFLOW from within SMS]]).
:*ArcMap (10.1 and newer) - the ArcTUFLOW Toolbox can be used to automatically create the model folders, model projection, TUFLOW control files and run TUFLOW to create the template files.

The following points on TUFLOW folders and filenames are worth noting:
:*TUFLOW accepts any folder structure, though the above listed format is most commonly used and is recommended. 
:*TUFLOW accepts spaces and special characters (such as ! or #) in filenames and paths, but other software may not. It is recommended that spaces and other special characters are not used in the simulation path and filenames. 
:*Folder paths, filenames, file extensions and TUFLOW commands are not case sensitive in any TUFLOW control files. 
:*Any directories that don't apply can be omitted, for example, if using QGIS or ArcMap the model\mi directory is not required. 
 

= Model Familiarisation=
Become familiar with the model location, using an aerial image and DEM: 
:*[[Tutorial_Site_Familiarisation_QGIS | QGIS]]
 

= TUFLOW Geometry Control File (TGC) =
The TGC file is a series of commands that build the geometry model. At its minimum, the TGC contains:
:*Information on the size and orientation of the grid;
:*Grid cell codes (whether cells are active or inactive);
:*Bed / ground elevations; and
:*Bed material type or flow resistance value.

Commands in the TGC file are applied in sequential order; the order (layering) of these commands is critical. The last occurrence of a command prevails, it is possible to override previous information with new data to modify the model in selected areas. This is useful but is also something to be aware of as to not override commands by mistake.

=== 2D Domain ===
Grid formats currently supported by TUFLOW include the ESRI ASCII grid format (.asc), binary grids (.flt) and geodetic grids (.tif). The Digital Elevation Model (DEM) is provided in .tif format. 

Defining the location and orientation of the TUFLOW 2D domain can be undertaken using four different methods: 
:*Specifying origin coordinates and a second set of coordinates for a point along the X-axis of the domain; 
:*Specifying the origin coordinate and domain orientation angle; 
:*Digitising a line (2d_loc) to represent the bottom edge of the 2D domain (with the line starting at the origin and finishing at a secondary location along the X-axis); or 
:*Digitising location polygon. 

The first method is covered in this tutorial as it is required to use a licence-free version of TUFLOW. The third method is the most commonly used. 
<ol>
<li>Create a new text file called '''M01_001.tgc''' and save it in '''Module_01\TUFLOW\model''' folder. Notice the use of ‘001’ for numbering. This is part of a naming convention, allowing for the iteration of both GIS and TUFLOW control files. This way allows files to be recognised from a specific run and also reverted back to a working iteration in model development. 
<li>Open the created '''M01_001.tgc''' in a text editor and specify the location and dimensions of the TUFLOW domain (rectangular computational area) and the cell size: 

<tt>Origin </tt> <tt>== </tt> <tt>292725, 6177615</tt> <tt> ! Bottom left corner (origin) of the 2D grid</tt> 
<tt>Orientation </tt> <tt>== </tt> <tt>293580, 6177415</tt> <tt> ! Point along the X-axis determining the orientation of the 2D grid </tt> 
<tt>Cell Size </tt> <tt>== </tt> <tt>5</tt> <tt> ! 2D cell size in metres</tt> 
<tt>Grid Size (X,Y) </tt> <tt>== </tt> <tt>850, 1000</tt> <tt> ! 2D grid extent dimensions in metres</tt> 
</ol>

=== Active and Inactive Areas of the 2D Domain ===
By default, every grid cell in a TUFLOW model is set as active and TUFLOW allows water to flow anywhere within the extents of the 2D domain. It is rare for a catchment to be a perfect rectangle. To reduce output file sizes and run times, permanently dry areas can be removed from the model. This can be an iterative process (i.e. run the model initially and refine). For the purpose of the tutorial a polygon is provided to define the active area. 
<ol>
<li>Set all 2D cells within the model domain rectangle to inactive by adding the following command to the TGC file: 
<tt>Set Code </tt> <tt>== </tt> <tt>0</tt> <tt> ! Sets all cells to inactive</tt>
<li>Define active areas: 
:*[[Tutorial_M01_Define_Active_Area_QGIS | QGIS - SHP]]
:*[[Tutorial_M01_Define_Active_Area_QGIS_GPKG | QGIS - GPKG]]
<li>Set all cells within the code polygon to active. The command needs to be written after the <tt> Set Code </tt> <tt>== </tt> <tt>0 </tt> command to overwrite the inactive cells within the polygon: 
'''QGIS - SHP''' 
<tt>Read GIS Code </tt> <tt>== </tt> <tt>gis\2d_code_M01_001_R.shp</tt> <tt> ! Sets cell codes according to attributes in the GIS layer</tt> 
'''QGIS - GPKG''' 
<tt>Read GIS Code </tt> <tt>== </tt> <tt>2d_code_M01_001_R</tt> <tt> ! Sets cell codes according to attributes in the GIS layer</tt> 
</ol>
Note: As mentioned, the order of commands in the TGC is critical. The final cell value (such as for code, elevation or material) is specified by the file lowest in the TGC. Consider the above two commands to set active and inactive cells, if the <tt>Read GIS Code </tt> was written before the <tt>Set Code </tt> command, all the cells within the code polygon would be first set to active and then overwritten to be all inactive, no hydraulic simulation could occur. 

=== Topography ===
The points that assign elevations at each 2D cell centre, mid-side and corner are called Zpts. For a description on the computational function of each of the Zpts in a TUFLOW cell, see [https://wiki.tuflow.com/Zpt_Description Zpt Description]. 

A DEM is used to assign elevations to the Zpts: 
<ol>
<li>Copy the DEM ('''DEM.tif''') from the '''DEM''' folder into a new '''Module_01\TUFLOW\model\grid''' folder. 
<li>Set a global elevation for the Zpts by adding the following line to the TGC file: 
<tt>Set Zpts </tt> <tt>== </tt> <tt> 100</tt> <tt> ! Sets every 2D elevation zpt to 100 metres</tt> 
<li>Assign elevations to the Zpts from the DEM. The command needs to be written after the <tt> Set Zpts </tt> <tt>== </tt> <tt>100 </tt> command to overwrite global Zpts where the DEM data are available: 
<tt>Read GRID Zpts </tt> <tt>== </tt> <tt> grid\DEM.tif</tt> <tt> ! Assigns the elevation of zpts from the grid</tt> 
</ol>
Note: The above data layering technique is common. After the first simulation, it is a good modelling practice to review the check files to confirm the topography in the model is as expected. Searching for a value of '100' is an easy way to identify if there are any gaps in the DEM dataset that were not expected (these should be fixed). 

=== Materials ===
Surface roughness or bed resistance values (e.g. Manning’s n) are assigned to material IDs. In order for TUFLOW to associate the Manning’s n to the Material ID, a TUFLOW materials file is required. This can be either a text file format .tmf, or a .csv file. This tutorial model utilises the csv format. 
<ol>
<li>Copy the '''materials.csv''' file from the '''Module_01\Tutorial_Data''' folder into the '''Module_01\TUFLOW\model''' folder. As a minimum this file must contain two columns; the first being the Material ID (as specified in the GIS layer), and the second being the Manning’s n. Additional data such as loss parameters and depth varying Manning's n values (applicable for direct rainfall modelling) are covered in later modules. 
 
[[File:Materials 02.png]] 
 
<li>Set a global material ID for all cells by adding the following line to the TGC file: 
<tt>Set Mat </tt> <tt>== </tt> <tt>1</tt> <tt> ! Sets all cells to a material ID of 1</tt> 
<li>Define spatial material definition:
:*[[Tutorial_M01_Materials_QGIS | QGIS - SHP]]
:*[[Tutorial_M01_Materials_QGIS_GPKG | QGIS - GPKG]]
<li>Assign materials from the GIS layer to overwrite the global material at all cells that fall within the material polygons: 
'''QGIS - SHP''' 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>gis\2d_mat_M01_001_R.shp</tt> <tt> ! Sets material values according to attributes in the GIS layer</tt> 
'''QGIS - GPKG''' 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_M01_001_R</tt> <tt> ! Sets material values according to attributes in the GIS layer</tt> 
<li>Save the TGC file.

</ol>
Note: As discussed in the previous sections, the order (layering) of these commands is important. 
 

= TUFLOW Boundary Control File (TBC) =
In this step the TBC and Boundary Condition Database (bc_dbase) are introduced. The TBC file contains information regarding the location of boundary conditions and internal links within the model. These include, but are not limited to: 

:*Upstream and downstream flow boundaries 
:*Downstream water level boundaries 
:*Water sources 
:*Direct rainfall
:*Infiltration 
:*1D/2D links 

=== Spatial Definition of Boundary Conditions ===
The following upstream and downstream boundaries are used in this tutorial: 

:*A flow vs time (QT) boundary and a source-area (SA) boundary is used for the inflows. 
:*A stage vs discharge (HQ) boundary is used for the outflow. 

Set up boundary condition layers: 

:*[[Tutorial_M01_Boundary_Conditions_QGIS | QGIS - SHP]]
:*[[Tutorial_M01_Boundary_Conditions_QGIS_GPKG | QGIS - GPKG]]

=== TUFLOW Boundary Control File (TBC) ===
The boundary condition layers are read into TUFLOW in a new text file, the TBC. 
<ol>
<li>Create a new text file and save as '''M01_001.tbc''' in the '''Module_01\TUFLOW\model''' folder. 
<li>Open the file in a text editor and add the boundary conditions: 
'''QGIS - SHP''' 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_M01_001_L.shp</tt> <tt> ! Reads in 2D boundaries</tt> 
<tt>Read GIS SA </tt> <tt>== </tt> <tt>gis\2d_sa_M01_001_R.shp</tt> <tt> ! Reads in 2D source area boundaries</tt> 
'''QGIS - GPKG''' 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_M01_001_L</tt> <tt> ! Reads in 2D boundaries</tt> 
<tt>Read GIS SA </tt> <tt>== </tt> <tt>2d_sa_M01_001_R</tt> <tt> ! Reads in 2D source area boundaries</tt> 
<li>Save the TBC.
</ol>
 

= TUFLOW Boundary Condition Database (bc_dbase) =
The bc_dbase is a comma delimited file with .csv extension. It can be opened in any spreadsheet software or a text editor. 
A hydrograph is associated with all of the upstream boundaries: 
<ol>
<li>Open the template bc database '''TUFLOW Tutorial Model BC Database.xlsx''' from the '''Module_01\Tutorial_Data''' folder. 
<li>There are two sheets in the file, 'bc_dbase' and '01p2hr'. Complete the bc_dbase worksheet: 
<ol>
<li>Enter the name of the first upstream boundary condition under the 'Name' heading. The name must appear exactly as it does in the boundary condition layer, (i.e. FC01). 
<li>Enter the text '01p2hr.csv' under the 'Source' heading. It is a source file for TUFLOW to extract the timeseries data. 
<li>Enter the text 'time' and 'inflow_FC01' under the 'Column 1' and 'Column 2' heading. These correspond to the data headers in the source timeseries file. 
</ol>
<li>Repeat the above process for all of the boundary conditions (i.e. FC02, FC04, FC05, FC06 and FC07). Note, FC02 is used in a later tutorial and Columns E to I are to remain black. The final bc_dbase should show as below: 
 
[[File:M01 bc dbase 003.png]] 
 
<li>Switch to the '01p2hr' sheet, and review the provided hydrographs. Note: the 'Inflow_FC02' hydrograph is not used in this tutorial. 
 
[[File:M01 100y2hr 002.png]] 
 
<li>Save both of the sheets in a csv format that TUFLOW can read. In the '''Module_01\TUFLOW\bc_dbase''' directory, there should be two new files, '''bc_dbase.csv''' and '''01p2hr.csv'''. 
</ol>
 

= 2D Time Series Plot Output =
The 2D plot output (2d_po) objects allow for a wide range of hydraulic parameters to be output from the 2D domain as time series data at predefined locations. 
:*[[Tutorial_M01_Time_Series_Plot_Output_QGIS | QGIS - SHP]] 
:*[[Tutorial_M01_Time_Series_Plot_Output_QGIS_GPKG | QGIS - GPKG]] 
 

= TUFLOW Control File (TCF) =
The TCF file references all the control files, specifies time and output controls. This is the last step before running the simulation. 
<ol>
<li>Create a new text file and save as '''M01_5m_001.tcf''' in the '''Module_01\TUFLOW\runs''' folder. 
<li>Open the file in a text editor and add the following commands: 
'''QGIS - SHP''' 
<tt>! MODEL INITIALISATION</tt> 
<tt>Tutorial Model </tt> <tt>== </tt> <tt> ON</tt> <tt> ! Required command to run this tutorial model licence free </tt> 
<tt>GIS Format </tt> <tt>== </tt> <tt> SHP</tt> <tt> ! Specify SHP as the output format for all GIS files</tt> 
<tt>SHP Projection </tt> <tt>== </tt> <tt> ..\model\gis\projection.prj </tt> <tt> ! Sets the GIS projection for the TUFLOW Model</tt> 
<tt>TIF Projection </tt> <tt>== </tt> <tt> ..\model\grid\DEM.tif </tt> <tt> ! Sets the GIS projection for the output grid files</tt> 
<tt>! Write Empty GIS Files == ..\model\gis\empty ! Creates template GIS layers, commented out as files were already created</tt> 
'''QGIS - GPKG''' 
<tt>! MODEL INITIALISATION</tt> 
<tt>Spatial Database </tt> <tt>== </tt> <tt> ..\model\gis\M01_001.gpkg </tt> <tt> ! Specify the location of the GeoPackage Spatial Database </tt> 
<tt>Tutorial Model </tt> <tt>== </tt> <tt> ON</tt> <tt> ! Required command to run this tutorial model licence free </tt> 
<tt>GIS Format </tt> <tt>== </tt> <tt> GPKG</tt> <tt> ! Specify GPKG as the output format for all GIS files</tt> 
<tt>GPKG Projection </tt> <tt>== </tt> <tt> ..\model\gis\projection.gpkg </tt> <tt> ! Sets the GIS projection for the TUFLOW Model</tt> 
<tt>TIF Projection </tt> <tt>== </tt> <tt> ..\model\grid\DEM.tif </tt> <tt> ! Sets the GIS projection for the output grid files</tt> 
<tt>! Write Empty GIS Files == ..\model\gis\empty ! Creates template GIS layers, commented out as files were already created</tt> 
<li> Define the solution scheme and specify Sub-Grid Sampling (SGS) commands: 
<tt>! SOLUTION SCHEME</tt> 
<tt>Solution Scheme </tt> <tt>== </tt> <tt> HPC</tt> <tt> ! Heavily Parallelised Compute, uses adaptive timestepping</tt> 
<tt>Hardware </tt> <tt>== </tt> <tt> GPU</tt> <tt> ! Comment out if GPU card is not available or replace with "Hardware == CPU" </tt> 
<tt>SGS </tt> <tt>== </tt> <tt> ON</tt> <tt> ! Switches on Sub-Grid Sampling</tt> 
<tt>SGS Sample Target Distance</tt> <tt>== </tt> <tt> 0.5</tt> <tt> ! Sets SGS Sample Target Distance to 0.5m</tt> 
For information on SGS, see Section 3.2 of the latest [https://downloads.tuflow.com/TUFLOW/Releases/2020-10/TUFLOW%20Release%20Notes.2020-10-AD.pdf Release Notes])
 

<li> Update the model inputs section. These commands reference the TGC, TBC, bc_dbase and materials file created in the above steps: 
<tt>! MODEL INPUTS</tt> 
<tt>Geometry Control File </tt> <tt>== </tt> <tt>..\model\M01_001.tgc</tt> <tt> ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt> ..\model\M01_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Conditions Control File</tt> 
<tt>BC Database </tt> <tt>== </tt> <tt> ..\bc_dbase\bc_dbase.csv</tt> <tt> ! Reference the Boundary Conditions Database</tt> 
<tt>Read Materials File </tt> <tt>== </tt> <tt>..\model\materials.csv</tt> <tt> ! Reference the Materials Definition File</tt> 

<li>Add the following time control commands: 
<tt>! TIME CONTROL</tt> 
<tt>Timestep </tt> <tt>== </tt> <tt> 1</tt> <tt> ! Specifies the first 2D computational timestep of 1 second</tt> 
<tt>Start Time </tt> <tt>== </tt> <tt> 0</tt> <tt> ! Specifies a simulation start time of 0 hours</tt> 
<tt>End Time </tt> <tt>== </tt> <tt> 3</tt> <tt> ! Specifies a simulation end time of 3 hours</tt> 

<li>Add the following output folder commands: 
<tt>! OUTPUT FOLDERS</tt> 
<tt>Log Folder </tt> <tt>== </tt> <tt> log</tt> <tt> ! Location of the log output files (e.g. .tlf and _messages files)</tt> 
<tt>Output Folder </tt> <tt>== </tt> <tt> ..\results\</tt> <tt> ! Location of the 2D output files and prefixes them with the .tcf filename</tt> 
<tt>Write Check Files </tt> <tt>== </tt> <tt> ..\check\</tt> <tt> ! Location of the 2D check files and prefixes them with the .tcf filename</tt> 

<li>Add the following output settings commands: 
<tt>! OUTPUT SETTINGS</tt> 
<tt>Map Output Format </tt> <tt>== </tt> <tt> XMDF TIF</tt> <tt> ! Result file types</tt> 
<tt>Map Output Data Types </tt> <tt>== </tt> <tt> h V d dt</tt> <tt> ! Outputs water levels, velocities, depths, minimum timestep</tt> 
<tt>Map Output Interval </tt> <tt>== </tt> <tt> 300</tt> <tt> ! Outputs map data every 300 seconds (5 minutes)</tt> 
<tt>TIF Map Output Interval </tt> <tt>== </tt> <tt> 0</tt> <tt> ! Outputs only maximums for grids</tt> 

<li>Reference the 2d_po layers. When reading in time-series layers, such as 2d_po files, its necessary to use a <tt>Time Series Output Interval </tt> command. This command specifies the output interval in seconds for the time-series based output: 
'''QGIS - SHP''' 
<tt>! TIME SERIES PLOT OUTPUT</tt> 
<tt>Read GIS PO </tt> <tt>== </tt> <tt> ..\model\gis\2d_po_M01_001_L.shp</tt> <tt> ! Reads in plot output line</tt> 
<tt>Read GIS PO </tt> <tt>== </tt> <tt> ..\model\gis\2d_po_M01_001_P.shp</tt> <tt> ! Reads in plot output point</tt> 
<tt>Time Series Output Interval </tt> <tt>== </tt> <tt> 60</tt> <tt> ! Outputs time series data every 60 seconds</tt> 
'''QGIS - GPKG''' 
<tt>! TIME SERIES PLOT OUTPUT</tt> 
<tt>Read GIS PO </tt> <tt>== </tt> <tt> 2d_po_M01_001_L</tt> <tt> ! Reads in plot output line</tt> 
<tt>Read GIS PO </tt> <tt>== </tt> <tt> 2d_po_M01_001_P</tt> <tt> ! Reads in plot output point</tt> 
<tt>Time Series Output Interval </tt> <tt>== </tt> <tt> 60</tt> <tt> ! Outputs time series data every 60 seconds</tt> 
<li>Save the TCF file. The TUFLOW simulation is ready to be run for the first time.
</ol>
The comments (following the exclamation marks) are not required and these commands are generally self explanatory. For this tutorial model they are included to clarify the purpose of each line. 
 

= Running the Simulation =
Set up a simple batch file (.bat) to run TUFLOW. This approach calls the TUFLOW executable file (.exe) and runs the TCF file.
<ol>
<li>Create a new text file in the '''Module_01\TUFLOW\runs''' folder and save as '''_run_M01_HPC.bat'''.
<li>Open the '''_run_M01_HPC.bat''' in a text editor and include a file path to the executable from the '''exe\2025.1.0''' folder and the TCF name: 
<tt>"..\..\..\exe\2025.1.0\TUFLOW_iSP_w64.exe" M01_5m_001.tcf</tt> 
Note: A relative path is used for the executable and the TCF, a full file path can also be used.
<li>Save the batch file and double click it in file explorer to run the simulation.
</ol>
This opens the TUFLOW console window and the simulation begins running. The simulation usually takes a few minutes to process (depending on the computer hardware). While the model is running, it is a good practise to fill out a modelling log. It includes developer notes keeping a record of TUFLOW simulations and changes from one version to the next, for more information see [https://wiki.tuflow.com/TUFLOW_Modelling_Log here]. A template is included in the '''Module_01\Tutorial_Data''' folder. 
If the simulation is successful, the console window should look like the image below.
<ol>
 
[[File:Simulation_Finished_a.png]] 
 
</ol>

= Troubleshooting =
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]
 

= Check Files =
TUFLOW writes a series of check files during the model initialisation process when the <tt>Write Check Files </tt> command is specified in the TCF. The files are either in a tabular form (.csv), GIS Vector format (.gpkg, .shp, .mif) or GIS Raster format (.tif, .flt, .asc) and contain information on the input data processed by TUFLOW. 
While the model is running, review the added features are specified correctly: 

:*[[Tutorial_M01_Check_Files_QGIS | QGIS - SHP]]
:*[[Tutorial_M01_Check_Files_QGIS_GPKG | QGIS - GPKG]]
 

= Results=
Two map output formats specified for this tutorial:
:*TIF - Grid based output format writing map output data types separately
:*XMDF - Mesh based output format containing all map output data types in a single file
When the model is finished, review the results: 
:*[[Tutorial_M01_Results_QGIS | QGIS]]
 

= Reviewing Model Performance =
There are a number of useful outputs from TUFLOW for reviewing the model performance. 
=== TUFLOW Log File ===
The first place to look is in the TUFLOW Log File (TLF). The <tt>Log Folder </tt> <tt>== </tt> <tt> log</tt> command in the TCF controls where the log file is written. 
Navigate to the '''Module_01\TUFLOW\runs\log''' folder and open the '''M01_5m_001.tlf''' file in a text editor. Scroll down to the bottom to 'Simulation Summary'. This includes information about the computation time, messages, volume calculations and mass error. 
<ol>
 
[[File:Simulation_Summary_02a.PNG]] 
 
</ol>

=== HPC TUFLOW Log File ===
As the model is using the HPC solution scheme, there is a second log file automatically written from the same command. Navigate to the '''Module_01\TUFLOW\runs\log''' folder and open the '''M01_5m_001.hpc.tlf''' file. The HPC solution scheme, by default, uses adaptive timestepping to progress through the simulation. The timestep is adjusted so it complies with the mathematical stability criteria of a 2D SWE explicit solution. This is controlled by three control numbers, further information is provided [https://wiki.tuflow.com/HPC_Adaptive_Timestepping here]. 
Scroll down the '''hpc.tlf''' to 'iStep'. This is the point at which the model successfully compiled and began running. The three HPC control numbers are listed in the columns after time. Then the number of wet cells, the volume of water, the dt (minimum timestep) and the efficiency of the solver. As the model starts to gain wet cells dt drops, but should eventually stabilise. Similarly, model efficiency should increase as the model progresses. 
 
<ol>
[[File:Simulation HPC.PNG]] 
</ol>
 

=== Other Model Performance Indicators ===
For more information on how to review HPC models, see [[HPC_Model_Review | HPC Model Review]]. 
 

= Conclusion =
:*Simple 2D TUFLOW model was created with required GIS and text based inputs.
:*Check files were used to review the model setup.
:*Results were visualised and the performance of the model reviewed. 
:*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
:*Alternatively, see the [[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]] to explore the full list of TUFLOW features.
 

= Increasing Model Resolution (Optional) =
This section includes an optional exercise to reduce the cell size from 5m to 2.5m. Consider the impact this has on the model results and the runtime. 
To reduce the cell size in the model: 
<ol>
<li>Save the TUFLOW control file '''M01_5m_001.tcf''' as '''M01_2.5m_001.tcf'''.
<li>Save the geometry control file '''M01_001.tgc''' as '''M01_2.5m_001.tgc'''.
<li>Modify the cell size in the geometry control file to '2.5' meters.
<li>In the TCF, update the reference to the new TGC.
<li>Update the batch file with the updated TCF file and run the simulation.
 </ol>
 
{{Tips Navigation
|uplink=[[Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

PyTuflow

2025-12-16T23:40:33Z

Pavlina Monhartova: /* Latest Documentation */

PyTuflow

2025-12-16T23:40:22Z

Pavlina Monhartova: Replaced content with "=Introduction= PyTUFLOW is a package of Python tools for extracting TUFLOW Classic and HPC time series results. It can be used to automate output tasks such as checking model health, goodness-of-fit for model calibration, viewing on-the-fly model output (used in conjunction with <tt>Write PO Online == ON</tt>), and high-volume output plotting from production runs. For worked examples demonstrating the use of..."

PyTuflow

2025-12-16T23:36:21Z

Pavlina Monhartova: /* Archive Guidance */

=Introduction=
PyTUFLOW is a package of Python tools for extracting TUFLOW Classic and HPC time series results. It can be used to automate output tasks such as checking model health, goodness-of-fit for model calibration, viewing on-the-fly model output (used in conjunction with <tt>Write PO Online == ON</tt>), and high-volume output plotting from production runs. 
For worked examples demonstrating the use of PyTUFLOW, please register for the free [https://www.tuflow.com/training/training-catalogue/tt004e-introduction-to-python-for-tuflow-elearning/ Introduction to Python for TUFLOW] eLearning Course.

=Installation=
The PyTuflow library can be installed via Python's packaging manager (pip). 
Open up the command prompt and enter the following: 
<pre>
python -m pip install pytuflow
</pre>

If python is not on your system path, you can navigate to the folder containing the <tt>python.exe</tt> before trying to install PyTuflow 
e.g. 
<pre>
cd c:\Python39
python -m pip install pytuflow
</pre>

=Class: ResData=

Class for TUFLOW time series results.

Initialised as an empty object, or with results with a *.tpc in TUFLOW 2016 release and later or *.info in TUFLOW 2013 release.

<pre>
import pytuflow

res = pytuflow.ResData() # initialising as an empty object
# or
res = pytuflow.ResData('M01_5m_001.tpc') # initialising with results
</pre>

==Methods==
{|class="wikitable" style="text-align: left;"
|! style="background-color:#005581; font-weight:bold; color:white" width=30%| Method
|! style="background-color:#005581; font-weight:bold; color:white;" width=20%|Description
|! style="background-color:#005581; font-weight:bold; color:white;" width=25%|Returns
|-
|rowspan='1' style='text-align: left'|[[#channelConnectionCount|channelConnectionCount]] ( ''str'' Node ID )
|rowspan='1'|Returns the number of channels connected to a given node
|''int'' Count
|-
|rowspan='1'|[[#channelConnections|channelConnections]] ( ''str'' Node ID )
|rowspan='1'|Returns a list of the channels connected to a given node
|''list'' Channel IDs
|-
|rowspan='1'|[[#channelCount|channelCount]] ()
|rowspan='1'|Returns the total number of channels in results
|''int'' Count
|-
|rowspan='1'|[[#channelResultTypes|channelResultTypes]] ()
|rowspan='1'|Returns a list of all the available result types for channels
|list of Result Types
|-
|rowspan='1'|[[#channels|channels]] ()
|rowspan='1'|Returns a list of all the channels IDs in the results
|''list'' Channel IDs
|-
|rowspan='1'|[[#channelsDownstream|channelsDownstream]] ( ''str'' Node ID )
|rowspan='1'|Returns a list of all the channels downstream of a given node
|''list'' Channel IDs
|-
|rowspan='1'|[[#channelsUpstream|channelsUpstream]] ( ''str'' Node ID )
|rowspan='1'|Returns a list of all the channels upstream of a given node
|''list'' Channel IDs
|-
|rowspan='1'|[[#format|format]] ()
|rowspan='1'|Returns the result format i.e. '2013' or '2016'
|''str'' Format
|-
|rowspan='2'|[[#getAdverseGradients|getAdverseGradients]] ()
|rowspan='2'|Returns locations of any adverse water level or energy level (if result type available) gradients in long profile. Note getLongProfileData method must be called prior to calling this method
|''tuple'' Adverse Water Level Gradient Locations ( ''list'' x data, ''list'' y data )
|-
|''tuple'' Adverse Energy Level Gradient Locations ( ''list'' x data, ''list'' y data )
|-
|rowspan='3'|[[#getLongProfileData|getLongProfileData]] ( ''float'' Timestep, ''str'' Result Type, ''str'' Channel ID, [optional] ''str'' 2nd Channel ID )
|rowspan='3'|Returns long profile data from a given channel to another channel. If no second channel is specified will continue until no further channels downstream
|''bool'' Error
|-
|''str'' Message
|-
|''tuple'' Profile Data ( ''list'' x values, ''list'' y values )
|-
|rowspan='2'|[[#getLongProfileTimeOfMaximum|getLongProfileTimeOfMaximum]] ()
|rowspan='2'|Returns the time of maximum water level along the current profile. Note getLongProfileData method must be called prior to calling this method
|''list'' x values
|-
|''list'' y values
|-
|rowspan='1'|[[#getPipes|getPipes]] ()
|rowspan='1'|Returns any pipe or culvert data in the current profile. Note getLongProfileData method must be called prior to calling this method
|''list'' pipes [ ''list'' pipe vertexes [ ''tuple'' vertex ( x point, y point ) ] ]
|-
|rowspan='3'|[[#getTimeSeriesData|getTimeSeriesData]] ( ''str'' Element, ''str'' Result Type, [optional] ''str'' domain )
|rowspan='3'|Returns time series data for the given element (1D node, 1D channel, 2D PO, RL) for a the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''tuple'' time series data ( ''list'' x data, ''list'' y data )
|-
|rowspan='2'|[[#load|load]] ( ''str'' Filepath )
|rowspan='2'|Loads result file. File formats are *.tpc for TUFLOW release 2016 and later, or *.info for TUFLOW release 2013
|''bool'' Error
|-
|''str'' Message
|-
|rowspan='1'|[[#longProfileResultTypes|longProfileResultTypes]] ()
|rowspan='1'|
|''list'' Result Types
|-
|rowspan='3'|[[#maximum|maximum]] ( ''str'' Element, ''str'' Result Type, [optional] ''str'' Domain )
|rowspan='3'|Returns the maximum result value for the given element (1D node, 1D channel, 2D PO, RL) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''float'' Maximum Value
|-
|rowspan='3'|[[#maximumTimestepChange|maximumTimestepChange]] ( ''str'' Element, ''str'' Result Type, [optional] ''str'' Domain )
|rowspan='3'|Returns the maximum change in result value in one timestep for the given element (RL elements supported only) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''float'' Maximum Value
|-
|rowspan='1'|[[#name|name]] ()
|rowspan='1'|Returns the name of the result
|''str'' Name
|-
|rowspan='1'|[[#nodeCount|nodeCount]] ()
|rowspan='1'|Returns the total number of nodes in the results
|''int'' Count
|-
|rowspan='1'|[[#nodeDownstream|nodeDownstream]] ( ''str'' Channel ID )
|rowspan='1'|Returns the name of the downstream node of a given channel
|''str'' Node ID
|-
|rowspan='1'|[[#nodeResultTypes|nodeResultTypes]] ()
|rowspan='1'|Returns a list of all the available result types for nodes
|''list'' Result Types
|-
|rowspan='1'|[[#nodes|nodes]] ()
|rowspan='1'|Returns a list of all the node IDs in the results
|''list'' Node IDs
|-
|rowspan='1'|[[#nodeUpstream|nodeUpstream]] ( ''str'' Channel ID )
|rowspan='1'|Returns the name of the upstream node of a given channel
|''str'' Node ID
|-
|rowspan='1'|[[#poNames|poNames]] ()
|rowspan='1'|Returns a list of all the available Plot Output names
|''list'' PO ID
|-
|rowspan='1'|[[#poResultTypes|poResultTypes]] ()
|rowspan='1'|Returns a list of all the available Plot Output result types
|''list'' Result Types
|-
|rowspan='1'|[[#rlCount|rlCount]] ()
|rowspan='1'|Returns the total number of Reporting Locations (of all geometry type) in the results
|''int'' Count
|-
|rowspan='1'|[[#rlLineCount|rlLineCount]] ()
|rowspan='1'|Returns the total number of line Reporting Locations in the results
|''int'' Count
|-
|rowspan='1'|[[#rlNames|rlNames]] ()
|rowspan='1'|Returns a list of all the Reporting Location names
|''list'' RL ID
|-
|rowspan='1'|[[#rlPointCount|rlPointCount]] ()
|rowspan='1'|Returns the total number of point Reporting Locations in the results
|''int'' Count
|-
|rowspan='1'|[[#rlRegionCount|rlRegionCount]] ()
|rowspan='1'|Returns the total number of region Reporting Locations in the results
|''int'' Count
|-
|rowspan='1'|[[#rlResultTypes|rlResultTypes]] ()
|rowspan='1'|Returns a list of all the available Reporting Location result types
|''list'' Result Types
|-
|rowspan='1'|[[#source|source]] ()
|rowspan='1'|Returns the full file path to the source result file (*.tpc or *.info)
|''str'' Path
|-
|rowspan='3'|[[#timeOfMaximum|timeOfMaximum]] ( ''str'' Element, ''str'' Result Type, [optional] ''str'' Domain )
|rowspan='3'|Returns the time of maximum for the given element (1D node, 1D channel, 2D PO, RL) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''float'' Time (hrs)
|-
|rowspan='3'|[[#timeOfMaximumTimestepChange|timeOfMaximumTimestepChange]] ( ''str'' Element, ''str'' Result Type, [optional] ''str'' Domain )
|rowspan='3'|Returns the time of maximum for change in result value in one timestep for the given element (RL elements supported only) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''float'' Time (hrs)
|-
|}

==channelConnectionCount==

channelConnectionCount ( Node ID ) 
Returns the number of channels connected to a given node 
;Parameters:
: '''Node ID:''' ''str''
:: Name or ID of node e.g. 'Chan_A.1'
;Returns:
: '''Count:''' ''int''
:: Number of connected channels
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
conn_count = res.channelConnectionCount(node)
# print to console
print('{0} channels connected to {1}'.format(conn_count, node))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channelConnections==

channelConnections ( Node ID ) 
Returns a list of the channels connected to a given node 
;Parameters:
: '''Node ID:''' ''str''
:: Name or ID of node e.g. 'Chan_A.1'
;Returns:
: '''Out:''' ''list''
:: List of connected channels e.g. ['Chan_A', 'Chan_B']
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
conn_chans = res.channelConnections(node)
# print to console
print('Channels connected to {0}:'.format(node))
for chan in conn_chans:
print(chan)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channelCount==

channelCount () 
Returns the total number of channels in results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of channels
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
chan_count = res.channelCount()
# print to console
print('{0} channels in results'.format(chan_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channelResultTypes==

channelResultTypes () 
Returns a list of all the available result types for channels 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of result types e.g. ['Q', 'V']
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
chan_rt = res.channelResultTypes()
# print to console
print('Available channel result types:')
for rt in chan_rt:
print(rt)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channels==
channels () 
Returns a list of all the channels IDs in the results 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of channels e.g. ['Chan_A', 'Chan_B', 'Chan_C']
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
chans = res.channels()
# print to console
print('Channels:')
for chan in chans:
print(chan)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channelsDownstream==
channelsDownstream ( Node ID ) 
Returns a list of all the channels downstream of a given node 
;Parameters:
: '''Node ID:''' ''str''
:: Name or ID of node e.g. 'Chan_A.1'
;Returns:
: '''Out:''' ''list''
:: List of channels e.g. ['Chan_B']
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
dns_chans = res.channelsDownstream(node)
# print to console
print('Channels downstream of {0}:'.format(node))
for chan in dns_chans:
print(chan)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==channelsUpstream==
channelsUpstream ( Node ID ) 
Returns a list of all the channels upstream of a given node 
;Parameters:
: '''Node ID:''' ''str''
:: Name or ID of node e.g. 'Chan_A.1'
;Returns:
: '''Out:''' ''list''
:: List of channels e.g. ['Chan_A']
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
ups_chans = res.channelsUpstream(node)
# print to console
print('Channels upstream of {0}:'.format(node))
for chan in ups_chans:
print(chan)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==format==
format () 
Returns the result format i.e. '2013' or '2016' 
;Parameters:
: -
;Returns:
: '''Format:''' ''str''
:: Format of results e.g. '2016'
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
format = res.format()
# print to console
print('Results format: {0}'.format(format)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==getAdverseGradients==
getAdverseGradients () 
Returns locations of any adverse water level or energy level (if result type available) gradients in long profile. Note getLongProfileData method must be called prior to calling this method 
;Parameters:
: -
;Returns:
: '''Adverse water level gradients:''' ''tuple''
:: ( ''list'' x data, ''list'' y data ) e.g. ([0, 5], [10, 12])
: '''Adverse energy level gradients:''' ''tuple''
:: ( ''list'' x data, ''list'' y data ) e.g. ([0, 5], [11, 14])
'''Example'''
<pre>
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()

# get long profiles and add to plot
chan = 'Chan_A'
timestep = 1.0
result_types = ['Bed Level', 'H'] # get both water level and bed level
for rt in result_types:
err_lp, mess_lp, data = res.getLongProfileData(timestep, rt, chan)

# check for error before plotting
if not err_lp:
x, y = data
ax.plot(x, y, label=rt)
else:
# error occurred getting long profile data, print error message to console
print(mess_lp)

# check for adverse gradients
adv = res.getAdverseGradients()
for i, data in enumerate(adv):
x, y = data

# get appropriate label
# getAdverseGradients() returns 2 datasets:
# first dataset adverse water level
# second dataset adverse energy level
if i == 0: # first dataset
label = 'Adverse Water Levels'
else: # second dataset
label = 'Adverse Energy Levels'

# add to plot as points
ax.plot(x, y, label=label, marker='o', linestyle='None')

# add legend to plot
lines, labs = ax.get_legend_handles_labels()
ax.legend(lines, labs)

# show plot
fig.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>

==getLongProfileData==
getLongProfileData ( Timestep, Result Type, Channel ID, [optional] 2nd Channel ID ) 
Returns long profile data from a given channel to another channel. If no second channel is specified will continue until no further channels downstream 
;Parameters:
: '''Timestep:''' ''float'' or ''str''
:: Output timestep to plot. Can be a value e.g. 1.5 or string e.g. 'max'
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Channel ID:''' ''str''
:: Starting channel for long profile e.g. 'Chan_A'
: '''2nd Channel ID:''' ''str''
:: Optional downstream channel ID to stop the long profile at e.g. 'Chan_D'
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Data:''' ''tuple''
:: '''x data points:''' ''list''
::: '''data point:''' ''float''
:: '''y data points:''' ''list''
::: '''data point:''' ''float''
:::: e.g. ([0, 1, 2, 3, 4, 5], [10, 20, 30, 20, 10, 0]
'''Example'''
<pre>
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()

# get long profiles and add to plot
chan = 'Chan_A'
timestep = 1.0
result_types = ['Bed Level', 'H'] # get both water level and bed level
for rt in result_types:
err_lp, mess_lp, data = res.getLongProfileData(timestep, rt, chan)

# check for error before plotting
if not err_lp:
x, y = data
ax.plot(x, y, label=rt)
else:
# error occurred getting long profile data, print error message to console
print(mess_lp)

# add legend to plot
lines, labs = ax.get_legend_handles_labels()
ax.legend(lines, labs)

# show plot
fig.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>

==getLongProfileTimeOfMaximum==
getLongProfileTimeOfMaximum () 
Returns the time of maximum water level along the current profile. Note getLongProfileData method must be called prior to calling this method 
;Parameters:
: -
;Returns:
: '''x data:''' ''list''
:: x points for plotting time of max along long profile e.g. [0, 1, 2, 3, 4, 5]
: '''y data:''' ''list''
:: y points for plotting time of max along long profile e.g. [10, 11, 12, 13, 14, 15]
'''Example'''
<pre>
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()

# get long profiles and add to plot
chan = 'Chan_A'
timestep = 'max' # maximum result along profile
result_types = ['Bed Level', 'H'] # get both water level and bed level
for rt in result_types:
err_lp, mess_lp, data = res.getLongProfileData(timestep, rt, chan)

# check for error before plotting
if not err_lp:
x, y = data
ax.plot(x, y, label=rt)
else:
# error occurred getting long profile data, print error message to console
print(mess_lp)

# also plot time of max water level on secondary axis
tom_x, tom_y = res.getLongProfileTimeOfMaximum()
ax2 = ax.twinx() # initialise secondary axis

# add to plot on secondary axis
ax2.plot(tom_x, tom_y, label='Time of Maximum', linestyle='--')

# combine axis legends and add to plot
lines, labs = ax.get_legend_handles_labels()
lines2, labs2 = ax2.get_legend_handles_labels()
comb_lines = lines + lines2
comb_labs = labs + labs2
ax.legend(comb_lines, comb_labs)

# show plot
fig.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>

==getPipes==
getPipes () 
Returns any pipe or culvert data in the current profile. Note getLongProfileData method must be called prior to calling this method 
;Parameters:
: -
;Returns:
: '''Pipe list:''' ''list''
:: '''Vertex list:''' ''list''
::: '''Vertex coords:''' ''tuple''
:::: e.g. [[(0, 0), (0, 1), (1, 1), (1, 0)], [(1, 1), (1, 2), (2, 2), (2, 1)]]
'''Example'''
<pre>
import matplotlib.pyplot as plt # plotting library
from matplotlib.patches import Polygon # will add pipes and culverts as polygon
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()

# get long profiles and add to plot
chan = 'Chan_A'
timestep = 1.0
result_types = ['Bed Level', 'H'] # get both water level and bed level
for rt in result_types:
err_lp, mess_lp, data = res.getLongProfileData(timestep, rt, chan)

# check for error before plotting
if not err_lp:
x, y = data
ax.plot(x, y, label=rt)
else:
# error occurred getting long profile data, print error message to console
print(mess_lp)

# get pipes and culverts and add to plot
pipes = res.getPipes()
for pipe in pipes: # loop through all pipes
polygon = Polygon(pipe, facecolor='0.9', edgecolor='0.5', label='Culverts and Pipes')
ax.add_patch(polygon)

# add legend to plot
lines, labs = ax.get_legend_handles_labels()

# filter duplicate legend items
# for example if there is more than one pipe or culvert we only want that to appear once in the legend
unique_lines = []
unique_labels = []
for i, label in enumerate(labs):
if label not in unique_labels:
unique_labels.append(label)
unique_lines.append(lines[i])
ax.legend(unique_lines, unique_labels)

# show plot
fig.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>

==getTimeSeriesData==
getTimeSeriesData ( Element, Result Type, [optional] domain ) 
Returns time series data for the given element (1D node, 1D channel, 2D PO, RL) for a the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL') 
;Parameters:
: '''Element:''' ''str''
:: Channel, Node, PO, or RL element to get time series data for
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Domain:''' ''str''
:: Optional input to specify which domain the Element belongs in. If left as default (None) and there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements.
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Data:''' ''tuple''
:: '''x data points:''' ''list''
:: '''y data points:''' ''list''
::: e.g. ([0, 1, 2, 3, 4, 5], [10, 20, 30, 20, 10, 0]
'''Examples''' 
Plotting results for multiple elements on the same graph
<pre>
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()

# get time series data and add to plot
elements = ['Chan_A', 'Chan_B', 'Chan_C']
result_type = 'Q'
for element in elements:
err_ts, mess_ts, data = res.getTimeSeriesData(element, result_type)

# check for error before plotting
if not err_ts:
x, y = data
ax.plot(x, y, label=element)
else:
# error occurred getting time series data, print error message to console
print(mess_ts)

# add legend to plot
lines, labs = ax.get_legend_handles_labels()
ax.legend(lines, labs)

# show plot
plt.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>
Plotting water level and velocity on the same plot using a secondary axis
<pre>
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before continuing
if not err:
# initialise plot
fig, ax = plt.subplots()
# initialise secondary axis
ax2 = ax.twinx()

# get time series data and add to plot
elements = ['Chan_A', 'Chan_B', 'Chan_C']
result_types = ['Q', 'V']
for element in elements:
for result_type in result_types:
err_ts, mess_ts, data = res.getTimeSeriesData(element, result_type)

# check for error before plotting
if not err_ts:
x, y = data
label = '{0}: {1}'.format(result_type, element)

# plot Q on first axis, V on secondary axis
if result_type == 'Q':
# first axis
ax.plot(x, y, label=label)
else: # must be 'V'
# secondary axis
ax2.plot(x, y, label=label, linestyle='--')
else:
# error occurred getting time series data, print error message to console
print(mess_ts)

# combine primary and secondary axis items and add to legend
lines, labs = ax.get_legend_handles_labels()
lines2, labs2 = ax2.get_legend_handles_labels()
lines_comb = lines + lines2
labs_comb = labs + labs2
ax.legend(lines_comb, labs_comb)

# show plot
fig.show()
else:
# did not load correctly, print error message to console
print(message)
</pre>
Saving a separate plot for each element as a *.png
<pre>
import os # library for operating system file and directory manipulation
import matplotlib.pyplot as plt # plotting library
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# save directory for figures
save_dir = r'C:TUFLOW\results\figures'

# check results were loaded successfully before continuing
if not err:
# get time series data and add to plot
elements = ['Chan_A', 'Chan_B', 'Chan_C']
result_type = 'Q'
for element in elements:
err_ts, mess_ts, data = res.getTimeSeriesData(element, result_type)

# check for error before plotting
if not err_ts:
# initialise plot
fig, ax = plt.subplots()
x, y = data
ax.plot(x, y, label=element)

# add legend to plot
lines, labs = ax.get_legend_handles_labels()
ax.legend(lines, labs)

# add axis labels
ax.set_xlabel('Time (hrs)')
ax.set_ylabel('Flow (m3/s)')

# save fig
save_name = 'Figure_{0}_{1}.png'.format(element, result_type)
save_path = os.path.join(save_dir, save_name)
fig.savefig(save_path)

else:
# error occurred getting time series data, print error message to console
print(mess_ts)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==load==
load ( Filepath ) 
Loads result file. File formats are *.tpc for TUFLOW release 2016 and later, or *.info for TUFLOW release 2013 
;Parameters:
: '''Filepath:''' ''str''
:: Full path to *.tpc or *.info
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, returns True if an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurs
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check if an error occurred
if err:
# print message
print(message)
</pre>

==longProfileResultTypes==
longProfileResultTypes () 
Returns list of available long profile result types 
;Parameters:
: -
;Returns:
: '''out:''' ''list''
:: List of available result types for long profile plotting
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
lp_rt = res.longProfileResultTypes()
# print to console
print('Available long profile result types:')
for rt in lp_rt:
print(rt)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==maximum==
maximum ( Element, Result Type, [optional] Domain ) 
Returns the maximum result value for the given element (1D node, 1D channel, 2D PO, RL) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL') 
;Parameters:
: '''Element:''' ''str''
:: Channel, Node, or RL element to get maximum result for. PO results do not currently support getting maximum value.
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Domain:''' ''str''
:: Optional input to specify which domain the Element belongs in. If left as default (None) and there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements.
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Maximum''' ''float''
:: Maximum result
'''Examples''' 
Maximum flow in a channel
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
channel = 'Chan_A'
maximum = res.maximum(channel, 'Q')
# print to console
print('Max flow at {0} is {1} m3/s'.format(channel, maximum)
else:
# did not load correctly, print error message to console
print(message)
</pre>
Maximum water level at a node
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
maximum = res.maximum(channel, 'H')
# print to console
print('Max water level at {0} is {1} mRL'.format(node, maximum)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==maximumTimestepChange==
maximumTimestepChange ( Element, Result Type, [optional] Domain ) 
Returns the maximum change in result value in one timestep for the given element (RL elements supported only) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL') 
;Parameters:
: '''Element:''' ''str''
:: RL element to get maximum change in a single timestep for. Currently RL elements are the only supported type.
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Domain:''' ''str''
:: Optional input to specify which domain the Element belongs in. If left as default (None) and there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements.
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Maximum''' ''float''
:: Maximum value change in any given timestep
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
loc = 'Reporting Location 1'
tsMaximum = res.maximumTimestepChange(channel, 'Q')
# print to console
print('Max flow change in any given timestep at {0} is {1} m3/s'.format(loc, tsMaximum)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==name==
name () 
Returns the name of the result 
;Parameters:
: -
;Returns:
: '''Name:''' ''str''
:: Name of results
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
name = res.name()
# print to console
print('Results from {0} loaded successfully.format(name))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==nodeCount==
nodeCount () 
Returns the total number of nodes in the results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of nodes
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node_count = res.nodeCount()
# print to console
print('{0} nodes in results.format(node_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==nodeDownstream==
nodeDownstream ( Channel ID ) 
Returns the name of the downstream node of a given channel 
;Parameters:
: '''Channel ID:''' ''str''
:: Name or ID of channel
;Returns:
: '''Node ID:''' ''str''
:: Name or ID of downstream node
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
channel = 'Chan_A'
dns_node = res.nodeDownstream(channel)
# print to console
print('Downstream node of channel {0} is {1}'.format(channel, dns_node))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==nodeResultTypes==
nodeResultTypes () 
Returns a list of all the available result types for nodes 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of available result types for nodes e.g. ['H', 'E']
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
result_types = res.nodeResultTypes()
# print to console
print('Available result types for nodes are:)
for result_type in result_types:
print(result_type)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==nodes==
nodes () 
Returns a list of all the node IDs in the results 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of all nodes names in results e.g. ['Chan_A.1', 'Chan_A.2', 'Chan_B.2', 'Chan_C.2'...]
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
nodes = res.nodes()
# print to console
print('Nodes:)
for node in nodes:
print(node)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==nodeUpstream==
nodeUpstream ( Channel ID ) 
Returns the name of the upstream node of a given channel 
;Parameters:
: '''Channel ID:''' ''str''
:: Name or ID of channel
;Returns:
: '''Node ID:''' ''str''
:: Name or ID of upstream node
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
channel = 'Chan_A'
ups_node = res.nodeUpstream(channel)
# print to console
print('Upstream node of channel {0} is {1}'.format(channel, ups_node))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==poNames==
poNames () 
Returns a list of all the available Plot Output names 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of all PO names in results e.g. ['Loc_1', 'Loc_2', 'Loc_3']
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
po_names = res.poNames()
# print to console
print('PO Names:)
for po_name in po_names:
print(po_name)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==poResultTypes==
poResultTypes () 
Returns a list of all the available Plot Output result types 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of available result types for Plot Outputs e.g. ['Q', 'H', 'V']
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
result_types = res.poResultTypes()
# print to console
print('Available result types for Plot Outputs are:)
for result_type in result_types:
print(result_type)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlCount==
rlCount () 
Returns the total number of Reporting Locations (of all geometry type) in the results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of RL objects
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
rl_count = res.rlCount()
# print to console
print('{0} RL objects in results.format(node_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlLineCount==
rlLineCount () 
Returns the total number of line Reporting Locations in the results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of RL Line objects
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
rl_line_count = res.rlLineCount()
# print to console
print('{0} RL Line objects in results.format(node_line_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlNames==
rlNames () 
Returns a list of all the Reporting Location names 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of all RL names in results e.g. ['Reporting_Loc_1', 'Reporting_Loc_2', 'Reporting_Loc_3']
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
rl_names = res.rlNames()
# print to console
print('RL Names:)
for rl_name in rl_names:
print(rl_name)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlPointCount==
rlPointCount () 
Returns the total number of point Reporting Locations in the results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of RL Point objects
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
rl_point_count = res.rlPointCount()
# print to console
print('{0} RL Point objects in results.format(node_point_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlRegionCount==
rlRegionCount () 
Returns the total number of region Reporting Locations in the results 
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of RL Region objects
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
rl_region_count = res.rlRegionCount()
# print to console
print('{0} RL Region objects in results.format(node_region_count))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==rlResultTypes==
rlResultTypes () 
Returns a list of all the available Reporting Location result types 
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of available result types for Reporting Locations e.g. ['Q', 'H', 'Vol']
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
result_types = res.rlResultTypes()
# print to console
print('Available result types for Reporting Locations are:)
for result_type in result_types:
print(result_type)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==source==
source () 
Returns the full file path to the source result file (*.tpc or *.info) 
;Parameters:
: -
;Returns:
: '''Source:''' ''str''
:: Full path to result file
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
source = res.source()
# print to console
print('Successfully loaded result from {0}.format(source))
else:
# did not load correctly, print error message to console
print(message)
</pre>

==timeOfMaximum==
timeOfMaximum ( Element, Result Type, [optional] Domain ) 
Returns the time of maximum for the given element (1D node, 1D channel, 2D PO, RL) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL') 
;Parameters:
: '''Element:''' ''str''
:: Channel, Node, or RL element to get maximum result for. PO results do not currently support getting time of maximum.
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Domain:''' ''str''
:: Optional input to specify which domain the Element belongs in. If left as default (None) and there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements.
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Time of Maximum:''' ''float''
:: Time of maximum
'''Example'''
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
node = 'Chan_A.1'
tom = res.timeOfMaximum(channel, 'H')
# print to console
print('Time of max water level at {0} is {1} hrs'.format(channel, tom)
else:
# did not load correctly, print error message to console
print(message)
</pre>

==timeOfMaximumTimestepChange==
timeOfMaximumTimestepChange ( Element, Result Type, [optional] Domain ) 
Returns the time of maximum for change in result value in one timestep for the given element (RL elements supported only) for the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL') 
;Parameters:
: '''Element:''' ''str''
:: RL element to get time of maximum change in a single timestep for. Currently RL elements are the only supported type.
: '''Result Type:''' ''str''
:: Result type e.g. 'H'
: '''Domain:''' ''str''
:: Optional input to specify which domain the Element belongs in. If left as default (None) and there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements.
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, True when an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurred
: '''Maximum''' ''float''
:: Time of maximum value change
'''Example''' 
<pre>
import pytuflow

# Initialise result class
res = pytuflow.ResData()

# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)

# check results were loaded successfully before calling function
if not err:
loc = 'Reporting Location 1'
tom_ts = res.timeOfMaximumTimestepChange(channel, 'Q')
# print to console
print('Time of max flow change in any given timestep at {0} is {1} hrs'.format(loc, tom_ts)
else:
# did not load correctly, print error message to console
print(message)
</pre>

=Archive Guidance=
Guidance for earlier version of pyTuflow can be accessed via the following link: [[PyTuflow_Archive| PyTuflow_Archive]].

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

PyTuflow

2025-12-16T23:36:05Z

Pavlina Monhartova:

PyTuflow Archive

2025-12-16T23:32:50Z

Pavlina Monhartova: Created page with "=Introduction= PyTUFLOW is a package of Python tools for extracting TUFLOW Classic and HPC time series results. It can be used to automate output tasks such as checking model health, goodness-of-fit for model calibration, viewing on-the-fly model output (used in conjunction with <tt>Write PO Online == ON</tt>), and high-volume output plotting from production runs. For worked examples demonstrating the use of PyT..."

TUFLOW Message 2912

2025-12-12T00:58:56Z

Pavlina Monhartova:

{{TUFLOW_Message
|tuflow_message=ERROR 2912 - Residual soil water contents not defined for soil moisture dependent function. 
ERROR 2912 - Saturated soil water contents not defined for soil moisture dependent function.
|alt_msg=ERROR 2912 - Saturated soil water contents must be greater than residual soil water contents in soil moisture dependent function.
|type=[[ERROR]]
|message_desc= The residual and saturated water contents (θr and θs) must be specified for each soil type in .tsoilf file when adjusting the groundwater flux using based on soil moisture. Refer to section 7.4.5.2.3 of the [https://docs.tuflow.com/classic-hpc/manual/2025.1/TwoD-Domains-1.html#AdjustKvh-5 TUFLOW Manual] for more details.
|suggestions= Include residual and saturated water contents (θr and θs) in .tsoilf file, as detailed in Table 7.21 of the [https://docs.tuflow.com/classic-hpc/manual/2025.1/TwoD-Domains-1.html#tab:tab-tsoilf-hpc TUFLOW Manual].

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

Hardware Benchmarking

2025-12-10T04:59:28Z

Pavlina Monhartova: /* Introduction */

=Introduction=
We frequently get asked, "What is the minimum or recommended hardware to use for TUFLOW modelling". This is always a tricky question, as the answer depends on the type and size of the models you are going to run. For a small model, TUFLOW should run on any modern PC or laptop that is capable of running Windows XP or later. However, for large models there may be requirements for a hefty computer. 

The tables below showing computer specifications and model run-time should help you compare systems. 

In this page we outline a hardware benchmark model which can be simulated without a TUFLOW dongle (license). This makes it easy to benchmark on a range of computers and the results are compiled below. 

We have typically found that for TUFLOW Classic, the CPU speed is the largest influence on TUFLOW runtimes, with the RAM speed also having an influence for large models. When using GPU hardware (available for TUFLOW HPC), the Graphics Card has the largest influence, specifically the number and speed of the CUDA cores. In order to quantify this we are compiling the computational times required for a range of different machines.

=Benchmark Model=
==Background==
The benchmark model is based on a “challenge” issued prior to the 2012 Flood Managers Association (FMA) Conference in Sacramento, USA. There is more information on the model setup and purpose in the [[FMA_Challenge_Models_Introduction | FMA challenge model introduction]]. 
This hardware benchmark is based on the second challenge which involves a coastal river in flood with two ocean outlets. The model has been modified slightly (mainly in terms of the outputs). It is setup to use both the TUFLOW Classic (CPU) and TUFLOW HPC (on both CPU and GPU hardware) for a range of cell sizes.
 

{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Cell Size (m)
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Number of cells
|-
|20.0|| 181,981
|-
|10.0|| 727,865
|-
|5.0 || 2,911,472
|-
|2.5 || 11,645,341
|}

The model runs for three days of simulation time (72 hours). The approximate run time for the 30m model on the CPU is likely to be ~20min and for the 15m version approximately 4 hours. Given the runtime for the CPU model at 10m resolution is likely to be > 12 hours, this is skipped in the benchmark (this can also be run without a licence).
 

==Models==
 
The simulated models are:
*20m model - TUFLOW Classic
*20m model - TUFLOW HPC CPU - 2 Cores (default)
*20m model - TUFLOW HPC - GPU Hardware
*10m model - TUFLOW HPC - GPU Hardware

The user also has an option to run a couple of bigger models on GPU hardware as part of the High End GPU Benchmarking. To run these models, please follow the steps outlined in the below section. 
HIGH END GPU BENCHMARKING MODELS
*5m model - TUFLOW HPC - GPU Hardware
*2.5m model - TUFLOW HPC - GPU Hardware

==To Participate==
To participate in the benchmark, please follow the steps below:
<ol>
<li> Download the model from [https://downloads.tuflow.com/TUFLOW/Wiki_Benchmark_Model/FMA2_GPU_CPU_Benchmark.zip FMA2_GPU_CPU_Benchmark.zip].
<li> Extract the model on a local drive of the computer you would like to benchmark.
<li> Navigate to the '''TUFLOW\runs\''' folder and run the '''Run_Benchmark.bat''' file. This checks if you are running a 32 or 64 bit system and then runs the benchmark. This also generates some output files that contain more information on the processor, memory and GPU card that you are using.
<li> If you have a high performance GPU Card you can also run the '''Run_Benchmark_HighPerformance_GPU.bat'''.
<li> Email the _ TUFLOW Simulations.log, cpu.txt, ram.txt and GPU.txt files to [mailto:support@tuflow.com support@tuflow.com] and we will includes these in the results tables below. 
</ol>
'''Note''': An NVIDIA graphics card that is CUDA compatible is required to run the GPU model. 
 

=List of Benchmarking Runtimes and Discussions=
==Benchmarking Runtimes (2018-03-AA Release)==
*[[Hardware_Benchmarking_-_Results#CPU_Results | CPU results]]
*[[Hardware_Benchmarking_-_Results#GPU_Results | GPU results]]

==Discussion Topics==
*[[Hardware_Benchmarking_Topic_HPC_on_CPU_vs_GPU | HPC (CPU) vs. HPC (GPU)]]
*[[Hardware_Benchmarking_Topic_Single_Precision_VS_Double_Precision | Single Precision Vs Double Precision]]
*[[ Hardware Selection Advice]]

==Hardware Selection Advice==
* [[Hardware_Selection_Advice | Hardware Selection Advice]]
 
{{Tips Navigation
|uplink=[[Main_Page| TUFLOW Main Page]]
}}

Hardware Benchmarking

2025-12-10T04:57:47Z

Pavlina Monhartova: /* To Participate */

=Introduction=
We frequently get asked, "What is the minimum or recommended hardware to use for TUFLOW modelling". This is always a tricky question, as the answer depends on the type and size of the models you are going to run. For a small model, TUFLOW should run on any modern PC or laptop that is capable of running Windows XP or later. However, for large models there may be requirements for a hefty computer. 

The tables below showing computer specifications and model run-time should help you compare systems. 

In this page we outline a hardware benchmark model which is available to download from [https://downloads.tuflow.com/_archive/TUFLOW/Benchmark_Models/FMA2_GPU_CPU_Benchmark.zip FMA2_GPU_CPU_Benchmark.zip] the model can be simulated without a TUFLOW dongle (license). This makes it easy to benchmark on a range of computers and the results are compiled below. 

We have typically found that for TUFLOW Classic, the CPU speed is the largest influence on TUFLOW runtimes, with the RAM speed also having an influence for large models. When using GPU hardware (available for TUFLOW HPC), the Graphics Card has the largest influence, specifically the number and speed of the CUDA cores. In order to quantify this we are compiling the computational times required for a range of different machines.

=Benchmark Model=
==Background==
The benchmark model is based on a “challenge” issued prior to the 2012 Flood Managers Association (FMA) Conference in Sacramento, USA. There is more information on the model setup and purpose in the [[FMA_Challenge_Models_Introduction | FMA challenge model introduction]]. 
This hardware benchmark is based on the second challenge which involves a coastal river in flood with two ocean outlets. The model has been modified slightly (mainly in terms of the outputs). It is setup to use both the TUFLOW Classic (CPU) and TUFLOW HPC (on both CPU and GPU hardware) for a range of cell sizes.
 

{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Cell Size (m)
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Number of cells
|-
|20.0|| 181,981
|-
|10.0|| 727,865
|-
|5.0 || 2,911,472
|-
|2.5 || 11,645,341
|}

The model runs for three days of simulation time (72 hours). The approximate run time for the 30m model on the CPU is likely to be ~20min and for the 15m version approximately 4 hours. Given the runtime for the CPU model at 10m resolution is likely to be > 12 hours, this is skipped in the benchmark (this can also be run without a licence).
 

==Models==
 
The simulated models are:
*20m model - TUFLOW Classic
*20m model - TUFLOW HPC CPU - 2 Cores (default)
*20m model - TUFLOW HPC - GPU Hardware
*10m model - TUFLOW HPC - GPU Hardware

The user also has an option to run a couple of bigger models on GPU hardware as part of the High End GPU Benchmarking. To run these models, please follow the steps outlined in the below section. 
HIGH END GPU BENCHMARKING MODELS
*5m model - TUFLOW HPC - GPU Hardware
*2.5m model - TUFLOW HPC - GPU Hardware

==To Participate==
To participate in the benchmark, please follow the steps below:
<ol>
<li> Download the model from [https://downloads.tuflow.com/TUFLOW/Wiki_Benchmark_Model/FMA2_GPU_CPU_Benchmark.zip FMA2_GPU_CPU_Benchmark.zip].
<li> Extract the model on a local drive of the computer you would like to benchmark.
<li> Navigate to the '''TUFLOW\runs\''' folder and run the '''Run_Benchmark.bat''' file. This checks if you are running a 32 or 64 bit system and then runs the benchmark. This also generates some output files that contain more information on the processor, memory and GPU card that you are using.
<li> If you have a high performance GPU Card you can also run the '''Run_Benchmark_HighPerformance_GPU.bat'''.
<li> Email the _ TUFLOW Simulations.log, cpu.txt, ram.txt and GPU.txt files to [mailto:support@tuflow.com support@tuflow.com] and we will includes these in the results tables below. 
</ol>
'''Note''': An NVIDIA graphics card that is CUDA compatible is required to run the GPU model. 
 

=List of Benchmarking Runtimes and Discussions=
==Benchmarking Runtimes (2018-03-AA Release)==
*[[Hardware_Benchmarking_-_Results#CPU_Results | CPU results]]
*[[Hardware_Benchmarking_-_Results#GPU_Results | GPU results]]

==Discussion Topics==
*[[Hardware_Benchmarking_Topic_HPC_on_CPU_vs_GPU | HPC (CPU) vs. HPC (GPU)]]
*[[Hardware_Benchmarking_Topic_Single_Precision_VS_Double_Precision | Single Precision Vs Double Precision]]
*[[ Hardware Selection Advice]]

==Hardware Selection Advice==
* [[Hardware_Selection_Advice | Hardware Selection Advice]]
 
{{Tips Navigation
|uplink=[[Main_Page| TUFLOW Main Page]]
}}

Hardware Benchmarking

2025-12-10T04:52:25Z

Pavlina Monhartova: /* To Participate */

=Introduction=
We frequently get asked, "What is the minimum or recommended hardware to use for TUFLOW modelling". This is always a tricky question, as the answer depends on the type and size of the models you are going to run. For a small model, TUFLOW should run on any modern PC or laptop that is capable of running Windows XP or later. However, for large models there may be requirements for a hefty computer. 

The tables below showing computer specifications and model run-time should help you compare systems. 

In this page we outline a hardware benchmark model which is available to download from [https://downloads.tuflow.com/_archive/TUFLOW/Benchmark_Models/FMA2_GPU_CPU_Benchmark.zip FMA2_GPU_CPU_Benchmark.zip] the model can be simulated without a TUFLOW dongle (license). This makes it easy to benchmark on a range of computers and the results are compiled below. 

We have typically found that for TUFLOW Classic, the CPU speed is the largest influence on TUFLOW runtimes, with the RAM speed also having an influence for large models. When using GPU hardware (available for TUFLOW HPC), the Graphics Card has the largest influence, specifically the number and speed of the CUDA cores. In order to quantify this we are compiling the computational times required for a range of different machines.

=Benchmark Model=
==Background==
The benchmark model is based on a “challenge” issued prior to the 2012 Flood Managers Association (FMA) Conference in Sacramento, USA. There is more information on the model setup and purpose in the [[FMA_Challenge_Models_Introduction | FMA challenge model introduction]]. 
This hardware benchmark is based on the second challenge which involves a coastal river in flood with two ocean outlets. The model has been modified slightly (mainly in terms of the outputs). It is setup to use both the TUFLOW Classic (CPU) and TUFLOW HPC (on both CPU and GPU hardware) for a range of cell sizes.
 

{| align="center" class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;"| Cell Size (m)
! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Number of cells
|-
|20.0|| 181,981
|-
|10.0|| 727,865
|-
|5.0 || 2,911,472
|-
|2.5 || 11,645,341
|}

The model runs for three days of simulation time (72 hours). The approximate run time for the 30m model on the CPU is likely to be ~20min and for the 15m version approximately 4 hours. Given the runtime for the CPU model at 10m resolution is likely to be > 12 hours, this is skipped in the benchmark (this can also be run without a licence).
 

==Models==
 
The simulated models are:
*20m model - TUFLOW Classic
*20m model - TUFLOW HPC CPU - 2 Cores (default)
*20m model - TUFLOW HPC - GPU Hardware
*10m model - TUFLOW HPC - GPU Hardware

The user also has an option to run a couple of bigger models on GPU hardware as part of the High End GPU Benchmarking. To run these models, please follow the steps outlined in the below section. 
HIGH END GPU BENCHMARKING MODELS
*5m model - TUFLOW HPC - GPU Hardware
*2.5m model - TUFLOW HPC - GPU Hardware

==To Participate==
To participate in the benchmark, please follow the steps below:
<ol>
<li> Download the model from [https://downloads.tuflow.com/TUFLOW/Wiki_Benchmark_Model/FMA2_GPU_CPU_Benchmark.zip FMA2_GPU_CPU_Benchmark.zip].
<li> Extract the model on a local drive of the computer you would like to benchmark.
<li> Navigate to the '''TUFLOW\runs\''' folder and run the '''Run_Benchmark.bat''' file. This checks if you are running a 32 or 64 bit system and then runs the benchmark. This also generates some output files that contain more information on the processor, memory and GPU card that you are using.
<li> If you have a high performance GPU Card you can also run the '''Run_Benchmark_HighPerformance_GPU.bat'''.
<li> Email the _ TUFLOW Simulations.log, cpu.txt, ram.txt and GPU.txt files to [mailto:support@tuflow.com support@tuflow.com] and we will includes these in the results tables below. 
</ol>
The computer information is determined in the batch file using the '''wmic''' and '''dxdiag''' commands. 
'''Note''' An NVIDIA graphics card that is CUDA compatible is required to run the GPU model. 
 

=List of Benchmarking Runtimes and Discussions=
==Benchmarking Runtimes (2018-03-AA Release)==
*[[Hardware_Benchmarking_-_Results#CPU_Results | CPU results]]
*[[Hardware_Benchmarking_-_Results#GPU_Results | GPU results]]

==Discussion Topics==
*[[Hardware_Benchmarking_Topic_HPC_on_CPU_vs_GPU | HPC (CPU) vs. HPC (GPU)]]
*[[Hardware_Benchmarking_Topic_Single_Precision_VS_Double_Precision | Single Precision Vs Double Precision]]
*[[ Hardware Selection Advice]]

==Hardware Selection Advice==
* [[Hardware_Selection_Advice | Hardware Selection Advice]]
 
{{Tips Navigation
|uplink=[[Main_Page| TUFLOW Main Page]]
}}

12D Model

2025-12-01T05:16:41Z

Pavlina Monhartova: /* 12d Model TUFLOW Editors */

=Introduction=
12d model is a complete civil engineering design software including data terrain modelling, road design, sub division, railway, drainage and much more.

The water water resources modules include the 1d HEC RAS interface, 1d pipe systems (culvert and urban networks) with rational and unsteady flow hydrology and the 2d TUFLOW analysis.

12d model integrates TUFLOW with the file creation, editing and result visualisation.

The section below is an extremely fast method to get a TUFLOW project up and running. 
For the full featured TUFLOW editors please see [[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]].

=Roadflow Quickstart.. Getting Started.. Fast=
The Roadflow interface is the quick start method of creating a TUFLOW project. It creates all of the TUFLOW files, launches the TUFLOW engine and reads the results for plan, section and 3d visualisation of results.

Prior to running this option you need to create a data terrain model (tin or super tin) and draw a rectangle indicating the TUFLOW grid extent. The optional data tab has further options and will be discussed later.
 [[File:GridExtentPolygon.png]] 
 
The roadflow panel is found on the menu under '''Design->TUFLOW->Roadflow'''. The rectangle is selected using the first field and the tin in entered in the second Ground tin field. The other values are typed entry as desired. Select the '''Run''' button to start the TUFLOW run.
 [[File:TUFLOW_Road_Flow.png]] 

The TUFLOW grid tin model will contain a 12d model grid tin with the centre and side elevations for the TUFLOW run.

While TUFLOW is running the usual data from the "black screen" is captured and displayed as graphed data. 
[[File:TUFLOW Run Panel.png]]

While TUFLOW is solving the results can be monitored and displayed in 12d. This will be discussed later.

When the TUFLOW run is complete, select the '''Read results''' button to link 12d to the result files for displaying. You will be instructed to select the tlf file for the run and then once again select the '''Read results''' button.
 [[File:RoadflowReadResults.png]] 
Remember the name of the '''Results tin model'''. This is the model you will add onto the views to see your results. 

Add the Results tin model onto a 3d OpenGL view. The results tin will be set to display water levels and the perspective views will have the water surface coloured by depth.
 [[File:Results shaded.png]] 

==Viewing Depth, Hazard, and Velocity Contours==
Select the '''Results Controls''' button to change what is displayed via the results grid tin. Change the '''Tin Inquire Results''' to '''Result Velocity Vector'''. This setting controls the
# contours displayed by the tin,
# the value shown by '''Tin Inquire Height',
# the level in the section view (yes you can plot velocity profiles across a channel),
# the result plotted in the time graphs,
# and the elevation shown in a 3d perspective view (in this case a 3d velocity map may be generated).
 [[File:TUFLOW Tin Results Settings Velocity Vectors.png]] 
Add the '''Results tin model''' (the one you were to remember) onto a plan view and check that the contours are turned on and set as desired (F11 key).
If you also have the raster image added to the view you will see the following. The 1m/s is drawn at the length in the field '''Arrow Scale'''. The colour of the arrows is the same colour as the tin (see '''Tins->Tin manager''').
 [[File:RoadflowVelocityContours.png]] 
One method of inquiring the contour values is via '''Tin Inquire Height'''. No need to select a tin if there is only one tin on the view. Move the pointer to a contour and the velocity is displayed.
 [[File:Tin Height Inquire Velocity.png]] 
 
==Time Series Graphs==
To graph the velocity versus time at any location use the '''Design->TUFLOW->Tuflow results graph'''. 
Select the '''Results tin model''' (the one you were to remember) for the '''TUFLOW results tin''', optionally enter a '''Label''' and use the pick arrow to select a location on the results grid. (your cursor snap should be on).
 [[File:TUFLOW Results Graph Velocity.png]] 
Note that if you leave the '''Label''' blank and pick a 12d string instead of a cursor location, the name of the string will be used as the label. Creating a model of graph locations strings is a perfect way to ensure all results are from the some x,y location. 
Selecting multiple locations will add additional graphs to the plot. There is a '''Clear''' button to start over. Right mouse selecting will produce a menu with '''Export dialog...''' for exporting the image for reporting. 
 

== Viewing results at Various Times==
Recall selecting the '''Results Controls''' button above (the same panel can be obtained via the menu '''Design->TUFLOW->TMO tin settings'''). The '''Time step''' is set to '''maximums''' when the results are read. The '''<''' and '''>''' arrows can be used to move to the previous and next time step. Alternatively, enter a time step in the '''Time step''' field and select '''Set'''. The modelling time will be displayed in the message area of the panel. If you enter a number greater than or equal to the '''Results available''' the maximum values at each cell centre will be displayed. The TUFLOW tmo format produces results at the cell centres. 
 [[File:TUFLOW Tin Results Settings prev next.png]] 
Referring back to the 3d view, the results are displayed for all of the cells, wet or dry. To show hide the dry cells select BOTH the '''Use wet/dry flag''' and '''Hide dry cells''. The '''Use wet/dry flag''' alone will change the colour of the tin solid to green (dry) or blue (wet). 
 

=[[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]]=

Go to [[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]].
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

12D Model

2025-12-01T05:16:25Z

Pavlina Monhartova: /* Roadflow Optional Tab */

=Introduction=
12d model is a complete civil engineering design software including data terrain modelling, road design, sub division, railway, drainage and much more.

The water water resources modules include the 1d HEC RAS interface, 1d pipe systems (culvert and urban networks) with rational and unsteady flow hydrology and the 2d TUFLOW analysis.

12d model integrates TUFLOW with the file creation, editing and result visualisation.

The section below is an extremely fast method to get a TUFLOW project up and running. 
For the full featured TUFLOW editors please see [[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]].

=Roadflow Quickstart.. Getting Started.. Fast=
The Roadflow interface is the quick start method of creating a TUFLOW project. It creates all of the TUFLOW files, launches the TUFLOW engine and reads the results for plan, section and 3d visualisation of results.

Prior to running this option you need to create a data terrain model (tin or super tin) and draw a rectangle indicating the TUFLOW grid extent. The optional data tab has further options and will be discussed later.
 [[File:GridExtentPolygon.png]] 
 
The roadflow panel is found on the menu under '''Design->TUFLOW->Roadflow'''. The rectangle is selected using the first field and the tin in entered in the second Ground tin field. The other values are typed entry as desired. Select the '''Run''' button to start the TUFLOW run.
 [[File:TUFLOW_Road_Flow.png]] 

The TUFLOW grid tin model will contain a 12d model grid tin with the centre and side elevations for the TUFLOW run.

While TUFLOW is running the usual data from the "black screen" is captured and displayed as graphed data. 
[[File:TUFLOW Run Panel.png]]

While TUFLOW is solving the results can be monitored and displayed in 12d. This will be discussed later.

When the TUFLOW run is complete, select the '''Read results''' button to link 12d to the result files for displaying. You will be instructed to select the tlf file for the run and then once again select the '''Read results''' button.
 [[File:RoadflowReadResults.png]] 
Remember the name of the '''Results tin model'''. This is the model you will add onto the views to see your results. 

Add the Results tin model onto a 3d OpenGL view. The results tin will be set to display water levels and the perspective views will have the water surface coloured by depth.
 [[File:Results shaded.png]] 

==Viewing Depth, Hazard, and Velocity Contours==
Select the '''Results Controls''' button to change what is displayed via the results grid tin. Change the '''Tin Inquire Results''' to '''Result Velocity Vector'''. This setting controls the
# contours displayed by the tin,
# the value shown by '''Tin Inquire Height',
# the level in the section view (yes you can plot velocity profiles across a channel),
# the result plotted in the time graphs,
# and the elevation shown in a 3d perspective view (in this case a 3d velocity map may be generated).
 [[File:TUFLOW Tin Results Settings Velocity Vectors.png]] 
Add the '''Results tin model''' (the one you were to remember) onto a plan view and check that the contours are turned on and set as desired (F11 key).
If you also have the raster image added to the view you will see the following. The 1m/s is drawn at the length in the field '''Arrow Scale'''. The colour of the arrows is the same colour as the tin (see '''Tins->Tin manager''').
 [[File:RoadflowVelocityContours.png]] 
One method of inquiring the contour values is via '''Tin Inquire Height'''. No need to select a tin if there is only one tin on the view. Move the pointer to a contour and the velocity is displayed.
 [[File:Tin Height Inquire Velocity.png]] 
 
==Time Series Graphs==
To graph the velocity versus time at any location use the '''Design->TUFLOW->Tuflow results graph'''. 
Select the '''Results tin model''' (the one you were to remember) for the '''TUFLOW results tin''', optionally enter a '''Label''' and use the pick arrow to select a location on the results grid. (your cursor snap should be on).
 [[File:TUFLOW Results Graph Velocity.png]] 
Note that if you leave the '''Label''' blank and pick a 12d string instead of a cursor location, the name of the string will be used as the label. Creating a model of graph locations strings is a perfect way to ensure all results are from the some x,y location. 
Selecting multiple locations will add additional graphs to the plot. There is a '''Clear''' button to start over. Right mouse selecting will produce a menu with '''Export dialog...''' for exporting the image for reporting. 
 

== Viewing results at Various Times==
Recall selecting the '''Results Controls''' button above (the same panel can be obtained via the menu '''Design->TUFLOW->TMO tin settings'''). The '''Time step''' is set to '''maximums''' when the results are read. The '''<''' and '''>''' arrows can be used to move to the previous and next time step. Alternatively, enter a time step in the '''Time step''' field and select '''Set'''. The modelling time will be displayed in the message area of the panel. If you enter a number greater than or equal to the '''Results available''' the maximum values at each cell centre will be displayed. The TUFLOW tmo format produces results at the cell centres. 
 [[File:TUFLOW Tin Results Settings prev next.png]] 
Referring back to the 3d view, the results are displayed for all of the cells, wet or dry. To show hide the dry cells select BOTH the '''Use wet/dry flag''' and '''Hide dry cells''. The '''Use wet/dry flag''' alone will change the colour of the tin solid to green (dry) or blue (wet). 
 

=[[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]]=

Please go to [[12d_model_TUFLOW_editors | 12d Model TUFLOW Editors]].
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

TUFLOW Message 2386

2025-11-12T06:44:53Z

Pavlina Monhartova:

{{TUFLOW_Message
|tuflow_message=WARNING 2386 - Output data type "dt" not valid for Classic solution scheme.
|alt_msg=WARNING 2386 - Output data type "Nu" not valid for Classic solution scheme. Please use "Cr" instead. 
WARNING 2386 - Output data type "Nc" not valid for Classic solution scheme. Please use "Cr" instead. 
WARNING 2386 - Output data type "Nd" not valid for Classic solution scheme. Please use "Cr" instead. 
WARNING 2386 - Output data type "Cr" not valid for HPC solution scheme. Please use "Nu", "Nc", or "Nd" instead. 
WARNING 2386 - Output data type "r" only valid for Classic solution scheme. 
WARNING 2386 - Output data type "CI" not valid with horizontal sub-surface flows or multiple vertical soils layers. 
WARNING 2386 - Output data type "RC" not valid for HPC solution scheme. Switched off. 
|type=[[WARNING]]
|message_desc=TUFLOW Classic solver applies fixed timestep and does not support the output data type "dt", "Nu", "Nc", or "Nd" (the [[HPC_Adaptive_Timestepping | HPC adaptive timestepping]]). On the other hand, "Cr" is the Courant Number output in TUFLOW Classic solution scheme, same as "r" is the flow regime, and are not supported by TUFLOW HPC solver. 
The Cumulative Infiltration (CI) output is only available for models with a single vertical soil layer, no horizontal movement of ground water and no drying of the soil layer through negative rainfall. When any of the three options (multiple vertical layers, horizontal movement or negative rainfall) can reduce the groundwater moisture, the water content in the layer is no longer a “cumulative value” so the CI output is not available.
|suggestions=Use supported output data types in each solver.

|uplink=[[2xxx_TUFLOW_Messages|2xxx Messages]]
}}

Tutorial Introduction

2025-10-23T07:03:35Z

Pavlina Monhartova:

= Introduction =
This TUFLOW licence free tutorial model is aimed at new users, stepping through the process of building and running a model. To begin, watch the following video:
:*[https://vimeo.com/505584298/2c91bd5f48 What Is TUFLOW?]

=Requirements and Downloads=
TUFLOW uses QGIS as its Graphical User Interface (GUI), in combination with text editor and spreadsheet software, for its model creation and result viewing. The group of software creates an extremely workflow efficient and flexible modelling environment. Notably, QGIS does not experience the data load/visualisation lag and display issues some other hydraulic modelling software GUIs are limited by when working with larger datasets. 

This short video introduces the required TUFLOW modelling programs:
:*[https://vimeo.com/505579529/03f4cb3d17 Required Programs] 

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-
| '''TUFLOW''' || TUFLOW is a computer program for simulating depth-averaged, one and two-dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid of square elements. 
It is recommended to always use the latest release version of TUFLOW. 

This tutorial model does not require a TUFLOW licence. 

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be used in the hardware command. 
||The TUFLOW executable is provided within the [https://wiki.tuflow.com/Tutorial_Introduction#Module_Data Tutorial Dataset].
|-
| '''QGIS''' QGIS TUFLOW plugin || The Geographic Information System (GIS) used to build models and view results. This tutorial was developed with QGIS 3.20. It is recommended to have QGIS 3.20 or later to ensure compatibility with TUFLOW plugin latest features. 
The TUFLOW plugin includes numerous tools to increase workflow efficiency. 

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]].
|-
| '''NotePad++''' Syntax Highlighting || A text editor is required for creation of the TUFLOW input files. This tutorial was developed with NotePad++. Ideally a text editor should be able to: 
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. 
TUFLOW colour coding can be enabled using syntax highlighting.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. 

For instructions on configuring Notepad++ for TUFLOW modelling, see [[NotepadPlusPlus_Tips |Notepad++ tips]].
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||
|-
| '''Windows File Explorer''' || Windows File Explorer is used for navigating, copying and renaming files. It is recommended to display file extension to allow for editing of file extensions. For more details, see [[Tutorial_Troubleshooting_QGIS#Editing_File_Extension | Editing file extension]]. ||
|}

=Module Data=
To build the tutorial model, download one of the datasets below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. There are two formats available, Shapefile and GeoPackage. GeoPackage has been supported since the 2023-03 Release, for tips on its use see [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_GPKG.zip Tutorial Dataset - QGIS - GPKG]
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_SHP.zip Tutorial Dataset - QGIS - SHP]

Note: there are numerous GIS packages that can be used, these tutorials have been specifically designed for QGIS using the QGIS TUFLOW Plugin. If you would like to see past tutorials for MapInfo, ArcGIS or SMS, please contact [mailto:support@tuflow.com support@tuflow.com].

=Tutorial Modules=
The download dataset contains the input files and working version of the tutorial model for reference. Results and check files are not included to keep the size of the download file manageable. The folder should be placed in a location with write permissions. 

The tutorial model is presented in a number of modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:

:*[[Tutorial_M01 | Module 1]] - 2D Base Model
:*[[Tutorial_M02 | Module 2]] - Topography Updates
:*[[Tutorial_M03 | Module 3]] - 1D Culverts
:*[[Tutorial_M04 | Module 4]] - 2D Bridges
:*[[Tutorial_M05 | Module 5]] - Integrated Urban Drainage
:*[[Tutorial_M06 | Module 6]] - Direct Rainfall
:*[[Tutorial_M07 | Module 7]] - Quadtree
:*[[Tutorial_M08 | Module 8]] - Scenario Management
:*[[Tutorial_M09 | Module 9]] - Event Management
:*[[Tutorial_M10 | Module 10]] - Dam Break
:*[[Tutorial_M11 | Module 11]] - 1D Open Channel

=Archive Dataset=
Historic tutorial model datasets can be accessed via the following link: [[Tutorial_Model_Archive| TUFLOW Classic Tutorial Model Archive]].

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
Alternatively, see the [[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]] to explore the full list of TUFLOW features.

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

Flood Modeller Tutorial Module01

2025-10-23T07:01:02Z

Pavlina Monhartova: /* TUFLOW HPC */

=Introduction=
In this module we will link an existing 2D TUFLOW domain to an existing Flood Modeller 1D model. The 2D TUFLOW domain will represent the floodplain in the study area, and the 1D Flood Modeller model will represent the watercourse and all online structures. 

1D-2D linked models are able to utilise the individual benefits of 1D and 2D solution schemes. In this example, the 1D Flood Modeller scheme is used to represent the watercourses where the flow is essentially uni-directional. A 2D scheme is suited to the representation of floodplains where more complex flow patterns may occur. 
 
As [[Tutorial_Module01_Archive#Reviewing_Model_Performance | discussed in Module 1 of the TUFLOW Tutorial Model]], the main watercourse channel is not very well represented using the 5m 2D cell size. In parts, the watercourse is only 5-10m wide and the 5m cell size could be considered too coarse to accurately represent the watercourse topography. 
[[file:Poor_2d_rep.png|400px]] 
Using a cell size that is coarse relative to the width of the watercourse channel may reduce the accuracy of the conveyance in the channel. There are two options for improving the representation of the creek channel: 
* decrease the width of the 2D cells; and/or
* model the channel as a 1D network, dynamically linked to the 2D domain (the floodplain).
In the [[Tutorial_Module01_Archive#Advanced_-_Model_Resolution_.28Optional.29 | optional section of Module 1 of the TUFLOW Tutorial Model]], we looked at reducing the cell size to get a better representation of the channel. In this module we will adopt the second approach of modelling the creek as 1D elements using Flood Modeller. 

TUFLOW may be dynamically linked to 1D networks using the hydrodynamic solutions of ESTRY (TUFLOW 1D), Flood Modeller, XP-SWMM and 12D Solutions’ Dynamic Drainage. 

Setting up a 1D/2D model where the 1D channel cuts through the 2D domain is probably the most time-consuming type of a model to setup. However, the reduction in simulation time can be beneficial and make this a good approach. For this module, the complete Flood Modeller 1D model has been provided, to allow for progressing through the module in a relatively short period of time. 

=Existing Model Data=
This tutorial builds upon the 2D TUFLOW domain that was constructed as part of [[Tutorial Module01_Archive|Module 1]] and [[Tutorial Module02_Archive|Module 2]] of the TUFLOW Tutorial Model. 
The model developed in these tutorial modules already contains some culverts modelled as 1D elements. The culverts are modelled in ESTRY, TUFLOW's internal 1D engine. One of these culverts will be kept in ESTRY and the other will be added to the Flood Modeller model. 
The 2D boundary conditions (upstream inflows and downstream stage-discharge boundary) will be removed from the model. These will instead be represented in Flood Modeller as it is a more typical schematisation for a 1D/2D linked model. 
The existing TUFLOW model consists of:
*Definition of Active/In-Active Areas
*Definition of Land Use
*1D ESTRY culverts
*1D/2D boundary links to connect the 1D ESTRY culverts to the 2D TUFLOW domain.

For further information on these elements, please refer to [[Tutorial Module01_Archive|Module 1]] and [[Tutorial Module02_Archive|Module 2]] of the TUFLOW Tutorial Model.

==Flood Modeller==
A complete Flood Modeller 1D model of the watercourse has been provided for the purposes of this tutorial. 
The model data has been arranged in the following folder structure:
*DAT: Contains the Flood Modeller 1D network file.
*IED: Contains event data of the model.
*IEF: A blank folder in which to store Flood Modeller Event Files used to simulate the model.
*RES: A blank folder in which to write the Flood Modeller result files.
For further information on each file type, please refer to the [https://help.floodmodeller.com/docs Flood Modeller User Manual]. 
For this tutorial, the floodplain of the study area will be modelled entirely in TUFLOW.
The cross-sections in the Flood Modeller 1D model have been trimmed to the top of bank to ensure there is no double-counting of storage within the floodplain.
Upstream and downstream boundary data is contained separately within the IED files. These will be referenced and linked to the Flood Modeller 1D model via the IEF simulation file.

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.

==Define the External 1D Networks==
This part of the module creates the GIS layers that specify the location of the Flood Modeller nodes that are to be connected to the 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_x1D_Nodes | ArcGIS]]
* [[FM Tute M01_MI_x1D_Nodes | MapInfo]]
* [[FM Tute M01_QGIS_x1D_Nodes | QGIS]]

==Define the 1D/2D Boundary Links==
This part of the module creates the 1D/2D boundaries to link the Flood Modeller 1D component to the TUFLOW 2D domain. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_1D2D_Links | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Links | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Links | QGIS]]

==Define Bank Elevations==
This part of the module defines the bank elevations of the watercourse which are the elevations of the 1D/2D boundary links created in the previous section. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Banks | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Banks | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Banks | QGIS]]

==Deactivate 2D cells ==
This part of the module describes the steps to deactivate the 2D cells where the 1D model is replacing the 2D solution. Follow the instructions below for your preferred GIS package.
* [[FM Tute M01_ARC_Code | ArcGIS]]
* [[FM Tute M01_MI_1D2D_Code | MapInfo]]
* [[FM Tute M01_QGIS_1D2D_Code | QGIS]]

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update the TUFLOW control files and Flood Modeller Simulation Files to create a linked model.
==TUFLOW Control Files==
==TUFLOW Geometry Control File==
We will first update the TUFLOW Geometry Control (TGC) file. The following changes have been changes made to the geometry:
* We have deactivated the cells along the watercourse which are represented in the 1D Flood Modeller component of the model
* We have enforced bank elevations along the watercourse.
 
<ol>
<li> In the '''FMT_Tutorial\FMT_M01\TUFLOW\model''' folder, save a copy of M01_5m_002.tgc as FMT_M01_001.tgc. </li>
<li> Open FMT_M01_001.tgc 

'''Mapinfo''' 
Add an extra command line after <tt> Read GIS Code </tt><tt>==</tt>..\model\mi\2d_code_FMT_M01_001_R.MIF </li>
:<tt>Read GIS Code BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001_R.MIF<tt> ! Deactivates the cells where the watercourse has been modelled in 1D </tt>

Note that the order of the commands is important. The layer '''2d_code_FMT_M01_001.MIF''' first activates cells within the modelled area then the layer '''2d_bc_FMT_M01_HX_001_R.MIF''' deactivates selected cells along the watercourse. 
'''Other GIS''' 
Add an extra command line after <tt> Read GIS Code </tt><tt>==</tt>..\model\gis\2d_code_FMT_M01_001_R.shp
:<tt>Read GIS Code BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_R.shp <tt> ! Deactivates the cells where the watercourse has been modelled in 1D </tt>

Note that the order of the commands is important. The layer '''2d_code_FMT_M01_001_R.shp''' first activates cells within the modelled area then the layer '''2d_bc_FMT_M01_HX_001_R.shp''' deactivates selected cells along the watercourse.

<li> Topography amendments should be added in a new section at the bottom of the TGC. These are: </li>
'''Mapinfo''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> mi\2d_bc_FMT_M01_HX_001_L.MIF | mi\2d_bc_FMT_M01_HX_001_P.MIF <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>
The two GIS layers must be read in together on the same command line. This tells TUFLOW to associate the points within the '''2d_bc_FMT_M01_HX_001_P.MIF''' layer (defining elevation) with the polylines within the '''2d_bc_FMT_M01_HX_001_L.MIF''' layer (defining bank location).

'''Other GIS''' 
:<tt>Read GIS Z HX Line MAX </tt> <tt>==</tt> gis\2d_bc_FMT_M01_HX_001_L.shp | gis\2d_bc_FMT_M01_HX_001_P.shp <tt>! Defines the bank crest levels (1D/2D boundary cell elevations). The 'MAX' option prevents any zpt elevations from being lowered </tt>
The two GIS layers must be read in together on the same command line. This tells TUFLOW to associate the points within the '''2d_bc_FMT_M01_HX_001_P.shp''' layer (defining elevation) with the polylines within the '''2d_bc_FMT_M01_HX_001_L.shp''' layer (defining bank location).

<li> Save the file. The geometry control file is now ready to be used.
</ol>

==TUFLOW Boundary Condition Control File==
We will now update the TUFLOW Boundary Condition control file (tbc) to reference the model boundary files created in previous steps.
<li> Add the 1D/2D boundaries that link the Flood Modeller open channel to the 2D floodplain</li>
<li> Update the 1D/2D boundaries which link the ESTRY culverts to the 2D floodplain, as some of these culverts are now modelled in Flood Modeller</li>
<li> Remove the external inflows applied to the TUFLOW model, as these are now applied in Flood Modeller</li>

<ol>
<li> Open '''M02_5m_001.tbc''' and save a copy as '''FMT_M01_001.tbc'''.
<li> Remove the boundary linking to the TUFLOW inflows by: 
'''Mapinfo'''
:Put an exclamation mark before the line reading. This tells TUFLOW to treat this command line as a comment: 
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M01_002_L.MIF
'''Other GIS'''
:Put an exclamation mark before the line reading: 
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M01_002_L.SHP

<li> Update the 1D/2D boundary links at the ESTRY culverts with the new layer:</li>
'''Mapinfo'''
:<tt>Read GIS BC</tt> <tt>== </tt> mi\2d_bc_M04_culverts_001_L.MIF <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>
'''Other GIS'''
:<tt>Read GIS BC</tt> <tt>== </tt> gis\2d_bc_M04_culverts_001_L.shp <tt>! This command reads in SX boundaries linking the 1D ESTRY culverts to the 2D domain</tt>

<li> Add reference to the 1D/2D boundary links that connect Flood Modeller to the 2D floodplain:</li>
'''Mapinfo'''
:<tt>Read GIS BC </tt> <tt>== </tt> mi\2d_bc_FMT_M01_HX_001_p.MIF | mi\2d_bc_FMT_M01_HX_001_L.MIF<tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>
'''Other GIS'''
:<tt>Read GIS BC </tt> <tt>== </tt> gis\2d_bc_FMT_M01_HX_001_p.shp | gis\2d_bc_FMT_M01_HX_001_L.shp <tt>! This command reads in HX boundaries linking the 1D Flood Modeller watercourse to the 2D domain</tt>

<li> Save the file. The boundary control file is now ready to be used.
</ol>

==TUFLOW Control File==
Finally, we need to edit the TUFLOW control file (.tcf). We will:
<li> Remove reference to model parameters that will be read in from Flood Modeller</li>
<li> Read in the GIS layer of the Flood Modeller Nodes </li>
<li> Read in the GIS layers to create Water Level Lines along the Flood Modeller component of the model (optional) </li>
<li> Add a reference to the ESTRY Control File
<li> Update reference to the boundary control file (.tbc) and geometry control file </li>
 
<ol>
<li> In the \FMT_Tutorial\FMT_M01\TUFLOW\runs folder, save a copy of the TUFLOW file created as a part of module 2 ('''M02_5m_001.tcf''') as '''FMT_M01_001.tcf'''. </li>

<li> In a linked Flood Modeller - TUFLOW model, the Start Time, End Time and 2D Timestep are read from the Flood Modeller .ief file. It is best practice to therefore remove these parameters from the tcf. And an exclamation mark in front of each of the below commands. 

<tt>! SIMULATION TIME CONTROL COMMANDS </tt>
:<tt>Timestep </tt> <tt>== </tt> 1.5 <tt>! Specifies a 2D computational timestep of 1.5 seconds </tt>
:<tt>Start time </tt> <tt>== </tt> 0 <tt>! Specifies a simulation start time of 0 hours </tt>
:<tt>End Time </tt> <tt>== </tt>3 <tt>! Specifies a simulation end time of 3 hours </tt> </li>

<li> We need to read in the GIS layers of the Flood Modeller Nodes. Place the below command line anywhere in the .tcf. It is good practice to create a section within the .tcf to reference all 1D commands: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nodes_001_P.MIF <tt>! GIS layer referencing node IDs from Flood Modeller </tt>
'''Other GIS''' 
:<tt>Read GIS X1D Nodes</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nodes_001_P.shp <tt>! GIS layer referencing node IDs from Flood Modeller </tt>

<li> Add commands to read in the GIS layers referencing Water Level Lines drawn along the Flood Modeller component of the model: </li>
'''Mapinfo''' 
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\mi\1d_x1d_FMT_M01_nwk_001_L.MIF <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\mi\1d_x1d_WLL_FMT_M01_001_L.MIF <tt>! GIS layer containing WLLs for visualising 1D results in 2D (optional)</tt>
'''Other GIS''' 
:<tt>Read GIS X1D Network</tt> <tt>== </tt>..\model\gis\1d_x1d_FMT_M01_nwk_001_L.shp <tt>! GIS layer representing channels to allow for the digitisation of Water Level Lines (optional)</tt>
:<tt>Read GIS X1D WLL</tt> <tt>== </tt> ..\model\gis\1d_x1d_WLL_FMT_M01_001_L.shp <tt>! GIS layer containing WLLs for visualising 1D results in 2D (optional)</tt>

<li> Add commands to read in the an Esty Control File which contains references to some of the culverts present on the floodplain: </li>
:<tt>ESTRY Control File</tt> <tt>== </tt>..\model\FMT_M01_001.ecf <tt>!Reference the ESTRY Control File </tt>

<li> Finally, update the links to the Geometry control file, the Boundary Condition control file and the bc_dbase file:</li>
:<tt>Geometry Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tgc
:<tt>BC Control File</tt> <tt>== </tt>..\model\FMT_M01_001.tbc
:<tt>BC Database</tt> <tt>== </tt>..\bc_dbase\bc_dbase_FMT_M01.csv

This concludes the changes that we need to make to the .tcf
</ol>

==Flood Modeller Simulation Files==
In the FMT_M01\Flood_Modeller folder, we have provided a complete Flood Modeller model. It is located in the DAT, IED and IEF folders. 
The DAT and IED files are complete and will not require any modification to link to TUFLOW. 
However, we will alter the IEF to create the link. The IEF alterations can be done either in a text editor of your choice or using the Flood Modeller Interface. 
The instructions below have been written for the Flood Modeller Interface version 4.2. 

==IEF File==
<ol>
<li> Open Flood Modeller. Select 'Load 1D Network'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\DAT''' and load the '''FMT_M01_001.dat'''.</li>
<li> Right click 'Event Data' and select 'Add Item'. Navigate to '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' and load the '''FMT_Inflows.IED'''.</li>
[[file:FMT Load1Dnwk.JPG|500px]]
<li> On the 'Simulation' tab, click New 1D Simulation. Save the file when prompted in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IEF''' folder as'''FMT_M01_001.ief'''</li>
<li> On the 'Files' Tab of the simulation window, set the following parameters:</li>
*Event Title: FMT_M01_001
*1D Data File: The full path to the \FMT_Tutorial\FMT_M01\Flood_Modeller\DAT\FMT_M01_001.dat
*Use Initial Conditions from: Network File (.dat)
*Results File: the full path to \FMT_Tutorial\FMT_M01\Flood_Modeller\RES\FMT_M01_001
<li>To the right of the Event Data box, click Add and select the '''FMT_Inflows.IED''' file in the '''\FMT_Tutorial\FMT_M01\Flood_Modeller\IED''' folder.</li>
[[file:FMT Simulation files.JPG|500px]]
<li>On the 'Times' tab, we will replace the simulation time parameters that were removed from TUFLOW. Enter the following parameters:</li>
*Run Type: Unsteady (Fixed Timestep)
*Start Time (hrs): 0
*Finish Time (hrs): 3
*Timestep (s):1
*Save Interval (s): 300
[[file:FMT Simulation times.JPG|500px]]
<li> Add the 'Links' tab by clicking View> Tabs > Links. On the 'Links' tab, enter the following parameters:
*2-d Scheme: TUFLOW
*2-d Timestep: 2
*2-d control file: full path to the '''FMT_M01_001.tcf''' from the '''\FMT_Tutorial\FMT_M01\TUFLOW\runs''' folder
[[file:FMT Simulation links.JPG|500px]]
<li> Add the 'Additional Output' tab by clicking View> Tabs > Additional Output. On the 'Additional Output' tab, select the check box for '2D Flow...'. This will add extra output to check the Flood Modeller and TUFLOW link. We will review this additional output in the following section.</li>
<li> Save the Scenario Data. </li>
</ol>

=Run the Simulation=
There are a number of different methods in which to start a Flood Modeller – TUFLOW model. Please refer to the [[Running_linked_Flood_Modeller_-_TUFLOW_Models | following page]] for a detailed discussion on each of these methods. 
Use your preferred method to start the model FMT_M01_001.ief or follow the guidance below. If the simulation fails to start, please refer to the troubleshooting guidance on this page. 
 
In the Complete_Model\FMT_M01\Flood_Modeller\IEF folder a batch file has been provided. To use the batch file in this tutorial: 
*Ensure that you [https://wiki.tuflow.com/Running_linked_Flood_Modeller_-_TUFLOW_Models set up the installation folders].
*Move the batch file to the FMT_Tutorial\FMT_M01\Flood_Modeller\IEF folder
*Open the batch file in a text editor. On the 'set FloodModeller=' line, change the path from the one provided to the full path to the ISISf32.exe file that you set up with the installation folders.
*Save and close the file
*Double click the batch file in your file explorer to run the file
 
When the simulation is running, the Flood Modeller status window will open. Flood Modeller will then open a tab with the TUFLOW output. 
[[file:FMP_Sim_Screen.png|500px]] 
The simulation will take a few minutes depending on the hardware setup. 
 

=Review the Results=
Modelled results can be processed, reviewed and visualised in many different packages. 
For a complete introduction to the different options, [[Tutorial_Module01_Archive#Viewing_Results | refer to Tutorial Module 1]]. 
 

==TUFLOW HPC==

To run the linked TUFLOW-Flood Modeller Pro model using HPC we simply need to add a single line to the Tuflow Control File. The HPC solver will only speed up the 2D calculations within the linked 1D-2D model, it will not speed up the 1D calculations that take place in the Flood Modeller Engine.
The relatively small nature of this specific model means that use of HPC on multiple CPU cores may not lead to significant improvements to model run times. However, should the machine have an NVIDIA GPU card present then it is possible to run the HPC solver on the GPU to significantly improve model runs times. The larger the 2D domain, the more significant the improvements to model run times through the use of the HPC solver.
To utilise the HPC solver:-

<ol>
<li> Save the TUFLOW runfile ( FMT_M01_001.tcf) as FMT_M01_002.tcf.</li>

<li> Add the following command to the TCF file:
:<tt> Solution Scheme </tt> <tt>== </tt>HPC <tt>! Use HPC solver to run the simulation</tt>
<li> If you have a CUDA enabled NVIDIA GPU device, you can also add the following command to run the HPC solver using GPU hardware:
:<tt> Hardware </tt> <tt>== </tt>GPU <tt>! Run HPC solver on GPU</tt>
<li> Save the TCF file and run the model.Troubleshooting for GPU Simulation
</ol>
===Troubleshooting for GPU Simulation===
If you receive the following error when trying to run the TUFLOW HPC model using GPU hardware:
<pre>TUFLOW GPU: Interrogating CUDA enabled GPUs …
TUFLOW GPU: Error: Non-CUDA Success Code returned
</pre>
or
<pre>ERROR 2785 - No GPU devices found, enabled or compatible.
</pre>

Please try the following steps:
<ol>
<li> Check if your GPU card is an NVIDIA GPU card. Currently, TUFLOW does not run on AMD type GPU.
<li> Check if your NVIDIA GPU card is CUDA enabled and whether the latest drivers are installed. Please see [[GPU_Setup | GPU Setup]].
</ol>
 
If you experience an issue that is not detailed above please send an email to [mailto:support@tuflow.com support@tuflow.com] 

=Conclusion=
We introduced the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 

 
{{Tips Navigation
|uplink=[[Flood_Modeller_Tutorial_Model| Back to Flood Modeller Tutorial Model]]
}}

Flood Modeller Tutorial Module02

2025-10-23T06:59:11Z

Pavlina Monhartova: /* Conclusions */

=Introduction=
In this tutorial we will add a representation of a proposed development which involves adding TUFLOW 1D pipe network elements into the existing model network to represent the drainage network, which will then be linked with Flood Modeller Pro.
 
This will involve:
*Modification of the floodplain topography by the creation of a 3D TIN surface;
*Revising the land use;
*The addition of pipes and pits to represent an underground drainage network;
*Linking the pipe network to Flood Modeller; and
*The addition of an inflow into the pipe network. 

=GIS and Model Inputs=
The steps necessary to modify each of the GIS inputs are demonstrated in MapInfo, ArcGIS and QGIS. At each stage please select your GIS package to view relevant instructions.
 
==Define Elevations (Building a TIN)==
We have provided the GIS layers necessary to modify the ground elevations to represent the proposed development. This part of the tutorial will demonstrate how a TIN is created from these GIS layers. We will also update the GIS defining the road crest level. Follow the instructions below for your preferred GIS package.
* [[FM Tute M02_ARC_Define_Elevations | ArcGIS]]
* [[FM Tute M02_MI_Define_Elevations | MapInfo]]
* [[FM Tute M02_QGIS_Define_Elevations | QGIS]] 

==Define Surface Roughness==
We have provided the GIS layers necessary to modify the land use areas that will change as part of the proposed development. This part of the tutorial will require populating the layer attributes to assign Manning’s n roughness values to each land use. Follow the instructions below for your preferred GIS package.
* [[FM Tute M02_ARC_Define_Roughness | ArcGIS]]
* [[FM Tute M02_MI_Define_Roughness | MapInfo]]
* [[FM Tute M02_QGIS_Define_Roughness | QGIS]]
==Define Pipe Network==
This part of the module creates the GIS layers that make up a pipe network. The pits of the pipe network will be linked to the 2D domain. We will also create the pit inlet database which links the GIS layers to depth-discharge curves. Follow the instructions below for your preferred GIS package.
* [[FM Tute M02_ARC_Pipe_Network | ArcGIS]]
* [[FM Tute M02_MI_Pipe_Network | MapInfo]]
* [[FM Tute M02_QGIS_Pipe_Network | QGIS]]
==Define Boundary Conditions==
This part of the module demonstrates how an inflow can be applied directly to the pits of the pipe network. A GIS layer of the inflow boundary has been provided. We will also modify the existing Boundary Conditions Database to include these new inflows. Follow the instructions below for your preferred GIS package.
* [[FM Tute M02_ARC_Boundary_Conditions | ArcGIS]]
* [[FM Tute M02_MI_Boundary_Conditions | MapInfo]]
* [[FM Tute M02_QGIS_Boundary_Conditions | QGIS]]
===Flood Modeller/ESTRY 1D/1D Link===
TUFLOW models can also be configured with Flood Modeller for dynamically linked 1D pipe network 2D overland flow modelling. The main driver for this feature is for Flood Modeller - TUFLOW models to utilise the powerful pipe network and manhole modelling capabilities of TUFLOW (see the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] for more details) and be able to link these networks into a Flood Modeller river model. 
 
Flood Modeller and TUFLOW (ESTRY) nodes will be considered linked if: 
<ol>
<li> An ESTRY node in a 1d_nwk layer, and a Flood Modeller node in a Read GIS X1D Nodes or Read GIS X1D Network layer are snapped.</li>
<li> The ESTRY node has a 1d_nwk Conn_1D_2D attribute of either "X1DH" or "X1DQ".</li>
::(i) If Conn_1D_2D is blank then “X1DH” is assumed.
::(ii) A connector "X" channel type can be used to connect the end of the linked ESTRY channel to the ESTRY node snapped to the Flood Modeller node if the end of the ESTRY channel and the snapped Flood Modeller /ESTRY nodes are not in the same location.
::(iii) Note that the upstream and downstream inverts for the ESTRY node linked to Flood Modeller should be set to -99999 unless the node is also being used to set the inverts of channels snapped to it.
<li> An "X1DH" link means a Flood Modeller 1D water level is being applied at the ESTRY node (ie. Flood Modeller sends ESTRY a water level and ESTRY sends back a +/- flow to Flood Modeller). </li>
<li> An "X1DQ" link means a Flood Modeller inflow/outflow is being applied at the ESTRY node (ie. Flood Modeller sends ESTRY a +/- flow and ESTRY sends back a water level). </li>
<li> An ESTRY X1DH (the default) would be used for most Flood Modeller ESTRY links. An X1DQ might be more appropriate where a Flood Modeller model stops and flows into an ESTRY model. 
</ol>
Generally, an ESTRY timestep will be smaller than the Flood Modeller timestep. In these cases, the total volume is accumulated over all ESTRY timesteps within a Flood Modeller timestep, and applied to the Flood Modeller model as a discharge by dividing the volume by the Flood Modeller timestep.
The mass balance _MB1D.csv file includes four new columns:
*X1DH V In: The volume of water in via a X1DH link.
*X1DH V Out: The volume of water out via a X1DH link.
*X1DQ V In: The volume of water in via a X1DQ link.
*X1DQ V Out: The volume of water out via a X1DQ link.
The type or existence of a connection can be checked by viewing the Conn_1D_2D attribute in the 1d_nwk_N_check layer. The _messages.mif/.shp layer contains CHECK 1393 messages at each ESTRY node linked to a Flood Modeller node.
 

=Modify Simulation Control Files=
Now that we have made all of the necessary changes to the GIS layers, we need to update our control files to include all the changes representing the proposed development.
 
==TUFLOW Geometry Control File==
There have been two changes to the model that impact the TGC file:
*We have created two layers that together form a 3D TIN representing changes to the ground elevations.
*We have created two 2d_mat layers that represent changes to the land use at the location of the proposed development.
<ol>
<li>Begin by opening FMT_M01_001.tgc in your text editor. Save the file as FMT_M02_001.tgc.
<li> Open FMT_M02_001.tgc
 
'''MapInfo Users'''
 
<li>We will now add the commands to modify the topography to represent the proposed development. Add the following commands after the READ GIS Z Shape line:</li>
:<tt>Create TIN Zpts WRITE TIN </tt><tt>==</tt> mi\2d_ztin_FMT_M02_development_001_R.MIF | mi\2d_ztin_FMT_M02_development_001_P.MIF </li>.
The <tt>Create TIN Zpts Write TIN </tt> command creates and writes an SMS .tin file to the same location as the GIS layer (in this case the TUFLOW\model\mi folder). The TIN can be viewed, checked and modified in SMS. This can then be read into the model directly using the <tt>Read TIN zpts</tt> command for any subsequent model simulations.
 
Our intention for the 2d_mat layers created in this module is for them to build upon the existing commands which modify roughness. We would like for the new layers to overwrite the existing layers at the location of the proposed development. This process of layering and building up the model is a powerful tool in TUFLOW that minimises data duplication and provides a means of quality control. We need to ensure that the commands reading in our new 2d_mat layers are read in after the existing commands.
 
:<tt>Read GIS Mat</tt><tt>==</tt> mi\2d_mat_FMT_M02_DEV_001_R.MIF
:<tt>Read GIS Mat</tt><tt>==</tt> mi\2d_mat_FMT_M02_DEV_Buildings_001_R.MIF
'''QGIS or ArcGIS Users'''
 
<li>We will now add the commands to modify the topography to represent the proposed development. Add the following commands after the READ GIS Z Shape line:</li>
:<tt>Create TIN Zpts WRITE TIN </tt><tt>==</tt> gis\2d_ztin_FMT_M02_development_001_R.shp | gis\2d_ztin_ FMT_M02_development_001_P.SHP </li>
The <tt>Create TIN Zpts Write TIN </tt> command creates and writes an SMS .tin file to the same location as the GIS layer (in this case the TUFLOW\model\gis folder). The TIN can be viewed, checked and modified in SMS. This can then be read into the model directly using the <tt>Read TIN zpts</tt> command for any subsequent model simulations.

Our intention for the 2d_mat layers created in this module is for them to build upon the existing commands which modify roughness. We would like for the new layers to overwrite the existing layers at the location of the proposed development. This process of layering and building up the model is a powerful tool in TUFLOW that minimises data duplication and provides a means of quality control. We need to ensure that the commands reading in our new 2d_mat layers are read in after the existing commands.

:<tt>Read GIS Mat</tt><tt>==</tt> gis\2d_mat_FMT_M02_DEV_001_R.MIF
:<tt>Read GIS Mat</tt><tt>==</tt> gis\2d_mat_FMT_M02_DEV_Buildings_001_R.MIF

<li> Save the file. The .tgc file is now ready to be used.</ol>

==ESTRY Control File==
There have been three changes to the model that impact the ECF file:
*We have created a 1d_nwk layer representing the culverts of the proposed pipe network
*We have created a 1d_nwk layer representing the pits of the proposed pipe network
*We have created a pit inlet database that links depth-discharge curves to the pit inlet type. 

<ol>
<li>Open FMT_M01_001.ecf in your text editor. Save the file as FMT_M02_001.ecf.
<li> Open FMT_M02_001.ecf 

'''MapInfo Users''' 
<li> Add the following commands at the bottom of the file as follows:
:<tt>Read GIS Network</tt> <tt>==</tt> mi\1d_nwk_FMT_M02_Pipes_001_L.MIF
:<tt>Read GIS Network</tt> <tt>==</tt> mi\1d_nwk_FMT_M02_Pits_001_P.MIF
:<tt>Pit Inlet Database</tt> <tt>==</tt> ..\pit_dbase\pit_inlet_dbase.csv

'''QGIS or ArcGIS Users''' 
<li> Add the following commands at the bottom of the file as follows:
:<tt>Read GIS Network</tt> <tt>==</tt> gis\1d_nwk_FMT_M02_Pipes_001_L.shp
:<tt>Read GIS Network</tt> <tt>==</tt> gis\1d_nwk_FMT_M02_Pits_001_P.shp
:<tt>Pit Inlet Database</tt> <tt>==</tt> ..\pit_dbase\pit_inlet_dbase.csv

<li>Save the file. The 1D control file is now ready to be used.</ol>

==TUFLOW Boundary Condition File==

There has been one change to the model that impacts the TBC file:
*We have created a 2d_sa layer to define inflows into the pipe network.
<ol>
<li>Open FMT_M01_001.tbc in your text editor and save as FMT_M02_001.tbc</li>

'''MapInfo Users''' 
<li>Insert the following commands after the existing <tt>Read GIS SA</tt><tt> ==</tt> mi\2d_sa_M01_002_R.MIF command:
:<tt>Read GIS SA PITS</tt><tt> ==</tt> mi\2d_sa_FMT_M02_001_R.MIF

'''QGIS or ArcGIS Users''' 
<li>Insert the following commands after the existing <tt>Read GIS SA</tt><tt> ==</tt> gis\2d_sa_M01_002_R.shp command:
:<tt>Read GIS SA PITS</tt><tt> ==</tt> gis\2d_sa_FMT_M02_001_R.shp

<li> Save the file. The tbc file is now ready to be used.</ol>

==TUFLOW Control File==

We will need to create a new tcf file that references the new tgc, ecf and tbc files.
<ol>
<li>Open FMT_M01_001.tcf and save as FMT_M02_DEV_001.tcf.
Update the following commands:
:<tt>Geometry Control File</tt><tt> ==</tt> ..\model\FMT_M02_001.tgc
:<tt>ESTRY Control File</tt><tt> ==</tt> ..\model\FMT_M02_001.ecf
:<tt>BC Control File</tt><tt> ==</tt> ..\model\FMT_M02_001.tbc
<li>We have also created a new bc_dbase in this module which will need to be referenced. Update the command as follows:
:<tt>BC Database</tt><tt> ==</tt> ..\bc_dbase\bc_dbase_FMT_M02.csv
<li>Lastly, update the following command to specify a new output folder for the results of this module:
:<tt>Output Folder</tt><tt> ==</tt> ..\results\FMT_M02\2d
<li>Save the file. The tcf file is now ready to be used.</ol>

==Flood Modeller Simulation Files==
<ol>
<li>Open the Flood Modeller Pro model as per [[Flood_Modeller_Tutorial_Module01 | Flood Modeller Tutorial Module 1]]
<li>In the 'Links' tab with the 2D scheme set as TUFLOW, change the full path of the 2D control file to the FMT_M02_DEV_001.tcf from the \FMT_Tutorial\FMT_M02\TUFLOW\runs folder
<li>Save the Scenario Data.</li></ol>

Use your preferred method to start the model FMT_M02_001.ief or follow the guidance in the [[Flood_Modeller_Tutorial_Module01 | Flood Modeller Tutorial Module 1]] page. If the simulation fails to start, please refer to the troubleshooting guidance on that page.

=Review Check Files=
Once the model has compiled and the simulation started, we can review the check files to ensure the changes have been correctly applied. The following section of this module outlines how the generated check files can be used to review each of the key changes we have made to the model. Note that there is often more than one check file that can be used to review each component of the model. The below steps outline just how some of these check files can be used.

'''Review Created TIN''' 

From the TUFLOW\check\2d\ folder import (into MapInfo) or open (ArcMap and QGIS):
*FMT_M02_001_DEM_Z.asc

The FMT_M02_001_DEM_Z.asc is a grid of the final zpts used by TUFLOW after processing of each of the layers within the tgc. It can be read by most mainstream GIS software and also visualised in SMS.

'''Review Changes to Roughness''' 

From the TUFLOW\check\2d\ folder import (into MapInfo) or open (ArcMap and QGIS):
*FMT_M02_001_grd_check

The grd_check file contains information on all cells within the model extent, such as ZC elevation and the location of the cell in relation to the model origin. One of the attributes of this check layer is the Material ID assigned to each cell. A review of this check file is recommended particularly when using multiple GIS layers to define the roughness of a 2D domain. The file can be colour coded to provide a visual representation of the roughness assigned to the entire model extent by:
*Thematically mapping the grd_check layer in MapInfo
*Changing the style of the grd_check file to 'Categorized' by the 'Material' column in QGIS
*By right clicking on the grd_check layer within the table of contents and click Properties. Once the properties dialogue window is open select the Symbology tab. Choose the Unique values option under Categories in the left-hand list and map the Value Field of interest.

'''Review Pipe Network''' 

From the TUFLOW\check\1d\ folder import (into MapInfo) or open (ArcMap and QGIS):
*FMT_M02_001_nwk_C_check
*FMT_M02_001_nwk_N_check

These two check files provide information on the all 1D elements within the model. The _nwk_C_check layer provides information on all 1D channels (including structures) in the model, whilst the _nwk_N_check layer provides information on the nodes. Notice how the _nwk_C check layer shows a series of dashed lines at the locations where we have specified pits in the model. These lines represent 'pit channels', zero length channels that connect the 1D pipe network to the 2D floodplain. Viewing in conjunction with the _nwk_N check layer shows two nodes are created at the upstream (ground level) and downstream (invert of the pipe network) ends of the pit channel. The orange triangle at the upstream end provides information on the link created with the 2D floodplain. The blue diamond at the downstream end provides information on the automatically created manhole at the junction between the culverts of the pipe network.

'''Review Boundaries and 1D/2D Links'''
From the TUFLOW\check\2d\ folder import (into MapInfo) or open (ArcMap and QGIS):
*FMT_M02_001_1d_to_2d_check
*FMT_M02_001_sac_check

The _1d_to_2d_check layer highlights the location of all 1D/2D boundary links within the model. Where we have digitised the pipe network, this check file shows the SX boundaries that have been created at the location of the pits. This check file also shows the ZC elevation of the SX boundary which can be compared to surrounding ZC elevations by viewing alongside the grd_check layer. The check layer also shows the HX boundaries digitised along the river banks in Module 01.

The _sac_check layer highlights the 2D cells connected to 1D pits where the 2d_sa inflow boundaries have been applied. The check file has been colour coded to show which 2D cells each of the four inflow boundaries has been applied to. The flow is distributed equally among each of the 2D cells.

=Review the Results=

Open the 2D results in your results viewer or import to your GIS package. It can be seen that during the flood event the capacity of the pipe network is exceeded resulting in flooding of the roads in the proposed development. 
[[File:M07 2d Results.PNG|800px]] 
 
The 1D ESTRY results can be viewed by importing the time series (_TS.mif or _TS_P.shp from the TUFLOW\results\1D folder, or opening any of the csv files outputted to TUFLOW\results\1d\csv. Another useful method for viewing the results of pipe networks is by importing in the _1d_ccA result layer found in the TUFLOW/results/1D folder. For each conduit or bridge within the model extent, this layer will provide information on the performance of the structure. Information such as percentage full and the time (in hours) the structure is at capacity are shown in this result layer. The layer is also automatically colour coded with thicker, dark purple lines highlighting structures that have reached capacity during the simulation. Thinner, pink lines show pipes that still have capacity.
 
[[File:M07 ccA Results.PNG|800px]]

=Conclusion=
We have added to the model a final proposed development scenario. Using the Create TIN Zpts command, we have altered the ground elevations to represent the development. We have also added a 1D pipe network which has been linked to the 2D domain as well as feeding flows in the 1-dimensional channel represented within Flood Modeller. A pit inlet database has been created to specify a depth-discharge relationship for flow into and out of the pits. This allows us to create a fully integrated urban drainage model comprises 1D representations of the pipe network and river system together with the 2D surface. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 

 
{{Tips Navigation
|uplink=[[Flood_Modeller_Tutorial_Model| Back to Flood Modeller Tutorial Model]]
}}

Flood Modeller Tutorial Model

2025-10-23T06:56:40Z

Pavlina Monhartova: /* Modules */

=Introduction=
The objective of this Flood Modeller – TUFLOW model is to demonstrate the ability of TUFLOW to link to an external 1D scheme and the various methods available in which to create this link. It is designed to supplement existing documentation and assumes the user has some prior knowledge of both the Flood Modeller and TUFLOW software packages.
This tutorial model has been developed by BMT with Jacobs. Please post comments, requests and feedback to [mailto:support@tuflow.com support@tuflow.com].

=Requirements and Downloads=
Both TUFLOW and Flood Modeller have relatively modest system requirements for small models such as the tutorial model. However, larger and more complex models may have higher hardware requirements - in particular memory (RAM). Both software are available in 32 and 64 bit versions.
==Hardware==
The tutorial model is designed to be small, to allow for quick simulation and load times. The tutorial model should run on any modern PC or laptop that is capable of running Windows 7 or later. If you would like to complete the optional TUFLOW HPC steps utilising a GPU card then you will need access to a CUDA enabled NVidia graphics card.
==Software==
===TUFLOW===

This tutorial model has been constructed using the 2018 release of TUFLOW. The tutorial model may be simulated licence free using TUFLOW Build 2016-03-AC or later. This can be obtained from the [https://tuflow.com/downloads/#tuflow downloads section] of the TUFLOW website. TUFLOW Build 2016-03-AD or later must be used in order to take advantage of the free TUFLOW link for this tutorial model. 

===Flood Modeller===
This tutorial model has been constructed using version 4.2 of Flood Modeller. This can be downloaded from the [https://www.floodmodeller.com/en-gb/downloads/ Flood Modeller Website]. The tutorial model may be simulated licence free using Version 4.2 to 4.6. These versions of Flood Modeller contains the free TUFLOW link, which permits simulation of linked models with up to 10 links or the tutorial model.

Larger models with more links will require a [https://www.floodmodeller.com/en-gb/sales/pricing-and-licensing-options/tuflow/ link licence]. A licence is also required is you intend to run the model in Flood Modeller 5 or later 

===GIS Software===
TUFLOW models typically require access to a GIS package, text editor, Microsoft Excel and a results viewer to build, review and visualise a model. Refer to the following Wiki page to view a list of compatible packages. Alternatively, Flood Modeller may be used as a GUI for creating and editing GIS layers in a TUFLOW model and also for visualising the results.
Instructions for this Flood Modeller – TUFLOW tutorial model have been provided using the following GIS and modelling packages:
*MapInfo
*QGIS
*ArcGIS

=Module Data=
All data to complete the tutorial has been provided, including a digital elevation model (DEM), aerial photography and a complete Flood Modeller model. Data for this tutorial is provided in a variety of different GIS compatible formats. Download the dataset that matches the GIS software you are using:
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_QGIS.zip QGIS Data Download]
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_Data_MapInfo.zip MapInfo Data Download]
*[https://downloads.tuflow.com/_archive/TUFLOW/Tutorial_Model/FMT_Tutorial_Data_ArcGIS.zip ArcGIS Data Download]

=Recommended Reading=
The aim of this tutorial is to demonstrate the steps undertaken to build, review and visualise the results of a linked Flood Modeller – TUFLOW model. It assumes that the user has a good understanding of both the 1D component of Flood Modeller and the 1D and 2D components of TUFLOW. The following resources may be of use:
*[[Tutorial_Introduction | TUFLOW Tutorial Model]]
*[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW User Manual]
*[https://www.floodmodeller.com/media/34731/isis_1d_quick_start_guide.pdf Flood Modeller 1D Quick Start Guide]
*[https://help.floodmodeller.com/docs Flood Modeller User Manual]

=Modules=
The tutorial is presented over a series of modules, with each module offering the opportunity to run the model and review the results. Each of the modules builds upon the previous iteration with models developed in the previous module made available.
New users are advised to undertake the modules in sequence, whilst more experienced users can skip to modules containing specific features of interest.
==Module 1: Linking Flood Modeller to TUFLOW==
The first tutorial module introduces the user to the linking of a TUFLOW 2D domain to a 1D Flood Modeller model. To access this module of the tutorial please see this page: [[Flood Modeller Tutorial Module01|Flood Modeller Tutorial Module 1]]. 
 
From this tutorial you will learn how to link an existing Flood Modeller 1D model to a TUFLOW 2D domain. 
This tutorial is ideal for those starting to learn how to link Flood Modellder and TUFLOW. 

==Module 2: Linking Flood Modeller to ESTRY==
The second tutorial demonstrates the linking of an ESTRY pipe network to an existing Flood Modeller – TUFLOW linked model. To access this module of the tutorial please see this page:
[[Flood Modeller Tutorial Module02|Flood Modeller Tutorial Module 2]]. 

From this tutorial you will learn how to add a 1D pipe network and connect it to the representation of the watercourse created in Flood Modeller and link it to the TUFLOW representation of the floodplain created as part of [[Flood Modeller Tutorial Module01|Flood Modeller Tutorial Module 1]]. This tutorial is ideal for those who would like to learn more about the interaction of TUFLOW with Flood Modeller including the simulation of fully integrated drainage systems.

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

Tutorial Introduction

2025-10-23T06:19:41Z

Pavlina Monhartova: /* Contact */

= Introduction =
This TUFLOW licence free tutorial model is aimed at new users, stepping through the process of building and running a model. To begin, watch the following video:
:*[https://vimeo.com/505584298/2c91bd5f48 What Is TUFLOW?]
 

=Requirements and Downloads=
TUFLOW uses QGIS as its Graphical User Interface (GUI), in combination with text editor and spreadsheet software, for its model creation and result viewing. The group of software creates an extremely workflow efficient and flexible modelling environment. Notably, QGIS does not experience the data load/visualisation lag and display issues some other hydraulic modelling software GUIs are limited by when working with larger datasets. 

This short video introduces the required TUFLOW modelling programs:
:*[https://vimeo.com/505579529/03f4cb3d17 Required Programs] 

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-
| '''TUFLOW''' || TUFLOW is a computer program for simulating depth-averaged, one and two-dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid of square elements. 
It is recommended to always use the latest release version of TUFLOW. 

This tutorial model does not require a TUFLOW licence. 

This tutorial is set up to use a NVIDIA GPU card. If this is not available, CPU can be used in the hardware command. 
||The TUFLOW executable is provided within the [https://wiki.tuflow.com/Tutorial_Introduction#Module_Data Tutorial Dataset].
|-
| '''QGIS''' QGIS TUFLOW plugin || The Geographic Information System (GIS) used to build models and view results. This tutorial was developed with QGIS 3.20. It is recommended to have QGIS 3.20 or later to ensure compatibility with TUFLOW plugin latest features. 
The TUFLOW plugin includes numerous tools to increase workflow efficiency. 

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]].
|-
| '''NotePad++''' Syntax Highlighting || A text editor is required for creation of the TUFLOW input files. This tutorial was developed with NotePad++. Ideally a text editor should be able to: 
*Colour code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. 
TUFLOW colour coding can be enabled using syntax highlighting.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. 

For instructions on configuring Notepad++ for TUFLOW modelling, see [[NotepadPlusPlus_Tips |Notepad++ tips]].
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created in Excel. ||
|-
| '''Windows File Explorer''' || Windows File Explorer is used for navigating, copying and renaming files. It is recommended to display file extension to allow for editing of file extensions. For more details, see [[Tutorial_Troubleshooting_QGIS#Editing_File_Extension | Editing file extension]]. ||
|}

 

=Module Data=
To build the tutorial model, download one of the datasets below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. There are two formats available, Shapefile and GeoPackage. GeoPackage has been supported since the 2023-03 Release, for tips on its use see [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_GPKG.zip Tutorial Dataset - QGIS - GPKG]
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/Tutorial_Models_QGIS_SHP.zip Tutorial Dataset - QGIS - SHP]

Note: there are numerous GIS packages that can be used, these tutorials have been specifically designed for QGIS using the QGIS TUFLOW Plugin. If you would like to see past tutorials for MapInfo, ArcGIS or SMS, please contact [mailto:support@tuflow.com support@tuflow.com].

=Tutorial Modules=
The download dataset contains the input files and working version of the tutorial model for reference. Results and check files are not included to keep the size of the download file manageable. The folder should be placed in a location with write permissions. 

The tutorial model is presented in a number of modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:

:*[[Tutorial_M01 | Module 1]] - 2D Base Model
:*[[Tutorial_M02 | Module 2]] - Topography Updates
:*[[Tutorial_M03 | Module 3]] - 1D Culverts
:*[[Tutorial_M04 | Module 4]] - 2D Bridges
:*[[Tutorial_M05 | Module 5]] - Integrated Urban Drainage
:*[[Tutorial_M06 | Module 6]] - Direct Rainfall
:*[[Tutorial_M07 | Module 7]] - Quadtree
:*[[Tutorial_M08 | Module 8]] - Scenario Management
:*[[Tutorial_M09 | Module 9]] - Event Management
:*[[Tutorial_M10 | Module 10]] - Dam Break
:*[[Tutorial_M11 | Module 11]] - 1D Open Channel
 

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
Alternatively, see the [[TUFLOW_Example_Models#Example_Model_Catalogue | TUFLOW Example Models]] to explore the full list of TUFLOW features.
 

=Archive Dataset=
Historic tutorial model datasets can be accessed via the following link: [[Tutorial_Model_Archive| TUFLOW Classic Tutorial Model Archive]].

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Main Page]]
}}

XPSWMM to TUFLOW-SWMM

2025-10-23T06:19:06Z

Pavlina Monhartova: /* Feedback / Suggestions */

= Introduction =
This Wiki page outlines recommended steps for the conversion of an XPSWMM model to TUFLOW. 

XPSWMM is a flood and urban stormwater drainage modeling software developed by Autodesk (previously Innovyze and XP Solutions). The XPSWMM solution uses EPA SWMM for its 1D calculations, dynamically linked to TUFLOW for its 2D calculations. The software functions within a custom build Graphical User Interface (GUI). Unknown to many XPSWMM modelers, during simulation, XPSWMM processes its inputs into TUFLOW files and also calls TUFLOW for the 2D calculations. As XPSWMM uses TUFLOW for its 2D engine, like-for-like results can be achieved using this software. The modeling workflow in TUFLOW differs from XPSWMM, as TUFLOW modeling is integrated with QGIS (Geographical Information System) GIS software instead of embedded within a software specific Graphical User Interface.

If you are building a TUFLOW SWMM model from scratch, not from XPSWMM, please refer to the [[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]]. Tutorials are provided for the following topics:
* [[TUFLOW SWMM Tutorial M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
* [[TUFLOW SWMM Tutorial M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
* [[TUFLOW SWMM Tutorial M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
* [[TUFLOW SWMM Tutorial M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.

== Dataset Download ==
The dataset used for this model conversion demonstration is available for download here: [https://downloads.tuflow.com/SWMM/XPSWMM_XPX_to_TUFLOW_Conversion.zip XPSWMM XPX to TUFLOW Conversion Dataset]. 
This dataset contains the XPSWMM model and the resulting TUFLOW model that is created. These can be found in the '''XPSWMM''' and '''Complete_Conversion''' folders respectively. 

'''If you are using this example conversion dataset, please rerun the XPSWMM model in the location where you save the dataset before beginning your own TUFLOW model conversion.''' Rerunning the model is necessary because XPSWMM will write TUFLOW files during its preprocessing, subsequently defining the correct file path information (for the location where you saved your files) in the newly written TUFLOW files. We also recommend creating your own TUFLOW model in a different folder from the provided TUFLOW dataset so you can easily compare your model against it. 

If you do not have access to a XPSWMM license and the XPSWMM Application, please refer to the [[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Model_Conversion_Without_a_XPSWMM_License |XPSWMM to TUFLOW SWMM Troubleshooting]] page. 

= XPSWMM to TUFLOW Model Conversion =
== Export Data From XPSWMM Model ==
'''Digital Terrain Model (DTM) Data''' 
XPSWMM reads its 2D DTM data in one of two ways:
* The DTM data can be directly specified in the '2D Model Settings', or
* The DTM data can be internally processed by XPSWMM using its terrain tools and DTM builder.
Depending on which method is applied to your XPSWMM model, the steps required to will vary. Review which method is used:
<ol>
<li> Open your existing model in XPSWMM.
<li> In the top dropdown menu options, go to Configuration > Job Control > 2D Model Settings. This will open a dialog.
<li> Under '2D Hydraulics Job Control', select 'Surface & Sampling'.
<li> Review the options in the 'Surface' section:
:* If 'Use DTM' is selected: Continue to the section below ([[XPSWMM_to_TUFLOW-SWMM#Export_DTM_Data_from_XPSWMM |Export DTM Data from XPSWMM]]) and complete the steps.
:* If 'Use Grid File for Topography' is selected and a 'Grid file' is specified, the steps outlined in the 'Export DTM Data From XPSWMM' section can be skipped. Go to the [[XPSWMM_to_TUFLOW-SWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]] section.
'''Note:''' If you have a .tif elevation file, you can continue to the [[XPSWMM_to_TUFLOW-SWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]] section. The conversion process will be identical however, once converted, you will have to create the '''TUFLOW\model\grid''' folder manually and copy the .tif file into it.
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_01b.mp4|width=1350}}
 
</ol>

=== Export DTM Data From XPSWMM ===
If 'Use DTM' was selected, XPSWMM preprocesses its Digital Terrain Model (DTM) into a binary XPTIN elevation dataset for inclusion in the TUFLOW model. XPTIN is a binary format that can't readily be used in GIS software. For this reason, the following steps outline how to obtain a DTM dataset in a GIS friendly form.
<ol>
<li> In the XPSWMM Layers panel, under 'Topography', right click on '''DTM''' and select 'Export DTM Data'.
:* Input TIN File: Select the relevant XPSWMM Input TIN file.
:* Output File Format: 'ASCII Grid File Format'.
:* Cell Size Value: Choose a suitable DTM resolution. This resolution should be finer than the hydraulic model resolution. Typically, a DTM resolution is 1/5th to 1/10th of the hydraulic model 2D cell size is common (1 in the example dataset).
''Note: XPSWMM requires an integer cell size value for this export step. For example, Cell Size Values of 1, 2, 3, 4, 5 ... are suitable. The XPSWMM export will not function if you specify a decimal cell size value (eg. 0.5, 2.5, etc.).''
<li> Click 'Export'.
<li> Save the file under an appropriate name (e.g. '''1D2D_Urban_Grid.asc''') to the folder where XPSWMM writes the .tcf during its simulation preprocessing. By default, this is the '''2D\Data''' folder. 
If this folder does not exist, either:
:* The XPSWMM model has not run, so the TUFLOW control files have not been created by XPSWMM. Run the XPSWMM model (go to Analyze > Solve... in top dropdown menu options).
:* Non-default output settings have been specified in XPSWMM. To determine the output location, in the top dropdown menu options, go to Configuration > Job Control > 2D Model Settings > Folder Options. Ensure the following 'Folder Locations' are selected.
::[[File: XPSWMM_to_TUFLOW_2DJobControl_FolderOptions_Dialog_01e.png]] 

<li> In the top dropdown menu options, navigate to Configuration > Job Control > 2D Model Settings. This will open a dialog, under '2D Hydraulics Job Control', select 'Surface & Sampling'.
<li> Tick on 'Use grid file for topography' and select '...' to navigate to the Grid file saved in the '''2D\Data''' folder. This file will be read directly into TUFLOW.
<li> Click 'OK' to save the settings.
<li> Run the XPSWMM model to rewrite the TUFLOW files (including the new linkage to the DTM dataset) to the Data folder (go to Analyze > Solve... in top dropdown menu options).
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_02b.mp4|width=1350}}
 
</ol>

=== Export XPX Data From XPSWMM ===
A XPX file is a simple command line file that contains the information needed to create link and node objects. To export this data from the XPSWMM model:
<ol>
<li> In XPSWMM, in the top dropdown menu options, navigate to File > Import/Export Data > Export XPX Data. This will open a dialog. Leave all options as default and click 'Export'.
<li> When prompted, save the file under an appropriate name (eg '''1D2D_Urban_001.xpx''') to the folder where the XPSWMM model is located.
 
{{Video|name=Animation_XPtoTUFLOW_Export_Data_03b.mp4|width=1350}}
 
</ol>

== Convert XPSWMM Model to TUFLOW SWMM ==
Ensure you have QGIS and have the QGIS TUFLOW Plugin installed:
*Install QGIS 3.34 or later: [https://www.qgis.org/download/ Latest 64-bit version of QGIS].
*Install the QGIS TUFLOW Plugin by following the instructions, [[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin Installation]].

The following steps outline the process of converting a XPSWMM model to TUFLOW SWMM using the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool.

<ol>
<li> Open QGIS and go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li> Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]'. This opens the dialog shown below.
:* XPSWMM Exported XPX File: Click '...' and navigate to the exported XPX data (e.g. '''1D2D_Urban_001.xpx'''). This should be located in the same folder as the XPSWMM model.
:* TUFLOW TCF Filename: Click '...' and navigate to the XPSWMM .tcf. This should be located in the '''2D\Data''' folder (e.g. '''2D\Data >> 1D2D_Urban_001.tcf''').
:* SWMM File Prefix: Choose an appropriate prefix for the SWMM files (e.g. '''1D2D_Urban_swmm''').
:* Output Solution Scheme: 'HPC'
:* Output Hardware Specification: 'GPU' (if GPU is not available, select 'CPU')
:* Output Vector Format: 'GPKG'
:* Output Raster Format: 'GTIFF'
:* Output Profile: Any option can be used. 'ALL IN ONE' is used in this example for model design consistency with the [[Tutorial_Introduction | TUFLOW SWMM Tutorials]].
:* Event name if no global storms: Choose an appropriate event name if applicable (100yr in the example dataset).
:* BC width for created 1D/2D connections (HX/SX): This value should be approximately 2 times the width of the hydraulic model 2D cell size (10 in the example dataset).
:* BC offset distance for created 1D/2D connections (HX/SX): Distance from the channel endpoint to the midpoint of the BC line (2 in the example dataset).
:* Output Folder: Click '...' and navigate to an appropriate location to save your TUFLOW model. In this location, create a new folder called '''TUFLOW''' and select it.
:* Output CRS: Select an appropriate Coordinate Reference System (CRS) for the model. For the demonstration model, the CRS is 'EPSG:32760 - WGS 84 / UTM zone 60S'.
<li> Click 'Run'. Once the tool is finished, click 'Close'.
 
{{Video|name=Animation_XPtoTUFLOW_Convert_01c.mp4|width=1350}}
 
</ol>

Inspect the output of the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool and load the TUFLOW model into QGIS:
<ol>
<li> In Windows File Explorer, inspect the files output by the processing tool. In particular:
* The '''TUFLOW\bc_dbase''' folder contains the BC Database which will contain any curves used in BC conditions, for easy extending to other events.
* The '''TUFLOW\model''' folder contains the TUFLOW SWMM Control File (TSCF) which holds all commands specific to SWMM, including links to the converted SWMM INP file.
* The '''TUFLOW\model\swmm''' folder contains a GeoPackage database ('''*_convert_messages.gpkg'''). This GeoPackage contains locations and descriptions of any errors or warnings that occurred during the conversion process.
: '''Note:''' Conversion messages are addressed in further detail here [[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Common_Conversion_Issues |XPSWMM to TUFLOW SWMM Troubleshooting]].
* The '''TUFLOW\runs''' folder contains the TCF. If event(s) are specified, the TCF filename with have event placeholder(s), i.e. '_~e1~_~e2~_' (e.g. '''1D2D_Urban_001_~e1~.tcf'''). Again, if event(s) are used, this folder also contains the TUFLOW Event File (TEF) with the event(s) specified. 
{{Video|name=Animation_XPtoTUFLOW_Convert_02b.mp4|width=800}}
 
<li> Open QGIS, and click on the ‘Load TUFLOW Layers from TCF’ symbol from the QGIS TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li> Navigate to the location of the TUFLOW model and go to the '''TUFLOW\runs''' folder. Select the TCF.
<li> In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li> Click ‘Open’ and ‘OK’.
<li> Change the symbology of the DTM dataset:
* In the QGIS Layers panel, right click on the DTM Grid file and select 'Properties'.
* In the Symbology tab, under 'Band Rendering', set the 'Render type' to 'Hillshade' and the 'Z Factor' to 3.
<li> Inspect the output GIS layers.
 
{{Video|name=Animation_XPtoTUFLOW_Convert_03b.mp4|width=1350}}
 
</ol>

== Recommended Additional Conversion Steps ==
While the bulk of the XPSWMM to TUFLOW SWMM model conversion is automated by the '[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]' processing tool, some required or recommended conventions must be implemented/updated manually. Therefore, it is highly recommended to complete the additional conversion steps: [[XPSWMM_to_TUFLOW-SWMM_Recommended_Additional_Conversion_Steps|Recommended Additional Conversion Steps]]. 
These steps can help improve model stability and they may also be helpful to address any messages that occurred when using the conversion tool.
 

== TUFLOW Simulation Execution ==
Set up a simple batch file (.bat) to run TUFLOW. This approach calls the TUFLOW executable file (.exe) and runs the TCF file.
<ol>
<li>Create a new text file in the '''TUFLOW\runs''' folder and save as '''_run_HPC.bat'''.
<li>Open the '''_run_HPC.bat''' in a text editor and include a file path to the TUFLOW executable and the TCF name: 
<tt>set exe="..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe" 
<tt>set run=start "TUFLOW" /wait %exe% -b 
%run% -e1 100yr 1D2D_Urban_001_~e1~.tcf</tt></tt> 
 
'''Note:''' A relative path is used for the executable and the TCF, full file path can also be used.
<li>Save the batch file and double click it in Windows File Explorer to run the simulation. This will open the TUFLOW Console Window and the simulation should be executed.
</ol>

TUFLOW simulations can be executed via numerous ways. A comprehensive summary of the most commonly used approaches is documented in the [[Running_TUFLOW | Running TUFLOW]] Wiki page.

=== Troubleshooting ===
Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 

= TUFLOW SWMM Result Viewing =
Are you familiar with loading and viewing TUFLOW results in QGIS? If not, we strongly recommend self-registering and completing our free eLearning:
[https://www.tuflow.com/training/training-course-catalogue/tt001-e-introduction-to-qgis-for-tuflow-elearning/ Introduction to QGIS for TUFLOW]. 

Our [[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]] also demonstrate working with TUFLOW SWMM results.

= Recommended Further Reading =
For users who wish to get a better understanding of either 2D TUFLOW or 1D EPA SWMM, the following resources may be of use: 
'''TUFLOW''': [https://www.tuflow.com www.tuflow.com]
*[https://www.tuflow.com/downloads/#tuflow TUFLOW User Manual]
*[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD release notes]
*[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]

 
'''EPA SWMM''': [https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]
*[https://downloads.tuflow.com/SWMM/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

TUFLOW SWMM Tutorial M04

2025-10-23T06:18:21Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
This tutorial, Module 4 of the TUFLOW SWMM tutorial dataset will demonstrate TUFLOW's in-built event management functionality. This powerful functionality runs multiple event combinations (e.g. magnitude, duration, temporal patterns, climate change) using a single set of control files, rather than creating a new set of control files for every event simulation. This tutorial demonstrates how event management can be used on a smaller scale, running only 6 models. 
The real power of event management is seen when running a model of a much greater size. For example, without implementing event management, a project requiring simulation of the following event combinations would require 144 TCF and bc_dbase files:
:*6 x Event Magnitude: 01%, 2%, 5%, 10%, 20% and 50% Annual Exceedance Probability (AEP)
:*8 x Event Duration: 1, 2, 3, 6, 9, 12, 18 and 24 hour storm
:*3 x Climate Change Planning Horizon: current climate, 2050, 2100
Using predefined naming conventions, with TUFLOW's event management functionality, all the events can be executed from a single TCF and bc_dbase file!

This feature of TUFLOW makes management of the model files easier, ensures consistency between the simulations and improves project quality control by reducing the likelihood of human error associated with incorrect file referencing. 

TUFLOW SWMM Tutorial Module 4 builds from the model created in [[TUFLOW_SWMM_Tutorial_M03|TUFLOW SWMM Tutorial Module 3]]. The completed TUFLOW SWMM Module 3 model is provided in the '''''TUFLOW_SWMM_Module_04\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend completing TUFLOW SWMM Modules 1, 2 and 3 prior to starting this tutorial. 

= Simulation Control Files =
TUFLOW's automated event management operates by introducing wildcard referencing into the boundary condition database. 
A new control file, called the 'TUFLOW Event File' (TEF) is added. It lists all event titles that are applied to the wildcard character in the boundary condition database. It also lists unique commands to associate with the specific events. 
Models are executed using a batch file, with the event specifically listed as a variable in the batch file syntax.

This tutorial example will upgrade our single simulation model to run six event simulations. The simulations will cater for three Annual Exceedance Probability (AEP) event magnitudes: 5%, 2% and 1% AEP. In Average Recurrence Interval (ARI) terminology, this translates to the 1 in 20, 50 and 100 year ARI events. These three design events will be simulated for two event storm durations: 1 and 2 hours. 

=== TUFLOW Boundary Condition Database (bc_dbase) ===
The first task when upgrading a model to include Event Management functionality is to decide on a naming convention for the event wildcard characters to be used in the bc_dbase.csv.
*Event Magnitude: '''AEP'''
*Event Duration: '''DUR'''
Update the bc_dbase with event magnitude and event duration wildcard characters.
<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_04\Tutorial_Data''' folder. Copy and paste the following files to the '''TUFLOW_SWMM_Module_04\TUFLOW\bc_dbase''' folder. These files contain the inflows and rainfall for each event magnitude and duration.
:*'''TS04_inflow_05p1hr.csv'''
:*'''TS04_inflow_05p2hr.csv'''
:*'''TS04_inflow_02p1hr.csv'''
:*'''TS04_inflow_02p2hr.csv'''
:*'''TS04_inflow_01p1hr.csv'''
:*'''TS04_inflow_01p2hr.csv'''
:*'''TS04_rainfall_05p1hr.csv'''
:*'''TS04_rainfall_05p2hr.csv'''
:*'''TS04_rainfall_02p1hr.csv'''
:*'''TS04_rainfall_02p2hr.csv'''
:*'''TS04_rainfall_01p1hr.csv'''
:*'''TS04_rainfall_01p2hr.csv''' 
The files with 'inflow' in their name are flow hydrograph boundary conditions sourced from an external hydrology model, such as HEC-HMS, RORB, URBS, WBNM etc. 
The files with 'rainfall' in their name are rainfall depth hyetographs used to define rainfall timeseries in the SWMM urban hydrology section of the model.

<li>Save a copy of the '''bc_dbase_TS03_001.csv''' as '''bc_dbase_TS04_001.csv'''.
<li>Open the file and make the following updates to the 'Source' column. The 'AEP' and 'DUR' wildcards must be between the special character '~' to function as a variable. Note, columns E to I are to remain blank. The final '''bc_dbase_TS04_001.csv''' should look like this: 
 
[[File:SWMM_M04_event_bcdbase_01a.png]] 
 
<li>Save '''bc_dbase_TS04_001.csv'''.
 
{{Video|name=Animation_TS4_Sim_Control_01b.mp4|width=1236}}
 
</ol>

=== TUFLOW Event File (TEF) ===
<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_04\Tutorial_Data''' folder. Copy the '''TS04_Event_File.tef''' to the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Open the TEF in a Text Editor (Notepad++ is recommended). There are three event magnitudes and two event durations listed:
:*Event Magnitudes: 5% , 2% and 1% AEP
:*Event Durations: 1hr and 2hrs
<li>The event specific commands are contained between the <tt>Define Event</tt> and <tt>End Define</tt> commands.
<li>The <tt>BC Event Source</tt> command is linked to the bc_dbase file ('''bc_dbase_TS04_001.csv'''). In the below examples, any occurrence of '~AEP~' in '''bc_dbase_TS04_001.csv''' will be replaced with '05p' and any occurrence of '~DUR~' in '''bc_dbase_TS04_001.csv''' will be replaced with '1hr'. Also, when the 1 hour event is called the simulation, the end time will be set to 2 hours (instead of 3 hours, as per the other simulations). 
<tt>! EVENT MAGNITUDES</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>05p</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~AEP~ | 05p</tt>
</ol><tt>End Define</tt> 
<tt>! EVENT DURATIONS</tt> 
<tt>Define Event</tt> <tt> == </tt> <tt>1hr</tt>
<ol><tt> BC Event Source </tt> <tt>==</tt> <tt> ~DUR~ | 1hr</tt> 
<tt> End Time </tt> <tt>==</tt> <tt> 2</tt>
</ol><tt>End Define</tt>
<li> When TUFLOW runs a simulation, it reads all of the defined events in the TEF, though only uses the event variables specified in the batch file. We will create a compatible batch file shortly.
 
{{Video|name=Animation_TS4_Sim_Control_02c.mp4|width=1236}}
 
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS03_5m_001.tcf''' in a Text Editor (Notepad++ is recommended). Save the file as '''TS04_5m_~e1~_~e2~_001.tcf''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Make the following reference update: 
<tt>BC Database </tt> <tt>== </tt> <tt>..\bc_dbase\bc_dbase_TS04_001.csv</tt> <tt> ! Reference the Boundary Conditions Database</tt> 
<li>Add the following commands to reference the TEF at the end of the TCF: 
<tt>! EVENTS</tt> 
<tt>Event File </tt> <tt>== </tt> <tt>TS04_Event_File.tef</tt> <tt> ! Reference the TUFLOW Event File</tt> 
The location of this command in the TCF is important. If there are any commands associated with an event which overwrite other existing commands (such as <tt>End Time</tt> <tt>==</tt>), the TEF file needs to be processed last for it to take precedence over other commands fulfilling the same purpose. Referencing this file in the last line in the TCF ensures this order of operation occurs as intended. 
<li>Save the TCF.
 
{{Video|name=Animation_TS4_Sim_Control_03c.mp4|width=1236}}
 
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_TS03_HPC.bat''' as '''_run_TS04_HPC.bat''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.

<li>Update the batch file to reference the '''TS04_5m_~e1~_~e2~_001.tcf''' and include event switches (-e1, -e2) defining event magnitude and event duration: 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 05p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 02p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 1hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<tt>%run% </tt> <tt> -e1 01p -e2 2hr TS04_5m_~e1~_~e2~_001.tcf </tt> 
<li>Save the batch file and double click it in Windows File Explorer to run the simulation. 
If the model simulation doesn't run, here is a link to some common [[Tutorial_Troubleshooting_QGIS | Trouble Shooting]] advice.
 
{{Video|name=Animation_TS4_Run_Sim_01c.mp4|width=1236}}
 
</ol>

== Troubleshooting ==
Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 

=Advanced Looping Batch File (Optional)=
Looping batch files are a powerful tool to enable high volume simulation management with the least amount syntax, and subsequently manual effort. For example, the following looped batch file executed 1440 simulation using 15 lines of syntax!
 
[[File:SWMM_M04_advanced_looping_batch_01c.png]] 
 

We will convert our sequential formatted batch file to a looped format:
<ol>
<li>Save a copy of '''_run_TS04_HPC.bat''' as '''_run_TS04_HPC_loop.bat''' in the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder.
<li>Add the following commands. Indentation is important in batch files, insert tabs to match the below spacing: 
<tt>echo </tt> <tt>off</tt> 
<tt>set </tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>set </tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait </tt><tt>%exe%</tt><tt> -b</tt> 
 
<tt>set</tt> <tt> AEP</tt><tt>=</tt><tt>05p 02p 01p</tt> 
<tt>set</tt> <tt> DUR</tt><tt>=</tt><tt>1hr 2hr</tt> 
 
<tt>for </tt><tt>%%a</tt><tt> in </tt><tt>(</tt><tt>%AEP%</tt><tt>)</tt><tt> do </tt><tt>(</tt> 
<ol><tt> for </tt><tt>%%b</tt><tt> in </tt><tt>(</tt><tt>%DUR%</tt><tt>)</tt><tt> do </tt><tt>( </tt> 
<ol><ol><tt> echo </tt><tt>Running </tt><tt>%%a %%b </tt> 
<tt> %run% </tt><tt>-e1 </tt><tt>%%a</tt><tt> -e2 </tt><tt>%%b </tt><tt>TS04_5m_~e1~_~e2~_001.tcf</tt> 
</ol></ol>) 
</ol>) 
'''Note:''' The 'AEP' and 'DUR' are user defined batch file variables. Projects may use different variable names. The 'AEP' refers to an event magnitude (Annual Exceedance Probability) and 'DUR' refers to an event duration.

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
If the model simulation doesn't run, here is a link to some common [[Tutorial_Troubleshooting_QGIS | Trouble Shooting]] advice.
 
{{Video|name=Animation_TS4_Run_Sim_02b.mp4|width=1236}}
 
</ol>

= Check and Result Files =
When the TUFLOW models were executed via the batch file, the names of check and result files should have been updated to include the event variables from the simulation. For example:

{| class="wikitable" width="60%" style="text-align:center"
!style="background-color:#005581; font-weight:bold; color:white;"| TCF
!style="background-color:#005581; font-weight:bold; color:white;"| Event 1 (-e1)
!style="background-color:#005581; font-weight:bold; color:white;"| Event 2 (-e2)
!style="background-color:#005581; font-weight:bold; color:white;"| Check and Result filename
|-
|rowspan="6"|TS04_5m_'''~e1~_~e2~'''_001.tcf
| 05p || 1hr || TS04_5m_'''05p_1hr'''_001
|-
| 05p || 2hr || TS04_5m_'''05p_2hr'''_001
|-
| 02p || 1hr || TS04_5m_'''02p_1hr'''_001
|-
| 02p || 2hr || TS04_5m_'''02p_2hr'''_001
|-
| 01p || 1hr || TS04_5m_'''01p_1hr'''_001
|-
| 01p || 2hr || TS04_5m_'''01p_2hr'''_001
|}

==Check Sucessful Completion of Multiple Simulations==
Open '''_TUFLOW Simulations.log''' from the '''TUFLOW_SWMM_Module_04\TUFLOW\runs''' folder. Confirm 'Finished' is tagged next to the entry for each of the six simulations we executed. This log confirms the model simulation was completed. 
 
{{Video|name=Animation_TS4_Results_01b.mp4|width=1350}}
 

==Viewing Multiple Simulation Results==
===Load Results===
Open the simulation results in QGIS. When loading multiple simulations which include 1D results (all with the same object IDs), a two step load workflow is recommended to avoid filling the QGIS layer panel with duplicate 1D object entries.
<ol>
<li> Open TUFLOW Viewer from the TUFLOW Plugin toolbar. 
 
[[File:tuflow_plugin_tuflow_viewer.png]] 
 
<li> Open 1D and 2D results: Select File > Load Results. Navigate to the '''TUFLOW\runs''' folder and select '''TS04_5m_~e1~_~e2~_001.tcf'''.
<li> When asked which simulation to load, select '''TS04_5m_01p_1hr_001'''.
<li> When asked 'Do you want to open result GIS layer?', select 'Yes'.
<li> After '''TS04_5m_01p_1hr_001''' has loaded, open the remaining result files:
* Select File > Load Results. Navigate to the '''TUFLOW\runs''' folder and select '''TS04_5m_~e1~_~e2~_001.tcf'''.
* When asked which simulation to load, select all remaining results (except '''TS04_5m_01p_1hr_001''').
* When asked 'Do you want to open result GIS layer?', select 'No'. The results will still be loaded, though will all be associated with the GIS objects loaded for the '''TS04_5m_01p_1hr_001''' simulation.
<li> In the QGIS Layers Panel, move the GIS vector (line and point) layers to the top of the list. This will ensure these layers are displayed above all mesh result layers in the project.
 
{{Video|name=Animation_TS4_Results_02c.mp4|width=1350}}
 
</ol>

===Mesh Results (Map Output)===
Inspect the results for all events.
<ol>
<li>Zoom in to the pipe network area.
<li>Click on the scalar dataset 'Depth' under the 'Result Type' in the TUFLOW Viewer 'Map Outputs' list. Toggle on the maximum depth output by clicking the [[File: max_output_icon.png]] symbol.
<li>Click through the results in the 'Open Results' list to observe the different max depth values.
 
{{Video|name=Animation_TS4_Results_03c.mp4|width=1350}}
 
</ol>

===Vector Results (Pipe Network Output)===
<ol>
<li>In the QGIS Layers Panel, right click '''TS04_5m_01p_1hr_001_swmm_ts_L''', and select 'Show Labels'.
<li>Use the 'Select Features' tool to highlight 'Pipe 3'.
<li>In the 'Open Results' list, select all 1hr duration event results (hold Ctrl to select multiple).
<li>Click on a scalar dataset 'Flow' under the 'Result Type' in the TUFLOW Viewer 'Time Series' list.
<li>Try multiple combinations of the simulation results to observe how the different events impacted flow through 'Pipe 3'.
<li>Click the 'Refresh Current Plot' [[File: Refreshplotblack.png || 20px]] button to update the plot window after making new selections.
<li>Click the 'Clear Current Plot' [[File: QGIS_Plugin_Icon_ClearPlot.png || 20px]] button to remove all data from the plot window if needed prior to making a new selection.
 
{{Video|name=Animation_TS4_Results_04c.mp4|width=1350}}
 
</ol>

= Conclusion =
*Automated Event Management functionality was added to the TUFLOW SWMM model.
*Multiple event simulations were run in sequence from a batch file.
*Creation of looped batch file was demonstrated for the efficient execution of bulk simulations.
*Multiple event simulation results were inspected using the QGIS TUFLOW Viewer.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M03

2025-10-23T06:17:52Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
This tutorial, Module 3 of the TUFLOW-SWMM tutorial dataset, demonstrates how to add SWMM urban hydrology to a 1D SWMM stormwater pipe network / 2D TUFLOW HPC catchment model. TUFLOW-SWMM Tutorial Module 3 builds from the model created in [[TUFLOW_SWMM_Tutorial_M02|TUFLOW SWMM Tutorial Module 2]]. The completed TUFLOW-SWMM Module 2 model is provided in the '''''TUFLOW_SWMM_Module_03\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW-SWMM linking, we recommend completing TUFLOW-SWMM Modules 1 and 2 prior to starting this tutorial. 

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder and select '''TS02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 
Style the TUFLOW layers. Suggested styling steps were provided in [[TUFLOW_SWMM_Tutorial_M01#Load_and_Style_TUFLOW_Model_Files|TUFLOW SWMM Tutorial M01]]. They have not been duplicated here. 
 

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_03''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS3_Configure_Project_01a.png]] 
</ol>
 

=== Increment TUFLOW GeoPackage File ===
We will now save a copy of '''TS02_001.gpkg''' with a new name, '''TS03_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS03_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS03_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_03\TUFLOW\model\gis''' folder.
 
{{Video|name=Animation_TS3_Initialization_02b.mp4|width=1236}}
 
</ol>

=== Increment SWMM GeoPackage File ===
SWMM pipe network junction attributes need to be updated when converting a TUFLOW 2D direct rainfall / SWMM 1D model ([[TUFLOW_SWMM_Tutorial_M02|TUFLOW SWMM Tutorial Module 2]]). into a format that uses SWMM hydrology instead of direct rainfall. Similar to above (incrementing the TUFLOW GeoPackage file), we will increment the SWMM pipe network database name so we do not alter the inputs necessary for '''TS02_5m_001.tcf''' to function without issue.
<ol>
<li> In the QGIS Layers Panel, open the '''TS02_001.tscf''' group. In the '''sw02_001.inp''' group, right click '''Links--Conduits'''.
<li> Select TUFLOW > SWMM - Increment GeoPackage. This opens the dialog shown below.
:*Output File: Click the '...'. This will automatically open to the '''TUFLOW\model\swmm''' folder. Set the output database name to '''sw03_001.gpkg''' and click 'Save'.
:*Existing GeoPackage Layers: 'Unload -- do not move'.
<li> Select 'OK'.
<li> The tool will automatically load '''sw03_001.gpkg''' into the QGIS workspace and remove '''sw02_001.inp''' from the QGIS workspace.
<li> In the QGIS Layers Panel, move '''sw03_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
 
{{Video|name=Animation_TS3_Initialization_03b.mp4|width=1236}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_03''' folder and type '''SWMM_M03''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Update SWMM GeoPackage Spatial Database==
In previous tutorials we have created new SWMM GeoPackage databases for our new entries. This tutorial will demonstrate a different update approach. Instead of creating a new SWMM GeoPackage database, we will update the existing database, '''sw03_001.gpkg''' by adding new SWMM Sections for the hydrology elements we will be incorporating into the model in this tutorial.

<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Add_Sections |GeoPackage - Add sections]]'. This opens the dialog shown below.
:*GPKG filename modify: Click the ... and navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\model\swmm''' folder. Select '''sw03_001.gpkg'''.
:*CRS for GeoPackage: Click the drop down menu and select 'Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S'.
:*SWMM Sections to add: Click the ..., and tick on:
::*'''Hydrology--Raingages'''
::*'''Hydrology--Subcatchments'''
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
 
{{Video|name=Animation_TS3_SWMM_Inputs_01b.mp4|width=1236}}
 
</ol>

The above steps have added the new sections to the SWMM GeoPackage database, '''sw03_001.gpkg'''. However, the new sections are not currently displayed in the QGIS Layers Panel. We need to close the database and reopen it to view the changes.
<ol>
<li>In the QGIS Layers Panel, right click '''sw03_001''' and select 'Remove Group...'.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw03_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw03_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw03_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project when we are making edits.
<li>In the QGIS Layers Panel, within the '''sw03_001''' group, move '''Hydrology--Subcatchments''' to the bottom. This will ensure that the other data within this database can be seen.
 
{{Video|name=Animation_TS3_SWMM_Inputs_02b.mp4|width=1236}}
 
</ol>

== SWMM GIS Data Entry ==

A GeoPackage called '''Urban_Hydrology.gpkg''' is provided in the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. It contains one SWMM input layer and one TUFLOW input layer:
:*'''SWMM_Subcatchments''': defines the 1D SWMM urban hydrology subcatchment delineation and associated parameters.
:*'''TUFLOW_Subcatchments''': defines the remaining 2D TUFLOW catchment hydrology subcatchment delineation. 

To populate the SWMM GeoPackage created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. Drag and drop the '''Urban_Hydrology.gpkg''' into QGIS.
<li>When prompted by QGIS select '''SWMM_Subcatchments'''. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Subcatchments''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''SWMM_Subcatchments'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw03_001 >> Hydrology--Subcatchments''' layer.
<li>Make the '''sw03_001 >> Hydrology--Subcatchments''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
<li>Remove '''Urban_Hydrology''' from the QGIS Layers Panel.
 
{{Video|name=Animation_TS3_SWMM_Inputs_03b.mp4|width=1236}}
 

</ol>

==SWMM GIS Data Updates==
The following updates are being made to the objects and layers within '''sw03_001.gpkg'''.

===Update SWMM Hydrology Raingages===
The text information within '''Hydrology--Raingages''' defines the pluviographs in the catchment. We will link to two different rain gages in this example. 
'''Note:''' 'Gage' is the American spelling of 'Gauge' in Oxford English.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Hydrology--Raingages''' and toggle on editing.
<li>Right click '''Hydrology--Raingages''' and select 'Open Attribute Table'.
<li>Click 'Add Feature' twice. Enter the following attributes (leave all other fields as ''NULL''):
{| class="wikitable" width="60%"
!style="background-color:#005581; font-weight:bold; color:white;"| Name
!style="background-color:#005581; font-weight:bold; color:white;"| Form
!style="background-color:#005581; font-weight:bold; color:white;"| Intevl
!style="background-color:#005581; font-weight:bold; color:white;"| SnowCatchDeficiency
!style="background-color:#005581; font-weight:bold; color:white;"| Format
!style="background-color:#005581; font-weight:bold; color:white;"| Tseries
|-
| RF_G1 || Volume || 0.1 || 1 || TIMESERIES || RF_FC04
|-
| RF_G2 || Volume || 0.1 || 1 || TIMESERIES || RF_FC07
|}
For a summary of the attributes associated with '''Hydrology--Raingages''', refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Raingages TUFLOW 2023-03-AD Release Notes (Table A.11)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]. 
Note, the spatial locations where the gage information is applied is covered in the following section.
<li> Turn off editing and save the information.
 
{{Video|name=Animation_TS3_SWMM_Inputs_04b.mp4|width=1236}}
 
</ol>

===Update SWMM Hydrology Subcatchments===
The information within '''Hydrology--Subcatchments''' defines the subcatchment parameters (including catchment area, width, slope, percent impervious, outlet specification and infiltration details). All required data entries have been pre-filled in the supplied dataset except the 'Area' information, which we will determine using QGIS. SWMM requires the hydrology subcatchment area information in hectares.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Hydrology--Subcatchments''' and toggle on editing.
<li>Right click '''Hydrology--Subcatchments''' and select 'Open Attribute Table'.
<li>Choose 'Area' as the target field and type the calculation expression, 'area($geometry) / 10000'.
:* 'area($geometry) ': Extracts the area of each region (subcatchment) in '''Hydrology--Subcatchments'''.
:* '/ 10000': Converts the area values into hectares. 
'''Note:''' The projection used in these tutorials is measured in meters. Thus, when QGIS extracts the area from a region, it reports the area in m2. If using a projection that is measured in feet, QGIS would extract the area in ft2.
<li>Click 'Update All'.
<li>Turn off editing and save the information.
<li>Inspect the attribute information within '''Hydrology--Subcatchments''' to familiarize yourself with the data. A few demonstration features have been included in the dataset.
:*Two rainfall gages are linked to the subcatchments. Downstream subcatchments linked to rain gage 'RF_G1'. Upstream subcatchments are linked to rain gage 'RF_G2'.
:*Subcatchments 'SPit11A' and 'SPit11A' are being routed to subcatchment 'SPit11C' before entering the SWMM pipe network. All other hydrology subcatchments route directly to a SWMM '''Node--Junctions'''. 
For a summary of the attributes associated with the layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Subcatchments TUFLOW 2023-03-AD Release Notes (Table A.38)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)].
 
{{Video|name=Animation_TS3_SWMM_Inputs_05b.mp4|width=1236}}
 
</ol>

===SWMM Options===
SWMM '''Project--Options''' defines the SWMM simulation controls, such as hydrology computation timestep. '''Project--Options''' are not required in the new GeoPackage database we are creating for this Tutorial. This is because this model will be constructed from multiple SWMM input (INP) files:
:*'''sw01_001.inp''' (road culverts).
:*'''sw03_001.inp''' (underground pipe network inputs and SWMM hydrology).
When TUFLOW processes SWMM inputs, it combines the multiple INP files into one single INP prior to simulation. For this model, the simulation control parameters defined in Module 1 ('''sw01_001 > Project--Options''') will apply. The options relevant to this tutorial that have already been defined in the Module 1 input include:
:*'''flow_units''': set to metric.
:*'''infiltration''' method: set to Green Ampt.
We need to change the SWMM hydrology timestep details. Updating this setting in the '''sw01_001.inp''' does not impact any of the previous tutorial modules, as they did not include any hydrology components.
<ol>
<li>In the QGIS Layers Panel, open the '''TS02_001.tscf''' group and select (left click) '''sw01_001 >> Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following hydrology timestep options:
:*WET_STEP: 00:01:00
:*DRY_STEP: 00:01:00
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS3_SWMM_Inputs_06b.mp4|width=1236}}
 
</ol>

== Export SWMM INP File ==
We will now create a new INP file for the pipe network and SWMM urban hydrology inputs and update '''sw01_001.inp''' to reflect the changes made to the hydrology options above.

<ol>
<li>In the QGIS Layers Panel, right click '''Hydrology--Subcatchments''' (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, update the 'GeoPackage Input File' parameter. Click '...', and navigate to the '''TUFLOW\model\gis''' folder. Select '''sw01_001.gpkg'''.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp files in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw03_001.inp''' and '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS3_SWMM_Inputs_07b.mp4|width=1236}}
 
</ol>

==TUFLOW GIS Updates==
We will be reverting the TUFLOW model back to a configuration that uses inflows from an external hydrology model (as per Module 1), instead of 2D direct rainfall (Module 2), in the areas not covered by SWMM urban hydrology. Instead of reusing the input from Module 1, we will need to use a new TUFLOW source area inflow layer. This will ensure that we do not double count the flow generated over the area now represented by SWMM.

<ol>
<li>Click on the ‘Import Empty File’ symbol from the TUFLOW plugin toolbar. 
[[File:tuflow_plugin_import_empty_file.png]] 
 
<li>Select '2d_sa' from the Empty Type list.
<li>In the Run ID box write 'TS03_001'.
<li>Tick the 'Regions' Geometry Type.
<li>In the Spatial Database Options, select 'All to one'. Navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\model\gis''' folder and select '''TS03_001.gpkg'''. Click Save and hit 'OK'.
<li>The '''2d_sa_TS03_001_R''' appears in the QGIS Layers Panel. 
 
[[File:TS3_import_empty_2d_sa_01a.png]] 
 
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. Drag and drop the '''Urban_Hydrology.gpkg''' into QGIS.
<li>When prompted by QGIS, select '''TUFLOW_Subcatchments'''. Click 'Add Layers'.
<li>In the QGIS Layers Panel, select (left click) the '''TUFLOW_Subcatchments''' layer.
<li>Use the 'Select Features' tool to highlight the four regions included in '''TUFLOW_Subcatchments'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''2d_sa_TS03_001_R''' layer.
<li>Make the '''2d_sa_TS03_001_R''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Hydrology.gpkg'''. 
The polygon entry we have updated refers to a new subcatchment name for the region adjacent to the SWMM subcatchments. The new name is 'FC06.62', instead of 'FC06'. When we update the TUFLOW Control files we will configure the file references so we are sourcing data from a new flow file obtained from an external hydrology model that has been updated with the reduced catchment area, in recognition of SWMM being used for the flow estimate in the proposed urban development area. 
'''Note:''' Common hydrology software used in combination with TUFLOW by modelers include: HEC-HMS, RORB, Drains, WBNM, URBS and more.''
 
{{Video|name=Animation_TS3_TUFLOW_Inputs_01b.mp4|width=1236}}
 
</ol>

==TUFLOW Boundary Updates==
As a result of the changes made to the TUFLOW inflows, new TUFLOW Boundary Condition csv files are also needed. Updated files have been provided in the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. These files provide the values and model linkages to the new hydrology inflows, which include the 'FC06.62' entry.
<ol>
<li>Copy '''bc_dbase_TS03_001.csv''' and '''TS03_01p2hr.csv''' from the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_03\TUFLOW\bc_dbase''' folder.
 
{{Video|name=Animation_TS3_TUFLOW_Boundary_01b.mp4|width=1236}}
 
</ol>

=Simulation Control Files=
To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.
<ol>
<li>Open '''TS02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended). Save the file as '''TS03_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder.
<li>Using the 'Open File' function in Notepad++:
:*Open '''TS02_001.tbc,''' and save the file as '''TS03_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS02_001.tscf,''' and save the file as '''TS03_001.tscf''' in the '''TUFLOW\model''' folder.
 
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Edit '''TS03_5m_001.tcf''' by making the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt>..\model\gis\TS03_001.gpkg</tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File</tt> <tt> == </tt> <tt>..\model\TS03_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Condition Control File</tt> 
<tt>BC Database</tt> <tt> == </tt> <tt>..\bc_dbase\bc_dbase_TS03_001.csv</tt> <tt> ! Reference the Boundary Condition Database</tt> 
<tt>SWMM Control File</tt> <tt> == </tt> <tt>..\model\TS03_001.tscf</tt> <tt> ! Reference the SWMM (1D) Control File</tt> 
<li> Add the following command to the '<tt>Time Control</tt>' section. This command is necessary for many TUFLOW-SWMM models, especially when using SWMM hydrology. The 2D timestep dictates the SWMM 1D timestep. Generally, this timestep is adequate for SWMM but in cases where the flows are contained in the 1D, the timestep may become too large for SWMM. This command forces it into the appropriate range. If this command is neglected, some models will experience very high mass errors. The range of timesteps used is reported in the SWMM .rpt file ('''TS03_5m_001_swmm.rpt''') in the '''TUFLOW\results''' folder. 
<tt>Timestep Maximum </tt> <tt>== </tt> <tt>3</tt> <tt> ! Specifies a maximum timestep of 3 seconds</tt> 
<li> Comment out the 'Map Cuttoff Depth' command by placing a '!' at the beginning of the line. This command is only necessary for 2D direct rainfall (rain on grid) modelling (SWMM Tutorial 2). 
<tt>! Map Cutoff Depth == 0.05</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_01b.mp4|width=1236}}
 
</ol>

===TUFLOW Boundary Control File (TBC)===
<ol>
<li>Edit '''TS03_001.tbc'''.
<li>Comment out the 'Global Rainfall BC' command by placing a '!' at the beginning of the line. This command is only necessary for 2D direct rainfall (rain on grid) modelling (SWMM Tutorial 2). 
<tt>! Global Rainfall BC == RF_FC04</tt>
 
<li>Add the following additional command: 
<tt>Read GIS SA</tt><tt> == </tt><tt>2d_sa_TS03_001_R </tt><tt>! Reads in 2D source area - Excluding SWMM areas</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_02c.mp4|width=1236}}
 
</ol>

===TUFLOW SWMM Control File (TSCF)===
<ol>
<li>Edit '''TS03_001.tscf'''.
<li>Replace <tt>Read SWMM</tt><tt> == </tt><tt>swmm\sw02_001.inp</tt> with the following command: 
<tt>Read SWMM</tt><tt> == </tt><tt>swmm\sw03_001.inp</tt> 
<li>As we are pushing flows from the subcatchments straight to the pipe network, the water level of the ponded water at the nodes can become much higher than the 2D water levels. The inlet will surcharge but the flow is throttled. The following command will pull water out of the 2D if the 1D ponded water level goes beyond 0.1 m higher than the 2D (not needed for rain on grid simulations). Add the following command: 
<tt>Maximum Inlet Ponded Depth</tt><tt> == </tt><tt>0.1 </tt><tt>! Pull ponded water out of the 1D domain as needed</tt> 
<li>Add the following command: 
<tt>Read BC Timeseries</tt><tt> == </tt><tt>RF_FC04 | RF_FC07 </tt><tt>! TUFLOW BC Database / SWMM Rain Gage Linkage</tt> 
 
{{Video|name=Animation_TS3_Sim_Control_03c.mp4|width=1236}}
 
</ol>

=Running the Simulation=
<ol>
<li>Save a copy of '''_run_TS02_HPC.bat''' as '''_run_TS03_HPC.bat''' in the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS03_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS03_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation. 
<li>Did your TUFLOW-SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 
 
{{Video|name=Animation_TS3_Run_Sim_01c.mp4|width=1236}} 
</ol>

= Check Files =
Review the SWMM INP and simulation report file from the '''TUFLOW_SWMM_Module_03\TUFLOW\results''' folder to confirm the new hydrology inputs are being processed correctly:
* View '''TS03_5m_001_swmm.inp''' in a text editor to confirm the combining of the two input INP files has occurred correctly. Also use the QGIS Processing tool, [[QGIS_SWMM_GeoPackage_Create_from_SWMM_inp |GeoPackage - Create from SWMM inp ]], to view the information in QGIS.
* View '''TS03_5m_001_swmm_curves.inp''' in a text editor to confirm the rainfall time series that has been used by the SWMM hydrology engine matches the input dataset.
* View '''TS03_5m_001_swmm.rpt''' in a text editor to confirm the model computation is healthy in term of mass conservation.

= Results Output =
Complete the steps outlined in following link to review the simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M03_Results_QGIS | TUFLOW SWMM Tutorial 03 Results]] 

= Conclusion =
*EPA SWMM urban hydrology was added to the model (replacing 2D drect rainfall / rain-on-grid).
*The 1D SWMM pipe urban pipe network junction attributes were updated to accomodate for the change in model configuration, from 2D direct rainfall to 1D SWMM hydrology.
*Check and result files associated with the SWMM hydrology modelling were inspected.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.
 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M01

2025-10-23T06:17:14Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, three culverts are added to represent flow through three separate road embankments. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. 

TUFLOW SWMM Tutorial Module 1 builds from the model created in [[Tutorial_M02 |TUFLOW Tutorial Module 2]] (in the TUFLOW Only tutorial dataset). The completed TUFLOW Module 2 model is provided in the '''''TUFLOW_SWMM_Module_01\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the [[Tutorial_Introduction | "TUFLOW Only" Tutorials]] to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW. 

= Project Initialization =
Three steps are required for the project initialization:
<ol>
<li> Setting the QGIS Project Coordinate Reference System (CRS).
<li> Configuring the QGIS TUFLOW Plugin.
<li> Establishing the new TUFLOW model GeoPackage file that will include new GIS inputs associated with this model update.
</ol>

== QGIS ==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Firstly, define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load and Style the GIS layers from the TUFLOW model:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and select '''M02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 

Style the TUFLOW layers however you desire. Common steps to do this are:
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
 
[[File:tuflow_plugin_styles_open_layers.png]] 
 
<li>Change the symbology of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Singleband pseudocolor
:*Color ramp: Spectral
:*Color ramp: Invert Color Ramp
:*Mode: Equal Interval
*From the Transparency tab, set the Global Opacity to 75%.
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_03d.mp4|width=1235}} 
<li>Create a hillshade of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Duplicate Layer'.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
*Right click on the '''DEM_Hillshade''' and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Hillshade
:*Z Factor: 3
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_04b.mp4|width=1235}} 
</ol>

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_01''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS1_Configure_Project_01a.png]] 
</ol>
 

=== Increment Model GeoPackage File ===
We will now save a copy of '''M02_001.gpkg''' with a new name, '''TS01_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS01_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS01_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_01\TUFLOW\model\gis''' folder. 
 
{{Video|name=Animation_TS1_Initialization_05c.mp4|width=1235}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_01''' folder and type '''SWMM_M01''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
Create a new folder in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder called '''swmm'''. This is the location where all SWMM inputs will be saved. 
 
In QGIS, create the SWMM GeoPackage Database:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click …, and tick on (if not already ticked):
::*'''Project--Title''', '''Project--Options''', '''Project --Report.'''
::*'''Nodes--Junctions''', '''Nodes--Outfalls.''', '''Nodes--Storage.'''
::*'''Links--Conduits, Links--Streets'''.
:*To define the ‘GPKG filename to create’: Click …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage database as '''sw01_001.gpkg'''.

<li>Click ‘Run’.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw01_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw01_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw01_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS1_SWMM_Inputs_01g.mp4|width=1236}}
 
 

== GIS Data Entry ==

A GeoPackage database called '''SWMM_Culverts.gpkg''' is provided in the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. It contains three layers:
:*'''Conduits:''' defines the culvert location, type and geometry.
:*'''Outfalls:''' defines the downstream culvert inverts.
:*'''Storage_nodes:''' defines the upstream culvert inverts.
 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. Drag and drop the '''SWMM_Culverts.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group'. By default, all items in the GeoPackage database will be selected. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Culverts >> Conduits''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Conduits'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw01_001.gpkg >> Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits. 
 
{{Video|name=Animation_TS1_SWMM_Inputs_02f.mp4|width=1236}}
 
<li>Similarly, copy the objects from '''Storage_nodes''' into '''Nodes--Storage'''. Junctions and storage nodes are allowed at the upstream end of culverts. Storage nodes are preferred for culverts receiving 2D flows not through a storm drain inlet.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
<li> Toggle off editing and save the edits.
<li>Remove '''SWMM_Culverts.gpkg'''.
 
{{Video|name=Animation_TS1_SWMM_Inputs_03f.mp4|width=1236}}
 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS1_SWMM_Inputs_04f.mp4|width=1236}}
</ol>
 

== GIS Data Updates ==
The provided GIS data requires numerous updates before proceeding to a model simulation. We have intentionally built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model build processing tools. The following updates are being made to objects and layers within '''sw01_001.gpkg'''.
===Update Conduit Details===
==== Node Details ====
Stage 1 of building the 1D SWMM network involves updating the 'From Node' and 'To Node' attribute information in '''Links--Conduits'''. This information defines the Link/Node connections. 
The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Storage''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
:*SWMM Node Layers: Tick on '''sw01_001 >> Nodes--Storage''' and '''sw01_001 >> Nodes--Outfalls'''. Click 'OK'.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
 
'''Tip 1:''' If you wish to only update a selection of objects, instead of selecting the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.' 
'''Tip 2:''' Unique Node ID's are required for the SWMM network to function error free. If you are following this workflow for a project model build, please ensure the '''Nodes--Storage''' and '''Nodes--Outfalls''' object ID information is unique. If duplicate ID values are assigned to multiple objects, consider using the '[[QGIS_SWMM_Integrity_Make_Object_Names_Unique |Integrity - Make object names unique ]]' TUFLOW SWMM processing tool to ensure all ID values are unique before using '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_05g.mp4|width=1236}}
 

</ol>

====Update Losses====
Stage 2 involves updating the loss attributes in the '''Links--Conduits''' layer. In this example, default loss values are used and will be entered manually. These loss values can be adjusted in your project models to reflect site specific information if desired.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>Right click '''Links--Conduits''' and select 'Open Attribute Table'.
<li>For each conduit, update the following fields:
:*losses_Kentry: 0.5
:*losses_Kexit: 1.0
:*losses_Kavg: 0.0
The video below demonstrates how to do this one entry at a time, or via the bulk attribute update options in QGIS.
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS1_SWMM_Inputs_06f.mp4|width=1236}}
</ol>
 

Since all the 1D SWMM inputs in this model are embankment culverts that all use the same loss parameters, it's not necessary to specify different loss attributes. The [[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] will demonstrate an urban pipe network added to the model, with different loss attributes required for the road culverts and underground storm pipe network links. To simplify this step, Module 2 uses the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' processing tool.
 
 

=== Create 1D/2D Connections===
The following instructions introduce a new tool that automates the creation of 1D/2D connections. Due to the limitations of SWMM boundary conditions, HX lines are required for the upstream end of the culvert (rather than SX), and SX connections are used at the downstream end of the culvert. 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below. 
'''Note:''' Ensure the 'Edit Features In-Place' tool has been turned off.
:*Input Conduits Layer: '''Links--Conduits'''
:*Create connections at: 'Both ends'.
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS01_001.gpkg'''. Click Save.
::<li>A dialog will open. In the Layer name field, write '''2d_bc_SWMM_Culvert_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Culvert_Connections_001_L''' appears in the QGIS Layers Panel. Select 'Apply TUFLOW Styles to Current Layer'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_07f.mp4|width=1236}}
</ol>
 
'''Note:''' The positions of the HX and SX connections may not be in the optimum location or extent using the generalized automated tool. As such, it is recommended to check the output from this processing step. In this module, the 1D/2D connections associated with '''2d_bc_SWMM_Culvert_Connections_001_L''' are checked in [[TUFLOW SWMM Tutorial M01 Check QGIS|TUFLOW SWMM Tutorial 01 Check Files]].
 
 

===Update Storage Node Details===
The attributes of the storage nodes need to be modified to represent the storage of the connected HX cells since these cells do not represent storage themselves. The area associated with the storage nodes should be similar to the areas of the HX cells. To set the area, we will use a "PYRAMIDAL" shape with the SWMM side slope (run/rise) (Z) set to 0 to represent vertical walls. As the cell size is 5m, and the length of each polyline is 10m, the length (L) will be set to 10m and the width (W) to 5m. These sizes will be modified later when we change the boundary conditions.

<ol>
<li> In the QGIS Layers Panel, select (left click) '''Nodes--Storage''' and toggle on editing.
<li> Right click '''Nodes--Storage''' and select 'Open Attribute Table'.
<li> Set the following attributes:
:* YMax: 50.0 (this is a value greater than the expected water level. It is required to allow water to fill node)
:* TYPE: 'PYRAMIDAL'
:* L: 10
:* W: 5
:* Z: 0.0
<li> Turn off editing to save the edits.

 
{{Video|name=Animation_TS1_SWMM_Inputs_08g.mp4|width=1236}}
 
</ol>

==SWMM Options==
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following options:
*'''START_DATE''': 2020-01-01 (Date Format: YYYY-MM-DD)
*'''REPORT_STEP''': 00:01:00
<li>Turn off editing to save the edits.
</ol>

{{Video|name=Animation_TS1_SWMM_Inputs_09f.mp4|width=1236}}
 Save the QGIS Project Workspace:

# Go to Project > Save. This will update '''SWMM_M01.qgz''', which was created previously in the folder '''TUFLOW_SWMM_Module_01'''. 

== Export SWMM INP File ==
SWMM is not able to read the '''sw01_001.gpkg''' database directly, therefore, we need to convert the GeoPackage file to a SWMM INP file format.

<ol>
<li>In the QGIS Layers Panel, right click '''Links--Conduits''' (or any of the SWMM layers) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS1_SWMM_Inputs_10e.mp4|width=1236}}
</ol> 

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, 'TS' is used as the file prefix in this series of tutorials. To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps. 

Set up the simulation control files:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and open '''M02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended).
<li>Save the file as '''TS01_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Open '''M01_001.tbc''' using the 'Open File' function in Notepad++. Save the file as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Create a new blank text file called '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS1_Sim_Control_00a.mp4|width=1235}} 
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is recommended) and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt> ..\model\gis\TS01_001.gpkg </tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS01_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Conditions Control File</tt>
<li>Add the following line in the '<tt>Model Inputs</tt>' section: 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS01_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt>
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>NetCDF Output Start Date </tt> <tt>== </tt> <tt>2020-01-01 00:00 </tt> <tt>! Sets the output units for the NetCDF time variable</tt>
<li>Save the TCF.
 
{{Video|name=Animation_TS1_Sim_Control_01c.mp4|width=1235}} 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tbc''' and select 'Open File'. This opens '''TS01_001.tbc''' into a new tab in Notepad ++.
<li>Add the following command line after '<tt>Read GIS SA </tt> <tt>== </tt> <tt>2d_sa_M01_001_R</tt>': 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Culvert_Connections_001_L</tt> <tt> ! Links 1D SWMM culverts to the 2D TUFLOW domain</tt>
<li>Save the TBC.
 
{{Video|name=Animation_TS1_Sim_Control_02c.mp4|width=1235}} 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is used to control the SWMM input data. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File. 
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tscf''' and select 'Open File'. This opens '''TS01_001.tscf''' into a new tab in Notepad ++.
<li>Add the following command: 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt> <tt> ! 1D SWMM culvert input file</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS1_Sim_Control_03c.mp4|width=1235}} 
</ol>
 

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS01_HPC.bat''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS01_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS01_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
 
If the model simulation doesn't run:
<ol>
<li> Check in the screen output or the tlf file near the end for "For SWMM Model Errors see:". This indicates that there is something wrong with the SWMM inputs. Reviewing that file will provide feedback on what is wrong.
<li> Review this link for common [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]] advice.
</ol>
 
{{Video|name=Animation_TS1_Run_Sim_01d.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M01_Check_QGIS | TUFLOW SWMM Tutorial 01 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M01_Results_QGIS | TUFLOW SWMM Tutorial 01 Results]] 

= Conclusion =
*EPA SWMM culverts were added to convey water through the structures under the three roads in the tutorial model.
*Check files were used to review the inclusion of 1D SWMM culverts to a 2D TUFLOW model.
*Results through the 1D culverts were assessed.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM. 
 

{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M02

2025-10-23T06:16:08Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
This tutorial, Module 2 of the TUFLOW SWMM tutorial dataset will demonstrate how to model underground stormwater pipe networks using SWMM, linked to the TUFLOW HPC 2D solution scheme. Boundary condition inflows to the model are defined using TUFLOW's 2D direct rainfall (rain on grid) approach. TUFLOW SWMM Tutorial Module 2 builds from the model created in [[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]. The completed TUFLOW SWMM Module 1 model is provided in the '''''TUFLOW_SWMM_Module_02\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend completing TUFLOW SWMM Module 1 prior to starting this tutorial. 

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 
Style the TUFLOW layers. Suggested styling steps were provided in [[TUFLOW_SWMM_Tutorial_M01#Project_Initialization|TUFLOW SWMM Tutorial M01]]. They have not been duplicated here. 
 

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_02''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS2_Configure_Project_01a.png]] 
</ol>
 

=== Increment TUFLOW GeoPackage File ===
We will now save a copy of '''TS01_001.gpkg''' with a new name, '''TS02_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS02_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS02_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.
 
{{Video|name=Animation_TS2_Initialization_02c.mp4|width=1236}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_02''' folder and type '''SWMM_M02''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
We will create a new SWMM GeoPackage database for our pipe network feature entries:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click the …, and tick on (if not already ticked):
::*'''Nodes--Junctions''', '''Nodes--Outfalls.'''
::*'''Links--Conduits, Links--Streets.'''
::*'''Inlets--Inlets.'''
:*To define the ‘GPKG filename to create’: Click the …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage Database as '''sw02_001.gpkg'''.
::'''Note:''' In Module 1 we also included '''Nodes--Storage''', '''Project--Title''', '''Project--Options''', and '''Project--Report''' in the GeoPackage file. '''Project--Options''' is not required this time as this tutorial model will use two SWMM INP files. The file created during Module 1 (for the road culverts) and the INP is to be created from this GeoPackage (for the underground pipe network inputs). When TUFLOW processes SWMM inputs, it combines the multiple INP files into one before simulation. As such, the details from the Module 1 '''Project--Options''' input will be used in this tutorial. If '''Project--Options''' are included in multiple Geopackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control file (TSCF) will be used. '''Nodes--Storage''' will not be used in this tutorial, as these are only needed to represent detention, or for nodes connected using HX boundaries.
<li>Click 'Run'.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw02_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw02_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw02_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS2_SWMM_Inputs_01e.mp4|width=1236}}

 

== GIS Data Entry ==

A GeoPackage called '''Urban_Development.gpkg''' is provided in the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. It contains three SWMM input layers (and five other geometry input layers to be used later in the module):
:*'''Pipes''': defines the underground pipe network location, type and geometry.
:*'''Junctions''': defines the pipe network inlets.
:*'''Outfalls''': defines the pipe network outlet.

 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. Drag and drop the '''Urban_Development.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select '''Pipes''', '''Junctions''' and '''Outfalls''' (hold Ctrl to select multiple). Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''Pipes''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Pipes'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_02d.mp4|width=1236}} 
<li>Similarly, copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of isolated culverts and all upstream ends of pipes within a network.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of isolated culverts and the most downstream end of a pipe network.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Development.gpkg'''.
 
{{Video|name=Animation_TS2_SWMM_Inputs_03c.mp4|width=1236}} 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS2_SWMM_Inputs_04c.mp4|width=1236}} 
</ol>

== GIS Data Updates ==
The provided GIS data requires numerous updates, prior to our model simulation. We have built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model built processing tools.

The following updates are being made to objects and layers within '''sw02_001.gpkg'''.
===Update SWMM Inlet Usage Layer Details===
An Inlet Usage Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as inlet type, street cross-section reference, surface inlet elevation, placement type (on-sag and on-grade). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''. It includes a variety of on-sag and on-grade inlets. On-sag inlets are used in locations where the inlet is located in an area of minimal longtudial slope. In this situation ponded surface water enters the pipe network. On-grade inlets are used where bypass flow is expected due to the inlet location being on a slope. For on-grade inlets, TUFLOW SWMM captures a percentage of the “approach flow” based on several factors including the total 2D approach flow, velocity and depth. 

<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder and save a copy of '''swmm_iu_TS02_001''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\swmm''' folder. 
<li>Navigate to the '''TUFLOW\model\swmm''' folder. Drag and drop '''swmm_iu_TS02_001''' into the QGIS workspace.
</ol>

When you progress from this tutorial to project modeling, you will need to create an Inlet Usage Layer yourself. The template file for this is available from '''model\gis\empty\swmm_iu_empty.gpkg'''. The file is created during the initial 'Write Empty' step of the model build process (refer to [[Tutorial_M01#Project_Initialisation | TUFLOW Tutorial Model 1]]). A summary of the attributes within the Inlet Usage Layer is documented in [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-TUFLOW-1.html#tab:tab-SWMMinletusage TUFLOW 2023-03-AD Release Notes (Table 4.1)]

The 'Inlet' Attribute within '''swmm_iu_TS02_001''' is an ID reference to inlet geometry and associated information listed within '''sw02_001.gpkg''' >> '''Inlets--Inlets'''. A single inlet type, 'Combo1', was referenced in '''swmm_iu_TS02_001''' (the provided Inlet Usage Layer). In recognition of this, we need to create the entry for 'Combo1' in the '''Inlets--Inlets''' layer.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Inlets--Inlets''' and toggle on editing.
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
:*Name: Combo1
:*Type: COMBINATION
:*Grate_Length: 0.6
:*Grate_Width: 0.3
:*Grate_Type: P_BAR-50
:*Curb_Length: 0.9
:*Curb_Height: 0.15
:*Curb_Throat: VERTICAL
For a summary of the attributes associated with the '''Inlets--Inlets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Inlets TUFLOW 2023-03-AD Release Notes (Table A.16)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_05c.mp4|width=1236}}
 
</ol>

===Update Streets Details===

Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in '''swmm_iu_TS02_001''' (the Inlet Usage Layer) using the 'StreetXSEC' field. 
We will now define this street cross-section type and its attributes.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Streets''' and toggle on editing.
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes:
:*Name: Xsec1
:*Tcrown: 7
:*Hcurb: 0.2
:*Sx: 4
:*nRoad: 0.014
:*a: 0
:*W: 0
:*Sides: 1
:*Tback: 5
:*Sback: 2
:*nBack: 0.016
For a summary of the attributes associated with the '''Links--Streets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Streets TUFLOW 2023-03-AD Release Notes (Table A.24)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_06c.mp4|width=1236}}
 
</ol>

===Update Conduit Details===
====Node Details====

The 'From Node' and 'To Node' attribute information in '''Links---Conduits''' is necessary to build the 1D SWMM network. It defines the link/node connections. The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Junctions''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
<li>Tick on the SWMM Node Layers: '''sw02_001 >> Nodes--Junctions''' and '''sw02_001 >> Nodes--Outfalls'''.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. 
For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
'''Tip:''' In a future modeling project, if you wish to only update selected objects, rather than the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features by Area' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'
 
{{Video|name=Animation_TS2_SWMM_Inputs_07c.mp4|width=1236}}
 
</ol>

====Update Losses====

Update the loss attributes in the '''Links--Conduits''' layer. These values will be entered automatically using the '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, ensure the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]] is still selected.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]'. This opens the dialog shown below.
:*Input inlet usage layers: '''swmm_iu_TS02_001'''.
:*Culvert opening - Entrance loss: 0.5
:*Culvert or pipe network outlet - Exit loss: 1.0
:*Pipe Network (manholes and pit inlets):
:::*Entrance loss: 0.2
:::*Exit loss: 0.4
<li>Select 'Modify All Features'.
<li>After the tool processing has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.
 
{{Video|name=Animation_TS2_SWMM_Inputs_08d.mp4|width=1236}}
 
</ol>

===1D/2D Linking===
The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, '''swmm_iu_TS02_001''', using the 'Conn1D_2D' attribute.
 
<ol>
 
[[File:swmm_iu_TS02_001_attribute_table_Conn1D2D.png]]
 
</ol>
 
To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]' tool will be used to automate this process.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>Use the 'Select Features' tool to select the most downstream object in '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below.
:*Input Conduits Layer: '''Links--Conduits'''
:*Tick on 'Selected features only'
:*Create connections at: 'Downstream end'
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS02_001.gpkg'''. Click 'Save'.
::<li>A dialog will open. In the layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' appears in the QGIS Layers Panel.
<li>Click the 'Apply TUFLOW Styles to Current Layer' symbol from the TUFLOW Plugin toolbar to style the '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' layer.
 
{{Video|name=Animation_TS2_SWMM_Inputs_09e.mp4|width=1236}}
 
</ol>

===Update SWMM Junction Details===

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Nodes--Junctions''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]' processing tool. This opens the dialog shown below.
:*Input Inlet Usage Layers: '''swmm_iu_TS02_001'''
:*Input BC Connection Layers: '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''
:*General Options:
:::*Maximum Depth Option (Ymax): 'Set to 0.0'.
:::*Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
:*Nodes connected to 2D without Inlets:
:::*None - leave defaults
:*Nodes connected to 2D with Inlets:
:::*Maximum depth (Ymax) option: 'Use global option'
:::*Ysur: 0 (ignored because ponding > 0.0)
:::*Area of Ponding (Apond): 5
:*Nodes without 2D Connection:
:::*Surcharge Depth: 50
:::*Area of Ponding (Apond): 0.0

<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly. 
For a summary of the attributes associated with the '''Nodes--Junctions''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Junctions TUFLOW 2023-03-AD Release Notes (Table A.30)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].
 
{{Video|name=Animation_TS2_SWMM_Inputs_10d.mp4|width=1236}}
 
</ol>

==SWMM Options==
The model we are building will use two SWMM INP files.
*'''sw01_001.inp''' was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the '''Project--Options''' necessary to execute the SWMM simulation. '''sw01_001.inp''' has been included in the base model we are using for Module 2. No changes will be made to it.
* We will create a new INP file for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in '''sw01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
'''Note:''' If '''Project--Options''' are included in multiple GeoPackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control File (TSCF) will be used.
 

== Export SWMM INP File ==
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw02_001.gpkg''' into a SWMM INP file.

<ol>
<li>Right click on the '''Links--Conduits''' layer in the '''sw02_001''' group (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw02_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS2_SWMM_Inputs_11e.mp4|width=1236}}
 
</ol>

== TUFLOW Boundary Updates ==
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:
*'''Globally uniform rainfall:''' This method applies temporally varied rainfall uniformly (spatially) over the entire model.
*'''Spatially varying rainfall:''' This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines. 
 
The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to [[Tutorial_M06 |TUFLOW Tutorial Module 6]].
 
<ol>
<li>Copy '''rainfall_stations.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Copy '''bc_dbase_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
</ol>
 
It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided.
<ol>
<li>Copy '''materials_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS2_TUFLOW_Boundary_01a.mp4|width=1235}}
 
</ol>

== TUFLOW Geometry Update ==
We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development. The updates will be consolidated within '''TS02_001.gpkg'''.

Copy the following TUFLOW geometry inputs to GeoPackage '''TS02_001.gpkg''':
<ol>
<li>Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
<li>Within the QGIS Browser Panel, there is a dropdown directory, 'Project Home'. This directory is a shortcut to the location where the QGIS workspace is saved. In this case, it is a shortcut to the '''TUFLOW_SWMM_Module_02''' folder.
<li>In the 'Project Home' directory, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder.
<li>Drag the following layers (hold Ctrl to select multiple) from the '''Urban_Development.gpkg''' and drop them into the '''TS02_001.gpkg''' contained within the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder:
:*'''2d_mat_TS02_Dev_Buildings_001_R'''
:*'''2d_mat_TS02_Dev_Lots_001_R'''
:*'''2d_ztin_TS02_Dev_001_L'''
:*'''2d_ztin_TS02_Dev_001_P'''
:*'''2d_ztin_TS02_Dev_001_R'''
</ol>
'''Note:''' The focus of this tutorial is not to demonstrate 2D geometry updates. If you are interested in learning about the above '''2d_ztin''' and '''2d_mat''' changes, please refer to [[Tutorial_M02 |TUFLOW Tutorial Module 2]].
 
<ol>
{{Video|name=Animation_TS2_TUFLOW_Geometry_01f.mp4|width=1236}}
 
</ol>

= Simulation Control Files =
To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is used here). Save the file as '''TS02_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Using the 'Open File' function in Notepad++:
:*Open '''M02_001.tgc,''' and save the file as '''TS02_001.tgc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tbc,''' and save the file as '''TS02_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tscf,''' and save the file as '''TS02_001.tscf''' in the '''TUFLOW\model''' folder.
 
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Open '''TS02_001.tcf''' and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt>..\model\gis\TS02_001.gpkg</tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>Geometry Control File</tt> <tt>== </tt> <tt>..\model\TS02_001.tgc</tt> <tt> ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS02_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Condition Control File</tt> 
<tt>BC Database </tt> <tt>== </tt> <tt>..\bc_dbase\bc_dbase_TS02_001.csv</tt> <tt> ! Reference the Boundary Condition Database</tt> 
<tt>Read Materials File </tt> <tt>== </tt> <tt>..\model\materials_TS02_001.csv</tt> <tt> ! Reference the Materials Definition File</tt> 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS02_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt> 
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>Map Cutoff Depth </tt> <tt>== </tt> <tt> 0.05 </tt> <tt>! Sets map cutoff depth of 0.05 meters</tt> 
<li> Save the TCF.
 
{{Video|name=Animation_TS2_Sim_Control_01d.mp4|width=1235}}
 
</ol>

=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li>Open '''TS02_001.tgc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command to the the '<tt>Topography</tt>' section below the below the existing '<tt>Read GIS Z Shape</tt>' command: 
<tt>Create TIN Zpts </tt> <tt>== </tt> <tt>2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P</tt> <tt> ! Urban Development Topography TIN</tt> 
<li>Add the following lines in the '<tt>Materials</tt>' section, below the existing material commands : 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Lots_001_R</tt><tt> ! Urban Development Landuse 1</tt> 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Buildings_001_R</tt> <tt> ! Urban Development Landuse 2</tt> 
<li>Save the TGC.
 
{{Video|name=Animation_TS2_Sim_Control_02b.mp4|width=1235}}
 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: 
<tt>! Read GIS SA == 2d_sa_M01_001_R</tt> 
<li>Add the following additional command lines: 
<tt>Global Rainfall BC </tt> <tt>== </tt> <tt>RF_FC04</tt><tt> ! Reads in global rainfall</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt> <tt> ! Links the 1D Pipe Network Outlets to the 2D domain</tt> 
<li>Save the TBC.
 
{{Video|name=Animation_TS2_Sim_Control_03d.mp4|width=1235}}
 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
<ol>
<li>Open '''TS02_001.tscf'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command lines after '<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt>': 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw02_001.inp</tt> <tt> ! 1D SWMM Pipe Network Input File</tt> 
<tt>Read GIS SWMM Inlet Usage </tt> <tt>== </tt> <tt>swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001</tt> <tt> ! 1D SWMM Pipe Network Inlet Usage Layer</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS2_Sim_Control_04b.mp4|width=1235}}
 
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_TS01_HPC.bat''' as '''_run_TS02_HPC.bat''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS02_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS02_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
<li>Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 
 
{{Video|name=Animation_TS2_Run_Sim_01c.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]] 

= Conclusion =
* 1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
* Check files were used to review the 1D SWMM pipe network model features.
* Simulation results in the 1D SWMM pipe network were viewed in time series and long section plot format.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com].
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.

 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M02

2025-10-23T06:15:51Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
This tutorial, Module 2 of the TUFLOW SWMM tutorial dataset will demonstrate how to model underground stormwater pipe networks using SWMM, linked to the TUFLOW HPC 2D solution scheme. Boundary condition inflows to the model are defined using TUFLOW's 2D direct rainfall (rain on grid) approach. TUFLOW SWMM Tutorial Module 2 builds from the model created in [[TUFLOW_SWMM_Tutorial_M01|TUFLOW SWMM Tutorial Module 1]]. The completed TUFLOW SWMM Module 1 model is provided in the '''''TUFLOW_SWMM_Module_02\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend completing TUFLOW SWMM Module 1 prior to starting this tutorial. 

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder and select '''TS01_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 
Style the TUFLOW layers. Suggested styling steps were provided in [[TUFLOW_SWMM_Tutorial_M01#Project_Initialization|TUFLOW SWMM Tutorial M01]]. They have not been duplicated here. 
 

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_02''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS2_Configure_Project_01a.png]] 
</ol>
 

=== Increment TUFLOW GeoPackage File ===
We will now save a copy of '''TS01_001.gpkg''' with a new name, '''TS02_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS02_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS02_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder.
 
{{Video|name=Animation_TS2_Initialization_02c.mp4|width=1236}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_02''' folder and type '''SWMM_M02''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
We will create a new SWMM GeoPackage database for our pipe network feature entries:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click the …, and tick on (if not already ticked):
::*'''Nodes--Junctions''', '''Nodes--Outfalls.'''
::*'''Links--Conduits, Links--Streets.'''
::*'''Inlets--Inlets.'''
:*To define the ‘GPKG filename to create’: Click the …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage Database as '''sw02_001.gpkg'''.
::'''Note:''' In Module 1 we also included '''Nodes--Storage''', '''Project--Title''', '''Project--Options''', and '''Project--Report''' in the GeoPackage file. '''Project--Options''' is not required this time as this tutorial model will use two SWMM INP files. The file created during Module 1 (for the road culverts) and the INP is to be created from this GeoPackage (for the underground pipe network inputs). When TUFLOW processes SWMM inputs, it combines the multiple INP files into one before simulation. As such, the details from the Module 1 '''Project--Options''' input will be used in this tutorial. If '''Project--Options''' are included in multiple Geopackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control file (TSCF) will be used. '''Nodes--Storage''' will not be used in this tutorial, as these are only needed to represent detention, or for nodes connected using HX boundaries.
<li>Click 'Run'.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw02_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw02_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw02_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS2_SWMM_Inputs_01e.mp4|width=1236}}

 

== GIS Data Entry ==

A GeoPackage called '''Urban_Development.gpkg''' is provided in the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. It contains three SWMM input layers (and five other geometry input layers to be used later in the module):
:*'''Pipes''': defines the underground pipe network location, type and geometry.
:*'''Junctions''': defines the pipe network inlets.
:*'''Outfalls''': defines the pipe network outlet.

 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder. Drag and drop the '''Urban_Development.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select '''Pipes''', '''Junctions''' and '''Outfalls''' (hold Ctrl to select multiple). Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''Pipes''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Pipes'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_02d.mp4|width=1236}} 
<li>Similarly, copy the objects from '''Junctions''' into '''Nodes--Junctions'''. Junctions are considered inlets, and should be defined at the upstream end of isolated culverts and all upstream ends of pipes within a network.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of isolated culverts and the most downstream end of a pipe network.
<li>Toggle off editing to save the edits.
<li>Remove '''Urban_Development.gpkg'''.
 
{{Video|name=Animation_TS2_SWMM_Inputs_03c.mp4|width=1236}} 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS2_SWMM_Inputs_04c.mp4|width=1236}} 
</ol>

== GIS Data Updates ==
The provided GIS data requires numerous updates, prior to our model simulation. We have built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model built processing tools.

The following updates are being made to objects and layers within '''sw02_001.gpkg'''.
===Update SWMM Inlet Usage Layer Details===
An Inlet Usage Layer defines the physical location of inlets to the pipe network. It also defines some of the site specific geometry, such as inlet type, street cross-section reference, surface inlet elevation, placement type (on-sag and on-grade). To reduce data entry requirements for this tutorial, a complete Inlet Usage Layer has been provided, '''swmm_iu_TS02_001'''. It includes a variety of on-sag and on-grade inlets. On-sag inlets are used in locations where the inlet is located in an area of minimal longtudial slope. In this situation ponded surface water enters the pipe network. On-grade inlets are used where bypass flow is expected due to the inlet location being on a slope. For on-grade inlets, TUFLOW SWMM captures a percentage of the “approach flow” based on several factors including the total 2D approach flow, velocity and depth. 

<ol>
<li>Navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder and save a copy of '''swmm_iu_TS02_001''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\model\swmm''' folder. 
<li>Navigate to the '''TUFLOW\model\swmm''' folder. Drag and drop '''swmm_iu_TS02_001''' into the QGIS workspace.
</ol>

When you progress from this tutorial to project modeling, you will need to create an Inlet Usage Layer yourself. The template file for this is available from '''model\gis\empty\swmm_iu_empty.gpkg'''. The file is created during the initial 'Write Empty' step of the model build process (refer to [[Tutorial_M01#Project_Initialisation | TUFLOW Tutorial Model 1]]). A summary of the attributes within the Inlet Usage Layer is documented in [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-TUFLOW-1.html#tab:tab-SWMMinletusage TUFLOW 2023-03-AD Release Notes (Table 4.1)]

The 'Inlet' Attribute within '''swmm_iu_TS02_001''' is an ID reference to inlet geometry and associated information listed within '''sw02_001.gpkg''' >> '''Inlets--Inlets'''. A single inlet type, 'Combo1', was referenced in '''swmm_iu_TS02_001''' (the provided Inlet Usage Layer). In recognition of this, we need to create the entry for 'Combo1' in the '''Inlets--Inlets''' layer.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Inlets--Inlets''' and toggle on editing.
<li>Right click '''Inlets--Inlets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes (leave all other fields as ''NULL''):
:*Name: Combo1
:*Type: COMBINATION
:*Grate_Length: 0.6
:*Grate_Width: 0.3
:*Grate_Type: P_BAR-50
:*Curb_Length: 0.9
:*Curb_Height: 0.15
:*Curb_Throat: VERTICAL
For a summary of the attributes associated with the '''Inlets--Inlets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Inlets TUFLOW 2023-03-AD Release Notes (Table A.16)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_05c.mp4|width=1236}}
 
</ol>

===Update Streets Details===

Street cross-section information is needed for SWMM on-grade inlet flow calculations. A single street cross-section type named 'Xsec1', is referenced in '''swmm_iu_TS02_001''' (the Inlet Usage Layer) using the 'StreetXSEC' field. 
We will now define this street cross-section type and its attributes.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Streets''' and toggle on editing.
<li>Right click '''Links--Streets''' and select 'Open Attribute Table'.
<li>Click 'Add Feature'. Enter the following attributes:
:*Name: Xsec1
:*Tcrown: 7
:*Hcurb: 0.2
:*Sx: 4
:*nRoad: 0.014
:*a: 0
:*W: 0
:*Sides: 1
:*Tback: 5
:*Sback: 2
:*nBack: 0.016
For a summary of the attributes associated with the '''Links--Streets''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Streets TUFLOW 2023-03-AD Release Notes (Table A.24)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].

<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS2_SWMM_Inputs_06c.mp4|width=1236}}
 
</ol>

===Update Conduit Details===
====Node Details====

The 'From Node' and 'To Node' attribute information in '''Links---Conduits''' is necessary to build the 1D SWMM network. It defines the link/node connections. The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Junctions''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
<li>Tick on the SWMM Node Layers: '''sw02_001 >> Nodes--Junctions''' and '''sw02_001 >> Nodes--Outfalls'''.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. 
For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
'''Tip:''' In a future modeling project, if you wish to only update selected objects, rather than the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features by Area' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.'
 
{{Video|name=Animation_TS2_SWMM_Inputs_07c.mp4|width=1236}}
 
</ol>

====Update Losses====

Update the loss attributes in the '''Links--Conduits''' layer. These values will be entered automatically using the '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, ensure the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]] is still selected.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Losses |Conduits - Assign losses]]'. This opens the dialog shown below.
:*Input inlet usage layers: '''swmm_iu_TS02_001'''.
:*Culvert opening - Entrance loss: 0.5
:*Culvert or pipe network outlet - Exit loss: 1.0
:*Pipe Network (manholes and pit inlets):
:::*Entrance loss: 0.2
:::*Exit loss: 0.4
<li>Select 'Modify All Features'.
<li>After the tool processing has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'losses_Kentry', 'losses_Kexit' and 'losses_Kavg' attribute information is now configured.
 
{{Video|name=Animation_TS2_SWMM_Inputs_08d.mp4|width=1236}}
 
</ol>

===1D/2D Linking===
The 1D SWMM / 2D TUFLOW linkage locations to connect the pipe network inlets to the surface have been already automatically defined in the SWMM Inlet Usage Layer, '''swmm_iu_TS02_001''', using the 'Conn1D_2D' attribute.
 
<ol>
 
[[File:swmm_iu_TS02_001_attribute_table_Conn1D2D.png]]
 
</ol>
 
To complete the pipe network, 1D/2D linkage is needed at the outlet of the pipe network. The '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]' tool will be used to automate this process.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>Use the 'Select Features' tool to select the most downstream object in '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below.
:*Input Conduits Layer: '''Links--Conduits'''
:*Tick on 'Selected features only'
:*Create connections at: 'Downstream end'
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS02_001.gpkg'''. Click 'Save'.
::<li>A dialog will open. In the layer name box, write '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' appears in the QGIS Layers Panel.
<li>Click the 'Apply TUFLOW Styles to Current Layer' symbol from the TUFLOW Plugin toolbar to style the '''2d_bc_SWMM_Pipe_Network_Connections_001_L''' layer.
 
{{Video|name=Animation_TS2_SWMM_Inputs_09e.mp4|width=1236}}
 
</ol>

===Update SWMM Junction Details===

<ol>
<li>In the QGIS Layers Panel, select (left click) '''Nodes--Junctions''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Junctions_Set_Attributes |Junctions - Set attributes ]]' processing tool. This opens the dialog shown below.
:*Input Inlet Usage Layers: '''swmm_iu_TS02_001'''
:*Input BC Connection Layers: '''2d_bc_SWMM_Pipe_Network_Connections_001_L'''
:*General Options:
:::*Maximum Depth Option (Ymax): 'Set to 0.0'.
:::*Nodes receiving subcatchment flows option (if connected to 2D): 'Based on options selected below'.
:*Nodes connected to 2D without Inlets:
:::*None - leave defaults
:*Nodes connected to 2D with Inlets:
:::*Maximum depth (Ymax) option: 'Use global option'
:::*Ysur: 0 (ignored because ponding > 0.0)
:::*Area of Ponding (Apond): 5
:*Nodes without 2D Connection:
:::*Surcharge Depth: 50
:::*Area of Ponding (Apond): 0.0

<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Nodes--Junctions''' to verify the data processing has been completed correctly. 
For a summary of the attributes associated with the '''Nodes--Junctions''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Junctions TUFLOW 2023-03-AD Release Notes (Table A.30)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)].
 
{{Video|name=Animation_TS2_SWMM_Inputs_10d.mp4|width=1236}}
 
</ol>

==SWMM Options==
The model we are building will use two SWMM INP files.
*'''sw01_001.inp''' was already created in TUFLOW SWMM Tutorial Module 1. It contained details defining the three culverts under the roads in the model. It also contained the associated 1D SWMM / 2D TUFLOW connection layer objects and the '''Project--Options''' necessary to execute the SWMM simulation. '''sw01_001.inp''' has been included in the base model we are using for Module 2. No changes will be made to it.
* We will create a new INP file for the SWMM pipe network inputs (covered in the next section). As SWMM Options are already included in '''sw01_001.inp''', they are not needed in this second (new) INP file. As such, no new SWMM Option commands are necessary for this tutorial.
'''Note:''' If '''Project--Options''' are included in multiple GeoPackage/INP files, the entry that is referenced lowest in the TUFLOW SWMM Control File (TSCF) will be used.
 

== Export SWMM INP File ==
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw02_001.gpkg''' into a SWMM INP file.

<ol>
<li>Right click on the '''Links--Conduits''' layer in the '''sw02_001''' group (or any other SWMM layer in the same GeoPackage) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw02_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS2_SWMM_Inputs_11e.mp4|width=1236}}
 
</ol>

== TUFLOW Boundary Updates ==
We will be using TUFLOW's 2D direct rainfall (also known as rain on grid) functionality for the catchment inflow boundary condition approach to demonstrate flows into the pipe network inlets. There is a wide range of direct rainfall options built into TUFLOW, including:
*'''Globally uniform rainfall:''' This method applies temporally varied rainfall uniformly (spatially) over the entire model.
*'''Spatially varying rainfall:''' This method applies temporally varied rainfall with spatial variation defined using polygon delineation, grid raster files or inbuilt TUFLOW TIN triangulation routines. 
 
The focus of this tutorial is not to demonstrate the available direct rainfall options. As such, we will be using the simplest approach, globally uniform rainfall. It does not require any GIS updates to implement the boundary condition change. Updates will be limited to the Boundary Condition Database reference and Control File syntax updates. Both are addressed in the next section. If you are interested in learning about the available direct rainfall options, please refer to [[Tutorial_M06 |TUFLOW Tutorial Module 6]].
 
<ol>
<li>Copy '''rainfall_stations.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
<li>Copy '''bc_dbase_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\bc_dbase''' folder.
</ol>
 
It is common to use depth varying manning's roughness when using direct rainfall. A Materials File using depth varying inputs has been provided.
<ol>
<li>Copy '''materials_TS02_001.csv''' from the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder to the '''TUFLOW_SWMM_Module_02\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS2_TUFLOW_Boundary_01a.mp4|width=1235}}
 
</ol>

== TUFLOW Geometry Update ==
We will update TUFLOW's 2D elevation and landuse to represent changes associated with the urban development. The updates will be consolidated within '''TS02_001.gpkg'''.

Copy the following TUFLOW geometry inputs to GeoPackage '''TS02_001.gpkg''':
<ol>
<li>Right click anywhere in the QGIS Toolbar Panel and tick on 'Browser Panel' from the 'Panels' options.
<li>Within the QGIS Browser Panel, there is a dropdown directory, 'Project Home'. This directory is a shortcut to the location where the QGIS workspace is saved. In this case, it is a shortcut to the '''TUFLOW_SWMM_Module_02''' folder.
<li>In the 'Project Home' directory, navigate to the '''TUFLOW_SWMM_Module_02\Tutorial_Data''' folder.
<li>Drag the following layers (hold Ctrl to select multiple) from the '''Urban_Development.gpkg''' and drop them into the '''TS02_001.gpkg''' contained within the '''TUFLOW_SWMM_Module_02\TUFLOW\model\gis''' folder:
:*'''2d_mat_TS02_Dev_Buildings_001_R'''
:*'''2d_mat_TS02_Dev_Lots_001_R'''
:*'''2d_ztin_TS02_Dev_001_L'''
:*'''2d_ztin_TS02_Dev_001_P'''
:*'''2d_ztin_TS02_Dev_001_R'''
</ol>
'''Note:''' The focus of this tutorial is not to demonstrate 2D geometry updates. If you are interested in learning about the above '''2d_ztin''' and '''2d_mat''' changes, please refer to [[Tutorial_M02 |TUFLOW Tutorial Module 2]].
 
<ol>
{{Video|name=Animation_TS2_TUFLOW_Geometry_01f.mp4|width=1236}}
 
</ol>

= Simulation Control Files =
To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps.
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is used here). Save the file as '''TS02_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Using the 'Open File' function in Notepad++:
:*Open '''M02_001.tgc,''' and save the file as '''TS02_001.tgc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tbc,''' and save the file as '''TS02_001.tbc''' in the '''TUFLOW\model''' folder.
:*Open '''TS01_001.tscf,''' and save the file as '''TS02_001.tscf''' in the '''TUFLOW\model''' folder.
 
</ol>

===TUFLOW Control File (TCF)===
<ol>
<li>Open '''TS02_001.tcf''' and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt>..\model\gis\TS02_001.gpkg</tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>Geometry Control File</tt> <tt>== </tt> <tt>..\model\TS02_001.tgc</tt> <tt> ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS02_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Condition Control File</tt> 
<tt>BC Database </tt> <tt>== </tt> <tt>..\bc_dbase\bc_dbase_TS02_001.csv</tt> <tt> ! Reference the Boundary Condition Database</tt> 
<tt>Read Materials File </tt> <tt>== </tt> <tt>..\model\materials_TS02_001.csv</tt> <tt> ! Reference the Materials Definition File</tt> 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS02_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt> 
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>Map Cutoff Depth </tt> <tt>== </tt> <tt> 0.05 </tt> <tt>! Sets map cutoff depth of 0.05 meters</tt> 
<li> Save the TCF.
 
{{Video|name=Animation_TS2_Sim_Control_01d.mp4|width=1235}}
 
</ol>

=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li>Open '''TS02_001.tgc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command to the the '<tt>Topography</tt>' section below the below the existing '<tt>Read GIS Z Shape</tt>' command: 
<tt>Create TIN Zpts </tt> <tt>== </tt> <tt>2d_ztin_TS02_Dev_001_R | 2d_ztin_TS02_Dev_001_L | 2d_ztin_TS02_Dev_001_P</tt> <tt> ! Urban Development Topography TIN</tt> 
<li>Add the following lines in the '<tt>Materials</tt>' section, below the existing material commands : 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Lots_001_R</tt><tt> ! Urban Development Landuse 1</tt> 
<tt>Read GIS Mat </tt> <tt>== </tt> <tt>2d_mat_TS02_Dev_Buildings_001_R</tt> <tt> ! Urban Development Landuse 2</tt> 
<li>Save the TGC.
 
{{Video|name=Animation_TS2_Sim_Control_02b.mp4|width=1235}}
 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Open '''TS02_001.tbc'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li> Comment out the 'Read GIS SA' command by placing '!' before the command: 
<tt>! Read GIS SA == 2d_sa_M01_001_R</tt> 
<li>Add the following additional command lines: 
<tt>Global Rainfall BC </tt> <tt>== </tt> <tt>RF_FC04</tt><tt> ! Reads in global rainfall</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Pipe_Network_Connections_001_L</tt> <tt> ! Links the 1D Pipe Network Outlets to the 2D domain</tt> 
<li>Save the TBC.
 
{{Video|name=Animation_TS2_Sim_Control_03d.mp4|width=1235}}
 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
<ol>
<li>Open '''TS02_001.tscf'''. If using Notepad++, right click the file reference in '''TS02_5m_001.tcf''' and select 'Open File'.
<li>Add the following command lines after '<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt>': 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw02_001.inp</tt> <tt> ! 1D SWMM Pipe Network Input File</tt> 
<tt>Read GIS SWMM Inlet Usage </tt> <tt>== </tt> <tt>swmm\swmm_iu_TS02_001.gpkg >> swmm_iu_TS02_001</tt> <tt> ! 1D SWMM Pipe Network Inlet Usage Layer</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS2_Sim_Control_04b.mp4|width=1235}}
 
</ol>

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_TS01_HPC.bat''' as '''_run_TS02_HPC.bat''' in the '''TUFLOW_SWMM_Module_02\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS02_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS02_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
<li>Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]. 
 
{{Video|name=Animation_TS2_Run_Sim_01c.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M02_Check_QGIS | TUFLOW SWMM Tutorial 02 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M02_Results_QGIS | TUFLOW SWMM Tutorial 02 Results]] 

= Conclusion =
* 1D EPA SWMM pipe network features and 2D direct rainfall (rain on grid) hydrology have been added to the tutorial model.
* Check files were used to review the 1D SWMM pipe network model features.
* Simulation results in the 1D SWMM pipe network were viewed in time series and long section plot format.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM.

 
{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Back to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M01

2025-10-23T06:14:35Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, three culverts are added to represent flow through three separate road embankments. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. 

TUFLOW SWMM Tutorial Module 1 builds from the model created in [[Tutorial_M02 |TUFLOW Tutorial Module 2]] (in the TUFLOW Only tutorial dataset). The completed TUFLOW Module 2 model is provided in the '''''TUFLOW_SWMM_Module_01\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the [[Tutorial_Introduction | "TUFLOW Only" Tutorials]] to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW. 

= Project Initialization =
Three steps are required for the project initialization:
<ol>
<li> Setting the QGIS Project Coordinate Reference System (CRS).
<li> Configuring the QGIS TUFLOW Plugin.
<li> Establishing the new TUFLOW model GeoPackage file that will include new GIS inputs associated with this model update.
</ol>

== QGIS ==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Firstly, define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load and Style the GIS layers from the TUFLOW model:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and select '''M02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 

Style the TUFLOW layers however you desire. Common steps to do this are:
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
 
[[File:tuflow_plugin_styles_open_layers.png]] 
 
<li>Change the symbology of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Singleband pseudocolor
:*Color ramp: Spectral
:*Color ramp: Invert Color Ramp
:*Mode: Equal Interval
*From the Transparency tab, set the Global Opacity to 75%.
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_03d.mp4|width=1235}} 
<li>Create a hillshade of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Duplicate Layer'.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
*Right click on the '''DEM_Hillshade''' and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Hillshade
:*Z Factor: 3
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_04b.mp4|width=1235}} 
</ol>

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_01''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS1_Configure_Project_01a.png]] 
</ol>
 

=== Increment Model GeoPackage File ===
We will now save a copy of '''M02_001.gpkg''' with a new name, '''TS01_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS01_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS01_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_01\TUFLOW\model\gis''' folder. 
 
{{Video|name=Animation_TS1_Initialization_05c.mp4|width=1235}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_01''' folder and type '''SWMM_M01''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
Create a new folder in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder called '''swmm'''. This is the location where all SWMM inputs will be saved. 
 
In QGIS, create the SWMM GeoPackage Database:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click …, and tick on (if not already ticked):
::*'''Project--Title''', '''Project--Options''', '''Project --Report.'''
::*'''Nodes--Junctions''', '''Nodes--Outfalls.''', '''Nodes--Storage.'''
::*'''Links--Conduits, Links--Streets'''.
:*To define the ‘GPKG filename to create’: Click …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage database as '''sw01_001.gpkg'''.

<li>Click ‘Run’.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw01_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw01_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw01_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS1_SWMM_Inputs_01g.mp4|width=1236}}
 
 

== GIS Data Entry ==

A GeoPackage database called '''SWMM_Culverts.gpkg''' is provided in the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. It contains three layers:
:*'''Conduits:''' defines the culvert location, type and geometry.
:*'''Outfalls:''' defines the downstream culvert inverts.
:*'''Storage_nodes:''' defines the upstream culvert inverts.
 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. Drag and drop the '''SWMM_Culverts.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group'. By default, all items in the GeoPackage database will be selected. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Culverts >> Conduits''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Conduits'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw01_001.gpkg >> Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits. 
 
{{Video|name=Animation_TS1_SWMM_Inputs_02f.mp4|width=1236}}
 
<li>Similarly, copy the objects from '''Storage_nodes''' into '''Nodes--Storage'''. Junctions and storage nodes are allowed at the upstream end of culverts. Storage nodes are preferred for culverts receiving 2D flows not through a storm drain inlet.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
<li> Toggle off editing and save the edits.
<li>Remove '''SWMM_Culverts.gpkg'''.
 
{{Video|name=Animation_TS1_SWMM_Inputs_03f.mp4|width=1236}}
 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS1_SWMM_Inputs_04f.mp4|width=1236}}
</ol>
 

== GIS Data Updates ==
The provided GIS data requires numerous updates before proceeding to a model simulation. We have intentionally built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model build processing tools. The following updates are being made to objects and layers within '''sw01_001.gpkg'''.
===Update Conduit Details===
==== Node Details ====
Stage 1 of building the 1D SWMM network involves updating the 'From Node' and 'To Node' attribute information in '''Links--Conduits'''. This information defines the Link/Node connections. 
The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Storage''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
:*SWMM Node Layers: Tick on '''sw01_001 >> Nodes--Storage''' and '''sw01_001 >> Nodes--Outfalls'''. Click 'OK'.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
 
'''Tip 1:''' If you wish to only update a selection of objects, instead of selecting the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.' 
'''Tip 2:''' Unique Node ID's are required for the SWMM network to function error free. If you are following this workflow for a project model build, please ensure the '''Nodes--Storage''' and '''Nodes--Outfalls''' object ID information is unique. If duplicate ID values are assigned to multiple objects, consider using the '[[QGIS_SWMM_Integrity_Make_Object_Names_Unique |Integrity - Make object names unique ]]' TUFLOW SWMM processing tool to ensure all ID values are unique before using '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_05g.mp4|width=1236}}
 

</ol>

====Update Losses====
Stage 2 involves updating the loss attributes in the '''Links--Conduits''' layer. In this example, default loss values are used and will be entered manually. These loss values can be adjusted in your project models to reflect site specific information if desired.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>Right click '''Links--Conduits''' and select 'Open Attribute Table'.
<li>For each conduit, update the following fields:
:*losses_Kentry: 0.5
:*losses_Kexit: 1.0
:*losses_Kavg: 0.0
The video below demonstrates how to do this one entry at a time, or via the bulk attribute update options in QGIS.
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS1_SWMM_Inputs_06f.mp4|width=1236}}
</ol>
 

Since all the 1D SWMM inputs in this model are embankment culverts that all use the same loss parameters, it's not necessary to specify different loss attributes. The [[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] will demonstrate an urban pipe network added to the model, with different loss attributes required for the road culverts and underground storm pipe network links. To simplify this step, Module 2 uses the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' processing tool.
 
 

=== Create 1D/2D Connections===
The following instructions introduce a new tool that automates the creation of 1D/2D connections. Due to the limitations of SWMM boundary conditions, HX lines are required for the upstream end of the culvert (rather than SX), and SX connections are used at the downstream end of the culvert. 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below. 
'''Note:''' Ensure the 'Edit Features In-Place' tool has been turned off.
:*Input Conduits Layer: '''Links--Conduits'''
:*Create connections at: 'Both ends'.
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS01_001.gpkg'''. Click Save.
::<li>A dialog will open. In the Layer name field, write '''2d_bc_SWMM_Culvert_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Culvert_Connections_001_L''' appears in the QGIS Layers Panel. Select 'Apply TUFLOW Styles to Current Layer'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_07f.mp4|width=1236}}
</ol>
 
'''Note:''' The positions of the HX and SX connections may not be in the optimum location or extent using the generalized automated tool. As such, it is recommended to check the output from this processing step. In this module, the 1D/2D connections associated with '''2d_bc_SWMM_Culvert_Connections_001_L''' are checked in [[TUFLOW SWMM Tutorial M01 Check QGIS|TUFLOW SWMM Tutorial 01 Check Files]].
 
 

===Update Storage Node Details===
The attributes of the storage nodes need to be modified to represent the storage of the connected HX cells since these cells do not represent storage themselves. The area associated with the storage nodes should be similar to the areas of the HX cells. To set the area, we will use a "PYRAMIDAL" shape with the SWMM side slope (run/rise) (Z) set to 0 to represent vertical walls. As the cell size is 5m, and the length of each polyline is 10m, the length (L) will be set to 10m and the width (W) to 5m. These sizes will be modified later when we change the boundary conditions.

<ol>
<li> In the QGIS Layers Panel, select (left click) '''Nodes--Storage''' and toggle on editing.
<li> Right click '''Nodes--Storage''' and select 'Open Attribute Table'.
<li> Set the following attributes:
:* YMax: 50.0 (this is a value greater than the expected water level. It is required to allow water to fill node)
:* TYPE: 'PYRAMIDAL'
:* L: 10
:* W: 5
:* Z: 0.0
<li> Turn off editing to save the edits.

 
{{Video|name=Animation_TS1_SWMM_Inputs_08g.mp4|width=1236}}
 
</ol>

==SWMM Options==
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following options:
*'''START_DATE''': 2020-01-01 (Date Format: YYYY-MM-DD)
*'''REPORT_STEP''': 00:01:00
<li>Turn off editing to save the edits.
</ol>

{{Video|name=Animation_TS1_SWMM_Inputs_09f.mp4|width=1236}}
 Save the QGIS Project Workspace:

# Go to Project > Save. This will update '''SWMM_M01.qgz''', which was created previously in the folder '''TUFLOW_SWMM_Module_01'''. 

== Export SWMM INP File ==
SWMM is not able to read the '''sw01_001.gpkg''' database directly, therefore, we need to convert the GeoPackage file to a SWMM INP file format.

<ol>
<li>In the QGIS Layers Panel, right click '''Links--Conduits''' (or any of the SWMM layers) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS1_SWMM_Inputs_10e.mp4|width=1236}}
</ol> 

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, 'TS' is used as the file prefix in this series of tutorials. To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps. 

Set up the simulation control files:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and open '''M02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended).
<li>Save the file as '''TS01_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Open '''M01_001.tbc''' using the 'Open File' function in Notepad++. Save the file as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Create a new blank text file called '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS1_Sim_Control_00a.mp4|width=1235}} 
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is recommended) and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt> ..\model\gis\TS01_001.gpkg </tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS01_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Conditions Control File</tt>
<li>Add the following line in the '<tt>Model Inputs</tt>' section: 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS01_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt>
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>NetCDF Output Start Date </tt> <tt>== </tt> <tt>2020-01-01 00:00 </tt> <tt>! Sets the output units for the NetCDF time variable</tt>
<li>Save the TCF.
 
{{Video|name=Animation_TS1_Sim_Control_01c.mp4|width=1235}} 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tbc''' and select 'Open File'. This opens '''TS01_001.tbc''' into a new tab in Notepad ++.
<li>Add the following command line after '<tt>Read GIS SA </tt> <tt>== </tt> <tt>2d_sa_M01_001_R</tt>': 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Culvert_Connections_001_L</tt> <tt> ! Links 1D SWMM culverts to the 2D TUFLOW domain</tt>
<li>Save the TBC.
 
{{Video|name=Animation_TS1_Sim_Control_02c.mp4|width=1235}} 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is used to control the SWMM input data. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File. 
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tscf''' and select 'Open File'. This opens '''TS01_001.tscf''' into a new tab in Notepad ++.
<li>Add the following command: 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt> <tt> ! 1D SWMM culvert input file</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS1_Sim_Control_03c.mp4|width=1235}} 
</ol>
 

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS01_HPC.bat''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS01_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS01_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
 
If the model simulation doesn't run:
<ol>
<li> Check in the screen output or the tlf file near the end for "For SWMM Model Errors see:". This indicates that there is something wrong with the SWMM inputs. Reviewing that file will provide feedback on what is wrong.
<li> Review this link for common [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]] advice.
</ol>
 
{{Video|name=Animation_TS1_Run_Sim_01d.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M01_Check_QGIS | TUFLOW SWMM Tutorial 01 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M01_Results_QGIS | TUFLOW SWMM Tutorial 01 Results]] 

= Conclusion =
*EPA SWMM culverts were added to convey water through the structures under the three roads in the tutorial model.
*Check files were used to review the inclusion of 1D SWMM culverts to a 2D TUFLOW model.
*Results through the 1D culverts were assessed.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM. 
 

{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW SWMM Tutorial M01

2025-10-23T06:13:43Z

Pavlina Monhartova: /* Other TUFLOW SWMM Tutorials */

= Introduction =
In this module, three culverts are added to represent flow through three separate road embankments. EPA SWMM is used as the solution scheme for the 1D culvert flow calculations, dynamically linked with the TUFLOW HPC 2D solution scheme. 

TUFLOW SWMM Tutorial Module 1 builds from the model created in [[Tutorial_M02 |TUFLOW Tutorial Module 2]] (in the TUFLOW Only tutorial dataset). The completed TUFLOW Module 2 model is provided in the '''''TUFLOW_SWMM_Module_01\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the [[Tutorial_Introduction | "TUFLOW Only" Tutorials]] to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW. 

= Project Initialization =
Three steps are required for the project initialization:
<ol>
<li> Setting the QGIS Project Coordinate Reference System (CRS).
<li> Configuring the QGIS TUFLOW Plugin.
<li> Establishing the new TUFLOW model GeoPackage file that will include new GIS inputs associated with this model update.
</ol>

== QGIS ==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.11 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see [https://wiki.tuflow.com/TUFLOW_QGIS_Plugin Installation of TUFLOW Plugin]. 
Firstly, define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol>
<li>Open QGIS.
<li>Go to Project > Properties…
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
 
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}} 

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load and Style the GIS layers from the TUFLOW model:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
 
[[File: Tuflow_plugin_load_tcf_layers.png]] 
 
<li>Navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and select '''M02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally
<li>Click ‘Open’ and ‘OK’.
</ol>
 

Style the TUFLOW layers however you desire. Common steps to do this are:
<ol>
<li>Click on the ‘Apply TUFLOW Styles to Open Layers’ symbol from the TUFLOW Plugin toolbar.
 
[[File:tuflow_plugin_styles_open_layers.png]] 
 
<li>Change the symbology of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Singleband pseudocolor
:*Color ramp: Spectral
:*Color ramp: Invert Color Ramp
:*Mode: Equal Interval
*From the Transparency tab, set the Global Opacity to 75%.
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_03d.mp4|width=1235}} 
<li>Create a hillshade of the DEM:
*Right click on the '''DEM''' file in the QGIS Layers Panel and select 'Duplicate Layer'.
*Right click on the '''DEM_copy''' and select 'Rename Layer'. Rename the layer to '''DEM_Hillshade'''.
*Right click on the '''DEM_Hillshade''' and select 'Properties'.
*From the Symbology tab, under 'Band Rendering' select the following options:
:*Render type: Hillshade
:*Z Factor: 3
*Click 'Apply' and 'OK'.
 
{{Video|name=Animation_TS1_Initialization_04b.mp4|width=1235}} 
</ol>

===TUFLOW Plugin===
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model: 
<ol>
<li>Open the 'Configure TUFLOW Project' tool by selecting Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Set the CRS (Coordinate Reference System) by selecting one of the vector layers associated with the opened model using the drop menu list. For example, ''2d_bc_M01_001_L''.
<li>To set the location of the TUFLOW folder, click 'Browse...' and navigate to the '''TUFLOW_SWMM_Module_01''' folder. Click 'Select Folder'.
<li>To set the location of the TUFLOW single precision executable file, click 'Browse...' and navigate to the '''exe\2023-03-AF''' folder. Select '''TUFLOW_iSP_w64.exe''' and click 'Open'.
<li>Select 'GPKG' as the GIS Format.
<li>Select 'TUFLOW Classic / HPC' as the TUFLOW Engine.
<li>Tick on 'Save Default Settings Globally'.
<li>Click 'OK'. 
 
[[File: TS1_Configure_Project_01a.png]] 
</ol>
 

=== Increment Model GeoPackage File ===
We will now save a copy of '''M02_001.gpkg''' with a new name, '''TS01_001.gpkg'''. This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li>In the QGIS Layers Panel, select (left click) '''2d_bc_M01_001_L'''.
<li>Click on the 'Increment Selected Layer' symbol from the TUFLOW Plugin toolbar. This opens the dialog shown below.
 
[[File:tuflow_plugin_increment_layer.png]] 
 
:*Source Layer: Automatically set to the selected layer, '''2d_bc_M01_001_L'''.
:*Output Database: Click 'Browse...'. This will automatically open to the '''TUFLOW\model\gis''' folder. Set the new output database name to '''TS01_001.gpkg''' and click 'Save'.
:*Output Layer Name: This will automatically increment to '''2d_bc_M01_00''2''_L'''. Change the name back to '''2d_bc_M01_00''1''_L'''.
:*Delete the pre-filled 'Incremented Layer' entry in the table. We do not wish to modify the version number associated with the 2d_bc file. This current exercise will not change the version number of any of the GIS layer inputs, it is simply establishing a copy of the existing GeoPackage where future edits will be saved to.
:*Select 'Remove Source Layer from Workspace'.
:*Select 'Increment Layer and Preserve Database'.
<li>Click 'OK'.
<li>The GeoPackage database, '''TS01_001.gpkg''' will now be in the '''TUFLOW_SWMM_Module_01\TUFLOW\model\gis''' folder. 
 
{{Video|name=Animation_TS1_Initialization_05c.mp4|width=1235}}
 
</ol>

===Save QGIS Project Workspace===
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_01''' folder and type '''SWMM_M01''' as the filename with the extension .qgz.
</ol>
 

= GIS Inputs =
==Create SWMM GeoPackage Spatial Database==
Create a new folder in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder called '''swmm'''. This is the location where all SWMM inputs will be saved. 
 
In QGIS, create the SWMM GeoPackage Database:
<ol>
<li>Go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_GeoPackage_Create |GeoPackage - Create]]'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click …, and tick on (if not already ticked):
::*'''Project--Title''', '''Project--Options''', '''Project --Report.'''
::*'''Nodes--Junctions''', '''Nodes--Outfalls.''', '''Nodes--Storage.'''
::*'''Links--Conduits, Links--Streets'''.
:*To define the ‘GPKG filename to create’: Click …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage database as '''sw01_001.gpkg'''.

<li>Click ‘Run’.
<li>Once the tool has finished, click ‘Close’.
<li>In Windows File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw01_001.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw01_001.gpkg'''. By default, all items in the available list should have been selected.
<li>In the QGIS Layers Panel, move '''sw01_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project.
</ol>
 
{{Video|name=Animation_TS1_SWMM_Inputs_01g.mp4|width=1236}}
 
 

== GIS Data Entry ==

A GeoPackage database called '''SWMM_Culverts.gpkg''' is provided in the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. It contains three layers:
:*'''Conduits:''' defines the culvert location, type and geometry.
:*'''Outfalls:''' defines the downstream culvert inverts.
:*'''Storage_nodes:''' defines the upstream culvert inverts.
 
To populate the GeoPackage database created in the previous section:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\Tutorial_Data''' folder. Drag and drop the '''SWMM_Culverts.gpkg''' into QGIS.
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group'. By default, all items in the GeoPackage database will be selected. Click 'Add Layers'.
<li>In the QGIS Layers Panel, right click on the '''SWMM_Culverts >> Conduits''' layer and select 'Zoom to Layer(s)'.
<li>Use the 'Select Features' tool to highlight all items included in '''Conduits'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu.
<li>In the QGIS Layers Panel, select (left click) the '''sw01_001.gpkg >> Links--Conduits''' layer.
<li>Make the '''Links--Conduits''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits. 
 
{{Video|name=Animation_TS1_SWMM_Inputs_02f.mp4|width=1236}}
 
<li>Similarly, copy the objects from '''Storage_nodes''' into '''Nodes--Storage'''. Junctions and storage nodes are allowed at the upstream end of culverts. Storage nodes are preferred for culverts receiving 2D flows not through a storm drain inlet.
<li>Also copy the objects from '''Outfalls''' into '''Nodes--Outfalls'''. Outfalls are treated as outlets, and are required at the downstream end of culverts.
<li> Toggle off editing and save the edits.
<li>Remove '''SWMM_Culverts.gpkg'''.
 
{{Video|name=Animation_TS1_SWMM_Inputs_03f.mp4|width=1236}}
 
<li>Inspect the attribute information within the respective layers to familiarize yourself with the data.
 
{{Video|name=Animation_TS1_SWMM_Inputs_04f.mp4|width=1236}}
</ol>
 

== GIS Data Updates ==
The provided GIS data requires numerous updates before proceeding to a model simulation. We have intentionally built these updates into this tutorial to demonstrate some of the available TUFLOW SWMM model build processing tools. The following updates are being made to objects and layers within '''sw01_001.gpkg'''.
===Update Conduit Details===
==== Node Details ====
Stage 1 of building the 1D SWMM network involves updating the 'From Node' and 'To Node' attribute information in '''Links--Conduits'''. This information defines the Link/Node connections. 
The information we will be adding to '''Links--Conduits''' is extracted from '''Nodes--Storage''' and '''Nodes--Outfalls''' automatically using the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool from the Processing Toolbox.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>In the Processing Toolbox, select the 'Edit Features In-Place' tool [[File:edit_features_in_place_icon.png]]. This allows the editing of an existing layer, instead of the creation of a new layer.
<li>Go to TUFLOW >> SWMM in the processing tool list and select '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'. This opens the dialog shown below.
:*SWMM Node Layers: Tick on '''sw01_001 >> Nodes--Storage''' and '''sw01_001 >> Nodes--Outfalls'''. Click 'OK'.
<li>Select 'Modify All Features'.
<li>Once the tool has finished, click 'Close'.
<li>Turn off editing to save the edits.
<li>View the attributes associated within '''Links--Conduits''' to verify the data processing has been completed correctly. The 'From Node' and 'To Node' attribute information is now configured correctly. For a broader understanding of the other attributes associated with the '''Links--Conduits''' layer, refer to [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Conduits TUFLOW 2023-03-AD Release Notes (Table A.19)] and the [https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM Reference Manual - Volume 2 (Hydraulics)]. 
 
'''Tip 1:''' If you wish to only update a selection of objects, instead of selecting the entire '''Links--Conduits''' dataset, select the target objects first using the 'Select Features' tool. The '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' tool will provide an option to 'Modify Selected Features', instead of 'Modify All Features.' 
'''Tip 2:''' Unique Node ID's are required for the SWMM network to function error free. If you are following this workflow for a project model build, please ensure the '''Nodes--Storage''' and '''Nodes--Outfalls''' object ID information is unique. If duplicate ID values are assigned to multiple objects, consider using the '[[QGIS_SWMM_Integrity_Make_Object_Names_Unique |Integrity - Make object names unique ]]' TUFLOW SWMM processing tool to ensure all ID values are unique before using '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_05g.mp4|width=1236}}
 

</ol>

====Update Losses====
Stage 2 involves updating the loss attributes in the '''Links--Conduits''' layer. In this example, default loss values are used and will be entered manually. These loss values can be adjusted in your project models to reflect site specific information if desired.
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits''' and toggle on editing.
<li>Right click '''Links--Conduits''' and select 'Open Attribute Table'.
<li>For each conduit, update the following fields:
:*losses_Kentry: 0.5
:*losses_Kexit: 1.0
:*losses_Kavg: 0.0
The video below demonstrates how to do this one entry at a time, or via the bulk attribute update options in QGIS.
<li>Turn off editing to save the edits.
 
{{Video|name=Animation_TS1_SWMM_Inputs_06f.mp4|width=1236}}
</ol>
 

Since all the 1D SWMM inputs in this model are embankment culverts that all use the same loss parameters, it's not necessary to specify different loss attributes. The [[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] will demonstrate an urban pipe network added to the model, with different loss attributes required for the road culverts and underground storm pipe network links. To simplify this step, Module 2 uses the '[[QGIS_SWMM_Conduits_Assign_Node_Fields |Conduits - Assign node fields]]' processing tool.
 
 

=== Create 1D/2D Connections===
The following instructions introduce a new tool that automates the creation of 1D/2D connections. Due to the limitations of SWMM boundary conditions, HX lines are required for the upstream end of the culvert (rather than SX), and SX connections are used at the downstream end of the culvert. 
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Links--Conduits'''.
<li>In the Processing Toolbox, go to TUFLOW >> SWMM and select '[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections |BC - Create channel endpoint 1D/2D connections]]'. This opens the dialog shown below. 
'''Note:''' Ensure the 'Edit Features In-Place' tool has been turned off.
:*Input Conduits Layer: '''Links--Conduits'''
:*Create connections at: 'Both ends'.
:*Offset Distance: 2
:*Length of BC lines: 10
:*Tick on 'Set 2D cell elevation to 1D culvert invert at 1D/2D connection cells if needed'.
:*Output Layer:
<ol>
::<li>Click the ... and select 'Save to GeoPackage'.
::<li>Navigate to the '''TUFLOW\model\gis''' folder and select '''TS01_001.gpkg'''. Click Save.
::<li>A dialog will open. In the Layer name field, write '''2d_bc_SWMM_Culvert_Connections_001_L'''.
::<li>Click 'OK'.
</ol>
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>The '''2d_bc_SWMM_Culvert_Connections_001_L''' appears in the QGIS Layers Panel. Select 'Apply TUFLOW Styles to Current Layer'.
 
{{Video|name=Animation_TS1_SWMM_Inputs_07f.mp4|width=1236}}
</ol>
 
'''Note:''' The positions of the HX and SX connections may not be in the optimum location or extent using the generalized automated tool. As such, it is recommended to check the output from this processing step. In this module, the 1D/2D connections associated with '''2d_bc_SWMM_Culvert_Connections_001_L''' are checked in [[TUFLOW SWMM Tutorial M01 Check QGIS|TUFLOW SWMM Tutorial 01 Check Files]].
 
 

===Update Storage Node Details===
The attributes of the storage nodes need to be modified to represent the storage of the connected HX cells since these cells do not represent storage themselves. The area associated with the storage nodes should be similar to the areas of the HX cells. To set the area, we will use a "PYRAMIDAL" shape with the SWMM side slope (run/rise) (Z) set to 0 to represent vertical walls. As the cell size is 5m, and the length of each polyline is 10m, the length (L) will be set to 10m and the width (W) to 5m. These sizes will be modified later when we change the boundary conditions.

<ol>
<li> In the QGIS Layers Panel, select (left click) '''Nodes--Storage''' and toggle on editing.
<li> Right click '''Nodes--Storage''' and select 'Open Attribute Table'.
<li> Set the following attributes:
:* YMax: 50.0 (this is a value greater than the expected water level. It is required to allow water to fill node)
:* TYPE: 'PYRAMIDAL'
:* L: 10
:* W: 5
:* Z: 0.0
<li> Turn off editing to save the edits.

 
{{Video|name=Animation_TS1_SWMM_Inputs_08g.mp4|width=1236}}
 
</ol>

==SWMM Options==
<ol>
<li>In the QGIS Layers Panel, select (left click) '''Project--Options''' and toggle on editing.
<li>Right click '''Project--Options''' and select 'Open Attribute Table'.
<li>Update the following options:
*'''START_DATE''': 2020-01-01 (Date Format: YYYY-MM-DD)
*'''REPORT_STEP''': 00:01:00
<li>Turn off editing to save the edits.
</ol>

{{Video|name=Animation_TS1_SWMM_Inputs_09f.mp4|width=1236}}
 Save the QGIS Project Workspace:

# Go to Project > Save. This will update '''SWMM_M01.qgz''', which was created previously in the folder '''TUFLOW_SWMM_Module_01'''. 

== Export SWMM INP File ==
SWMM is not able to read the '''sw01_001.gpkg''' database directly, therefore, we need to convert the GeoPackage file to a SWMM INP file format.

<ol>
<li>In the QGIS Layers Panel, right click '''Links--Conduits''' (or any of the SWMM layers) and select 'TUFLOW' > 'SWMM - Export inp file'.
<li>This will open the '[[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp |GeoPackage - Write to SWMM inp]]' processing tool, prepopulated with the filename of the layer's GeoPackage. 
'''Note:''' This tool can also be activated from the Processing Toolbox.
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<li>This tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw01_001.inp''' to the '''TUFLOW\model\swmm''' folder.
 
{{Video|name=Animation_TS1_SWMM_Inputs_10e.mp4|width=1236}}
</ol> 

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

To differentiate the TUFLOW SWMM tutorials from the TUFLOW/ESTRY tutorials, 'TS' is used as the file prefix in this series of tutorials. To avoid the potential risk of overwriting existing control files accidentally, we will start by saving new control files where we will be making subsequent syntax updates during the following steps. 

Set up the simulation control files:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder and open '''M02_5m_001.tcf''' in a Text Editor (Notepad++ is recommended).
<li>Save the file as '''TS01_5m_001.tcf''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Open '''M01_001.tbc''' using the 'Open File' function in Notepad++. Save the file as '''TS01_001.tbc''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
<li>Create a new blank text file called '''TS01_001.tscf''' and save it in the '''TUFLOW_SWMM_Module_01\TUFLOW\model''' folder.
 
{{Video|name=Animation_TS1_Sim_Control_00a.mp4|width=1235}} 
</ol>

=== TUFLOW Control File (TCF) ===
<ol>
<li>Open '''TS01_5m_001.tcf''' in a Text Editor (Notepad++ is recommended) and make the following reference updates: 
<tt>Spatial Database </tt> <tt>== </tt> <tt> ..\model\gis\TS01_001.gpkg </tt> <tt> ! Specify the location of the GeoPackage Spatial Database</tt> 
<tt>BC Control File </tt> <tt>== </tt> <tt>..\model\TS01_001.tbc</tt> <tt> ! Reference the TUFLOW Boundary Conditions Control File</tt>
<li>Add the following line in the '<tt>Model Inputs</tt>' section: 
<tt>SWMM Control File </tt> <tt>== </tt> <tt> ..\model\TS01_001.tscf </tt> <tt> ! Reference the SWMM (1D) Control File</tt>
<li>Add the following line in the '<tt>Output Settings</tt>' section: 
<tt>NetCDF Output Start Date </tt> <tt>== </tt> <tt>2020-01-01 00:00 </tt> <tt>! Sets the output units for the NetCDF time variable</tt>
<li>Save the TCF.
 
{{Video|name=Animation_TS1_Sim_Control_01c.mp4|width=1235}} 
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tbc''' and select 'Open File'. This opens '''TS01_001.tbc''' into a new tab in Notepad ++.
<li>Add the following command line after '<tt>Read GIS SA </tt> <tt>== </tt> <tt>2d_sa_M01_001_R</tt>': 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>2d_bc_SWMM_Culvert_Connections_001_L</tt> <tt> ! Links 1D SWMM culverts to the 2D TUFLOW domain</tt>
<li>Save the TBC.
 
{{Video|name=Animation_TS1_Sim_Control_02c.mp4|width=1235}} 
</ol>

=== TUFLOW SWMM Control File (TSCF) ===
A new control file, the TUFLOW SWMM Control File (TSCF), is used to control the SWMM input data. All 1D SWMM files and commands are referenced in the TUFLOW SWMM Control File. 
<ol>
<li>From '''TS01_001.tcf''', right click '''TS01_001.tscf''' and select 'Open File'. This opens '''TS01_001.tscf''' into a new tab in Notepad ++.
<li>Add the following command: 
<tt>Read SWMM </tt> <tt>== </tt> <tt>swmm\sw01_001.inp</tt> <tt> ! 1D SWMM culvert input file</tt> 
<li>Save the TSCF.
 
{{Video|name=Animation_TS1_Sim_Control_03c.mp4|width=1235}} 
</ol>
 

= Running the Simulation =
<ol>
<li>Save a copy of '''_run_M02_HPC.bat''' as '''_run_TS01_HPC.bat''' in the '''TUFLOW_SWMM_Module_01\TUFLOW\runs''' folder.
<li>Update the batch file to reference the '''TS01_5m_001.tcf''' : 
<tt>'''set'''</tt> <tt>exe</tt><tt>=</tt><tt>"..\..\..\exe\2023-03-AF\TUFLOW_iSP_w64.exe"</tt> 
<tt>'''set'''</tt> <tt>run</tt><tt>=</tt><tt>start "TUFLOW" /wait</tt> <tt> %exe%</tt> <tt> -b</tt> 
<tt>%run% </tt> <tt>TS01_5m_001.tcf </tt>

<li>Save the batch file and double click it in Windows File Explorer to run the simulation.
 
If the model simulation doesn't run:
<ol>
<li> Check in the screen output or the tlf file near the end for "For SWMM Model Errors see:". This indicates that there is something wrong with the SWMM inputs. Reviewing that file will provide feedback on what is wrong.
<li> Review this link for common [[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]] advice.
</ol>
 
{{Video|name=Animation_TS1_Run_Sim_01d.mp4|width=1236}} 
</ol>

= Check Files and Results Output=
Complete the steps outlined in following links to review check files and simulation results from the TUFLOW SWMM model simulation:

[[TUFLOW_SWMM_Tutorial_M01_Check_QGIS | TUFLOW SWMM Tutorial 01 Check Files]] 
[[TUFLOW_SWMM_Tutorial_M01_Results_QGIS | TUFLOW SWMM Tutorial 01 Results]] 

= Conclusion =
*EPA SWMM culverts were added to convey water through the structures under the three roads in the tutorial model.
*Check files were used to review the inclusion of 1D SWMM culverts to a 2D TUFLOW model.
*Results through the 1D culverts were assessed.
 

=Other TUFLOW SWMM Tutorials=
*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM]] - How to convert an XPSWMM model to TUFLOW SWMM. 
 

{{Tips Navigation
|uplink=[[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Modules| Return to TUFLOW SWMM Tutorial Introduction Main Page]]
}}

TUFLOW Example Models

2025-10-23T06:12:42Z

Pavlina Monhartova: /* Further Learning */

=Introduction=
These example models have been developed to demonstrate the most common TUFLOW model design features and applications. This dataset is useful for experienced modellers wishing to further develop their skills via demonstration examples. Although the models are based on the TUFLOW tutorial model dataset, new users are encouraged to familiarise themselves with TUFLOW through the [[Tutorial_Introduction |Tutorial Model Introduction]] before using this dataset. Unlike the tutorials, this dataset does not include step-by-step instructions / documentation. Users of this dataset are expected to have a basic knowledge TUFLOW, and have suitable skills to open the model files by referencing the TUFLOW Control File (TCF) referenced in the feature catalogue list below. 

=Example Model Data=
The model data is available for download from https://downloads.tuflow.com/TUFLOW/Wiki_Example_Models/TUFLOW_Example_Model_Dataset.zip 
The dataset only includes model input files. The models can be run to create simulation check and result files. Batch files (*.bat) for each of the example feature categories has been provided within the "runs" folder of the TUFLOW project. 

If you are unfamiliar with using batch files, additional information explaining how to use them to execute multiple simulations is available here: [[Run_TUFLOW_From_a_Batch-file| Run TUFLOW From a Batch-file]].

=Example Model Catalogue=
Below is a complete list of the example models. This dataset uses TUFLOW HPC as the computational engine.

Click on the following shortcuts to skip directly to the targeted major feature category in the table below: 
*[[TUFLOW_Example_Models#Project Initiation| Project Initiation]]
*[[TUFLOW_Example_Models#Model Units| Model Units]]
*[[TUFLOW_Example_Models#Solver Options| Solver Options]]
*[[TUFLOW_Example_Models#Output Options| Output Options]]
*[[TUFLOW_Example_Models#Boundary Condition Options| Boundary Condition Options]] (Inflows, Outflows, Losses)
*[[TUFLOW_Example_Models#Topography Features| Topography Features]] (Static Updates, Dynamic Updates, Sub-Grid Sampling)
*[[TUFLOW_Example_Models#Structures| Structures]] (Bridges, Weirs, Culverts, Operational Controls)
*[[TUFLOW_Example_Models#Multiple Domain Model Design| Multiple Domain Model Design]] (2D/2D, 1D open channel / 2D floodplain, 1D pipe network / 2D floodplain)
*[[TUFLOW_Example_Models#Bulk Simulation Management| Bulk Simulation Management]]
*[[TUFLOW_Example_Models#Advection Dispersion| Advection Dispersion]]
*[[TUFLOW_Example_Models#Non-Newtonian | Non-Newtonian]]
*[[TUFLOW_Example_Models#Mathematical Operations| Mathematical Operations]]

{| class="wikitable" style="text-align:center;"
! colspan="4" style="position:sticky; top:0; background-color:#005581; font-weight:bold; color:white; z-index:2;" | Example Model Catalogue
|-
! colspan="2" style="position:sticky; top:2.2em; background-color:#fff; font-weight:bold; z-index:2;" | Model Category
! style="position:sticky; top:2.2em; background-color:#fff; font-weight:bold; z-index:2;" | Description
! style="position:sticky; top:2.2em; background-color:#fff; font-weight:bold; z-index:2;" | Model Name
|-
| colspan="2" id="Project Initiation" | Project Initiation
| Write empty files
| Create_Empties.tcf
|-

|-
| colspan="2" rowspan="2" id="Model Units" |Model Units
|Basic 2D model (SI units - m)
|EG00_001.tcf
|-
|Basic 2D model (US units - ft)
|EG00_002.tcf
|-

|-
| colspan="2" rowspan="8" id="Solver Options" |Solver Options
|TUFLOW Classic
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|TUFLOW HPC - Sub-Grid Sampled (SGS) topography enabled
|EG01_002.tcf
|-
|TUFLOW HPC - Sub-Grid Sampled (SGS) topography disabled
|EG01_003.tcf
|-
|TUFLOW HPC - Multiple GPU cards
|EG01_004.tcf
|-
|TUFLOW HPC - Newtonian Viscosity (Wu Turbulence)
|EG01_006.tcf
|-
|TUFLOW HPC - Newtonian Viscosity (Smagorinsky)
|EG01_007.tcf
|-
|TUFLOW HPC - Quadtree
|See Section [[TUFLOW_Example_Models#Multiple Domain Model Design| EG13]]
|-
|ESTRY
|See Section [[TUFLOW_Example_Models#1D Culverts, Bridges, Weirs| EG11]], [[TUFLOW_Example_Models#1D Operating Structures| EG12]], [[TUFLOW_Example_Models#1D Pipe Network / 2D Floodplain Modelling| EG15]]
|-

| colspan="2" rowspan="19" id="Output Options" |Output Options
|2D xmdf (binary time series) and grid (maximums) output
|EG02_001.tcf
|-
|Time and duration of inundation (Time Output Cut-off = Depth)
|EG02_002.tcf
|-
|Time and duration of inundation (Time Output Cut-off = VxD)
|EG02_003.tcf
|-
|Time and duration of inundation (Time Output Cut-off = Hazard)
|EG02_004.tcf
|-
|Gauge level map output interval control (2d_glo)
|EG02_005.tcf
|-
|2D SGS high resolution grid output
|EG02_006.tcf
|-
|2D SGS high resolution grid output with manual specification of output resolution
|EG02_007.tcf
|-
|Output Zone (2d_oz)
|EG02_008.tcf
|-
|Write Restart File (See EG06_004.tcf for Read Restart File)
|EG02_009.tcf
|-
|2D plot output (2d_po point, line and region)
|EG02_010.tcf
|-
|2D structure outputs
|EG02_011.tcf
|-
|2D Long Profile (2d_lp)
|EG02_012.tcf
|-
|1D/2D Reporting locations - 1D river (1d_nwk), 2D floodplain
|EG02_013.tcf
|-
|1D/2D Reporting locations - 1D pipe network (1d_nwk), 2D floodplain
|EG02_014.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Depth)
|EG02_015.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Velocity)
|EG02_016.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = VxD)
|EG02_017.tcf
|-
|Evacuation route inundation reporting (2d_zshr) (Route Cut Off Type = Hazard)
|EG02_018.tcf
|-
|Translating gauge data information to catchment receptors (Read GIS Objects)
|EG02_019.tcf

|-
| rowspan="52" id="Boundary Condition Options" |Boundary Condition Options
| rowspan="19" id="Inflows" |Inflows
|2D flow (m^3/s) vs time upstream inflow (2d_bc, QT)
|EG03_001.tcf
|-
|2D head (m) vs time upstream inflow (2d_bc, HT)
|EG03_002.tcf
|-
|Internal catchment inflow (m^3/s)(2d_sa)
|EG03_003.tcf
|-
|Internal catchment inflow (m^3/s) with streamlines (2d_sa, 2d_strm)
|EG03_004.tcf
|-
|Internal catchment rainfall (mm) (2d_sa_rf)
|EG03_005.tcf
|-
|Direct rainfall (mm) (2D Global Rainfall)
|EG03_006.tcf
|-
|Direct rainfall (mm) (2d_rf)
|EG03_007.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - IDW)
|EG03_008.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - TIN)
|EG03_009.tcf
|-
|Direct rainfall (mm) (Rainfall Control File - Poly)
|EG03_010.tcf
|-
|Direct rainfall (mm) (time varying gridded rainfall) - netcdf format
|EG03_011.tcf
|-
|Direct rainfall (mm) (time varying gridded rainfall) - flt format
|EG03_012.tcf
|-
|Direct rainfall (mm) (2d_rf) - negative rainfall
|EG03_013.tcf
|-
|Direct rainfall (2d_rf) and internal catchment rainfall (2d_sa_rf) for buildings
|EG03_014.tcf
|-
|HEC-DSS flow (m^3/s) vs time upstream inflow (2d_bc, QT)
|EG03_015.tcf
|-
|HEC-DSS flow (m^3/s) vs time upstream inflow (2d_bc, QT, multiple events)
|EG03_016.tcf
|-
|1D flow (m^3/s) vs time upstream inflow (1d_bc, QT)
|EG14_001.tcf
|-
|1D flow (m^3/s) vs time internal inflow (1d_bc, QT)
|EG14_002.tcf
|-
|1D flow (m^3/s) vs time internal inflow to 1D pits (1d_bc, QT)
|EG14_003.tcf
|-

| rowspan="6" id="Outflows" |Outflows
|2D Automatic stage discharge downstream boundary (2d_bc, HQ)
|EG04_001.tcf
|-
|2D User-specified stage discharge downstream boundary (2d_bc, HQ)
|EG04_002.tcf
|-
|2D Stage time downstream boundary (2d_bc, HT)
|EG04_003.tcf
|-
|1D Automatic stage discharge downstream boundary (1d_bc, HQ)
|EG04_004.tcf
|-
|1D User-specified stage discharge downstream boundary (1d_bc, HQ)
|EG04_005.tcf
|-
|1D Stage time downstream boundary (1d_bc, HT)
|EG04_006.tcf
|-

| rowspan="19" id="Loss Options" |Loss Options
|Rainfall excess loss approach - IL/CL (Global loss applied via the TBC file)
|EG05_001.tcf
|-
|Rainfall excess loss approach - IL/CL (applied via the materials file)
|EG05_002.tcf
|-
|Infiltration loss approach - IL/CL
|EG05_003.tcf
|-
|Infiltration loss approach - IL/CL, porosity
|EG05_004.tcf
|-
|Infiltration loss approach - IL/CL, porosity, initial moisture
|EG05_005.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type)
|EG05_006.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type), initial moisture
|EG05_007.tcf
|-
|Infiltration loss approach - Green Ampt (USDA soil type), initial moisture, ponding
|EG05_008.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties)
|EG05_009.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture
|EG05_010.tcf
|-
|Infiltration loss approach - Green Ampt (User specified soil properties), initial moisture, ponding
|EG05_011.tcf
|-
|Infiltration loss approach - Horton
|EG05_012.tcf
|-
|Infiltration loss approach - Horton, porosity
|EG05_013.tcf
|-
|Infiltration loss approach - Horton, porosity, initial moisture
|EG05_014.tcf
|-
|Groundwater - no horizontal infiltration
|EG05_015.tcf
|-
|Groundwater - 1 soil layer, horizontal hydraulic conductivity
|EG05_016.tcf
|-
|Groundwater - 2 soil layers, horizontal hydraulic conductivity
|EG05_017.tcf
|-
|Groundwater level versus time downstream boundary (2d_bc, GT)
|EG05_018.tcf
|-
|Groundwater linking to 1D
|EG05_019.tcf
|-

| rowspan="8" id="Other" |Other
|Spatially varied initial water level commands (2d_iwl)
|EG06_001.tcf
|-
|Spatially varied initial water level commands (Grid 2d_iwl)
|EG06_002.tcf
|-
|2D pump (2d_bc, SH)
|EG06_003.tcf
|-
|Read Restart File (See EG02_009.tcf for Write Restart File)
|EG06_004.tcf
|-
|Storage Reduction Factor (global specification)
|EG06_005.tcf
|-
|Storage Reduction Factor (2d_srf) (location specific update)
|EG06_006.tcf
|-
|External Stress - Wind (global specification)
|EG06_007.tcf
|-
|Dynamic Topography Options (Dam / Levee Failure)
|See Section [[TUFLOW_Example_Models#Dynamic Topography Updates| EG08]]

|-
| rowspan="28" id="Topography Features" |Topography Features
| rowspan="12" id="Static Topography Updates" |Static Topography Updates
|Cell resolution change
|EG07_001.tcf
|-
|Thin breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_002.tcf
|-
|Thick breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_003.tcf
|-
|Gully (Min) breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_004.tcf
|-
|Ridge (Max) breakline topography update (2d_zsh_L, 2d_zsh_P)
|EG07_005.tcf
|-
|Region update - Absolute value change, No merge (2d_zsh_R)
|EG07_006.tcf
|-
|Region update - Relative value change, No merge (2d_zsh_R)
|EG07_007.tcf
|-
|Region update - Absolute value change, Partial merge (2d_zsh_R, 2d_zsh_P)
|EG07_008.tcf
|-
|Region update - Feature removal (2d_zsh_R)
|EG07_009.tcf
|-
|Advanced topography update - TIN (2d_ztin_R, 2d_ztin_P)
|EG07_010.tcf
|-
|Advanced topography update - TIN (2d_ztin_R, 2d_ztin_L, 2d_ztin_P)
|EG07_011.tcf
|-
|Depth varying Manning's n
|EG07_012.tcf
|-
| rowspan="13" id="Dynamic Topography Updates" |Dynamic Topography Options (Dam / Levee Failure)
|2D embankment failure - Time trigger, linear evolution
|EG08_001.tcf
|-
|2D embankment failure - Time trigger, non-linear evolution
|EG08_002.tcf
|-
|2D embankment failure - Water level trigger, linear evolution
|EG08_003.tcf
|-
|2D embankment failure - Water level trigger, non-linear evolution
|EG08_004.tcf
|-
|2D embankment failure - Water level difference trigger, linear evolution
|EG08_005.tcf
|-
|2D embankment failure - Water level difference trigger, non-linear evolution
|EG08_006.tcf
|-
|2D flood barrier reinstatement - Time trigger
|EG08_007.tcf
|-
|2D flood barrier reinstatement - Water level trigger
|EG08_008.tcf
|-
|2D flood barrier reinstatement - Water level difference trigger
|EG08_009.tcf
|-
|1D piping failure transitioning to 1D dam failure - Time trigger
|EG08_010.tcf
|-
|1D dam failure - Time trigger
|EG08_011.tcf
|-
|1D piping failure transitioning to 1D dam failure - Water level trigger
|EG08_012.tcf
|-
|1D dam failure - Water level trigger
|EG08_013.tcf
|-
| rowspan="3" id="Sub Grid Sampling" |Sub Grid Sampling
|Breakline detection delta tool
|EG09_001.tcf
|-
|2D SGS high resolution grid output
|EG09_002.tcf
|-
|2D SGS high resolution grid output with manual specification of output resolution
|EG09_003.tcf
|-
| rowspan="37" id="Structures" |Structures
| rowspan="9" id="2D Structures" |2D Structures
|Bridge (2d_fc)
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|Bridge (2d_fcsh)
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
|Bridge - horizontal deck (2d_lfcsh)
|EG10_003.tcf
|-
|Bridge - variable deck form geometry (2d_lfcsh)
|EG10_004.tcf
|-
|Bridge - horizontal deck (2d_bg)
|EG10_005.tcf
|-
|2D weir coefficient change (global specification)
|EG10_006.tcf
|-
|2D weir coefficient change (location specific update)
|EG10_007.tcf
|-
|Bridge (2d_bg) - horizontal deck, auto superstructure FLC
|EG10_008.tcf
|-
|Fences (2d_lfcsh)
|EG10_009.tcf
|-

| rowspan="14" id="1D Structures" |1D Structures
|1D culverts - Circular and Box type. SX point, line and region 1D/2D examples
|EG11_001.tcf
|-
|1D culverts - Irregular shape (e.g. Arch)
|EG11_002.tcf
|-
|1D culverts - Unidirectional structures (flapgate) (1d_nwk)
|EG11_003.tcf
|-
|1D culverts - ARR2019 blockage matrix (1d_nwk)
|EG11_~e1~_~e2~_004.tcf
|-
|1D M channel - User defined flow matrix (1d_nwk)
|EG11_005.tcf
|-
|1D Q channel - Upstream Depth-Discharge Relationship (1d_nwk)
|EG11_006.tcf
|-
|Bridge (1d_nwk, 1d_bg)
|EG11_007.tcf
|-
|Weir (1d_nwk)
|EG11_008.tcf
|-
|Pump (1d_nwk) - pump curve
|EG11_009.tcf
|-
|Sluice gate (1d_nwk)
|EG11_010.tcf
|-
|Gated spillway (1d_nwk)
|EG11_011.tcf
|-
|Arch bridge (1D), no orifice flow
|EG11_012.tcf
|-
|Arch bridge (1D), orifice flow enabled
|EG11_013.tcf
|-
|Arch bridge (1D), orifice flow enabled with calibration factor
|EG11_014.tcf
|-

| rowspan="14" id="1D Operating Structures" |1D Operating Structures
|Pump operational (1d_nwk) - time trigger
|EG12_001.tcf
|-
|Pump operational - 1D water level trigger (1d_nwk)
|EG12_002.tcf
|-
|Pump operational - 2D water level trigger (1d_nwk)
|EG12_003.tcf
|-
|Pump operational - Depth above structure invert trigger (1d_nwk)
|EG12_004.tcf
|-
|Q flow matrix - Operation based on water level trigger (1d_nwk)
|EG12_005.tcf
|-
|Q flow matrix - Operation based on water level trigger and time delay (1d_nwk)
|EG12_006.tcf
|-
|Sluice gate operational - Time trigger (simulation time) (1d_nwk)
|EG12_007.tcf
|-
|Sluice gate operational - Water level trigger(1d_nwk)
|EG12_008.tcf
|-
|Gated spillway operational - Time trigger (Day) (1d_nwk)
|EG12_009.tcf
|-
|Gated spillway operational - Water level trigger (1d_nwk)
|EG12_010.tcf
|-
|Coordinated operation (multiple interacting structures) - Pump and Gated Spillway
|EG12_011.tcf
|-
|Coordinated operation controlled by status of another structure
|EG12_012.tcf
|-
|Pump operational (1d_nwk) - pump curve
|EG12_013.tcf
|-
|Pump operational (1d_nwk) - Time stamp after water level trigger
|EG12_014.tcf
|-

| rowspan="17" id="Multiple Domain Model Design" |Multiple Domain Model Design
| rowspan="5" id="2D/2D Modelling" |2D/2D Modelling
|TUFLOW HPC - Quadtree: Sample target distance
|EG13_001.tcf
|-
|TUFLOW HPC - Quadtree: Sample frequency nesting
|EG13_002.tcf
|-
|TUFLOW HPC - Quadtree: Memory efficient pre-processing
|EG13_003.tcf
|-
|TUFLOW HPC - Quadtree: Sample frequency
|EG13_004.tcf
|-
|TUFLOW Classic - M2D
|Refer to [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]]
|-
| rowspan="1" id="1D Open Channel / 2D Floodplain Modelling" |1D Open Channel / 2D Floodplain Modelling
|1D river (1d_nwk), 2D floodplain
|EG14_001.tcf
|-

| rowspan="11" id="1D Pipe Network / 2D Floodplain Modelling" |1D Pipe Network / 2D Floodplain Modelling
|1D pipe network (1d_nwk), 2D floodplain, 2d_sa_rf inflow (mm) to 1D pits
|EG15_000.tcf
|-
|1D pipe network (1d_nwk), 2D floodplain, 2d_sa inflow (m^3/s) to 1D pits
|EG15_001.tcf
|-
|1D pipe network (1d_nwk), 2D floodplain, 2d_rf direct rainfall
|EG15_002.tcf
|-
|1D pipe network (1d_nwk), 2D / 2D floodplain quadtree
|EG15_003.tcf
|-
|1D pipe network (1d_nwk), manually specified manholes (1d_mh), 2D floodplain
|EG15_004.tcf
|-
|1D pipe network (1d_nwk), non-default (fixed) manhole loss method, 2D floodplain
|EG15_005.tcf
|-
|1D pipe network (1d_nwk), localised manually specified manhole losses, 2D floodplain
|EG15_006.tcf
|-
|1D virtual pipes, 2D floodplain
|EG15_007.tcf
|-
|1D virtual pipes connected to 1D pipe network (trunk drainage line), 2D floodplain
|EG15_008.tcf
|-
|1D storage tank (1d_na)
|EG15_009.tcf
|-
|1D storage tank (1d_nwk)
|EG15_010.tcf
|-

| rowspan="6" id="Bulk Simulation Management" |Bulk Simulation Management
| rowspan="6" id="Scenario / Event Management" |Scenario / Event Management
|Scenario (single)
|EG16_~s1~_001.tcf
|-
|Scenario (multiple)
|EG16_~s1~_~s2~_002.tcf
|-
|Set Variable
|EG16_~s1~_~s2~_003.tcf
|-
|Event (single)
|EG16_~e1~_004.tcf
|-
|Event (multiple)
|EG16_~e1~_~e2~_005.tcf
|-
|Scenario (multiple), Event (multiple), Set Variable
|EG16_~s1~_~s2~_~e1~_~e2~_006.tcf
|-

| rowspan="10" id="Other" |Other
| rowspan="3" id="Advection Dispersion" |Advection Dispersion
|Advection Dispersion
|EG17_001.tcf
|-
|Advection Dispersion with settling
|EG17_002.tcf
|-
|Advection Dispersion with decay
|EG17_003.tcf
|-
| rowspan="2" id="Non-Newtonian" |Non-Newtonian
|Non-newtonian viscosity
|EG18_001.tcf
|-
|Non-newtonian mixing (dam failure scenario)
|EG18_002.tcf
|-
| rowspan="5" id="Mathematical Operations" |Mathematical Operations
|Unit Conversion
|EG19_001.tcf
|-
|Using Variables
|EG19_~e1~_~e2~_002.tcf
|-
|Adjust Event Variables
|EG19_~e1~_~e2~_003.tcf
|-
|Apply Loss Factors
|EG19_~e1~_~e2~_004.tcf
|-
|Logic Control
|EG19_005.tcf
|}

=Archive Dataset=
Historic example model datasets can be accessed via the following link: [[TUFLOW_Classic_Example_Model_Archive| TUFLOW Classic Example Model Archive]].

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 

 
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

TUFLOW SWMM Tutorial Introduction

2025-10-23T06:12:14Z

Pavlina Monhartova: /* Recommended Further Reading */

On request from USA XPSWMM users, TUFLOW linkage with 1D EPA Storm Water Management Model (SWMM) has been added as a supported feature in TUFLOW 2023-03-AD release or newer. EPA SWMM is used for simulating urban watershed hydrologic and 1D hydraulic behavior. Initially developed in the early 1970's by the USA Environmental Protection Agency (EPA), the software has since undergone numerous updates and enhancements to become one of the most used 1D stormwater runoff and water quality analysis tools in North America. The primary uses of EPA SWMM include designing and evaluating stormwater systems and also planning and assessment of low-impact developments (also known as Water Sensitive Urban Design). For more details about EPA SWMM, please visit: [https://www.epa.gov/water-research/storm-water-management-model-swmm https://www.epa.gov/water-research/storm-water-management-model-swmm].

 
This EPA SWMM series of tutorials has been written in USA English for the predominantly USA SWMM user base.

= Introduction =
The following tutorial models are aimed at new and experienced users, stepping through the process of building and running TUFLOW SWMM together. The main objective aims to demonstrate the ability for TUFLOW to link to 1D EPA SWMM in a variety of different common use case scenarios.

'''Note, if you are not already familiar with TUFLOW, we recommend first completing Module 1 and 2 of the [[Tutorial_Introduction | "TUFLOW Only" Tutorials]] to establish an understanding of 2D modeling, before progressing to learning how to link 1D EPA SWMM to 2D TUFLOW.''' 
 TUFLOW has supported 1D/2D dynamic coupling since its initial 2D solver development in 1989. Traditionally, 1D (1 Dimensional) linking and associated modeling has been applied using TUFLOW's 1D solver, ESTRY. As demonstrated in:
:*[[Tutorial_M03 | Module 3 - 1D Culverts]]
:*[[Tutorial_M05 | Module 5 - Integrated Urban Pipe Network Drainage]]
:*[[Tutorial_M11 | Module 11 - 1D Open Channel]] 
EPA SWMM's inclusion in TUFLOW does not replace ESTRY, rather both 1D solvers complement each other. Links to the TUFLOW SWMM tutorials are included in the section below.

=Software Requirements=
TUFLOW uses QGIS as its Graphical User Interface (GUI), in combination with text editor and spreadsheet software, for its model creation and result viewing. The group of software creates an extremely workflow efficient and flexible modeling environment. Notably, QGIS does not experience the data load/visualization lag and display issues some other hydraulic modeling software GUI's are limited by when working with larger datasets. 

{| class="wikitable" width="75%"

! style="background-color:#005581; font-weight:bold; color:white;"| Requirement
! style="background-color:#005581; font-weight:bold; color:white;" | Brief Description
! style="background-color:#005581; font-weight:bold; color:white;" | Download
|-
| '''TUFLOW''' || TUFLOW is a computer program for simulating depth-averaged, one and two-dimensional free-surface flows such as occurs from floods and tides, with the 2D solution occurring over a regular grid or quadtree mesh of square elements. 
It is recommended to always use the latest release version of TUFLOW. 

This tutorial model does not require a TUFLOW license. 

This tutorial is configured to use a NVIDIA GPU card. If this is not available, your CPU can be used via the Hardware command. 
||The TUFLOW executable is provided within the [[TUFLOW_SWMM_Tutorial_Introduction#Tutorial_Data | Tutorial Download Dataset]].
|-
| '''QGIS''' QGIS TUFLOW plugin || QGIS is the Geographic Information System (GIS) Graphical User Interface (GUI) used to build models and view results. The QGIS TUFLOW plugin includes numerous tools to increase workflow efficiency.

This tutorial was developed using QGIS 3.34 and QGIS TUFLOW Plugin 3.11. Please use these or newer versions of QGIS and the plugin. Earlier releases will not include the TUFLOW SWMM automation tools demonstrated in the Tutorials.

||[https://qgis.org/download/ Latest 64-bit version of QGIS]. 

[[TUFLOW_QGIS_Plugin| QGIS TUFLOW Plugin Installation]].
|-
| '''NotePad++''' Syntax Highlighting || A text editor is required for creation of the TUFLOW control (script) files. This tutorial was developed with NotePad++. Ideally a text editor should be able to: 
*Color code the TUFLOW control files;
*Open other files from the active control file; and
*Launch a TUFLOW simulation. 
TUFLOW color coding can be enabled using syntax highlighting.
|| [https://notepad-plus-plus.org/downloads/ Latest 64-bit version of Notepad++]. 

[https://downloads.tuflow.com/_archive/Miscellaneous/NPP_TUFLOW_Syntax_Highlighting.zip TUFLOW syntax highlighting for Notepad++]. 

For instructions on configuring Notepad++ for TUFLOW modeling, see [[NotepadPlusPlus_Tips |Notepad++ tips]].
|-
| '''Microsoft Excel''' || A spreadsheet software is required for working with tabular data and .csv files. This tutorial has been created using Excel. ||
|}

 

=Tutorial Data=
To build the tutorial model, download the dataset below. This includes a digital elevation model (DEM), aerial photography, background model data for the tutorial model and a working version of the model. GeoPackage database has been used as the GIS format for the model build tasks. For tips on using GeoPackage databases see [https://wiki.tuflow.com/GeoPackage_Tips GeoPackage Tips].
:*[https://downloads.tuflow.com/TUFLOW/Wiki_Tute_Models/TUFLOW_SWMM_Tutorial_Models_QGIS_GPKG.zip TUFLOW SWMM Tutorial Dataset - QGIS - GPKG]

=Tutorial Modules=
The download dataset contains the input files and working version of the tutorial model for reference. Results and check files are not included to keep the size of the download file manageable; they will be created when running the model simulations. The folder should be placed in a location with write permissions. 

The tutorial model is presented in several modules. All modules can be completed independently, however new users are encouraged to undertake the modules in sequence:

:*[[TUFLOW_SWMM_Tutorial_M01 | TUFLOW SWMM Module 1]] - 1D SWMM Culverts
:*[[TUFLOW_SWMM_Tutorial_M02 | TUFLOW SWMM Module 2]] - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
:*[[TUFLOW_SWMM_Tutorial_M03 | TUFLOW SWMM Module 3]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
:*[[TUFLOW_SWMM_Tutorial_M04 | TUFLOW SWMM Module 4]] - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.
:*[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM: Automated (Recommended) Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Automated XPX Conversion Tool Approach.
:*[[XPSWMM_to_TUFLOW-SWMM_Archive | XPSWMM to TUFLOW SWMM: Manual Approach]] - How to convert an XPSWMM model to TUFLOW SWMM: Manual Approach.

== TUFLOW SWMM Documentation ==
TUFLOW SWMM documentation can be found in the TUFLOW Manual, the 2023-03-AD release notes for TUFLOW-SWMM and in the TUFLOW plugin documentation for the related QGIS tools.

* [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
* [https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD Release notes - SWMM Section]
* [[TUFLOW QGIS Plugin#Processing_Toolbox|TUFLOW QGIS Plugin Documentation including SWMM tools]]

=Recommended Further Reading=
For users who wish to get a better understanding of either 1D EPA SWMM or 2D TUFLOW, the following resources may be of use:
 
'''EPA SWMM''': [https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]
*[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]
*[https://downloads.tuflow.com/SWMM/swmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]

 
'''TUFLOW''': [https://www.tuflow.com www.tuflow.com]
*[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]
*[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD release notes]
*[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]

=Contact=
For comments, requests and feedback contact [mailto:support@tuflow.com support@tuflow.com]. 
For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 

{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}

TUFLOW CATCH Tutorial M04

2025-10-23T06:08:13Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, a TUFLOW CATCH integrated model with interventions is developed. 

TUFLOW CATCH Tutorial 04 is built from the models created in [[TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 02]] and [[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]]. The completed TUFLOW CATCH Tutorial 03 is provided in the '''TUFLOW_CATCH_Module_04\Modelling''' folder of the download dataset as the starting point for this tutorial.
If unfamiliar with TUFLOW CATCH, it is recommended to complete [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]], [[TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 02]] and [[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]] prior to starting this tutorial.

= Meteorological Data =
Meteorological inputs are defined in boundary condition blocks within the receiving model block of the TUFLOW CATCH Control file (.tcc).  For this tutorial, timeseries meteorological data has been supplied.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_04\Tutorial_Data''' folder. Copy the '''TC04_met_ts_001.csv''' and paste it in the '''TUFLOW_CATCH_Module_04\Modelling\TUFLOWFV\bc_dbase\met''' folder. This file contains the timeseries meteorological data.
<li>Open the file. As this file is read by TUFLOW FV, the first column (Time) must contain the date is ISODATE format (DD/MM/YYYY hh:mm:ss). The other columns contain the data for the meteorological conditions that will be simulated in this model: 
{|
|
* '''AIR_TEMP''': Air temperature (degrees Celsius)
|
:::* '''REL_HUM''': Relative humidity (%)
|-
|
*'''LW_RAD''': Downward longwave radiation (W m<tt>-2</tt>)
|
:::*'''W10_X''': Zonal wind velocity at 10m (m s-1)
|-
|
*'''SW_RAD''': Downward shortwave radiation (W m-2)
|
:::*'''W10_Y''': Meridional wind velocity at 10m (m s-1)
|}

[[File: TC4_met_ts_data_01a.png]] 
 
</ol>

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

==== Generate Template Files ====
This tutorial requires a Water Quality Control file (.fvwq) and a Sediment Transport Control file (.fvsed). Use the TUFLOW CATCH plugin to generate template files:
<ol>
<li>In QGIS, go to Processing > Toolbox from the top drop down menu options to open the Processing Toolbox.
<li>Go to TUFLOW Catch in the processing tool list and select 'Create TUFLOW Catch Project'. This opens the dialog shown below:
*Project Name: '''TC04'''
*Project Folder: Click '...', and navigate to the '''TUFLOW_CATCH_Module_04\Modelling''' folder.
*Project CRS: Click the drop down menu and select 'Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
* TUFLOW HPC Executable: Click '...', and navigate to the '''exe\TUFLOW\2025.1.0 folder'''. Select '''TUFLOW_iSP_w64.exe'''.
* TUFLOW FV Executable: Click '...', and navigate to the '''exe\TUFLOWFV\2025.1.0''' folder. Select '''TUFLOWFV.exe'''.
* Default GIS Format: Click the drop down menu and select 'SHP'.
* Tick on 'Setup Control File Templates'.
* Control File Templates: Expand the 'Advanced Parameters' section. Click '...', and tick on: Water Quality Control file (.fvwq) and Sediment Control file (.fvsed). Ensure all other files are ticked off.
<li> Click 'Run'. Once the tool has finished click 'Close'. 
 
[[File: TC4_Create_CATCH_Project_01a.png]] 
 
</ol>

=== Water Quality Control File (FVWQ) ===
<ol>
<li> Navigate to the '''TUFLOWFV\wqm''' folder and open '''TC04_001.fvwq''' in a text editor.
<li> In the 'Simulation Controls' sections, update the following commands: 
<tt>Simulation Class == DO ! Specify the simulation class to Dissolved Oxygen</tt> 
<tt>WQ dt == 300 ! Interval for updating the water quality module </tt> 
<tt>WQ Units == mgL ! Specify the units to be mgL </tt> 

<li> In the 'Constituent Model Settings', add the following commands to specify the constituent (oxygen and pathogens) parameters. For more information on the model settings for each constituent, refer to the TUFLOW FV Water Quality Manual: [https://docs.tuflow.com/fv/wqm/manual/2025.1/SimulationConstruction-1.html#ConModClssOxy-4 Section 4.6.3.1 (Oxygen)] and [https://docs.tuflow.com/fv/wqm/manual/2025.1/SimulationConstruction-1.html#ConModClssPth-4 Section 4.6.3.2 (Pathogens)]. 
<tt>Oxygen Model == O2 ! Set the oxygen model</tt> 
:<tt>Oxygen Min Max == 0.0, 12.0 ! Specify the allowable minimum and maximum oxygen concentrations</tt> 
:<tt>Oxygen Benthic == 4.7, 1.08 ! Specify the global benthic parameters </tt> 
<tt>End Oxygen Model</tt> 
<tt>Pathogen Model == Free, Ecoli ! Set the pathogen model and name</tt> 
:<tt>Alive Min Max == 0.0, 1e7 ! Specify the allowable minimum and maximum concentrations</tt> 
:<tt>Mortality == 0.08, 2e-12, 6.1, 1.0, 1.11 ! Specify the mortality parameters</tt> 
:<tt>Visible Inactivation == 0.082, 0.0067, 0.5 ! Specify the visible light inactivation parameters</tt> 
:<tt>UVA Inactivation == 0.5, 0.0067, 0.5 ! Specify the UV-A light inactivation parameters</tt> 
:<tt>UVB Inactivation == 1.0, 0.0067, 0.5 ! Specify the UV-B light inactivation parameters</tt> 
:<tt>Settling == -0.03 ! Specify the settling of non-attached pathogens</tt> 
<tt>End Pathogen Model</tt> 

<li> In the 'Material Specifications' section, add the following material blocks to specify oxygen flux for each material ID. 
<tt>Material == Default ! Defines default properties for all materials</tt> 
:<tt>Oxygen Flux == -1400.0 </tt> 
<tt>End Material</tt> 
<tt>Material == 1 ! Defines properties for material ID 1 (overwrites default)</tt> 
:<tt>Oxygen Flux == -1100.0 </tt> 
<tt>End Material</tt> 
<tt>Material == 2 ! Defines properties for material ID 2 (overwrites default)</tt> 
:<tt>Oxygen Flux == -1200.0 </tt> 
<tt>End Material</tt> 
<tt>Material == 3 ! Defines properties for material ID 3 (overwrites default)</tt> 
:<tt>Oxygen Flux == -1300.0 </tt> 
<tt>End Material</tt> 

<li> Save the FVWQ.
</ol>

=== Sediment Transport Control File (FVSED) ===
<ol>
<li> Navigate to the '''TUFLOWFV\stm''' folder and open '''TC04_001.fvsed''' in a text editor.
<li> Update the following command to match the output interval for the rest of the model (300secs or 5mins): 
<tt>Update dt == 300 ! Interval for updating the sediment transport module</tt> 

<li> In the 'Settings' section, update the following commands. For more information on these commands, please refer to the [https://downloads.tuflow.com/TUFLOWFV/Releases/Latest/TUFLOW_FV_ST_and_PT_Modules_User_Manual.pdf TUFLOW FV Sediment Transport Manual]. 
<tt>Erosion Depth Limits == 0.1, 0.5 ! Depth limits within which the erosion rate is scaled down (meters)</tt> 
<tt>Deposition Depth Limits == 0.1, 0.5 ! Depth limits within which the deposition rate is scaled down (meters)</tt> 
<tt>Bed Roughness Model == ks ! Set bed roughness model</tt> 
<tt>Bed Roughness Parameters == 0.02, 0.02 ! Specify the bed roughness for current and waves</tt> 

<li> In the 'Fractions' section, add in the following Fraction block to set the parameters for clay. 
<tt>Fraction == Clay ! Set sediment fraction</tt> 
:<tt>d50 == 0.0002 ! Specify the median grain size of the sediment fraction (meters)</tt> 
:<tt>Particle Density == 2650.0 ! Specify the density of the particle group (kg/m3)</tt> 
:<tt>Settling Model == Constant ! Set the settling model</tt> 
:<tt>Settling Parameters == 1e-05 ! Specify constant settling velocity (m/s)</tt> 
:<tt>Critical Stress Model == Constant ! Set the critical stress model</tt> 
:<tt>Critical Stress Parameters == 0.15 ! Specify constant critical stress (N/m2)</tt> 
:<tt>Erosion Model == Mehta ! Set the erosion model</tt> 
:<tt>Erosion Parameters == 0.01, 0.5, 1.0 ! Specify constant erosion rate (g/m2s), critical shear stress (N/m2) and power coefficient</tt> 
:<tt>Deposition Model == ws0 ! Set the deposition model</tt> 
<tt>End Fraction</tt> 

<li> In the 'Materials' section, add the following material blocks to set the sediment transport for each material ID. 
<tt>Material == 1, 2 ! Defines properties for material IDs 1 and 2</tt> 
:<tt>Nlayer == 1 ! Number of sediment bed layers</tt> 
:<tt>Layer == 1 ! Bed layer number </tt> 
::<tt>Dry Density == 800 ! Dry density of bed layer (kg/m3) </tt> 
::<tt>Initial Mass == 1500 ! Initial mass of each sediment fraction (kg/m2) </tt> 
:<tt>End Layer</tt> 
<tt>End Material</tt> 
<tt>Material == 3 ! Defines properties for material ID 3</tt> 
:<tt>Nlayer == 1 ! Number of sediment bed layers</tt> 
:<tt>Layer == 1 ! Bed layer number </tt> 
::<tt>Dry Density == 800 ! Dry density of bed layer (kg/m3) </tt> 
::<tt>Initial Mass == 3200 ! Initial mass of each sediment fraction (kg/m2) </tt> 
:<tt>End Layer</tt> 
<tt>End Material</tt> 

<li>Save the FVSED.
</ol>

== TUFLOW CATCH Control File (TCC) ==
=== Global Settings ===
For this tutorial, leave all commands as is. This section of the .tcc was populated in [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]].

=== Catchment Hydraulic Model ===
This block contains commands that construct the TUFLOW HPC simulation.
<ol>
<li> Save a copy of '''TC03_001.tcc''' as '''TC04_001.tcc''' in the '''TUFLOW_CATCH_Module_04\Modelling\TUFLOWCATCH\runs''' folder.
<li> Open '''TC04_001.tcc''' in a text editor, and comment out the following command: 
<tt>! Pollutant == Salinity, Temperature, WQ_DISS_OXYGEN_MG_L, WQ_PATH_ECOLI_ALIVE_CFU_100ML, WQ_PATH_ECOLI_DEAD_CFU_100ML, SED_CLAY ! Specify the pollutant names</tt> 
</ol>

=== Pollutant Export Model ===
This block contains commands that control the pollutant export (and other constituent) simulation. As this tutorial model is an integrated simulation with interventions, we must turn the pollutant export model back on:
<ol>
<li> Set the pollutant export model: 
<tt>Catchment Pollutant Export Model == Mass Accumulation Release </tt> 
<li> Uncomment all the commands. The pollutant export model block should look the same as in [[TUFLOW_CATCH_Tutorial_M02#Pollutant_Export_Model | TUFLOW CATCH Tutorial 02]]
</ol>

=== Receiving Model ===
This block contains commands that construct the TUFLOW FV simulation. For this tutorial, the receiving model block must be updated to include water quality and sediment transport.
<ol>
<li> In the 'General Parameters' section, update the following commands to turn on salinity, temperature, sediment and heat. For more information on these commands, refer to [https://downloads.tuflow.com/TUFLOWFV/Releases/Latest/TUFLOW_FV_User_Manual.pdf Appendix B of the TUFLOW FV Manual]  
<tt>Include Salinity == 1,0 </tt> 
<tt>Include Temperature == 1,0 </tt> 
<tt>Include Sediment == 1,0 </tt> 
<tt>Include Heat == 1 </tt> 

<li> In the 'Water Quality' section, update the following commands to set the general WQ parameters and to reference the Water Quality Control file. 
<tt>Water Quality Model == TUFLOW </tt> 
<tt>Water Quality Control File == ..\..\TUFLOWFV\wqm\TC04_001.fvwq ! Reference the Water Quality Control File</tt> 
<tt>Water Quality Model Directory == ..\..\TUFLOWFV\wqm\ ! Location of the Water Quality Directory</tt> 
<tt>Cell Water Quality Depth == 0.05 ! Minimum depth to execute water quality calculations (meters)</tt> 

<li> In the 'Sediment Transport' section, update the following command to reference the Sediment Control file: 
<tt>Sediment Control File == ..\..\TUFLOWFV\stm\TC04_001.fvsed ! Reference the Sediment Control File</tt> 

<li> In the 'Initial Conditions' section, update the following commands to set the initial temperature, salinity, sediment concentration and water quality concentrations. The initial water level was set in [[TUFLOW_CATCH_Tutorial_M03#Receiving_Model | TUFLOW CATCH Tutorial 03]]. 
<tt>Initial Temperature == 17.0 ! Specify initial temperature (degrees Celsius)</tt> 
<tt>Initial Salinity == 0.0 ! Specify initial salinity (psu)</tt> 
<tt>Initial Sediment Concentration == 20 ! Specify initial suspended sediment concentration for clay (mg/L)</tt> 
<tt>Initial WQ Concentration == 8.0, 1e6, 1e6 ! Specify initial water quality concentration for dissolved oxygen, alive and dead E. coli</tt> 

<li>In the 'Meteorology' section, add the following boundary condition blocks to specify meteorological conditions. The variable '<tt>met_ts</tt>' is used to define the location of the meteorological data. 
<tt>Set Variable met_ts == ..\..\TUFLOWFV\bc_dbase\met\TC04_met_ts_001.csv </tt> 
<tt>BC == LW_RAD, <<met_ts>> ! Downward longwave radiation (W m-2)</tt> 
:<tt>BC Header == Time, LW_RAD ! Column headers to read from time series file</tt> 
:<tt>BC Update dt == 300 ! Specify update timestep for BC (seconds)</tt> 
:<tt>BC Time Units == Hours ! Specify time units</tt> 
:<tt>BC Reference Time == 01/01/2021 10:00 ! Specify boundary condition reference time</tt> 
<tt>End BC</tt> 
<tt>BC == SW_RAD, <<met_ts>> ! Downward shortwave radiation (W m-2)</tt> 
:<tt>BC Header == Time, SW_RAD</tt> 
:<tt>BC Update dt == 300</tt> 
:<tt>BC Time Units == Hours</tt> 
:<tt>BC Reference Time == 01/01/2021 10:00</tt> 
<tt>End BC</tt> 
<tt>BC == W10, <<met_ts>> ! Wind velocity at 10m (m s-1)</tt> 
:<tt>BC Header == Time, W10_X, W10_Y</tt> 
:<tt>BC Update dt == 300</tt> 
:<tt>BC Time Units == Hours</tt> 
:<tt>BC Reference Time == 01/01/2021 10:00</tt> 
<tt>End BC</tt> 
<tt>BC == AIR_TEMP, <<met_ts>> ! Temperature input (deg C)</tt> 
:<tt>BC Header == Time, AIR_TEMP</tt> 
:<tt>BC Update dt == 300</tt> 
:<tt>BC Time Units == Hours</tt> 
:<tt>BC Reference Time == 01/01/2021 10:00</tt> 
<tt>End BC</tt> 
<tt>BC == REL_HUM, <<met_ts>> ! Relative humidity (%)</tt> 
:<tt>BC Header == Time, REL_HUM</tt> 
:<tt>BC Update dt == 300</tt> 
:<tt>BC Time Units == Hours</tt> 
:<tt>BC Reference Time == 01/01/2021 10:00</tt> 
<tt>End BC</tt> 

<li> In the 'Outputs' section, update the existing NetCDF output block to include sediment: 
<tt>Output == NetCDF </tt> 
:<tt>Output Parameters == h, v, d, sed_1 ! Outputs water level, velocity, depth and sediment</tt> 
:<tt>Output Interval == 30 ! Interval to output the data (seconds) </tt> 
:<tt>Suffix == HD ! Specify suffix for the output NetCDF file </tt>
<tt>End Output</tt> 

<li> At the end of the 'Outputs' section, add the following output block to output water quality results. 
<tt>Output == NetCDF </tt> 
:<tt>Output Parameters == wq_all ! Outputs water quality results </tt> 
:<tt>Output Interval == 30 ! Interval to output the data (seconds) </tt> 
:<tt>Suffix == WQ ! Specify suffix for the output NetCDF file </tt>
<tt>End Output</tt> 

<li>Save the TCC.
</ol>

= Running the Simulation =
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. Save a copy of '''_run_TC03_CATCH.bat''' as '''_run_TC04_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the '''TC04_001.tcc''': 
<tt>set exe="..\..\..\..\exe\TUFLOWCATCH\2025.1.0\TUFLOWCATCH.exe"</tt> 
<tt>%exe% TC04_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation. 
</ol>

= Troubleshooting =
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]

= Results Output =
Complete the steps outlined in the following links to review simulation results from the TUFLOW CATCH integrated model simulation:
:*[[TUFLOW_CATCH_Tutorial_M04_Results_QGIS | TC04 - Results]] 

= Conclusion =
* A TUFLOW CATCH Integrated model was created.
* Meteorological data, water quality and sediment transport were added to the model.
* A TUFLOW CATCH JSON file was created to review the transfer of results (particularly pollutants) between the TUFLOW HPC and the TUFLOW FV domains.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

TUFLOW CATCH Tutorial M01

2025-10-23T06:07:55Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, a TUFLOW CATCH pollutant export model is developed. 

TUFLOW CATCH Tutorial 01 is built from the model created in [[Tutorial_M06#Part_3_-_Rainfall_Control_File | TUFLOW Tutorial Module 6 - Part 3]]. The completed TUFLOW Module 6 (part 3) is provided in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW''' folder of the download dataset as the starting point for this tutorial. If unfamiliar with TUFLOW, it is recommended to complete Modules 1, 2, 3 and 6 of the [[Tutorial_Introduction | TUFLOW Tutorials]] to establish an understanding of 1D and 2D TUFLOW modelling, including direct rainfall models.

= Project Initialisation =
TUFLOW CATCH models are separated into a series of folders which contain the input and output files. The recommended directory structure for TUFLOW CATCH models consists of a top-level folder, '''Modelling''', which contains three subfolders:
* '''TUFLOW''': Contains TUFLOW HPC input files.
* '''TUFLOWCATCH''': Contains the TUFLOW CATCH Control file, as well as all check, results and log files.
* '''TUFLOWFV''': Contains TUFLOW FV input files.
The third level subfolders are outlined below. For a more detailed description, refer to the [https://docs.tuflow.com/catch/latest/ TUFLOW CATCH Manual]. For more information on TUFLOW HPC or TUFLOW FV folder structures, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] or the [https://downloads.tuflow.com/TUFLOWFV/Releases/Latest/TUFLOW_FV_User_Manual.pdf TUFLOW FV Manual]. 
<ol>
[[File:TC1_folder_structure_01a.png|left]]
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" | Folder
! style="background-color:#005581; font-weight:bold; color:white;" width=10%| Sub-Folder (s)
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description
|-
|rowspan="3" style="text-align: center;"|TUFLOW
| bc_dbase model|| Follows standard TUFLOW structure.
|-
| catch || Not used, but generated for internal use. It holds files that are produced during computation, but deleted when the simulation finishes successfully.
|-
| check results runs || Not used, but generated for internal use. All TUFLOW check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|-
|rowspan="6" style="text-align: center;"|TUFLOWCATCH
| bc_dbase|| Contains the output boundary condition and time-series data.
|-
| check || Contains the GIS and other check files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV to carry out quality control checks
|-
| model || Not used - generated for internal use.
|-
| results|| Contains the result files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
| runs|| Contains the .tcc simulation control file.
|-
| runs\log || Contains the log files (e.g. .catchlog, .tlf, .log, etc) and _messages.shp files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
|rowspan="2" style="text-align: center;"|TUFLOWFV
| bc_dbase model stm wqm|| Follows standard TUFLOW FV structure.
|-
| check results runs || Not used, but generated for internal use. All TUFLOW FV check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|}
</ol>

The TUFLOW CATCH folders can be set up manually, or automatically through the TUFLOW CATCH QGIS Plugin (recommended).
:*[[TUFLOW_CATCH_Tutorial_M01_Project_Initialisation_QGIS | TUFLOW CATCH Project Initialisation]]

= GIS Inputs =
Create, import and view input data:
:*[[TUFLOW_CATCH_Tutorial_M01_GIS_Inputs_QGIS | TC01 - GIS Inputs]]

= TUFLOW Boundary Condition Database (bc_dbase) =
Update the bc_dbase with a reference to the timeseries temperature data:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''temperature.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\bc_dbase''' folder. This file contains the timeseries temperature data.
<li> Open the file. As this file will be read by TUFLOW CATCH, the first column must contain the date in ISODATE format (DD/MM/YYYY hh:mm:ss). It will also be read by TUFLOW HPC, and therefore must have a column specifying a time in hours from the beginning of the model. In this case, the 'TUFLOW_Time' column contains the time in hours. For example, 01/01/2021 10:00:00 corresponds to 0, 01/01/2021 11:00:00 to 1, and so on. 
 
[[File: TC1_temperature_csv_01a.png]] 
 
<li> In the '''TUFLOW\bc_dbase''' folder, save a copy of the '''bc_dbase_M06_001.csv''' as '''bc_dbase_TC01_001.csv'''.
<li> Open the file and add the reference to the timeseries temperature data as shown below: 
 
[[File: TC1_bc_dbase_01a.png]] 
 
<li> Save the bc_dbase.
</ol>

= Materials =
Surface roughness or bed resistance values (e.g. Manning’s n) are assigned to material IDs. To simulate a more complex catchment area, more material IDs have been specified.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''materials_TC01_001.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. This file is a modified version of '''materials_M06_002.csv''' from [[Tutorial_M06#Materials_2 | TUFLOW Tutorial Module 6]].
<li>Open the file. Roughness values (Manning's n) have been applied to the five new material IDs: 
 
[[File: TC1_materials_01b.png]] 
 
<li>These new material IDs have been assigned to allow different pollutant export properties to be specified to each material ID. This is discussed in the [[#Pollutant_Export_Model | TUFLOW CATCH Control File]] section.
</ol>

= TUFLOW Soil File (.tsoilf) =
The soils (.tsoilf) file is similar to the materials file. A positive integer ID is assigned to each soil, then an infiltration method followed by the soil parameters. For this tutorial, there is only one soil type (ID 1) which is applied across the whole model.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''TC01_soils_001.tsoilf''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. 
<li>Open the file. The Green-Ampt (GA) infiltration method has been used. For more information on infiltration methods, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
 
[[File: TC1_soils_file_01a.png]] 
 
</ol>

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 
=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li> Save a copy of '''M02_001.tgc''' as '''TC01_001.tgc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC01_001.tgc''' in a text editor and add the following line after the '<tt>Read GIS Mat</tt>' command to reference the new materials GIS layer. 
<tt>Read GIS Mat == gis\2d_mat_TC01_001_R.shp ! Sets material values according to attributes in the GIS layer</tt> 
<li> Save the TGC.
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Save a copy of '''M06_003.tbc''' as '''TC01_001.tbc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC01_001.tbc''' in a text editor and remove or comment out the reference to the 2D boundaries using a '<tt>!</tt>' symbol. 
<tt>! Read GIS BC == gis\2d_bc_M01_001_L.shp ! Reads in downstream 2D boundary</tt> 
<li> Add the additional lines to reference the 1D/2D culvert connections: 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_M03_culverts_001_P.shp</tt> <tt> ! Links the 1D culverts to the 2D domain</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_M03_culverts_001_R.shp | gis\2d_bc_M03_culverts_001_L.shp</tt> <tt> ! Links the 1D culverts to the 2D domain</tt> 
<li>Save the TBC.
</ol>

=== TUFLOW ESTRY Control File (ECF) ===
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder, and open '''TC01_001.ecf''' in a text editor. This file was created using the TUFLOW CATCH plugin.
<li> In the '1D Time Control' section, ensure the following command has been specified to set the 1D computational timestep: 
<tt>Timestep </tt> <tt>== </tt> <tt>0.5</tt> <tt> ! Specifies a 1D computational timestep of 0.5 seconds</tt> 
<li> In the '1D Elements' section, add the following command to define the culverts: 
<tt>Read GIS Network </tt> <tt>== </tt> <tt>gis\1d_nwk_M03_culverts_001_L.shp</tt> <tt> ! Defines culverts</tt>
<li> Add the following command line to define the Advection Dispersion (AD) approach. For more information on Advection Dispersion, please refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
<tt>AD Approach == METHOD A ! Sets the modelling approach for the Advection Dispersion through 1D channels</tt>
<li>Save the ECF.
</ol>

== TUFLOW CATCH Control File (TCC) ==
A TUFLOW CATCH simulation is set up and executed by constructing a TUFLOW CATCH Control file (.tcc). TUFLOW Control file (.tcf) and TUFLOW FV Control file (.fvc) are not used. The .tcc has four command blocks:
<ol>
<li> Global commands
<li> Catchment Hydraulic Model (TUFLOW HPC) commands
<li> Catchment Pollutant Export Model
<li> Receiving Model (TUFLOW FV) commands
</ol>
All blocks must be included in the above order, but the later three can be switched on and off with a single command.

The TUFLOW CATCH plugin has created a .tcc template file in the '''TUFLOWCATCH\runs''' folder, '''TC01_001.tcc'''. This file has been populated with all the commands needed to execute a TUFLOW CATCH simulation. In this section, the template commands will be populated/updated for this tutorial model.

=== Global Settings ===
This section contains information that is applied equally to both TUFLOW HPC and TUFLOW FV.
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOWCATCH\runs''' folder and open '''TC01_001.tcc''' into a text editor.
<li> In the 'Simulation Settings' section, update the time commands: 
<tt>Start Time == 01/01/2021 10:00:00 ! Specifies the simulation start time</tt> 
<tt>End Time == 01/01/2021 13:00:00 ! Specifies the simulation end time</tt> 
<li> In the 'Boundary Condition Configuration' section, update the BC and CSV output intervals: 
<tt>Catch BC Output Interval Nodestring == 300 ! Outputs BC nodestring data every 300 seconds</tt> 
<tt>Catch BC Output Interval Lateral == 300 ! Outputs BC lateral data every 300 seconds</tt> 
<tt>CSV Write Frequency Day == 0.01 ! Writes CSV output every 0.01 days</tt> 
</ol>

=== Catchment Hydraulic Model (TUFLOW HPC) ===
This block contains commands that construct the TUFLOW HPC simulation. These commands are almost entirely those that would be used in setting up a standalone TUFLOW HPC control file (.tcf), with a small number of additional commands that relate to TUFLOW CATCH.
<ol>
<li> Set the catchment hydraulic model: 
<tt>Catchment Hydraulic Model == HPC </tt>

<li> Set the zero date. TUFLOW HPC does not support ISODATE format, while TUFLOW FV requires it. This command ensures compatibility by setting the date in TUFLOW FV ISODATE format that corresponds to zero hours in TUFLOW HPC boundary condition files. 
<tt>Zero Date == 01/01/2021 10:00 ! Specifies the simulation start time in TUFLOW FV ISODATE format</tt> 

<li> In the 'GIS' section, remove or comment out the following command using a '<tt>!</tt>' symbol. The SHP projection has already been set in the [[#Global_Settings |Global Settings]] section. 
<tt>! SHP Projection == ..\..\TUFLOW\model\gis\projection.shp</tt> 

<li> In the 'GIS' section, set the projection for the output grid files: 
<tt>TIF Projection == ..\..\TUFLOW\model\grid\DEM.tif ! Sets the GIS projection for the output grid files</tt> 

<li> In the 'Solver' section, set the timestep maximum and time format: 
<tt>Timestep Maximum == 2.5 ! Specifies a maximum timestep (seconds)</tt> 
<tt>Time Format == TUFLOWFV ! Specifies the time format of output results</tt> 

<li> In the 'SGS' section, set the sample target distance: 
<tt>SGS Sample Target Distance == 0.5 ! Sets SGS Sample Target Distance (meters)</tt> 

<li> In the 'Control Files' section, ensure all control files are referenced. 
<tt>Geometry Control File == ..\..\TUFLOW\model\TC01_001.tgc ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File == ..\..\TUFLOW\model\TC01_001.tbc ! Reference the TUFLOW Boundary Conditions Control File</tt> 
<tt>BC Database == ..\..\TUFLOW\bc_dbase\bc_dbase_TC01_001.csv ! Reference the Boundary Conditions Database</tt> 
<tt>Read Materials File == ..\..\TUFLOW\model\materials_TC01_001.csv ! Reference the Materials Definition File</tt> 
<tt>Rainfall Control File == ..\..\TUFLOW\model\M06_point2grid_003.trfc ! Reference the TUFLOW Rainfall Control File</tt> 
<tt>ESTRY Control File == ..\..\TUFLOW\model\TC01_001.ecf ! Reference the ESTRY (1D) Control File</tt> 

<li> In the 'Soils' section, reference the soils file (.tsoilf), and define the soil parameters: 
<tt>Read Soils File == ..\..\TUFLOW\model\TC01_soils_001.tsoilf ! Reference the Soils File</tt> 
<tt>Soil Negative Rainfall Approach == FACTOR </tt> 
<tt>Soil Negative Rainfall Factor == 0.2 </tt> 

<li> In the 'Pollutant Configuration' section, reference the receiving polygon and set the pollutants. In this tutorial, salinity, temperature, dissolved oxygen (WQ_DISS_OXYGEN_MG_L), alive and dead ecoli (WQ_PATH_ECOLI_ALIVE/DEAD_CFU_100ML) and clay sediment (SED_CLAY) are simulated. 
<tt>Receiving Polygon == ..\..\TUFLOW\model\gis\2d_rp_TC01_001_R.shp ! GIS layer defining the receiving polygon</tt> 
<tt>Pollutant == Salinity, Temperature, WQ_DISS_OXYGEN_MG_L, WQ_PATH_ECOLI_ALIVE_CFU_100ML, WQ_PATH_ECOLI_DEAD_CFU_100ML, SED_CLAY ! Specify the pollutant names </tt> 

<li> In the 'Output Map Configuration' section, update the following commands to set the map output formats, the map output interval, map cuttoff depth and to define the TIF output parameters. 
<tt>Map Output Format == XMDF TIF ! Result file types</tt> 
<tt>Map Output Data Types == catch h v d ! Output data types</tt> 
<tt>Map Output Interval == 30 ! Interval of output map data (seconds)</tt> 
<tt>Map Cutoff Depth == 0.05 ! Sets map cutoff depth (meters)</tt> 
<tt>TIF Map Output Interval == 0 ! Interval of output TIF map data (seconds)</tt> 
<tt>TIF Map Output Data Types == h d dt ! TIF result file types</tt> 
</ol>

===Pollutant Export Model===
This block contains commands that control the pollutant export (and other constituent) simulation.
<ol>
<li> Set the pollutant export model: 
<tt>Catchment Pollutant Export Model == Mass Accumulation Release </tt>

<li> In the 'Constant Concentrations' section, add the following commands. They set the pollutants 'Salinity' and 'WQ_DISS_OXYGEN_MG_L' (dissolved oxygen) to a constant concentration value that is applied equally to all boundaries and summary files where appropriate. 
<tt>Constant Salinity == 0.0 ! Specify the constant concentration of salinity</tt> 
<tt>Constant WQ_DISS_OXYGEN_MG_L == 8.0 ! Specify the constant concentration of dissolved oxygen</tt> 

<li> In the 'Time Series' section, add the following command. It sets the pollutant 'Temperature' to be a time-series input, and points to the name 'temp' in the bc_dbase. 
<tt>Time-Series Temperature == temp ! Specify temperature as a timeseries and the corresponding BC database name</tt> 

<li>In the 'Pollutant Export Properties' section, add the material block '<tt>ALL</tt>' (<tt>Material == ALL</tt>) from the page linked below. This code block defines the default pollutant export properties for each pollutant. Once uniform conditions are set, progressive specifications of material by material pollutant behaviour can be set. These specifications override previous settings on a spatial basis. Including the default (<tt>ALL</tt>) material block is considered best practice, as it ensures that all pollutants have export properties defined across the entire TUFLOW HPC domain, otherwise an error will occur. For more information on the pollutant export parameters, refer to [https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpPE-4 Section 4.5.3.3 of the TUFLOW CATCH Manual].
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Default_.28ALL.29 | Pollutant Export Properties: ALL]] 

<li>To set the pollutant export properties for the different material IDs, blocks similar to the above (e.g. <tt>Material == 4</tt>) can be used. The material IDs correspond to those defined in the '''2d_mat_TC01_001.shp''' and '''2d_mat_M01_001.shp''' GIS layers. 
 
To estimate E. coli export rates for each paddock, the area of each paddock was calculated. Based on this, appropriate animal populations were assigned. Using these values, the E. coli rates were calculated. For more information on pollutant export calculations, refer to [https://docs.tuflow.com/catch/manual/2025.0/ProcessDescriptions-1.html#ProcessDescriptionsMats-3 Section 3.2.3 of the TUFLOW CATCH Manual]. 
 
[[File: TC1_aerial_with_paddocks_01a.png|left]]
 
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Material ID
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Paddock Name
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Area (ha)
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Animals
|-
|6||paddockA||1.5|| 23 Sheep, 7 Lambs
|-
|7||paddockB||0.3||2 Cows
|-
|8||paddockC||1.2||20 Sheep
|-
|9||paddockD || 1||4 Cows, 2 Calves
|}
 
 

<li> Set the pollutant export properties for material ID 1. This is the material ID for all areas within the model domain not covered by a material region. These pollutant export properties define the release and deposition of clay sediment. Sediment pollutants generally use the 'Shear1' method. For more information on 'Shear1', refer to [https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpSS-5 Section 4.5.3.3.2 of the TUFLOW CATCH Manual]. 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Model_Area_.281.29 | Pollutant Export Properties: 1]]

<li>Set the pollutant export properties for material ID 4 (waterholes, eddies, etc). These properties define settling (deposition velocity) of alive and dead E. coli to 2 meters per day (approx 25cm during the simulation). 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Slow_Moving_Water_.284.29 | Pollutant Export Properties: 4]]

<li>Set the pollutant export properties for material ID's 6 (paddockA), 7 (paddockB), 8 (paddockC) and 9 (paddockD). These properties define the accumulation (rate) and washoff of alive and dead E. coli for the animals on the paddock. 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Paddocks_.286.2C_7.2C_8_and_9.29 | Pollutant Export Properties: 6, 7, 8, 9]]

<li> For this tutorial, leave all interventions commands as is. This section of the .tcc will be discussed in [[TUFLOW_CATCH_Tutorial_M02 |TUFLOW CATCH Tutorial 02]].
<li> Save the .tcc.
</ol>

===Receiving Model (TUFLOW FV)===
For this tutorial, leave all commands as is. This section of the .tcc will be populated in [[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]].

=Running the Simulation=
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. The TUFLOW CATCH plugin created a batch file (.bat) that references the .tcc called '''Demonstration.bat'''.
<li>Save a copy of '''Demonstration.bat''' as '''_run_TC01_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the TUFLOW CATCH executable: 
<tt>set exe="..\..\..\..\exe\TUFLOWCATCH\2025.1.0\TUFLOWCATCH.exe"</tt> 
<tt>%exe% TC01_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation.
</ol>

=Troubleshooting=
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]

=Check Files and Results Output=
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH pollutant export model simulation:
:*[[TUFLOW_CATCH_Tutorial_M01_Check_Files_QGIS | TC01 - Check Files]] 
:*[[TUFLOW_CATCH_Tutorial_M01_Results_QGIS | TC01 - Results]] 

=Reviewing Model Performance=
There are a number of useful outputs from TUFLOW CATCH for reviewing the model performance.

===TUFLOW CATCH Log File (.catchlog)===
The first file to review is the TUFLOW CATCH Log File (.catchlog). The <tt>Log Folder == log</tt> command in the .tcc controls where the .catchlog is written. 
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001.catchlog''' file in a text editor. It contains a summary of the TUFLOW CATCH simulation. The following are the key points to review: 
* '''Global Settings:''' The commands from the 'Global Settings' section of the .tcc are echoed here. Review these to confirm that the correct settings have been applied. 
:[[File: TC1_catchlog_01b.png]] 
* '''Simulation Configuration:''' The .catchlog outlines which models have been used and what simulation configuration has been run. In this tutorial, the catchment hydraulic and pollutant export models have been applied, indicating a pollutant export configuration. 
:[[File: TC1_catchlog_02a.png]] 
* '''Run Status:''' At the end of the file, a message will confirm the simulation outcome.
:* If successful, it will state 'Run Successful' 
::[[File: TC1_catchlog_03b.png]] 
:* If an issue occurred, the simulation will stop and an error message will be reported. An example error is shown in the image below.
::'''Note:''' Each TUFLOW CATCH error message has a corresponding wiki page that provides further details about the error, and suggestions for how to fix the issue. Refer to [[5xxx_TUFLOW_Messages | 5xxx Messages]] for a list of all TUFLOW CATCH related error messages. 
::[[File: TC1_catchlog_04c.png]] 

===Other Log Files===
Once the .catchlog has been reviewed, it is recommended to check the TUFLOW Log File (.tlf) if the catchment hydraulic model has been specified and to check the TUFLOW FV Log File (.log) if the receiving model has been specified. These files contain TUFLOW and TUFLOW FV specific check, warning and error messages.

====TUFLOW Log File (.tlf)====
Since the catchment hydraulic model is specified in this tutorial, review the TUFLOW Log File. The <tt>Log Folder == log</tt> command in the .tcc defines where the .tlf is written 
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001_catchment_hydraulic.tlf''' file in a text editor.
* Scroll down to the bottom to 'Simulation Summary'. This includes information about the computation time, messages, volume calculations and mass error.
* Review any check, warning or error messages.
* For more information on reviewing TUFLOW log outputs, refer to [[HPC_Model_Review | HPC Model Review]].

====TUFLOW FV Log File (.log)====
The receiving model has not been specified in this tutorial, so no TUFLOW FV Log File (.log) has been created. The TUFLOW FV Log File will be reviewed in [[TUFLOW_CATCH_Tutorial_M03#Reviewing_Model_Performance | TUFLOW CATCH Tutorial 03]].

=Conclusion=
* A TUFLOW CATCH Pollutant Export model was created. A downstream receiving polygon was used to track pollutants in the receiving waters.
* Check files were used to review the transfer from the Catchment Hydraulic model (TUFLOW HPC) into the receiving polygon.
* TUFLOW CATCH time series results and TUFLOW map outputs were assessed to observe the pollutant behaviours.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

TUFLOW CATCH Tutorial M03

2025-10-23T06:07:35Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, a TUFLOW CATCH hydrology model is developed. 

TUFLOW CATCH Tutorial 03 is built from the model created in [[TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 02]]. The completed TUFLOW CATCH Tutorial 02 is provided in the '''TUFLOW_CATCH_Module_03\Modelling''' folder of the download dataset as the starting point for this tutorial.
If unfamiliar with TUFLOW CATCH, it is recommended to complete [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]] and [[TUFLOW_CATCH_Tutorial_M02 | TUFLOW CATCH Tutorial 02]] prior to starting this tutorial.

= GIS Inputs =
Create, import and view input data:
:*[[TUFLOW_CATCH_Tutorial_M03_TUFLOW_HPC_GIS_Inputs_QGIS | TC03 - TUFLOW HPC GIS Inputs]]
:*[[TUFLOW_CATCH_Tutorial_M03_TUFLOW_FV_GIS_Inputs_QGIS | TC03 - TUFLOW FV GIS Inputs]]

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Save a copy of '''TC01_001.tbc''' as '''TC03_001.tbc''' in the '''TUFLOW_CATCH_Module_03\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC03_001.tbc''' in a text editor and update the reference to the 1D/2D culvert connections: 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_TC03_001_P.shp</tt> <tt> ! Links the two upstream 1D culverts to the 2D domain</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_TC03_001_L.shp</tt> <tt> ! Links the two upstream 1D culverts to the 2D domain</tt> 
<li>Save the TBC.
</ol>

=== TUFLOW ESTRY Control File (ECF) ===
<ol>
<li> Save a copy of '''TC01_001.ecf''' as '''TC03_001.ecf''' in the '''TUFLOW_CATCH_Module_03\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC03_001.ecf''' in a text editor and update the following line to reference the new 1d_nwk layer (containing the two upstream culverts): 
<tt>Read GIS Network </tt> <tt>== </tt> <tt>gis\1d_nwk_TC03_001_L.shp</tt> <tt> ! Defines the two upstream culverts</tt>
<li>Save the ECF.
</ol>

== TUFLOW CATCH Control File (TCC) ==
=== Global Settings ===
For this tutorial, leave all commands as is. This section of the .tcc was populated in [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]].

=== Catchment Hydraulic Model ===
This block contains commands that construct the TUFLOW HPC simulation.
<ol>
<li> Save a copy of '''TC02_001.tcc''' as '''TC03_001.tcc''' in the '''TUFLOW_CATCH_Module_03\Modelling\TUFLOWCATCH\runs''' folder.
<li> Open '''TC03_001.tcc''' in a text editor, and update the following commands to reference the new TBC and ECF: 
<tt>BC Control File == ..\..\TUFLOW\model\TC03_001.tbc ! Reference the TUFLOW Boundary Conditions Control File</tt> 
<tt>ESTRY Control File == ..\..\TUFLOW\model\TC03_001.ecf ! Reference the ESTRY (1D) Control File</tt> 

<li> Remove or comment out the following command using a '<tt>!</tt>' symbol. The receiving polygon can only be used in the pollutant export configuration of TUFLOW CATCH. 
<tt>! Receiving Polygon == ..\..\TUFLOW\model\gis\2d_rp_TC01_001_R.shp ! GIS layer defining the receiving polygon</tt> 
</ol>

=== Pollutant Export Model ===
This block contains commands that control the pollutant export (and other constituent) simulation. As this tutorial model is a hydrology simulation, we must set the pollutant export model to 'None', and comment out all commands. The pollutant export model block should look similar to the below: 
:<tt>Catchment Pollutant Export Model == None</tt> 
::<tt>! Constant Salinity == 0.0</tt> 
::<tt>! Constant WQ_DISS_OXYGEN_MG_L == 8.0</tt> 
::<tt>! Time-Series Temperature == temp</tt> 
::<tt>! Material == ALL ! Default parameters for all materials</tt> 
:::<tt> ! SED_CLAY, Method == Shear1, Rate == 0.0, Limit == 100.0, Depth Threshold == 0.02, Deposition Stress == 0.1, Erosion Stress == 0.5, Deposition Velocity == 0.1, Erosion Rate == 0.05</tt> 
:::<tt> ! WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Washoff1, Rate == 0.0, Limit == 0.0, Time Constant == 3600.00, Rain Threshold == 1.0, Depth Threshold == 0.20, Deposition Velocity == 0.0</tt> 
:::<tt> ! WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Washoff1, Rate == 0.0, Limit == 0.0, Time Constant == 3600.00, Rain Threshold == 1.0, Depth Threshold == 0.20, Deposition Velocity == 0.0</tt> 
::<tt>! End Material </tt> 
::<tt>! Other material specifications ...</tt> 
::<tt>! Read GIS Intervention == ..\..\TUFLOW\model\gis\2d_im_TC02_001_L.shp ! GIS layer defining interventions</tt> 
::<tt>! Device == ALL ! Default parameters for all devices</tt> 
:::<tt> ! SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
:::<tt> ! WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
:::<tt> ! WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
::<tt>! End Device</tt> 
::<tt>! Other mass removal specifications ...</tt> 
:<tt>End Catchment Pollutant Export Model </tt> 

=== Receiving Model ===
This block contains commands that construct the TUFLOW FV simulation. These commands are almost entirely those that would be used in setting up a standalone TUFLOW FV control file (.fvc), with a small number of additional commands that relate to TUFLOW CATCH.
<ol>
<li> Set the receiving model: 
<tt>Receiving Model == TUFLOWFV </tt>

<li>Above the 'Hardware' section, add the following command. This command allows the simulation to proceed if minor timestepping mismatches occur in the boundary condition timeseries files (written by TUFLOW CATCH). 
<tt>Global Temporal Extrapolation Check == WARNING </tt> 

<li>In the 'Timestep Commands' section, update the following commands: 
<tt>CFL == 0.95 ! Specify the Courant–Friedrichs–Lewy (CFL) number</tt> 
<tt>Timestep Limits == 0.10,1.0 ! Specify the minimum and maximum timesteps (seconds)</tt> 
<tt>Display dt == 30 ! Interval of displaying timestep information to the log (seconds)</tt> 

<li>In the 'Model Parameters' section, update the following commands. All other commands in this section relate to 3D modelling, so they can be removed or ignored. 
<tt>Stability Limits == 100.0, 10.0 ! Specify maximum water level (meters) and velocity (m/s) which indicate an unstable model</tt> 
<tt>Momentum Mixing Model == Smagorinsky ! Specify the momentum mixing model</tt> 
<tt>Global Horizontal Eddy Viscosity == 0.2 ! Specify the Smagorinsky coefficient</tt> 
<tt>Global Horizontal Eddy Viscosity Limits == 0.05, 99999. ! Specify the minimum and maximum eddy viscosity (m2/s)</tt> 
<tt>Scalar Mixing Model == Smagorinsky ! Specify the scalar mixing model</tt> 
<tt>Global Horizontal Scalar Diffusivity == 0.2 ! Specify the Smagorinsky coefficient</tt> 
<tt>Global Horizontal Scalar Diffusivity Limits == 0.05, 99999. ! Globally sets the minimum and maximum horizontal scalar diffusivity limits</tt> 

<li>At the end of the 'Model Parameters' section, add the following command to set the cell wetting and drying depths: 
<tt>Cell Wet/Dry Depths == 5.0e-03, 5.0e-02 ! Specify the cell wetting and drying depths (meters)</tt> 

<li>In the '2D Geometry' section, update the following commands to reference the TUFLOW FV mesh and the model domain: 
<tt>Geometry 2D == ..\..\TUFLOWFV\model\geo\Stream_Mesh.2dm ! 2D geometry input file (mesh file)</tt> 
<tt>Read Grid Zpts == ..\..\TUFLOWFV\model\geo\DEM.asc ! Assigns the elevation of Zpts from the grid</tt> 

<li>In the 'Materials' section, update/add the following commands. They reference the TUFLOW FV materials GIS layer and specify the surface roughness or bed resistance values (e.g. Manning’s n) assigned to each material ID within the TUFLOW FV model domain. These are distinct materials from those specified in the catchment hydraulic model. 
<tt>Set Mat == 1 ! Sets the default material ID for all cells in the TUFLOW FV model domain</tt> 
<tt>Read GIS Mat == ..\..\TUFLOWFV\model\gis\2d_mat_TC03_FV_001_R.shp ! Sets the TUFLOW FV material values according to attributes in the GIS layer</tt> 
<tt>Material == 1 ! Defines properties for material ID 1</tt>
:<tt>Bottom Roughness == 0.011 ! Specify the Manning's roughness</tt> 
<tt>End Material</tt> 
<tt>Material == 2 ! Defines properties for material ID 2</tt> 
:<tt>Bottom Roughness == 0.015 ! Specify the Manning's roughness</tt> 
<tt>End Material</tt> 
<tt>Material == 3 ! Defines properties for material ID 3</tt> 
:<tt>Bottom Roughness == 0.017 ! Specify the Manning's roughness</tt> 
<tt>End Material</tt> 

<li>In the 'Initial Conditions' section, update the following command to set the initial water level: 
<tt>Initial Water Level == 35.0 ! Specify initial water level (meters)</tt> 

<li>In the 'Non-Catchment Boundaries' section, update the following commands to reference the downstream TUFLOW FV normal (friction slope) boundary and to define its boundary conditions. 
<tt>Read GIS Nodestring == ..\..\TUFLOWFV\model\gis\2d_ns_TC03_DS_boundary_001_L.shp ! GIS nodestring layer defining non-catchment boundary(ies)</tt> 
<tt>BC == QN, DS, 0.001 ! Defines BC type, BC name and friction slope</tt> 
<tt>End BC</tt> 

<li>In the 'Catchment Boundaries' section, update the following command to reference the upstream (inflow) TUFLOW FV boundary. TUFLOW CATCH uses this nodestring to automatically write boundaries that include momentum from catchment hydraulic model predictions. For more information, refer to [https://docs.tuflow.com/catch/manual/2025.1/SimulationConstruction-1.html#SCTCCFV-3 Section 4.5.4 of the TUFLOW CATCH Manual]. 
<tt>Catchment BC Nodestring == ..\..\TUFLOWFV\model\gis\2d_ns_TC03_US_boundary_001_L.shp ! GIS nodestring layer defining catchment boundary(ies) that include momentum</tt> 

<li>Above the 'Outputs' section, add the following commands to reference the downstream TUFLOW FV culvert and its parameters. 
<tt>Read GIS Nodestring == ..\..\TUFLOWFV\model\gis\2d_ns_TC03_culverts_001_L.shp ! GIS nodestring layer defining the downstream culvert</tt> 
<tt>Read GIS Nodestring == ..\..\TUFLOWFV\model\gis\2d_ns_TC03_weir_001_L.shp ! GIS nodestring layer enforcing the road crest at the downstream culvert</tt> 
<tt>Structure == Linked Nodestrings, FC01.2_R_US, FC01.2_R_DS ! Defines the structure type, culvert US nodestring ID, culvert DS nodestring ID</tt> 
:<tt>Flux Function == Culvert ! Culvert flux function </tt> 
:<tt>Culvert File == ..\..\TUFLOWFV\model\csv\TC03_culvert_dbase_001.csv, 1 ! Reference the culvert database and the number of culverts </tt>
<tt>End Structure</tt> 
<tt>Structure == Nodestring, FC01.2_W ! Defines the structure type and the nodestring ID</tt> 
:<tt>Flux Function == Weir_dz ! Weir_dz flux function </tt> 
:<tt>Properties == 0.1, 1.705 ! Defines the weir height above face elevation (meters) and the weir coefficient</tt>
<tt>End Structure</tt> 

<li>In the 'Outputs' section, update/add the following commands. Ensure that the 'Flux' block is removed or commented out. 
<tt>Output == NetCDF </tt> 
:<tt>Output Parameters == h, v, d ! Outputs water level, velocity and depth </tt> 
:<tt>Output Interval == 30 ! Interval to output the data (seconds) </tt> 
:<tt>Suffix == HD ! Specify suffix for the output NetCDF file </tt>
<tt>End Output</tt> 
<tt>Output == Mass </tt> 
:<tt>Output Interval == 30 ! Interval to output the data (seconds) </tt>
<tt>End Output</tt> 

<li>Remove or comment out the following commands: 
<tt>! Write Restart dt == 24</tt> 
<tt>! Restart Overwrite == 1 </tt> 

<li> Save the .tcc.
</ol>

= Running the Simulation =
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. Save a copy of '''_run_TC02_CATCH.bat''' as '''_run_TC03_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the '''TC03_001.tcc''': 
<tt>set exe="..\..\..\..\exe\TUFLOWCATCH\2025.1.0\TUFLOWCATCH.exe"</tt> 
<tt>%exe% TC03_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation. 
</ol>

= Troubleshooting =
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]

= Check Files and Results Output =
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH hydrology model simulation:
:*[[TUFLOW_CATCH_Tutorial_M03_Check_Files_QGIS | TC03 - Check Files]] 
:*[[TUFLOW_CATCH_Tutorial_M03_Results_QGIS | TC03 - Results]] 

=Reviewing Model Performance=
As discussed in [[TUFLOW_CATCH_Tutorial_M01#Reviewing_Model_Performance | TUFLOW CATCH Tutorial 01]], there are a number of useful outputs from TUFLOW CATCH for reviewing the model performance. 
In this tutorial, the receiving model was specified. As such, the TUFLOW FV Log File (.log) should be reviewed. The <tt>Log Folder == log</tt> command in the .tcc defines where the .log is written. 
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC03_001_receiving.log''' file in a text editor.
* Scroll down to the bottom to 'Simulation Summary'. This includes information about the computation time and messages. If an error occurred (stopping the simulation), the error message will be output just above the 'Simulation Summary'.
* Review any check, warning or error messages.

'''Note:''' It is recommended to check all simulation log files at the end of each run. For this tutorial, the catchment hydraulic and receiving models were specified, so '''TC03_001.catchlog''', '''TC03_001_catchment_hydraulic.tlf''' and '''TC03_001_receiving.log''' should all be reviewed.

= Conclusion =
* A TUFLOW CATCH Hydrology model was created.
* A TUFLOW FV mesh was added to the stream and the downstream culvert was redefined in TUFLOW FV format.
* A TUFLOW CATCH JSON file was created to review the transfer of results between the TUFLOW HPC and the TUFLOW FV domains.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

TUFLOW CATCH Tutorial M02

2025-10-23T06:07:03Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, a TUFLOW CATCH pollutant export model with interventions is developed. Interventions are representative of water quality pollutant treatment infrastructure. 

TUFLOW CATCH Tutorial 02 is built from the pollutant export model created in [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]]. The completed TUFLOW CATCH Tutorial 01 is provided in the '''TUFLOW_CATCH_Module_02\Modelling''' folder of the download dataset as the starting point for this tutorial.
If unfamiliar with TUFLOW CATCH, it is recommended to complete [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]] prior to starting this tutorial.

= GIS Inputs =
Create, import and view input data:
:*[[TUFLOW_CATCH_Tutorial_M02_GIS_Inputs_QGIS | TC02 - GIS Inputs]]

= Treatment Tables =
Treatment tables can be used in TUFLOW CATCH models with interventions. Treatment tables are one of the mass removal methods offered by TUFLOW CATCH. A treatment table is a two dimensional array that defines the proportion of pollutant mass removed from the incoming water based on:
* Incoming pollutant concentration: The concentration of a given pollutant entering the treatment device.
:''Note:'' The concentration units depend on the pollutant. Refer to [https://docs.tuflow.com/catch/manual/2025.1/SimulationConstruction-1.html#SCTCCPollExpUnits-5 Section 4.5.3.3.3 of the TUFLOW CATCH Manual] for details on unit conventions.
* Flow rate: The volume of water passing through the treatment device (m³/s).
Treatment tables allow users to vary pollutant removal efficiency. This recognises that some intervention devices perform better when pollutants enter at higher concentrations and lower flow rates, rather than at lower concentrations with higher flow rates. For more information about treatment tables and their properties, please refer to [https://docs.tuflow.com/catch/manual/2025.1/ProcessDescriptions-1.html#ProcessDescriptionsIntervMatrix-4 Section 3.3.1.2 of the TUFLOW CATCH Manual].

For this tutorial, treatment tables for E. coli and clay have been provided:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_02\Tutorial_Data''' folder. Copy the '''TC02_ecoli_treatment_001.csv''' and '''TC02_clay_treatment_001.csv''' and paste them in the '''TUFLOW_CATCH_Module_02\Modelling\TUFLOW\bc_dbase''' folder.
<li>Open the '''TC02_ecoli_treatment_001.csv'''. The first row (below the title) defines the incoming concentration (cfu/100mL) and the first column defines the incoming flow rate (m³/s). The other values are the mass removal factors, which define the proportion of pollutant removed for a given concentration and flow rate. For example, for an incoming concentration of 200000 cfu/100mL and an incoming flow rate of 1 m³/s, the removal factor is 0.2. The concentration and flow ranges were determined from the outputs of the previous tutorial model ([[TUFLOW_CATCH_Tutorial_M01 |TUFLOW CATCH Tutorial 01]]). 
 
[[File: TC2_treatment_table_ecoli_01b.png]] 
 
<li>Open the '''TC02_clay_treatment_001.csv'''. This file follows the same structure as the E. coli treatment table, however the incoming concentrations are in mg/L instead of cfu/100mL. 
 
[[File: TC2_treatment_table_clay_01b.png]] 
 
</ol>

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 

== TUFLOW CATCH Control File (TCC) ==
=== Global Settings ===
For this tutorial, leave all commands as is. This section of the .tcc was populated in [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]].

=== Catchment Hydraulic Model ===
For this tutorial, leave all commands as is. This section of the .tcc was populated in [[TUFLOW_CATCH_Tutorial_M01 | TUFLOW CATCH Tutorial 01]].

=== Pollutant Export Model ===
This block contains commands that control the pollutant export (and other constituent) simulation. For this tutorial, the pollutant export model block must be updated to include interventions.
<ol>
<li> Save a copy of '''TC01_001.tcc''' as '''TC02_001.tcc''' in the '''TUFLOW_CATCH_Module_02\Modelling\TUFLOWCATCH\runs''' folder. Open '''TC02_001.tcc''' in a text editor.
<li> In the 'Interventions' section, update the following command to reference the interventions (2d_im) layer created earlier in this tutorial. 
<tt>Read GIS Intervention == ..\..\TUFLOW\model\gis\2d_im_TC02_001_L.shp ! GIS layer defining interventions</tt> 

<li>In the 'Mass Removal Properties' section, add the following device block. This block defines the default mass removal properties for all pollutants across all devices. Including it is considered best practice, as it ensures that all devices have their mass export properties specified. For more information on the mass removal parameters, please refer to [https://docs.tuflow.com/catch/manual/2025.1/SimulationConstruction-1.html#SCTCCPollExpInter-4 Section 4.5.3.5 of the TUFLOW CATCH Manual]. 
<tt>Device == ALL ! Default parameters for all devices</tt> 
:<tt>SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 1.0</tt> 
<tt>End Device</tt> 

<li>Set the mass removal properties for intervention devices 'trench1' and 'trench2'. These devices are placed around the edges of paddocks C and D to manage the E. coli runoff. 
<tt>Device == trench1, trench2 ! Defines mass removal properties for trench1 and trench2</tt> 
:<tt>SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 0.4</tt> 
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.9</tt> 
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.9</tt> 
<tt>End Device</tt> 

<li>Set the mass removal properties for intervention device 'retentionBasin'. This device is place parallel to the road on the eastern side of the model. It has been placed between paddockB and the culvert under the road to minimise clay and E. coli runoff. 
<tt>Device == retentionBasin ! Defines mass removal properties for retentionBasin</tt> 
:<tt>SED_CLAY, Method == Eqn, Eqn == Constant, Coefficients == 0.8</tt> 
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC02_ecoli_treatment_001.csv</tt> 
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC02_ecoli_treatment_001.csv</tt> 
<tt>End Device</tt> 

<li> Set the mass removal properties for intervention devices 'bufferStrip1' and 'bufferStrip2'. These devices are placed strategically to manage clay sediment runoff. 
<tt>Device == bufferStrip1, bufferStrip2 ! Defines mass removal properties for bufferStrip1 and bufferStrip2</tt> 
:<tt>SED_CLAY, Method == Table, Path == ..\..\TUFLOW\bc_dbase\TC02_clay_treatment_001.csv</tt> 
:<tt>WQ_PATH_ECOLI_ALIVE_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.4</tt> 
:<tt>WQ_PATH_ECOLI_DEAD_CFU_100ML, Method == Eqn, Eqn == Constant, Coefficients == 0.7</tt> 
<tt>End Device</tt> 

<li> Save the .tcc.
</ol>

=== Receiving Model ===
For this tutorial, leave all commands as is. This section of the .tcc will be populated in [[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]].

= Running the Simulation =
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. Save a copy of '''_run_TC01_CATCH.bat''' as '''_run_TC02_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the '''TC02_001.tcc''': 
<tt>set exe="..\..\..\..\exe\TUFLOWCATCH\2025.1.0\TUFLOWCATCH.exe"</tt> 
<tt>%exe% TC02_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation. 
</ol>

= Troubleshooting =
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]

= Check Files and Results Output =
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH pollutant export model simulation:

:*[[TUFLOW_CATCH_Tutorial_M02_Check_Files_QGIS | TC02 - Check Files]] 
:*[[TUFLOW_CATCH_Tutorial_M02_Results_QGIS | TC02 - Results]] 

= Conclusion =
* Intervention devices were added to a TUFLOW CATCH Pollutant Export model.
* Check files were used to review the placement of intervention devices.
* TUFLOW CATCH interventions summary and TUFLOW map outputs were assessed to observe the mass removal for each intervention device.
* For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}

TUFLOW CATCH Tutorial M01

2025-10-23T06:06:40Z

Pavlina Monhartova: /* Conclusion */

= Introduction =
In this module, a TUFLOW CATCH pollutant export model is developed. 

TUFLOW CATCH Tutorial 01 is built from the model created in [[Tutorial_M06#Part_3_-_Rainfall_Control_File | TUFLOW Tutorial Module 6 - Part 3]]. The completed TUFLOW Module 6 (part 3) is provided in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW''' folder of the download dataset as the starting point for this tutorial. If unfamiliar with TUFLOW, it is recommended to complete Modules 1, 2, 3 and 6 of the [[Tutorial_Introduction | TUFLOW Tutorials]] to establish an understanding of 1D and 2D TUFLOW modelling, including direct rainfall models.

= Project Initialisation =
TUFLOW CATCH models are separated into a series of folders which contain the input and output files. The recommended directory structure for TUFLOW CATCH models consists of a top-level folder, '''Modelling''', which contains three subfolders:
* '''TUFLOW''': Contains TUFLOW HPC input files.
* '''TUFLOWCATCH''': Contains the TUFLOW CATCH Control file, as well as all check, results and log files.
* '''TUFLOWFV''': Contains TUFLOW FV input files.
The third level subfolders are outlined below. For a more detailed description, refer to the [https://docs.tuflow.com/catch/latest/ TUFLOW CATCH Manual]. For more information on TUFLOW HPC or TUFLOW FV folder structures, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual] or the [https://downloads.tuflow.com/TUFLOWFV/Releases/Latest/TUFLOW_FV_User_Manual.pdf TUFLOW FV Manual]. 
<ol>
[[File:TC1_folder_structure_01a.png|left]]
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white;" | Folder
! style="background-color:#005581; font-weight:bold; color:white;" width=10%| Sub-Folder (s)
! style="background-color:#005581; font-weight:bold; color:white;" width=75%| Description
|-
|rowspan="3" style="text-align: center;"|TUFLOW
| bc_dbase model|| Follows standard TUFLOW structure.
|-
| catch || Not used, but generated for internal use. It holds files that are produced during computation, but deleted when the simulation finishes successfully.
|-
| check results runs || Not used, but generated for internal use. All TUFLOW check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|-
|rowspan="6" style="text-align: center;"|TUFLOWCATCH
| bc_dbase|| Contains the output boundary condition and time-series data.
|-
| check || Contains the GIS and other check files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV to carry out quality control checks
|-
| model || Not used - generated for internal use.
|-
| results|| Contains the result files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
| runs|| Contains the .tcc simulation control file.
|-
| runs\log || Contains the log files (e.g. .catchlog, .tlf, .log, etc) and _messages.shp files produced by TUFLOW CATCH, TUFLOW and TUFLOW FV.
|-
|rowspan="2" style="text-align: center;"|TUFLOWFV
| bc_dbase model stm wqm|| Follows standard TUFLOW FV structure.
|-
| check results runs || Not used, but generated for internal use. All TUFLOW FV check and results files are written to the '''TUFLOWCATCH\check''' folder and the '''TUFLOWCATCH\results''' folder respectively. TUFLOW CATCH simulations are run from the .tcc file in the '''TUFLOWCATCH\runs''' folder.
|}
</ol>

The TUFLOW CATCH folders can be set up manually, or automatically through the TUFLOW CATCH QGIS Plugin (recommended).
:*[[TUFLOW_CATCH_Tutorial_M01_Project_Initialisation_QGIS | TUFLOW CATCH Project Initialisation]]

= GIS Inputs =
Create, import and view input data:
:*[[TUFLOW_CATCH_Tutorial_M01_GIS_Inputs_QGIS | TC01 - GIS Inputs]]

= TUFLOW Boundary Condition Database (bc_dbase) =
Update the bc_dbase with a reference to the timeseries temperature data:
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''temperature.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\bc_dbase''' folder. This file contains the timeseries temperature data.
<li> Open the file. As this file will be read by TUFLOW CATCH, the first column must contain the date in ISODATE format (DD/MM/YYYY hh:mm:ss). It will also be read by TUFLOW HPC, and therefore must have a column specifying a time in hours from the beginning of the model. In this case, the 'TUFLOW_Time' column contains the time in hours. For example, 01/01/2021 10:00:00 corresponds to 0, 01/01/2021 11:00:00 to 1, and so on. 
 
[[File: TC1_temperature_csv_01a.png]] 
 
<li> In the '''TUFLOW\bc_dbase''' folder, save a copy of the '''bc_dbase_M06_001.csv''' as '''bc_dbase_TC01_001.csv'''.
<li> Open the file and add the reference to the timeseries temperature data as shown below: 
 
[[File: TC1_bc_dbase_01a.png]] 
 
<li> Save the bc_dbase.
</ol>

= Materials =
Surface roughness or bed resistance values (e.g. Manning’s n) are assigned to material IDs. To simulate a more complex catchment area, more material IDs have been specified.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''materials_TC01_001.csv''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. This file is a modified version of '''materials_M06_002.csv''' from [[Tutorial_M06#Materials_2 | TUFLOW Tutorial Module 6]].
<li>Open the file. Roughness values (Manning's n) have been applied to the five new material IDs: 
 
[[File: TC1_materials_01b.png]] 
 
<li>These new material IDs have been assigned to allow different pollutant export properties to be specified to each material ID. This is discussed in the [[#Pollutant_Export_Model | TUFLOW CATCH Control File]] section.
</ol>

= TUFLOW Soil File (.tsoilf) =
The soils (.tsoilf) file is similar to the materials file. A positive integer ID is assigned to each soil, then an infiltration method followed by the soil parameters. For this tutorial, there is only one soil type (ID 1) which is applied across the whole model.
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOW_CATCH_Module_01\Tutorial_Data''' folder. Copy the '''TC01_soils_001.tsoilf''' and paste it in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder. 
<li>Open the file. The Green-Ampt (GA) infiltration method has been used. For more information on infiltration methods, refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
 
[[File: TC1_soils_file_01a.png]] 
 
</ol>

= Simulation Control Files =
The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its configuration information refer to [[NotepadPlusPlus_Tips | Notepad++ Tips]]. 
=== TUFLOW Geometry Control File (TGC) ===
<ol>
<li> Save a copy of '''M02_001.tgc''' as '''TC01_001.tgc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC01_001.tgc''' in a text editor and add the following line after the '<tt>Read GIS Mat</tt>' command to reference the new materials GIS layer. 
<tt>Read GIS Mat == gis\2d_mat_TC01_001_R.shp ! Sets material values according to attributes in the GIS layer</tt> 
<li> Save the TGC.
</ol>

=== TUFLOW Boundary Control File (TBC) ===
<ol>
<li>Save a copy of '''M06_003.tbc''' as '''TC01_001.tbc''' in the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder.
<li> Open the '''TC01_001.tbc''' in a text editor and remove or comment out the reference to the 2D boundaries using a '<tt>!</tt>' symbol. 
<tt>! Read GIS BC == gis\2d_bc_M01_001_L.shp ! Reads in downstream 2D boundary</tt> 
<li> Add the additional lines to reference the 1D/2D culvert connections: 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_M03_culverts_001_P.shp</tt> <tt> ! Links the 1D culverts to the 2D domain</tt> 
<tt>Read GIS BC </tt> <tt>== </tt> <tt>gis\2d_bc_M03_culverts_001_R.shp | gis\2d_bc_M03_culverts_001_L.shp</tt> <tt> ! Links the 1D culverts to the 2D domain</tt> 
<li>Save the TBC.
</ol>

=== TUFLOW ESTRY Control File (ECF) ===
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOW\model''' folder, and open '''TC01_001.ecf''' in a text editor. This file was created using the TUFLOW CATCH plugin.
<li> In the '1D Time Control' section, ensure the following command has been specified to set the 1D computational timestep: 
<tt>Timestep </tt> <tt>== </tt> <tt>0.5</tt> <tt> ! Specifies a 1D computational timestep of 0.5 seconds</tt> 
<li> In the '1D Elements' section, add the following command to define the culverts: 
<tt>Read GIS Network </tt> <tt>== </tt> <tt>gis\1d_nwk_M03_culverts_001_L.shp</tt> <tt> ! Defines culverts</tt>
<li> Add the following command line to define the Advection Dispersion (AD) approach. For more information on Advection Dispersion, please refer to the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. 
<tt>AD Approach == METHOD A ! Sets the modelling approach for the Advection Dispersion through 1D channels</tt>
<li>Save the ECF.
</ol>

== TUFLOW CATCH Control File (TCC) ==
A TUFLOW CATCH simulation is set up and executed by constructing a TUFLOW CATCH Control file (.tcc). TUFLOW Control file (.tcf) and TUFLOW FV Control file (.fvc) are not used. The .tcc has four command blocks:
<ol>
<li> Global commands
<li> Catchment Hydraulic Model (TUFLOW HPC) commands
<li> Catchment Pollutant Export Model
<li> Receiving Model (TUFLOW FV) commands
</ol>
All blocks must be included in the above order, but the later three can be switched on and off with a single command.

The TUFLOW CATCH plugin has created a .tcc template file in the '''TUFLOWCATCH\runs''' folder, '''TC01_001.tcc'''. This file has been populated with all the commands needed to execute a TUFLOW CATCH simulation. In this section, the template commands will be populated/updated for this tutorial model.

=== Global Settings ===
This section contains information that is applied equally to both TUFLOW HPC and TUFLOW FV.
<ol>
<li> Navigate to the '''TUFLOW_CATCH_Module_01\Modelling\TUFLOWCATCH\runs''' folder and open '''TC01_001.tcc''' into a text editor.
<li> In the 'Simulation Settings' section, update the time commands: 
<tt>Start Time == 01/01/2021 10:00:00 ! Specifies the simulation start time</tt> 
<tt>End Time == 01/01/2021 13:00:00 ! Specifies the simulation end time</tt> 
<li> In the 'Boundary Condition Configuration' section, update the BC and CSV output intervals: 
<tt>Catch BC Output Interval Nodestring == 300 ! Outputs BC nodestring data every 300 seconds</tt> 
<tt>Catch BC Output Interval Lateral == 300 ! Outputs BC lateral data every 300 seconds</tt> 
<tt>CSV Write Frequency Day == 0.01 ! Writes CSV output every 0.01 days</tt> 
</ol>

=== Catchment Hydraulic Model (TUFLOW HPC) ===
This block contains commands that construct the TUFLOW HPC simulation. These commands are almost entirely those that would be used in setting up a standalone TUFLOW HPC control file (.tcf), with a small number of additional commands that relate to TUFLOW CATCH.
<ol>
<li> Set the catchment hydraulic model: 
<tt>Catchment Hydraulic Model == HPC </tt>

<li> Set the zero date. TUFLOW HPC does not support ISODATE format, while TUFLOW FV requires it. This command ensures compatibility by setting the date in TUFLOW FV ISODATE format that corresponds to zero hours in TUFLOW HPC boundary condition files. 
<tt>Zero Date == 01/01/2021 10:00 ! Specifies the simulation start time in TUFLOW FV ISODATE format</tt> 

<li> In the 'GIS' section, remove or comment out the following command using a '<tt>!</tt>' symbol. The SHP projection has already been set in the [[#Global_Settings |Global Settings]] section. 
<tt>! SHP Projection == ..\..\TUFLOW\model\gis\projection.shp</tt> 

<li> In the 'GIS' section, set the projection for the output grid files: 
<tt>TIF Projection == ..\..\TUFLOW\model\grid\DEM.tif ! Sets the GIS projection for the output grid files</tt> 

<li> In the 'Solver' section, set the timestep maximum and time format: 
<tt>Timestep Maximum == 2.5 ! Specifies a maximum timestep (seconds)</tt> 
<tt>Time Format == TUFLOWFV ! Specifies the time format of output results</tt> 

<li> In the 'SGS' section, set the sample target distance: 
<tt>SGS Sample Target Distance == 0.5 ! Sets SGS Sample Target Distance (meters)</tt> 

<li> In the 'Control Files' section, ensure all control files are referenced. 
<tt>Geometry Control File == ..\..\TUFLOW\model\TC01_001.tgc ! Reference the TUFLOW Geometry Control File</tt> 
<tt>BC Control File == ..\..\TUFLOW\model\TC01_001.tbc ! Reference the TUFLOW Boundary Conditions Control File</tt> 
<tt>BC Database == ..\..\TUFLOW\bc_dbase\bc_dbase_TC01_001.csv ! Reference the Boundary Conditions Database</tt> 
<tt>Read Materials File == ..\..\TUFLOW\model\materials_TC01_001.csv ! Reference the Materials Definition File</tt> 
<tt>Rainfall Control File == ..\..\TUFLOW\model\M06_point2grid_003.trfc ! Reference the TUFLOW Rainfall Control File</tt> 
<tt>ESTRY Control File == ..\..\TUFLOW\model\TC01_001.ecf ! Reference the ESTRY (1D) Control File</tt> 

<li> In the 'Soils' section, reference the soils file (.tsoilf), and define the soil parameters: 
<tt>Read Soils File == ..\..\TUFLOW\model\TC01_soils_001.tsoilf ! Reference the Soils File</tt> 
<tt>Soil Negative Rainfall Approach == FACTOR </tt> 
<tt>Soil Negative Rainfall Factor == 0.2 </tt> 

<li> In the 'Pollutant Configuration' section, reference the receiving polygon and set the pollutants. In this tutorial, salinity, temperature, dissolved oxygen (WQ_DISS_OXYGEN_MG_L), alive and dead ecoli (WQ_PATH_ECOLI_ALIVE/DEAD_CFU_100ML) and clay sediment (SED_CLAY) are simulated. 
<tt>Receiving Polygon == ..\..\TUFLOW\model\gis\2d_rp_TC01_001_R.shp ! GIS layer defining the receiving polygon</tt> 
<tt>Pollutant == Salinity, Temperature, WQ_DISS_OXYGEN_MG_L, WQ_PATH_ECOLI_ALIVE_CFU_100ML, WQ_PATH_ECOLI_DEAD_CFU_100ML, SED_CLAY ! Specify the pollutant names </tt> 

<li> In the 'Output Map Configuration' section, update the following commands to set the map output formats, the map output interval, map cuttoff depth and to define the TIF output parameters. 
<tt>Map Output Format == XMDF TIF ! Result file types</tt> 
<tt>Map Output Data Types == catch h v d ! Output data types</tt> 
<tt>Map Output Interval == 30 ! Interval of output map data (seconds)</tt> 
<tt>Map Cutoff Depth == 0.05 ! Sets map cutoff depth (meters)</tt> 
<tt>TIF Map Output Interval == 0 ! Interval of output TIF map data (seconds)</tt> 
<tt>TIF Map Output Data Types == h d dt ! TIF result file types</tt> 
</ol>

===Pollutant Export Model===
This block contains commands that control the pollutant export (and other constituent) simulation.
<ol>
<li> Set the pollutant export model: 
<tt>Catchment Pollutant Export Model == Mass Accumulation Release </tt>

<li> In the 'Constant Concentrations' section, add the following commands. They set the pollutants 'Salinity' and 'WQ_DISS_OXYGEN_MG_L' (dissolved oxygen) to a constant concentration value that is applied equally to all boundaries and summary files where appropriate. 
<tt>Constant Salinity == 0.0 ! Specify the constant concentration of salinity</tt> 
<tt>Constant WQ_DISS_OXYGEN_MG_L == 8.0 ! Specify the constant concentration of dissolved oxygen</tt> 

<li> In the 'Time Series' section, add the following command. It sets the pollutant 'Temperature' to be a time-series input, and points to the name 'temp' in the bc_dbase. 
<tt>Time-Series Temperature == temp ! Specify temperature as a timeseries and the corresponding BC database name</tt> 

<li>In the 'Pollutant Export Properties' section, add the material block '<tt>ALL</tt>' (<tt>Material == ALL</tt>) from the page linked below. This code block defines the default pollutant export properties for each pollutant. Once uniform conditions are set, progressive specifications of material by material pollutant behaviour can be set. These specifications override previous settings on a spatial basis. Including the default (<tt>ALL</tt>) material block is considered best practice, as it ensures that all pollutants have export properties defined across the entire TUFLOW HPC domain, otherwise an error will occur. For more information on the pollutant export parameters, refer to [https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpPE-4 Section 4.5.3.3 of the TUFLOW CATCH Manual].
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Default_.28ALL.29 | Pollutant Export Properties: ALL]] 

<li>To set the pollutant export properties for the different material IDs, blocks similar to the above (e.g. <tt>Material == 4</tt>) can be used. The material IDs correspond to those defined in the '''2d_mat_TC01_001.shp''' and '''2d_mat_M01_001.shp''' GIS layers. 
 
To estimate E. coli export rates for each paddock, the area of each paddock was calculated. Based on this, appropriate animal populations were assigned. Using these values, the E. coli rates were calculated. For more information on pollutant export calculations, refer to [https://docs.tuflow.com/catch/manual/2025.0/ProcessDescriptions-1.html#ProcessDescriptionsMats-3 Section 3.2.3 of the TUFLOW CATCH Manual]. 
 
[[File: TC1_aerial_with_paddocks_01a.png|left]]
 
{| class="wikitable"

! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Material ID
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Paddock Name
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Area (ha)
! style="background-color:#005581; font-weight:bold; color:white; padding: 10px" |Animals
|-
|6||paddockA||1.5|| 23 Sheep, 7 Lambs
|-
|7||paddockB||0.3||2 Cows
|-
|8||paddockC||1.2||20 Sheep
|-
|9||paddockD || 1||4 Cows, 2 Calves
|}
 
 

<li> Set the pollutant export properties for material ID 1. This is the material ID for all areas within the model domain not covered by a material region. These pollutant export properties define the release and deposition of clay sediment. Sediment pollutants generally use the 'Shear1' method. For more information on 'Shear1', refer to [https://docs.tuflow.com/catch/manual/2025.0/SimulationConstruction-1.html#SCTCCPollExpSS-5 Section 4.5.3.3.2 of the TUFLOW CATCH Manual]. 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Model_Area_.281.29 | Pollutant Export Properties: 1]]

<li>Set the pollutant export properties for material ID 4 (waterholes, eddies, etc). These properties define settling (deposition velocity) of alive and dead E. coli to 2 meters per day (approx 25cm during the simulation). 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Slow_Moving_Water_.284.29 | Pollutant Export Properties: 4]]

<li>Set the pollutant export properties for material ID's 6 (paddockA), 7 (paddockB), 8 (paddockC) and 9 (paddockD). These properties define the accumulation (rate) and washoff of alive and dead E. coli for the animals on the paddock. 
:*[[TUFLOW_CATCH_Tutorial_M01_Pollutant_Export#Paddocks_.286.2C_7.2C_8_and_9.29 | Pollutant Export Properties: 6, 7, 8, 9]]

<li> For this tutorial, leave all interventions commands as is. This section of the .tcc will be discussed in [[TUFLOW_CATCH_Tutorial_M02 |TUFLOW CATCH Tutorial 02]].
<li> Save the .tcc.
</ol>

===Receiving Model (TUFLOW FV)===
For this tutorial, leave all commands as is. This section of the .tcc will be populated in [[TUFLOW_CATCH_Tutorial_M03 | TUFLOW CATCH Tutorial 03]].

=Running the Simulation=
<ol>
<li>In Windows File Explorer, navigate to the '''TUFLOWCATCH\runs''' folder. The TUFLOW CATCH plugin created a batch file (.bat) that references the .tcc called '''Demonstration.bat'''.
<li>Save a copy of '''Demonstration.bat''' as '''_run_TC01_CATCH.bat''' and open the file in a text editor.
<li>Update the batch file to reference the TUFLOW CATCH executable: 
<tt>set exe="..\..\..\..\exe\TUFLOWCATCH\2025.1.0\TUFLOWCATCH.exe"</tt> 
<tt>%exe% TC01_001.tcc</tt>
<li>Double click the batch file in file explorer to run the simulation.
</ol>

=Troubleshooting=
See tips on common mistakes and troubleshooting steps if the model doesn't run:
:*[[Tutorial_Troubleshooting_QGIS | QGIS]]

=Check Files and Results Output=
Complete the steps outlined in the following links to review check files and simulation results from the TUFLOW CATCH pollutant export model simulation:
:*[[TUFLOW_CATCH_Tutorial_M01_Check_Files_QGIS | TC01 - Check Files]] 
:*[[TUFLOW_CATCH_Tutorial_M01_Results_QGIS | TC01 - Results]] 

=Reviewing Model Performance=
There are a number of useful outputs from TUFLOW CATCH for reviewing the model performance.

===TUFLOW CATCH Log File (.catchlog)===
The first file to review is the TUFLOW CATCH Log File (.catchlog). The <tt>Log Folder == log</tt> command in the .tcc controls where the .catchlog is written. 
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001.catchlog''' file in a text editor. It contains a summary of the TUFLOW CATCH simulation. The following are the key points to review: 
* '''Global Settings:''' The commands from the 'Global Settings' section of the .tcc are echoed here. Review these to confirm that the correct settings have been applied. 
:[[File: TC1_catchlog_01b.png]] 
* '''Simulation Configuration:''' The .catchlog outlines which models have been used and what simulation configuration has been run. In this tutorial, the catchment hydraulic and pollutant export models have been applied, indicating a pollutant export configuration. 
:[[File: TC1_catchlog_02a.png]] 
* '''Run Status:''' At the end of the file, a message will confirm the simulation outcome.
:* If successful, it will state 'Run Successful' 
::[[File: TC1_catchlog_03b.png]] 
:* If an issue occurred, the simulation will stop and an error message will be reported. An example error is shown in the image below.
::'''Note:''' Each TUFLOW CATCH error message has a corresponding wiki page that provides further details about the error, and suggestions for how to fix the issue. Refer to [[5xxx_TUFLOW_Messages | 5xxx Messages]] for a list of all TUFLOW CATCH related error messages. 
::[[File: TC1_catchlog_04c.png]] 

===Other Log Files===
Once the .catchlog has been reviewed, it is recommended to check the TUFLOW Log File (.tlf) if the catchment hydraulic model has been specified and to check the TUFLOW FV Log File (.log) if the receiving model has been specified. These files contain TUFLOW and TUFLOW FV specific check, warning and error messages.

====TUFLOW Log File (.tlf)====
Since the catchment hydraulic model is specified in this tutorial, review the TUFLOW Log File. The <tt>Log Folder == log</tt> command in the .tcc defines where the .tlf is written 
Navigate to the '''Modelling\TUFLOWCATCH\runs\log''' folder and open the '''TC01_001_catchment_hydraulic.tlf''' file in a text editor.
* Scroll down to the bottom to 'Simulation Summary'. This includes information about the computation time, messages, volume calculations and mass error.
* Review any check, warning or error messages.
* For more information on reviewing TUFLOW log outputs, refer to [[HPC_Model_Review | HPC Model Review]].

====TUFLOW FV Log File (.log)====
The receiving model has not been specified in this tutorial, so no TUFLOW FV Log File (.log) has been created. The TUFLOW FV Log File will be reviewed in [[TUFLOW_CATCH_Tutorial_M03#Reviewing_Model_Performance | TUFLOW CATCH Tutorial 03]].

=Conclusion=
* A TUFLOW CATCH Pollutant Export model was created. A downstream receiving polygon was used to track pollutants in the receiving waters.
* Check files were used to review the transfer from the Catchment Hydraulic model (TUFLOW HPC) into the receiving polygon.
* TUFLOW CATCH time series results and TUFLOW map outputs were assessed to observe the pollutant behaviours.
*For further training opportunities see [https://tuflow.com/training/training-course-catalogue/ TUFLOW Training Catalogue] and/or contact [mailto:training@tuflow.com training@tuflow.com]. 
 
{{Tips Navigation
|uplink=[[TUFLOW_CATCH_Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}