Skip to content

Commit

Permalink
MOM6: +Add DECAY_ADJUSTED_BBL_TKE option for ePBL BBL
Browse files Browse the repository at this point in the history 
- NOAA-GFDL/MOM6@d8a270b6e +Add DECAY_ADJUSTED_BBL_TKE option for ePBL BBL
- NOAA-GFDL/MOM6@4a53050d6 +(*)Add ePBL bottom boundary mixing option
- NOAA-GFDL/MOM6@2e8e2a591 +Add and test find_Kd_from_PE_chg
- NOAA-GFDL/MOM6@18dffbfc6 +Add run-time ability to debug ePBL sensitivities
- NOAA-GFDL/MOM6@8f0a593e4 +Add EPBL_MLD_ITER_BUG runtime parameter
- NOAA-GFDL/MOM6@af76c6c18 *Fix a bug when EPBL_ORIGINAL_PE_CALC is false
  • Loading branch information
@mom6bot
mom6bot committed Dec 12, 2024
1 parent 1e1882e commit dadf5fa
Show file tree
Hide file tree
Showing 19 changed files with 197 additions and 29 deletions.
12 changes: 12 additions & 0 deletions ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2137,6 +2137,11 @@ MKE_TO_TKE_EFFIC = 0.0 ! [nondim] default = 0.0
TKE_DECAY = 2.5 ! [nondim] default = 2.5
! TKE_DECAY relates the vertical rate of decay of the TKE available for
! mechanical entrainment to the natural Ekman depth.
DIRECT_EPBL_MIXING_CALC = False ! [Boolean] default = False
! If true and there is no conversion from mean kinetic energy to ePBL turbulent
! kinetic energy, use a direct calculation of the diffusivity that is supported
! by a given energy input instead of the more general but slower iterative
! solver.
EPBL_MSTAR_SCHEME = "CONSTANT" ! default = "CONSTANT"
! EPBL_MSTAR_SCHEME selects the method for setting mstar. Valid values are:
! CONSTANT - Use a fixed mstar given by MSTAR
Expand Down Expand Up @@ -2180,11 +2185,18 @@ EPBL_VEL_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0
! the PBL diffusivity.
VSTAR_SURF_FAC = 1.2 ! [nondim] default = 1.2
! The proportionality times ustar to set vstar at the surface.
EPBL_BBL_EFFIC = 0.0 ! [nondim] default = 0.0
! The efficiency of bottom boundary layer mixing via ePBL. Setting this to a
! value that is greater than 0 to enable bottom boundary layer mixing from EPBL.
USE_LA_LI2016 = False ! [Boolean] default = False
! A logical to use the Li et al. 2016 (submitted) formula to determine the
! Langmuir number.
EPBL_LT = False ! [Boolean] default = False
! A logical to use a LT parameterization.
EPBL_OPTIONS_DIFF = 0 ! default = 0
! If positive, this is a coded integer indicating a pair of settings whose
! differences are diagnosed in a passive diagnostic mode via extra calls to
! ePBL_column. If this is 0 or negative no extra calls occur.
!EPBL_USTAR_MIN = 1.45842E-18 ! [m s-1]
! The (tiny) minimum friction velocity used within the ePBL code, derived from
! OMEGA and ANGSTROM.
Expand Down
23 changes: 19 additions & 4 deletions ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2168,6 +2168,11 @@ MKE_TO_TKE_EFFIC = 0.0 ! [nondim] default = 0.0
TKE_DECAY = 0.01 ! [nondim] default = 2.5
! TKE_DECAY relates the vertical rate of decay of the TKE available for
! mechanical entrainment to the natural Ekman depth.
DIRECT_EPBL_MIXING_CALC = False ! [Boolean] default = False
! If true and there is no conversion from mean kinetic energy to ePBL turbulent
! kinetic energy, use a direct calculation of the diffusivity that is supported
! by a given energy input instead of the more general but slower iterative
! solver.
EPBL_MSTAR_SCHEME = "OM4" ! default = "CONSTANT"
! EPBL_MSTAR_SCHEME selects the method for setting mstar. Valid values are:
! CONSTANT - Use a fixed mstar given by MSTAR
Expand Down Expand Up @@ -2207,10 +2212,13 @@ EPBL_MLD_BISECTION = True ! [Boolean] default = False
! mixed layer depth. Otherwise use the false position after a maximum and
! minimum bound have been evaluated and the returned value or bisection before
! this.
EPBL_MLD_ITER_BUG = True ! [Boolean] default = True
! If true, use buggy logic that gives the wrong bounds for the next iteration
! when successive guesses increase by exactly EPBL_MLD_TOLERANCE.
EPBL_MLD_MAX_ITS = 20 ! default = 20
! The maximum number of iterations that can be used to find a self-consistent
! mixed layer depth. If EPBL_MLD_BISECTION is true, the maximum number
! iteractions needed is set by Depth/2^MAX_ITS < EPBL_MLD_TOLERANCE.
! mixed layer depth. If EPBL_MLD_BISECTION is true, the maximum number of
! iterations needed is set by Depth/2^MAX_ITS < EPBL_MLD_TOLERANCE.
EPBL_MIN_MIX_LEN = 0.0 ! [meter] default = 0.0
! The minimum mixing length scale that will be used by ePBL. The default (0)
! does not set a minimum.
Expand All @@ -2233,6 +2241,9 @@ EPBL_VEL_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0
! the PBL diffusivity.
VSTAR_SURF_FAC = 1.2 ! [nondim] default = 1.2
! The proportionality times ustar to set vstar at the surface.
EPBL_BBL_EFFIC = 0.0 ! [nondim] default = 0.0
! The efficiency of bottom boundary layer mixing via ePBL. Setting this to a
! value that is greater than 0 to enable bottom boundary layer mixing from EPBL.
USE_LA_LI2016 = True ! [Boolean] default = False
! A logical to use the Li et al. 2016 (submitted) formula to determine the
! Langmuir number.
Expand All @@ -2242,12 +2253,12 @@ EPBL_LANGMUIR_SCHEME = "ADDITIVE" ! default = "NONE"
! NONE - Do not do any extra mixing due to Langmuir turbulence
! RESCALE - Use a multiplicative rescaling of mstar to account for Langmuir
! turbulence
! ADDITIVE - Add a Langmuir turblence contribution to mstar to other
! ADDITIVE - Add a Langmuir turbulence contribution to mstar to other
! contributions
LT_ENHANCE_COEF = 0.044 ! [nondim] default = 0.447
! Coefficient for Langmuir enhancement of mstar
LT_ENHANCE_EXP = -1.5 ! [nondim] default = -1.33
! Exponent for Langmuir enhancementt of mstar
! Exponent for Langmuir enhancement of mstar
LT_MOD_LAC1 = 0.0 ! [nondim] default = -0.87
! Coefficient for modification of Langmuir number due to MLD approaching Ekman
! depth.
Expand All @@ -2263,6 +2274,10 @@ LT_MOD_LAC4 = 0.0 ! [nondim] default = 0.95
LT_MOD_LAC5 = 0.22 ! [nondim] default = 0.95
! Coefficient for modification of Langmuir number due to ratio of Ekman to
! unstable Obukhov depth.
EPBL_OPTIONS_DIFF = 0 ! default = 0
! If positive, this is a coded integer indicating a pair of settings whose
! differences are diagnosed in a passive diagnostic mode via extra calls to
! ePBL_column. If this is 0 or negative no extra calls occur.
!EPBL_USTAR_MIN = 1.45842E-18 ! [m s-1]
! The (tiny) minimum friction velocity used within the ePBL code, derived from
! OMEGA and ANGSTROM.
Expand Down
4 changes: 2 additions & 2 deletions ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short
View file
Original file line number Diff line number Diff line change
Expand Up @@ -670,12 +670,12 @@ EPBL_LANGMUIR_SCHEME = "ADDITIVE" ! default = "NONE"
! NONE - Do not do any extra mixing due to Langmuir turbulence
! RESCALE - Use a multiplicative rescaling of mstar to account for Langmuir
! turbulence
! ADDITIVE - Add a Langmuir turblence contribution to mstar to other
! ADDITIVE - Add a Langmuir turbulence contribution to mstar to other
! contributions
LT_ENHANCE_COEF = 0.044 ! [nondim] default = 0.447
! Coefficient for Langmuir enhancement of mstar
LT_ENHANCE_EXP = -1.5 ! [nondim] default = -1.33
! Exponent for Langmuir enhancementt of mstar
! Exponent for Langmuir enhancement of mstar
LT_MOD_LAC1 = 0.0 ! [nondim] default = -0.87
! Coefficient for modification of Langmuir number due to MLD approaching Ekman
! depth.
Expand Down
23 changes: 19 additions & 4 deletions ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2187,6 +2187,11 @@ MKE_TO_TKE_EFFIC = 0.0 ! [nondim] default = 0.0
TKE_DECAY = 0.01 ! [nondim] default = 2.5
! TKE_DECAY relates the vertical rate of decay of the TKE available for
! mechanical entrainment to the natural Ekman depth.
DIRECT_EPBL_MIXING_CALC = False ! [Boolean] default = False
! If true and there is no conversion from mean kinetic energy to ePBL turbulent
! kinetic energy, use a direct calculation of the diffusivity that is supported
! by a given energy input instead of the more general but slower iterative
! solver.
EPBL_MSTAR_SCHEME = "OM4" ! default = "CONSTANT"
! EPBL_MSTAR_SCHEME selects the method for setting mstar. Valid values are:
! CONSTANT - Use a fixed mstar given by MSTAR
Expand Down Expand Up @@ -2226,10 +2231,13 @@ EPBL_MLD_BISECTION = True ! [Boolean] default = False
! mixed layer depth. Otherwise use the false position after a maximum and
! minimum bound have been evaluated and the returned value or bisection before
! this.
EPBL_MLD_ITER_BUG = True ! [Boolean] default = True
! If true, use buggy logic that gives the wrong bounds for the next iteration
! when successive guesses increase by exactly EPBL_MLD_TOLERANCE.
EPBL_MLD_MAX_ITS = 20 ! default = 20
! The maximum number of iterations that can be used to find a self-consistent
! mixed layer depth. If EPBL_MLD_BISECTION is true, the maximum number
! iteractions needed is set by Depth/2^MAX_ITS < EPBL_MLD_TOLERANCE.
! mixed layer depth. If EPBL_MLD_BISECTION is true, the maximum number of
! iterations needed is set by Depth/2^MAX_ITS < EPBL_MLD_TOLERANCE.
EPBL_MIN_MIX_LEN = 0.0 ! [meter] default = 0.0
! The minimum mixing length scale that will be used by ePBL. The default (0)
! does not set a minimum.
Expand All @@ -2252,6 +2260,9 @@ EPBL_VEL_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0
! the PBL diffusivity.
VSTAR_SURF_FAC = 1.2 ! [nondim] default = 1.2
! The proportionality times ustar to set vstar at the surface.
EPBL_BBL_EFFIC = 0.0 ! [nondim] default = 0.0
! The efficiency of bottom boundary layer mixing via ePBL. Setting this to a
! value that is greater than 0 to enable bottom boundary layer mixing from EPBL.
USE_LA_LI2016 = True ! [Boolean] default = False
! A logical to use the Li et al. 2016 (submitted) formula to determine the
! Langmuir number.
Expand All @@ -2261,12 +2272,12 @@ EPBL_LANGMUIR_SCHEME = "ADDITIVE" ! default = "NONE"
! NONE - Do not do any extra mixing due to Langmuir turbulence
! RESCALE - Use a multiplicative rescaling of mstar to account for Langmuir
! turbulence
! ADDITIVE - Add a Langmuir turblence contribution to mstar to other
! ADDITIVE - Add a Langmuir turbulence contribution to mstar to other
! contributions
LT_ENHANCE_COEF = 0.044 ! [nondim] default = 0.447
! Coefficient for Langmuir enhancement of mstar
LT_ENHANCE_EXP = -1.5 ! [nondim] default = -1.33
! Exponent for Langmuir enhancementt of mstar
! Exponent for Langmuir enhancement of mstar
LT_MOD_LAC1 = 0.0 ! [nondim] default = -0.87
! Coefficient for modification of Langmuir number due to MLD approaching Ekman
! depth.
Expand All @@ -2282,6 +2293,10 @@ LT_MOD_LAC4 = 0.0 ! [nondim] default = 0.95
LT_MOD_LAC5 = 0.22 ! [nondim] default = 0.95
! Coefficient for modification of Langmuir number due to ratio of Ekman to
! unstable Obukhov depth.
EPBL_OPTIONS_DIFF = 0 ! default = 0
! If positive, this is a coded integer indicating a pair of settings whose
! differences are diagnosed in a passive diagnostic mode via extra calls to
! ePBL_column. If this is 0 or negative no extra calls occur.
!EPBL_USTAR_MIN = 1.45842E-18 ! [m s-1]
! The (tiny) minimum friction velocity used within the ePBL code, derived from
! OMEGA and ANGSTROM.
Expand Down
4 changes: 2 additions & 2 deletions ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short
View file
Original file line number Diff line number Diff line change
Expand Up @@ -698,12 +698,12 @@ EPBL_LANGMUIR_SCHEME = "ADDITIVE" ! default = "NONE"
! NONE - Do not do any extra mixing due to Langmuir turbulence
! RESCALE - Use a multiplicative rescaling of mstar to account for Langmuir
! turbulence
! ADDITIVE - Add a Langmuir turblence contribution to mstar to other
! ADDITIVE - Add a Langmuir turbulence contribution to mstar to other
! contributions
LT_ENHANCE_COEF = 0.044 ! [nondim] default = 0.447
! Coefficient for Langmuir enhancement of mstar
LT_ENHANCE_EXP = -1.5 ! [nondim] default = -1.33
! Exponent for Langmuir enhancementt of mstar
! Exponent for Langmuir enhancement of mstar
LT_MOD_LAC1 = 0.0 ! [nondim] default = -0.87
! Coefficient for modification of Langmuir number due to MLD approaching Ekman
! depth.
Expand Down
Loading

0 comments on commit dadf5fa

Please sign in to comment.