TUFLOW Version Backward Compatibility: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
 
(42 intermediate revisions by 3 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 23 ⟶ 26:
|No backward compatible workaround provided.<br>
|-
|If using “Reveal“<font color="blue"><tt>Reveal 1D Nodes</tt></font> <font color="red"><tt>==</tt></font><tt> ON”ON</tt>”, “Time“<font color="blue"><tt>Time Series Output Interval</tt></font> <font color="red"><tt>==</tt></font> ” must be specified.
|No backward compatible workaround provided.<br>
|-
Line 51 ⟶ 54:
|Set <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release.<br>
|-
|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 "<font color="red"><tt>==</tt></font>")
|Set <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt>PRE 2016</tt> if similar results are required to the 2013-12-AC release.<br>
|-
Line 66 ⟶ 69:
 
| rowspan=1|2013-12-AA
| New default settings – see <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>==</tt></font><tt> PRE 2013-12</fonttt> in the user manual for a list of the commands that have changed in their default setting.
| Set <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt>PRE 2013-12</tt> if similar results are required to the 2012-05 release.
|-
Line 72 ⟶ 75:
| rowspan=1|2013-12-AC
| The default setting for <font color="blue">Link 2D2D Approach</font> has changed.
| Set <font color="blue"><tt>Link 2D2D Approach </tt></font> <font color="red"><tt>== </tt></font><tt>METHOD B</fonttt> to achieve the same results as Builds 2013-12-AA and 2013-12-AB. See Link 2D2D Approach for more information.
 
|-
Line 79 ⟶ 82:
 
| rowspan=2| 2012-05-AA
| New default settings – see <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt>PRE 2012-05</fonttt> for a list of the commands that have changed in their default setting.
| Set <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><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 <font color="blue"><tt>Manhole Approach </tt></font> <font color="red"><tt>== </tt></font><tt>Method A</fonttt> to achieve the same results as Build 2011-09-AA.
|-
 
Line 102 ⟶ 105:
| No workaround. Use the same platform (w32 or w64) for all simulations. Use <font color="blue">Model Platform</font> to force which platform should be used.
|-
| New default settings – see <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt> PRE 2010-10</fonttt> for a list of the commands that have changed in their default setting.
| Set <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt>PRE 2010-10</tt> if similar results are required to the 2008-08 or 2009 07 releases.
|-
Line 116 ⟶ 119:
| rowspan=1| 2008-08-AC
| The default setting for <font color="blue"><u>Shallow Depth Stability Factor</u></font> has changed.
| Set <font color="blue"><tt>Shallow Depth Stability Factor </tt></font> <font color="red"><tt>== 3</tt></font><tt> 3</tt> for models without direct rainfall to achieve the same results as Builds 2008-08-AA and 2008-08-AB. See <font color="blue">Shallow Depth Stability Factor</font> for more information.
|-
 
Line 122 ⟶ 125:
|-
| Uses a new set of defaults for a number of commands (see <font color="blue">Defaults</font> ).
| 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 <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><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 <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><tt> PRE 2008-08</fonttt> 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 <font color="blue"><u>Bed Resistance Depth Interpolation</u></font>.
Line 152 ⟶ 155:
| The new defaults may produce slightly different results. For established models run using the 2006-06-XX builds, use <font color="blue"><tt>Defaults </tt></font> <font color="red"><tt>== </tt></font><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 <font color="blue"><tt>Zero Material Values to One </tt></font> <font color="red"><tt>== OFF</tt></font><tt> OFF</tt> (previously ON)
| Will not cause different results if a <font color="blue"><tt>Set Mat </tt></font> <font color="red"><tt>== </tt></font><tt> 1</tt> is specified before other material settings in the .tgc file, or if every cell has been assigned a material value.
|-
| <font color="blue"><tt>Inside Region </tt></font> <font color="red"><tt>== </tt></font><tt> Method B</fonttt> (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).
|-
| <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>]
|
|}
 
=Frequently Asked QuestionQuestions (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 <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>
Line 260 ⟶ 264:
 
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 and an update of the model would not be cost effective.<br>
 
<br>
{{Tips Navigation