MOM6: Add rescaling parameter to kappa shear (#643)

- NOAA-GFDL/MOM6@9059671be Add rescaling parameter to kappa shear (#643)

coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all

@@ -1683,6 +1683,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all

@@ -1683,6 +1683,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all

@@ -1683,6 +1683,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/Baltic/MOM_parameter_doc.all

@@ -1683,6 +1683,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all

@@ -1920,6 +1920,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all

@@ -1966,6 +1966,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all

@@ -1985,6 +1985,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all

@@ -1966,6 +1966,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all

@@ -1985,6 +1985,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all

@@ -1944,6 +1944,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/SIS2/MOM_parameter_doc.all

@@ -1655,6 +1655,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all

@@ -1655,6 +1655,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all

@@ -1655,6 +1655,10 @@ KAPPA_N_OVER_S_SCALE_COEF2 = 0.0 ! [nondim] default = 0.0
  ! The square of the ratio of the coefficients of the buoyancy and shear scales
  ! in the diffusivity equation, Set this to 0 (the default) to eliminate the
  ! shear scale. This is only used if USE_JACKSON_PARAM is true.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 KAPPA_SHEAR_TOL_ERR = 0.1 ! [nondim] default = 0.1
  ! The fractional error in kappa that is tolerated. Iteration stops when changes
  ! between subsequent iterations are smaller than this everywhere in a column.

ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all

@@ -1149,6 +1149,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all

@@ -1263,6 +1263,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all

@@ -1348,6 +1348,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all

@@ -1149,6 +1149,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all

@@ -1263,6 +1263,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all

@@ -1348,6 +1348,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.

ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all

@@ -1149,6 +1149,10 @@ KD_SEED_KAPPA_SHEAR = 1.0 ! [m2 s-1] default = 1.0
  ! A moderately large seed value of diapycnal diffusivity that is used as a
  ! starting turbulent diffusivity in the iterations to find an energetically
  ! constrained solution for the shear-driven diffusivity.
+LZ_RESCALE = 1.0 ! [nondim] default = 1.0
+ ! A coefficient to rescale the distance to the nearest solid boundary. This
+ ! adjustment is to account for regions where 3 dimensional turbulence prevents
+ ! the growth of shear instabilies [nondim].
 TKE_BACKGROUND = 0.0 ! [m2 s-2] default = 0.0
  ! A background level of TKE used in the first iteration of the kappa equation.
  ! TKE_BACKGROUND could be 0.