UNST-4638: Rename keyword sigmaGrowthFactor to zLayerGrowthFactor

examples/dflowfm/03_dflowfm_dwaq_sequential/dflowfm/f34_dynamo.mdu

@@ -41,7 +41,7 @@ RenumberFlowNodes                 = 1
 Kmx                               = 12                                                                  # Number of vertical layers use 0 for 2D
 Layertype                         = 2                                                                   # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 NumTopSig                         = 0                                                                   # Number of sigma-layers on top of z-layers
-SigmaGrowthFactor                 = 1                                                                   # Layer thickness growth factor from DzTopUniAboveZ downwards
+zLayerGrowthFactor                = 1                                                                   # z-layer thickness growth factor from DzTopUniAboveZ downwards
 BathymetryFile                    =                                                                     # Bathymetry points file *.xyb
 GridEnclosureFile                 =                                                                     # Enclosure polygon file *.pol (third column 1/-1: inside/outside)
 PillarFile                        =                                                                     # Polyline file *.pliz, containing bridge pillars with rows x, y, drag coefficient and diameter

examples/dflowfm/04_dflowfm_dwaq_parallel/dflowfm/f34_dynamo.mdu

@@ -41,7 +41,7 @@ RenumberFlowNodes                 = 1
 Kmx                               = 12                                                                  # Number of vertical layers use 0 for 2D
 Layertype                         = 2                                                                   # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 NumTopSig                         = 0                                                                   # Number of sigma-layers on top of z-layers
-SigmaGrowthFactor                 = 1                                                                   # Layer thickness growth factor from DzTopUniAboveZ downwards
+zLayerGrowthFactor                = 1                                                                   # z-layer thickness growth factor from DzTopUniAboveZ downwards
 BathymetryFile                    =                                                                     # Bathymetry points file *.xyb
 GridEnclosureFile                 =                                                                     # Enclosure polygon file *.pol (third column 1/-1: inside/outside)
 PillarFile                        =                                                                     # Polyline file *.pliz, containing bridge pillars with rows x, y, drag coefficient and diameter

examples/dflowfm/05_dflowfm_dwaq-BLOOM_sequential/dflowfm/f34_BLOOM.mdu

@@ -41,7 +41,7 @@ RenumberFlowNodes                 = 0
 Kmx                               = 8                                                                   # Number of vertical layers use 0 for 2D
 Layertype                         = 1                                                                   # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 NumTopSig                         = 0                                                                   # Number of sigma-layers on top of z-layers
-SigmaGrowthFactor                 = 1.2                                                                 # Layer thickness growth factor from DzTopUniAboveZ downwards
+zLayerGrowthFactor                = 1.2                                                                 # z-layer thickness growth factor from DzTopUniAboveZ downwards
 BathymetryFile                    =                                                                     # Bathymetry points file *.xyb
 GridEnclosureFile                 =                                                                     # Enclosure polygon file *.pol (third column 1/-1: inside/outside)
 PillarFile                        =                                                                     # Polyline file *.pliz, containing bridge pillars with rows x, y, drag coefficient and diameter

examples/dflowfm/06_dflowfm_dwaq-BLOOM_parallel/dflowfm/f34_BLOOM.mdu

@@ -41,7 +41,7 @@ RenumberFlowNodes                 = 0
 Kmx                               = 8                                                                   # Number of vertical layers use 0 for 2D
 Layertype                         = 1                                                                   # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 NumTopSig                         = 0                                                                   # Number of sigma-layers on top of z-layers
-SigmaGrowthFactor                 = 1.2                                                                 # Layer thickness growth factor from DzTopUniAboveZ downwards
+zLayerGrowthFactor                = 1.2                                                                 # z-layer thickness growth factor from DzTopUniAboveZ downwards
 BathymetryFile                    =                                                                     # Bathymetry points file *.xyb
 GridEnclosureFile                 =                                                                     # Enclosure polygon file *.pol (third column 1/-1: inside/outside)
 PillarFile                        =                                                                     # Polyline file *.pliz, containing bridge pillars with rows x, y, drag coefficient and diameter

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/fm_deprecated_keywords.f90

@@ -25,6 +25,7 @@ subroutine default_fm_deprecated_keywords()
       call add_deprecated_keyword(deprecated_mdu_keywords, 'General', 'AutoStart', DEPRECATED)
       call add_deprecated_keyword(deprecated_mdu_keywords, 'Geometry', 'OrgFloorlevtoplaydef', DEPRECATED)
       call add_deprecated_keyword(deprecated_mdu_keywords, 'Geometry', 'circumcenter', DEPRECATED, 'Use circumcenterMethod instead.')
+      call add_deprecated_keyword(deprecated_mdu_keywords, 'Geometry', 'sigmaGrowthFactor', DEPRECATED, 'Use zLayerGrowthFactor instead.')
       call add_deprecated_keyword(deprecated_mdu_keywords, 'Numerics', 'Vertadvtypsal', DEPRECATED, 'Use verticalAdvectionType instead.')
       call add_deprecated_keyword(deprecated_mdu_keywords, 'Numerics', 'Vertadvtyptem', DEPRECATED, 'Use verticalAdvectionType instead.')
       call add_deprecated_keyword(deprecated_mdu_keywords, 'Processes', 'ThetaVertical', DEPRECATED, 'Use VerticalAdvectionType instead.')

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/m_flow.f90

@@ -80,7 +80,7 @@ module m_flow ! flow arrays-999
    integer :: ieps !< bottom boundary type eps. eqation, 1=dpmorg, 2 = dpmsandpit, 3=D3D, 4=Dirichlethdzb
    real(kind=dp) :: tur_time_int_factor = 0 !< Turbulence time integration factor for using LAX-based-scheme (0.0 - 1.0) for turbulent quantities (0.0: flow links, 0.5: fifty-fifty, 1.0: flow nodes)
    integer :: tur_time_int_method = TURB_LAX_CONNECTED !< Where to apply tur_time_int_factor (1: apply to all cells, 2: only when vertical layers are horizontally connected)
-   real(kind=dp) :: sigmagrowthfactor !<layer thickness growth factor from bed up
+   real(kind=dp) :: z_layer_growth_factor !< z-layer thickness growth factor from DzTopUniAboveZ downwards
    real(kind=dp) :: dztopuniabovez = -999.0_dp !< bottom level of lowest uniform layer == blmin if not specified
    real(kind=dp) :: Floorlevtoplay = -999.0_dp !< floor  level of top zlayer, == sini if not specified
    real(kind=dp) :: dztop = -999.0_dp !< if specified, dz of top layer, kmx = computed, if not, dz = (ztop-zbot)/kmx
@@ -564,7 +564,7 @@ subroutine default_flow()
       layertype = LAYTP_SIGMA !< 1 = sigma-layers, 2 = z- or z-sigma-layers, 3 = polygon defined mixed layers, 4 = density controlled sigma-layers
       iturbulencemodel = 3 !< 0=no, 1 = constant, 2 = algebraic, 3 = k-eps, 4 = k-tau
       ieps = 2 !< bottom boundary type eps. eqation, 1=dpmorg, 2 = dpmsandpit, 3=D3D, 4=Dirichlethdzb
-      sigmagrowthfactor = 1.0_dp !<layer thickness growth factor from bed up
+      z_layer_growth_factor = 1.0_dp
 
       ! Remaining of variables is handled in reset_flow()
       call reset_flow()

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/unstruc_model.f90

@@ -664,7 +664,7 @@ end subroutine loadModel
    subroutine readMDUFile(filename, istat)
       use time_module, only: ymd2modified_jul, datetimestring_to_seconds
       use m_flow, notinuse_s => success
-      !,                  only : kmx, layertype, mxlayz, sigmagrowthfactor, iturbulencemodel, &
+      !,                  only : kmx, layertype, mxlayz, z_layer_growth_factor, iturbulencemodel, &
       !                         LAYTP_SIGMA, numtopsig, spirbeta,                              &
       !                         dztopuniabovez, dztop, uniformhu, jahazlayer, Floorlevtoplay,         &
       !                         javakeps,                                                             &
@@ -937,8 +937,9 @@ subroutine readMDUFile(filename, istat)
             call warn_flush()
             numtopsig = 0
          end if
-         call prop_get(md_ptr, 'geometry', 'Numtopsiguniform', JaNumtopsiguniform, success)
-         call prop_get(md_ptr, 'geometry', 'SigmaGrowthFactor', sigmagrowthfactor)
+         call prop_get(md_ptr, 'geometry', 'Numtopsiguniform', JaNumtopsiguniform)
+         call prop_get(md_ptr, 'geometry', 'sigmaGrowthFactor', z_layer_growth_factor)
+         call prop_get(md_ptr, 'geometry', 'zLayerGrowthFactor', z_layer_growth_factor)
          call prop_get(md_ptr, 'geometry', 'Dztopuniabovez', dztopuniabovez)
          call prop_get(md_ptr, 'geometry', 'Dztop', Dztop)
          call prop_get(md_ptr, 'geometry', 'Toplayminthick', Toplayminthick)
@@ -2642,7 +2643,7 @@ end subroutine writeMDUFile
 
 !> Write a model definition to a file pointer
    subroutine writeMDUFilepointer(mout, writeall, istat)
-      use m_flow ! ,                !  only : kmx, layertype, mxlayz, sigmagrowthfactor, numtopsig, &
+      use m_flow ! ,                !  only : kmx, layertype, mxlayz, z_layer_growth_factor, numtopsig, &
       !         Iturbulencemodel, spirbeta, dztopuniabovez, dztop, jahazlayer, Floorlevtoplay ,  &
       !         fixedweirtopwidth, fixedweirtopfrictcoef, fixedweirtalud, ifxedweirfrictscheme,         &
       !         Tsigma, jarhoxu, iStrchType, STRCH_USER, STRCH_EXPONENT, STRCH_FIXLEVEL, laycof
@@ -2929,7 +2930,7 @@ subroutine writeMDUFilepointer(mout, writeall, istat)
             call prop_set(prop_ptr, 'geometry', 'Numtopsiguniform', jaNumtopsiguniform, 'Indicating whether the number of sigma-layers in a z-sigma-model is constant (=1) or decreasing (=0) (depending on local depth)')
          end if
 
-         call prop_set(prop_ptr, 'geometry', 'SigmaGrowthFactor', sigmagrowthfactor, 'Layer thickness growth factor from bed up')
+         call prop_set(prop_ptr, 'geometry', 'zLayerGrowthFactor', z_layer_growth_factor, 'z-layer thickness growth factor from DzTopUniAboveZ downwards')
          if (writeall .or. dztop /= dmiss) then
             call prop_set(prop_ptr, 'geometry', 'Dztop', Dztop, 'Z-layer thickness of layers above level Dztopuniabovez')
          end if
@@ -2957,7 +2958,7 @@ subroutine writeMDUFilepointer(mout, writeall, istat)
          end if
 
          if (writeall .or. dztopuniabovez /= dmiss) then
-            call prop_set(prop_ptr, 'geometry', 'Dztopuniabovez', Dztopuniabovez, 'Above this level layers will have uniform Dztop, below we use SigmaGrowthFactor')
+            call prop_set(prop_ptr, 'geometry', 'Dztopuniabovez', Dztopuniabovez, 'Above this level layers will have uniform Dztop, below we use zLayerGrowthFactor')
          end if
          if (Tsigma /= 100.0_dp) then
             call prop_set(prop_ptr, 'geometry', 'Tsigma', Tsigma, 'Sigma Adaptation period for Layertype==4 (s)')

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_gui/changegeometryparameters.f90

@@ -102,7 +102,7 @@ subroutine CHANGEgeometryPARAMETERS()
       it(2 * 18) = 2
       OPTION(19) = 'Layertype                           ( ) '
       it(2 * 19) = 2
-      OPTION(20) = 'Sigmagrowthfactor                   ( ) '
+      OPTION(20) = 'zLayerGrowthFactor                  ( ) '
       it(2 * 20) = 6
       OPTION(21) = 'Sillheightmin                       (m) '
       it(2 * 21) = 6
@@ -240,7 +240,7 @@ subroutine CHANGEgeometryPARAMETERS()
       call IFormPutDouble(2 * 17, zkdropstep, '(F8.3)')
       call IFORMPUTINTEGER(2 * 18, ifixedweirscheme)
       call IFORMPUTINTEGER(2 * 19, Layertype)
-      call IFormPutDouble(2 * 20, Sigmagrowthfactor, '(F8.3)')
+      call IFormPutDouble(2 * 20, z_layer_growth_factor, '(F8.3)')
       call IFormPutDouble(2 * 21, Sillheightmin, '(F8.3)')
       call IFORMPUTINTEGER(2 * 22, Mxlayz)
       call IFORMPUTINTEGER(2 * 23, ihuzcsig)
@@ -305,7 +305,7 @@ subroutine CHANGEgeometryPARAMETERS()
             call IFormGetDouble(2 * 17, zkdropstep)
             call IFORMgeTINTEGER(2 * 18, ifixedweirscheme)
             call IFORMgeTINTEGER(2 * 19, Layertype)
-            call IFormGetDouble(2 * 20, Sigmagrowthfactor)
+            call IFormGetDouble(2 * 20, z_layer_growth_factor)
             call IFormGetDouble(2 * 21, Sillheightmin)
             call IFORMgetINTEGER(2 * 22, Mxlayz)
             call IFORMgeTINTEGER(2 * 23, ihuzcsig)

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_kernel/prepost/flow_allocflow.f90

@@ -46,7 +46,7 @@ subroutine flow_allocflow()
                         limitingTimestepEstimation, limitingTimestepEstimation_cum, flowCourantNumber, kbot, ktop, ktop0, kmxn, Lbot, Ltop, &
                         kmxL, ustb, ustw, laydefnr, laytyp, laymx, nlaybn, nrlayn, jamapflowanalysis, mxlaydefs, kmx, kbotc, kmxc, layertype, &
                         LAYTP_SIGMA, LAYTP_DENS_SIGMA, LAYTP_Z, LAYTP_POLYGON_MIXED, numvertdis, mxlays, sdkx, dkx, zlaybot, iStrchType, &
-                        zlaytop, Floorlevtoplay, dztop, dztopuniabovez, sini, sigmagrowthfactor, numtopsig, janumtopsiguniform, mxlayz, kmxx, &
+                        zlaytop, Floorlevtoplay, dztop, dztopuniabovez, sini, z_layer_growth_factor, numtopsig, janumtopsiguniform, mxlayz, kmxx, &
                         zslay, dzslay, strch_user, laycof, strch_exponent, indlaynod, wflaynod, ndkx, jazlayeratubybob, lnkx, ln0, ucx, squ, &
                         sqi, dvyc, uqcx, uqcy, vol0, ucyq, vol1, ucy, qin, ucxq, vih, dvxc, vol1_f, sqa, volerror, sq, ucmag, jatrt, ucx_mor, &
                         ucy_mor, uc1d, u1du, japure1d, alpha_mom_1d, alpha_ene_1d, q1d, au1d, wu1d, sar1d, volu1d, freeboard, hsonground, &
@@ -300,7 +300,7 @@ subroutine flow_allocflow()
                zbb = zbt
                dzb = dzm
                do while (zbb > zmn .and. mx < kmxx - 1)
-                  dzb = dzb * sigmagrowthfactor
+                  dzb = dzb * z_layer_growth_factor
                   zbb = zbb - dzb
                   mx = mx + 1
                end do
@@ -393,7 +393,7 @@ subroutine flow_allocflow()
 
                   dzb = dzm
                   do k = mx - kuni - 1, 1, -1
-                     dzb = dzb * sigmagrowthfactor
+                     dzb = dzb * z_layer_growth_factor
                      zslay(k, j) = zslay(k + 1, j) - dzb
                   end do
                end if

src/engines_gpl/dflowfm/packages/dflowfm_kernel/test/io/resources/MDUversion/new_general.mdu

@@ -52,7 +52,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 
 [numerics]
 CFLMax            = 0.7

src/engines_gpl/dflowfm/packages/dflowfm_kernel/test/io/resources/MDUversion/old_model.mdu

@@ -52,7 +52,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 
 [numerics]
 CFLMax            = 0.7

src/engines_gpl/dflowfm/packages/dflowfm_kernel/test/io/resources/MDUversion/stretch_example.mdu

@@ -50,11 +50,10 @@ Bamin             = 1E-06
 OpenBoundaryTolerance= 3
 RenumberFlowNodes = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
 Kmx               = 18        # Maximum number of vertical layers
 Layertype         = 1         # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 Numtopsig         = 0         # Number of sigma layers in top of z-layer model
-SigmaGrowthFactor = 1.        # Layer thickness growth factor from bed up
+zLayerGrowthFactor = 1.       # z-layer thickness growth factor from DzTopUniAboveZ downwards
 StretchType       = 1         # Type of layer stretching, 0 = uniform, 1 = user defined, 2 = fixed level double exponential
 Dxwuimin2D        = 0.1       # Smallest fraction dx/wu , set dx > Dxwuimin2D*wu, Default = 0.1
 StretchCoef       = 1, 1.404019, 1.971269, 2.767610, 3.885900, 5.455881, 7.660161, 10.755012, 15.100148, 15.100148, 10.755012, 7.660161, 5.455881, 3.885900, 2.767610, 1.971269, 1.404019, 1             # Prescribes the layer thicknesses in percentages

src/engines_gpl/dflowfm/res/mdustandardwithdefaults.mdu

@@ -47,7 +47,7 @@ RenumberFlowNodes                 = 1                   # Renumber the flow node
 Kmx                               = 0                   # Maximum number of vertical layers
 Layertype                         = 1                   # 1 = sigma-layers, 2 = z- or z-sigma-layers
 Numtopsig                         = 0                   # Number of sigma layers in top of z-layer model
-SigmaGrowthFactor                 = 1.                  # Layer thickness growth factor from bed up
+zLayerGrowthFactor                = 1.                  # z-layer thickness growth factor from DzTopUniAboveZ downwards
 StretchType                       = 0                   # Type of layer stretching, 0 = uniform, 1 = user defined, 2 = fixed level double exponential
 
 [numerics]

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_water_depth_global_level/FM_model.mdu

@@ -58,7 +58,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_water_depth_level_ignore_globals/FM_model.mdu

@@ -58,7 +58,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_water_depth_level_no_globals/FM_model.mdu

@@ -58,7 +58,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_water_global_level_depth/FM_model.mdu

@@ -58,7 +58,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_water_only_depths/FM_model.mdu

@@ -58,7 +58,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/IniField1dField_with_2d/FM_model.mdu

@@ -56,7 +56,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 AllowBndAtBifurcation= 1
 ChangeVelocityAtStructures= 1
 ChangeStructureDimensions= 0

src/test/engines_gpl/dflowfm/packages/test_dflowfm/test_data/observCrossSections_snapped/FlowFM.mdu

@@ -51,7 +51,7 @@ RenumberFlowNodes = 1
 Kmx               = 0
 Layertype         = 1
 Numtopsig         = 0
-SigmaGrowthFactor = 1
+zLayerGrowthFactor = 1
 
 [numerics]
 CFLMax            = 0.7

src/test/utils_lgpl/ec_module/packages/ec_module_test/tests/FMtests/f05_boundary_conditions/c010_waterlevel_tim_constant/tfl.mdu

@@ -41,7 +41,7 @@ RenumberFlowNodes                    = 1                                     # S
 Kmx                                  = 0                                     # Max nr of vertical layers
 Layertype                            = 1                                     # Vertical layer type (1: sigma-layers, 2: z- or z-sigma-layers)
 Numtopsig                            = 0                                     # Nr of sigmalayers in top of Zlayer model
-SigmaGrowthFactor                    = 1.                                    # layer thickness growth factor from bed up
+zLayerGrowthFactor                   = 1.                                    # z-layer thickness growth factor from DzTopUniAboveZ downwards
 
 [numerics]
 CFLMax                               = 0.7                                   # Max. Courant nr.