Skip to content

MOM6: Refactor btcalc to reduce duplicated code #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marshallward merged 1 commit into from
Apr 23, 2025
Merged

MOM6: Refactor btcalc to reduce duplicated code #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ WRITE_GEOM = 1 ! default = 1
! If =0, never write the geometry and vertical grid files. If =1, write the
! geometry and vertical grid files only for a new simulation. If =2, always
! write the geometry and vertical grid files. Other values are invalid.
GEOM_FILE = "ocean_geometry" ! default = "ocean_geometry"
! The file into which to write the ocean geometry.
USE_DBCLIENT = False ! [Boolean] default = False
! If true, initialize a client to a remote database that can be used for online
! analysis and machine-learning inference.
Expand Down Expand Up @@ -382,6 +384,8 @@ USE_RGC_TRACER = False ! [Boolean] default = False
! If true, use the RGC_tracer tracer package.
USE_IDEAL_AGE_TRACER = True ! [Boolean] default = False
! If true, use the ideal_age_example tracer package.
USE_MARBL_TRACERS = False ! [Boolean] default = False
! If true, use the MARBL tracer package.
USE_REGIONAL_DYES = False ! [Boolean] default = False
! If true, use the regional_dyes tracer package.
USE_OIL_TRACER = False ! [Boolean] default = False
Expand Down Expand Up @@ -957,8 +961,6 @@ MEKE_GM_SRC_ALT = False ! [Boolean] default = False
MEKE_GEOMETRIC = False ! [Boolean] default = False
! If true, uses the GM coefficient formulation from the GEOMETRIC framework
! (Marshall et al., 2012).
USE_KH_IN_MEKE = False ! [Boolean] default = False
! If true, uses the thickness diffusivity calculated here to diffuse MEKE.
USE_GME = False ! [Boolean] default = False
! If true, use the GM+E backscatter scheme in association with the Gent and
! McWilliams parameterization.
Expand Down Expand Up @@ -998,7 +1000,8 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True
! If true, calculate the Coriolis accelerations at the end of each timestep for
! use in the predictor step of the next split RK2 timestep.
FPMIX = False ! [Boolean] default = False
! If true, apply profiles of momentum flux magnitude and direction
! If true, add non-local momentum flux increments and diffuse down the Eulerian
! gradient.
VISC_REM_BUG = True ! [Boolean] default = True
! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
! for in two places. This parameter controls the defaults of two individual
Expand Down Expand Up @@ -2002,6 +2005,7 @@ OPACITY_SCHEME = "MANIZZA_05" ! default = "MANIZZA_05"
! into opacities. Currently valid options include:
! MANIZZA_05 - Use Manizza et al., GRL, 2005.
! MOREL_88 - Use Morel, JGR, 1988.
! OHLMANN_03 - Use Ohlmann, J Clim, 2003. (only use if dz(1)>2.0m)
BLUE_FRAC_SW = 0.5 ! [nondim] default = 0.5
! The fraction of the penetrating shortwave radiation that is in the blue band.
PEN_SW_NBANDS = 3 ! default = 1
Expand Down Expand Up @@ -2046,6 +2050,10 @@ KHTR = 10.0 ! [m2 s-1] default = 0.0
! The background along-isopycnal tracer diffusivity.
KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0
! The minimum along-isopycnal tracer diffusivity.
FULL_DEPTH_KHTR_MIN = False ! [Boolean] default = False
! If true, KHTR_MIN is enforced throughout the whole water column. Otherwise,
! KHTR_MIN is only enforced at the surface. This parameter is only available
! when KHTR_USE_EBT_STRUCT=True and KHTR_MIN>0.
KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0
! The maximum along-isopycnal tracer diffusivity.
KHTR_PASSIVITY_COEFF = 3.0 ! [nondim] default = 0.0
Expand Down Expand Up @@ -2133,9 +2141,12 @@ ENERGYSAVEDAYS_GEOMETRIC = 0.0 ! [days] default = 0.0

! === module ocean_stochastics_init ===
DO_SPPT = False ! [Boolean] default = False
! If true, then stochastically perturb the thermodynamic tendemcies of T,S, amd
! If true, then stochastically perturb the thermodynamic tendencies of T,S, amd
! h. Amplitude and correlations are controlled by the nam_stoch namelist in the
! UFS model only.
DO_SKEB = False ! [Boolean] default = False
! If true, then stochastically perturb the currents using the stochastic kinetic
! energy backscatter scheme.
PERT_EPBL = False ! [Boolean] default = False
! If true, then stochastically perturb the kinetic energy production and
! dissipation terms. Amplitude and correlations are controlled by the nam_stoch
Expand Down
19 changes: 15 additions & 4 deletions coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ WRITE_GEOM = 1 ! default = 1
! If =0, never write the geometry and vertical grid files. If =1, write the
! geometry and vertical grid files only for a new simulation. If =2, always
! write the geometry and vertical grid files. Other values are invalid.
GEOM_FILE = "ocean_geometry" ! default = "ocean_geometry"
! The file into which to write the ocean geometry.
USE_DBCLIENT = False ! [Boolean] default = False
! If true, initialize a client to a remote database that can be used for online
! analysis and machine-learning inference.
Expand Down Expand Up @@ -382,6 +384,8 @@ USE_RGC_TRACER = False ! [Boolean] default = False
! If true, use the RGC_tracer tracer package.
USE_IDEAL_AGE_TRACER = True ! [Boolean] default = False
! If true, use the ideal_age_example tracer package.
USE_MARBL_TRACERS = False ! [Boolean] default = False
! If true, use the MARBL tracer package.
USE_REGIONAL_DYES = False ! [Boolean] default = False
! If true, use the regional_dyes tracer package.
USE_OIL_TRACER = False ! [Boolean] default = False
Expand Down Expand Up @@ -957,8 +961,6 @@ MEKE_GM_SRC_ALT = False ! [Boolean] default = False
MEKE_GEOMETRIC = False ! [Boolean] default = False
! If true, uses the GM coefficient formulation from the GEOMETRIC framework
! (Marshall et al., 2012).
USE_KH_IN_MEKE = False ! [Boolean] default = False
! If true, uses the thickness diffusivity calculated here to diffuse MEKE.
USE_GME = False ! [Boolean] default = False
! If true, use the GM+E backscatter scheme in association with the Gent and
! McWilliams parameterization.
Expand Down Expand Up @@ -998,7 +1000,8 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True
! If true, calculate the Coriolis accelerations at the end of each timestep for
! use in the predictor step of the next split RK2 timestep.
FPMIX = False ! [Boolean] default = False
! If true, apply profiles of momentum flux magnitude and direction
! If true, add non-local momentum flux increments and diffuse down the Eulerian
! gradient.
VISC_REM_BUG = True ! [Boolean] default = True
! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
! for in two places. This parameter controls the defaults of two individual
Expand Down Expand Up @@ -2002,6 +2005,7 @@ OPACITY_SCHEME = "MANIZZA_05" ! default = "MANIZZA_05"
! into opacities. Currently valid options include:
! MANIZZA_05 - Use Manizza et al., GRL, 2005.
! MOREL_88 - Use Morel, JGR, 1988.
! OHLMANN_03 - Use Ohlmann, J Clim, 2003. (only use if dz(1)>2.0m)
BLUE_FRAC_SW = 0.5 ! [nondim] default = 0.5
! The fraction of the penetrating shortwave radiation that is in the blue band.
PEN_SW_NBANDS = 3 ! default = 1
Expand Down Expand Up @@ -2046,6 +2050,10 @@ KHTR = 10.0 ! [m2 s-1] default = 0.0
! The background along-isopycnal tracer diffusivity.
KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0
! The minimum along-isopycnal tracer diffusivity.
FULL_DEPTH_KHTR_MIN = False ! [Boolean] default = False
! If true, KHTR_MIN is enforced throughout the whole water column. Otherwise,
! KHTR_MIN is only enforced at the surface. This parameter is only available
! when KHTR_USE_EBT_STRUCT=True and KHTR_MIN>0.
KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0
! The maximum along-isopycnal tracer diffusivity.
KHTR_PASSIVITY_COEFF = 3.0 ! [nondim] default = 0.0
Expand Down Expand Up @@ -2133,9 +2141,12 @@ ENERGYSAVEDAYS_GEOMETRIC = 0.0 ! [days] default = 0.0

! === module ocean_stochastics_init ===
DO_SPPT = False ! [Boolean] default = False
! If true, then stochastically perturb the thermodynamic tendemcies of T,S, amd
! If true, then stochastically perturb the thermodynamic tendencies of T,S, amd
! h. Amplitude and correlations are controlled by the nam_stoch namelist in the
! UFS model only.
DO_SKEB = False ! [Boolean] default = False
! If true, then stochastically perturb the currents using the stochastic kinetic
! energy backscatter scheme.
PERT_EPBL = False ! [Boolean] default = False
! If true, then stochastically perturb the kinetic energy production and
! dissipation terms. Amplitude and correlations are controlled by the nam_stoch
Expand Down
19 changes: 15 additions & 4 deletions coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ WRITE_GEOM = 1 ! default = 1
! If =0, never write the geometry and vertical grid files. If =1, write the
! geometry and vertical grid files only for a new simulation. If =2, always
! write the geometry and vertical grid files. Other values are invalid.
GEOM_FILE = "ocean_geometry" ! default = "ocean_geometry"
! The file into which to write the ocean geometry.
USE_DBCLIENT = False ! [Boolean] default = False
! If true, initialize a client to a remote database that can be used for online
! analysis and machine-learning inference.
Expand Down Expand Up @@ -382,6 +384,8 @@ USE_RGC_TRACER = False ! [Boolean] default = False
! If true, use the RGC_tracer tracer package.
USE_IDEAL_AGE_TRACER = True ! [Boolean] default = False
! If true, use the ideal_age_example tracer package.
USE_MARBL_TRACERS = False ! [Boolean] default = False
! If true, use the MARBL tracer package.
USE_REGIONAL_DYES = False ! [Boolean] default = False
! If true, use the regional_dyes tracer package.
USE_OIL_TRACER = False ! [Boolean] default = False
Expand Down Expand Up @@ -957,8 +961,6 @@ MEKE_GM_SRC_ALT = False ! [Boolean] default = False
MEKE_GEOMETRIC = False ! [Boolean] default = False
! If true, uses the GM coefficient formulation from the GEOMETRIC framework
! (Marshall et al., 2012).
USE_KH_IN_MEKE = False ! [Boolean] default = False
! If true, uses the thickness diffusivity calculated here to diffuse MEKE.
USE_GME = False ! [Boolean] default = False
! If true, use the GM+E backscatter scheme in association with the Gent and
! McWilliams parameterization.
Expand Down Expand Up @@ -998,7 +1000,8 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True
! If true, calculate the Coriolis accelerations at the end of each timestep for
! use in the predictor step of the next split RK2 timestep.
FPMIX = False ! [Boolean] default = False
! If true, apply profiles of momentum flux magnitude and direction
! If true, add non-local momentum flux increments and diffuse down the Eulerian
! gradient.
VISC_REM_BUG = True ! [Boolean] default = True
! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted
! for in two places. This parameter controls the defaults of two individual
Expand Down Expand Up @@ -2002,6 +2005,7 @@ OPACITY_SCHEME = "MANIZZA_05" ! default = "MANIZZA_05"
! into opacities. Currently valid options include:
! MANIZZA_05 - Use Manizza et al., GRL, 2005.
! MOREL_88 - Use Morel, JGR, 1988.
! OHLMANN_03 - Use Ohlmann, J Clim, 2003. (only use if dz(1)>2.0m)
BLUE_FRAC_SW = 0.5 ! [nondim] default = 0.5
! The fraction of the penetrating shortwave radiation that is in the blue band.
PEN_SW_NBANDS = 3 ! default = 1
Expand Down Expand Up @@ -2046,6 +2050,10 @@ KHTR = 10.0 ! [m2 s-1] default = 0.0
! The background along-isopycnal tracer diffusivity.
KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0
! The minimum along-isopycnal tracer diffusivity.
FULL_DEPTH_KHTR_MIN = False ! [Boolean] default = False
! If true, KHTR_MIN is enforced throughout the whole water column. Otherwise,
! KHTR_MIN is only enforced at the surface. This parameter is only available
! when KHTR_USE_EBT_STRUCT=True and KHTR_MIN>0.
KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0
! The maximum along-isopycnal tracer diffusivity.
KHTR_PASSIVITY_COEFF = 3.0 ! [nondim] default = 0.0
Expand Down Expand Up @@ -2133,9 +2141,12 @@ ENERGYSAVEDAYS_GEOMETRIC = 0.0 ! [days] default = 0.0

! === module ocean_stochastics_init ===
DO_SPPT = False ! [Boolean] default = False
! If true, then stochastically perturb the thermodynamic tendemcies of T,S, amd
! If true, then stochastically perturb the thermodynamic tendencies of T,S, amd
! h. Amplitude and correlations are controlled by the nam_stoch namelist in the
! UFS model only.
DO_SKEB = False ! [Boolean] default = False
! If true, then stochastically perturb the currents using the stochastic kinetic
! energy backscatter scheme.
PERT_EPBL = False ! [Boolean] default = False
! If true, then stochastically perturb the kinetic energy production and
! dissipation terms. Amplitude and correlations are controlled by the nam_stoch
Expand Down
Loading