TUFLOW Version Backward Compatibility: Difference between revisions

Content deleted Content added
No edit summary
 
(24 intermediate revisions by 4 users not shown)
Line 1:
 
=Backward Compatibility Change Register=
 
'''<font color="red">For changes in defaults post the 2017-09 build, see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.'''</font>
 
{|class="wikitable"
 
Line 158 ⟶ 161:
| Testing thus far has not shown any difference between the two methods (other than the substantial gains in processing time of polygons).
|-
| <font color="blue"><tt>Line Cell Selection </tt></font> <font color="red"><tt>== </tt></font><tt> Method D</fonttt> (previously Method C)
| May change results slightly, but improved stability and a smoother water levels along HX lines result.
|-
| <font color="blue"><tt>VG Z Adjustment </tt></font> <font color="red"><tt>== </tt></font><tt> MAX ZC</fonttt> (previously ZC)
| May change results slightly, but stability should be significantly enhanced in some situations.
|-
| <font color="blue"><tt>Bed Resistance Cell Sides </tt></font> <font color="red"><tt>== INTERROGATE</tt></font><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.
|-
| <font color="blue"><tt>Culvert Flow </tt></font> <font color="red"><tt>== </tt></font><tt> Method D</fonttt> (previously Method C)
<font color="blue"><tt>Culvert Critical H/D </tt></font> <font color="red"><tt>== OFF</tt></font><tt> OFF</tt> (previously <font color="blue"><tt>Culvert Critical H/D </tt></font> <font color="red"><tt>== </tt></font><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 <font color="blue"><tt>Structure Losses </tt></font> <font color="red"><tt>== ADJUST</tt></font><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).
Line 178 ⟶ 181:
|-
| 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 <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt> PRE 2007-07-AA</fonttt> 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.
Line 189 ⟶ 192:
|-
| 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 <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt> PRE 2006-06-AA</fonttt> to use the previous default settings. Each of the new default settings and their affects are discussed in the rows below.
|-
| <font color="blue"><tt>Cell Wet/Dry Depth </tt></font> <font color="red"><tt>== </tt></font><tt> 0.002</fonttt> (previously 0.05) and <font color="blue"><tt>Cell Side Wet/Dry Depth </tt></font> <font color="red"><tt>== </tt></font><tt> 0.001</fonttt> (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.
|-
| <font color="blue"><tt>Adjust Head at ESTRY Interface </tt></font> <font color="red"><tt>== OFF</tt></font><tt> OFF</tt> (previously ON)
| Usually does not have a major influence on results except where very high velocities occur.
|-
| <font color="blue"><tt>Boundary Cell Selection </tt></font> <font color="red"><tt>== </tt></font><tt> Method C</fonttt> (previously Method A) and <font color="blue"><tt>Line Cell Selection </tt></font> <font color="red"><tt>== </tt></font><tt> Method C</fonttt> (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.
|-
| <font color="blue"><tt>Viscosity Formulation </tt></font> <font color="red"><tt>== Smagorinsky</tt></font><tt> Smagorinsky</tt> (previously Constant) and <font color="blue"><tt>Viscosity Coefficient </tt></font> <font color="red"><tt>== </tt></font><tt> 0.2</fonttt> (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).
|-
| <font color="blue"><tt>Structure Losses </tt></font> <font color="red"><tt>== ADJUST</tt></font><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.
|-
| <font color="blue"><tt>Storage Above Structure Obvert (%) </tt></font> <font color="red"><tt>== 5</tt></font><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.
|-
| <font color="blue"><tt>Depth Limit Factor </tt></font> <font color="red"><tt>== 10</tt></font><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.
|-
| <font color="blue"><tt>Culvert Flow </tt></font> <font color="red"><tt>== </tt></font><tt> Method C</fonttt> (previously Method B)
| Usually only minor effects plus improved stability.
|-
| <font color="blue"><tt>Culvert Add Dynamic Head </tt></font> <font color="red"><tt>== ON</tt></font><tt> ON</tt> (previously OFF)
| Minor influence.
|-
| <font color="blue"><tt>Bridge Flow </tt></font> <font color="red"><tt>== </tt></font><tt> Method B</fonttt> (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.
|-
| <font color="blue"><tt>WLL Approach </tt></font> <font color="red"><tt>== </tt></font><tt> Method B</fonttt> (previously Method A)
| Only affects the presentation of results. Note, that Method A is no longer recommended or supported.
|-
| <font color="blue"><tt>Apply All Inverts </tt></font> <font color="red"><tt>== ON</tt></font><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).
|-
| <font color="blue"><tt>Conveyance Calculation </tt></font> <font color="red"><tt>== </tt></font><tt> ALL PARALLEL</fonttt> (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
|-
| <font color="blue"><tt>Flow Calculation </tt></font> <font color="red"><tt>== </tt></font><tt> Method B</fonttt> (previously Method A)
| Negligible effect.
 
|-
|'''Builds prior to 2006-06-XX'''
| Contact <font[mailto:support@tuflow.com color="blue">support@tuflow.com</font>]
|
|}
Line 242 ⟶ 245:
== Why are model results developed in an older release different to a newer release? ==
If comparing a Classic model with HPC, also check the <u>[[HPC_FAQ#Will_TUFLOW_HPC_and_TUFLOW_Classic_results_match.3F | Will TUFLOW HPC and TUFLOW Classic results match?]]</u> page in addition to this answer. <br>
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 new Wu turbulence scheme (2020 onwards) see <u>[[HPC_FAQ#With_Wu_turbulence_scheme_being_the_new_default.2C_are_old_models_using_Smagorinsky_wrong.3F | here]]</u>.
* Changes to the default settings and values, e.g.:
**different default eddy viscosity formulation and/or coefficients,
Line 254 ⟶ 257:
* 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 <u>[[Check_Files_1d_to_2d_bc | 1d_to_2d check file]]</u>.
Line 260 ⟶ 263:
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.<br>
 
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 <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command is considered reasonable for established models that are to be used for minor tasks andwhere an update of the model would not be cost effective.<br>
 
<br>