From 48f7d1f341509552b5f80386a10ff0bc64ab124f Mon Sep 17 00:00:00 2001 From: MOM6 bot Date: Wed, 25 Oct 2023 12:39:00 -0400 Subject: [PATCH] MOM6: ice shelf dHdt and optimization - NOAA-GFDL/MOM6@c9fc30d61 ice shelf dHdt and optimization - NOAA-GFDL/MOM6@3d07e5beb Comment omega_w2x entries in nuopc_cap - NOAA-GFDL/MOM6@3720b9920 Comment all omega_w2x entries - NOAA-GFDL/MOM6@e2bbb08dc Set fpmix to false by default - NOAA-GFDL/MOM6@5e6e6576f remove fms_io_mod import - NOAA-GFDL/MOM6@de55fd6d2 fix multiinstance log filename correction and remove FMS1 io api calls. - NOAA-GFDL/MOM6@d363034fc Deprecate mct cap (#257) - NOAA-GFDL/MOM6@5bc0c5e07 Pass wavebands from coupler to wave_parameters_CS (#255) - NOAA-GFDL/MOM6@be40a4136 add run time info (#114) - NOAA-GFDL/MOM6@d9aa751a4 Revert order of variables in vertFPmix - NOAA-GFDL/MOM6@66fd876af Removed L_diag and moved variables in vertFPmix - NOAA-GFDL/MOM6@7b7052e9b Describe local variables and make code consistent - NOAA-GFDL/MOM6@d4aa10857 Add Leith+E (#251) - NOAA-GFDL/MOM6@c57789f41 Rearrange do-loops and if statements - NOAA-GFDL/MOM6@2f34d6521 Merge latest mom-ocean main (#254) - NOAA-GFDL/MOM6@8ec0de7b0 Merge remote-tracking branch 'MAIN/main' into feature/update-to-main-20230811 - NOAA-GFDL/MOM6@27518f750 Make neutral diffusion work with 3D diffusivities - NOAA-GFDL/MOM6@a58803372 Make HBD work with 3D diffusivities - NOAA-GFDL/MOM6@36c1e266b Make tracer diffusivities 3D - NOAA-GFDL/MOM6@cf29f1beb Allocate hbl - NOAA-GFDL/MOM6@53ccbc329 Fix line length - NOAA-GFDL/MOM6@8234e696d Add hbd to the control structure - NOAA-GFDL/MOM6@b4bd22322 Output relevant fields when diff or visc < 0 - NOAA-GFDL/MOM6@61baca8ea Option to taper neutral diffusion - NOAA-GFDL/MOM6@8812ba999 Merge remote-tracking branch 'gustavo/fpmix_draft_17may2022' into fpmix_draft_18April2023 - NOAA-GFDL/MOM6@32b969ef4 Accommodate multi-instance runs in CESM (#241) - NOAA-GFDL/MOM6@ebf11d7c7 migrate nearly all refs to CFC_cap into MOM_tracer_flow_control and MOM_CFC_cap - NOAA-GFDL/MOM6@a697159a2 Obsolete the USE_LATERAL_BOUNDARY_DIFFUSION option - NOAA-GFDL/MOM6@eff5036e0 Unit tests and final cleaning - NOAA-GFDL/MOM6@b85581ea8 read atm CFC hemispheric aveages from CFC_BC_FILE, instead of 2D fields - NOAA-GFDL/MOM6@db06a5494 add CFC_BC_year_offset, converts model time to time in CFC_BC_file - NOAA-GFDL/MOM6@c2a30839c Improve performance of hor_bnd_diffusion - NOAA-GFDL/MOM6@f666a67cb Rename module to hor_bnd_diffusion - NOAA-GFDL/MOM6@9b4bd84b5 Add mssing call to get_param for FPMIX - NOAA-GFDL/MOM6@864506e85 Add omega_w2x to fluxes and forces - NOAA-GFDL/MOM6@7624a83b8 Add missing use for vertFPmix - NOAA-GFDL/MOM6@143d11752 Updates to vertFPmix - NOAA-GFDL/MOM6@cb65bdcef Change name of logical - NOAA-GFDL/MOM6@9c103f1f9 First draft for fpmix - NOAA-GFDL/MOM6@b7390f7e0 Makes set_u_at_v and set_v_at_u public --- .../AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all | 16 +- .../Concurrent_ice_1deg/MOM_parameter_doc.all | 16 +- .../MOM_parameter_doc.all | 16 +- ice_ocean_SIS2/Baltic/MOM_parameter_doc.all | 16 +- .../MOM_parameter_doc.all | 16 +- .../Baltic_OM4_025/MOM_parameter_doc.all | 16 +- .../Baltic_OM4_05/MOM_parameter_doc.all | 16 +- ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all | 16 +- ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all | 16 +- ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all | 16 +- ice_ocean_SIS2/SIS2/MOM_parameter_doc.all | 16 +- .../SIS2_bergs_cgrid/MOM_parameter_doc.all | 16 +- .../SIS2_cgrid/MOM_parameter_doc.all | 16 +- .../cooling_only/BML/MOM_parameter_doc.all | 14 +- .../cooling_only/EPBL/MOM_parameter_doc.all | 14 +- .../cooling_only/KPP/MOM_parameter_doc.all | 14 +- .../mech_only/BML/MOM_parameter_doc.all | 14 +- .../mech_only/EPBL/MOM_parameter_doc.all | 14 +- .../mech_only/KPP/MOM_parameter_doc.all | 14 +- .../BML/MOM_parameter_doc.all | 14 +- .../EPBL/MOM_parameter_doc.all | 14 +- .../KPP/MOM_parameter_doc.all | 14 +- .../wind_only/BML/MOM_parameter_doc.all | 14 +- .../wind_only/EPBL/MOM_parameter_doc.all | 14 +- .../wind_only/KPP/MOM_parameter_doc.all | 14 +- ocean_only/DOME/MOM_parameter_doc.all | 16 +- .../Phillips_2layer/MOM_parameter_doc.all | 16 +- .../MOM_parameter_doc.all | 14 +- .../adjustment2d/layer/MOM_parameter_doc.all | 16 +- .../adjustment2d/rho/MOM_parameter_doc.all | 16 +- .../adjustment2d/z/MOM_parameter_doc.all | 16 +- ocean_only/benchmark/MOM_parameter_doc.all | 16 +- ocean_only/circle_obcs/MOM_parameter_doc.all | 16 +- ocean_only/double_gyre/MOM_parameter_doc.all | 16 +- .../external_gwave/MOM_parameter_doc.all | 16 +- .../layer/MOM_parameter_doc.all | 16 +- .../flow_downslope/rho/MOM_parameter_doc.all | 16 +- .../sigma/MOM_parameter_doc.all | 16 +- .../flow_downslope/z/MOM_parameter_doc.all | 16 +- .../global_ALE/hycom/MOM_parameter_doc.all | 16 +- .../global_ALE/layer/MOM_parameter_doc.all | 16 +- .../global_ALE/layer/available_diags.000000 | 195 ++++++++++-------- ocean_only/global_ALE/z/MOM_parameter_doc.all | 16 +- .../global_ALE/z/available_diags.000000 | 195 ++++++++++-------- .../lock_exchange/MOM_parameter_doc.all | 16 +- .../MOM_parameter_doc.all | 16 +- .../nonBous_global/MOM_parameter_doc.all | 16 +- .../resting/layer/MOM_parameter_doc.all | 16 +- ocean_only/resting/z/MOM_parameter_doc.all | 16 +- .../seamount/layer/MOM_parameter_doc.all | 16 +- ocean_only/seamount/rho/MOM_parameter_doc.all | 16 +- .../seamount/sigma/MOM_parameter_doc.all | 16 +- ocean_only/seamount/z/MOM_parameter_doc.all | 16 +- .../single_column/BML/MOM_parameter_doc.all | 14 +- .../single_column/EPBL/MOM_parameter_doc.all | 14 +- .../single_column/KPP/MOM_parameter_doc.all | 14 +- .../sloshing/layer/MOM_parameter_doc.all | 16 +- ocean_only/sloshing/rho/MOM_parameter_doc.all | 16 +- ocean_only/sloshing/z/MOM_parameter_doc.all | 16 +- .../MOM_parameter_doc.all | 16 +- .../tracer_mixing/rho/MOM_parameter_doc.all | 16 +- .../tracer_mixing/z/MOM_parameter_doc.all | 16 +- ocean_only/unit_tests/MOM_parameter_doc.all | 14 +- src/MOM6 | 2 +- 64 files changed, 907 insertions(+), 427 deletions(-) diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all index 090767aaeb..3de7c0890f 100644 --- a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all @@ -949,6 +949,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1121,6 +1123,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1911,6 +1916,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1946,10 +1954,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all index 75e67de407..8b72026d10 100644 --- a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all @@ -949,6 +949,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1121,6 +1123,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1911,6 +1916,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1946,10 +1954,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all index 39edb6376e..82317160d1 100644 --- a/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all @@ -949,6 +949,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1121,6 +1123,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1911,6 +1916,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1946,10 +1954,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all index 17c158087e..a89a31291e 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all @@ -949,6 +949,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1121,6 +1123,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1911,6 +1916,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1946,10 +1954,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all index 46828d1783..3e1d40f69c 100644 --- a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all @@ -1090,6 +1090,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1335,6 +1337,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2110,6 +2115,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -2157,10 +2165,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all index e8889b4684..17b2718b95 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all @@ -1184,6 +1184,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1359,6 +1361,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2203,6 +2208,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -2235,10 +2243,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all index 9849a7b49b..2df6d4d1d1 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all @@ -1198,6 +1198,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1378,6 +1380,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2222,6 +2227,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 50.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -2269,10 +2277,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all index 6615b02a2a..ef3eadc070 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all @@ -1184,6 +1184,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1359,6 +1361,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2203,6 +2208,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -2235,10 +2243,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all index fe364bf018..2956e0bfa9 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all @@ -1198,6 +1198,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1378,6 +1380,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2222,6 +2227,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 50.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -2269,10 +2277,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all index 169913c717..bba93fcd09 100644 --- a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all @@ -1175,6 +1175,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1352,6 +1354,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2165,6 +2170,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -2212,10 +2220,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all index 1e235dc75a..92f5df5518 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all @@ -921,6 +921,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1093,6 +1095,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1883,6 +1888,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1918,10 +1926,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all index 83984131aa..872bb07c80 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all @@ -921,6 +921,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1093,6 +1095,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1887,6 +1892,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1922,10 +1930,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all index 6205de29d6..8466e153c9 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all @@ -921,6 +921,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1093,6 +1095,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1883,6 +1888,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1918,10 +1926,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all index ffa02495d5..3cccfeb06a 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all @@ -885,6 +885,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1331,6 +1334,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1363,10 +1369,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all index e642e5ec5e..6abdc10c94 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1432,6 +1435,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1464,10 +1470,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all index a951367e7e..6f73657e2c 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1431,6 +1434,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1463,10 +1469,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all index e2d9c0885b..074625289d 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all @@ -885,6 +885,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1331,6 +1334,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1363,10 +1369,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all index 6c35421b93..1cc008aa73 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1432,6 +1435,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1464,10 +1470,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all index d9c555177c..6372bc087c 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1431,6 +1434,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1463,10 +1469,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all index 042e6246db..d3384d7fe4 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all @@ -885,6 +885,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1331,6 +1334,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1363,10 +1369,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all index 9bc45917af..eca9f8863c 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1432,6 +1435,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1464,10 +1470,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all index 94e5c0c678..8e744281cc 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1431,6 +1434,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1463,10 +1469,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all index 18c463dbd4..96aa4bbbc9 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all @@ -885,6 +885,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1331,6 +1334,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1363,10 +1369,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all index 91df57b42b..704e8c5364 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1432,6 +1435,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1464,10 +1470,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all index 9ec0dc0d98..a0b077f7e9 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1431,6 +1434,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1463,10 +1469,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/DOME/MOM_parameter_doc.all b/ocean_only/DOME/MOM_parameter_doc.all index a89ce29797..e44f7ad1fd 100644 --- a/ocean_only/DOME/MOM_parameter_doc.all +++ b/ocean_only/DOME/MOM_parameter_doc.all @@ -792,6 +792,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -913,6 +915,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1425,6 +1430,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1457,10 +1465,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.all b/ocean_only/Phillips_2layer/MOM_parameter_doc.all index 160b8b110b..cf4fdbed81 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.all +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.all @@ -729,6 +729,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -850,6 +852,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1292,6 +1297,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1324,10 +1332,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all index 61154de30e..70f7717040 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all @@ -994,6 +994,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1431,6 +1434,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1463,10 +1469,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all index 8604fc1398..d0e6f53b40 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all @@ -779,6 +779,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -939,6 +941,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1423,6 +1428,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1455,10 +1463,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all index 6b642190b8..aa4a1745c3 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all @@ -933,6 +933,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1093,6 +1095,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1573,6 +1578,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1605,10 +1613,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.all b/ocean_only/adjustment2d/z/MOM_parameter_doc.all index 80063179da..4fb25b8097 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.all @@ -885,6 +885,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1045,6 +1047,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1525,6 +1530,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1557,10 +1565,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/benchmark/MOM_parameter_doc.all b/ocean_only/benchmark/MOM_parameter_doc.all index b3e566fd28..bba4a699f0 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.all +++ b/ocean_only/benchmark/MOM_parameter_doc.all @@ -868,6 +868,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1015,6 +1017,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1683,6 +1688,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 1.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1718,10 +1726,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.all b/ocean_only/circle_obcs/MOM_parameter_doc.all index b315b6c04b..6bf4f618f0 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.all +++ b/ocean_only/circle_obcs/MOM_parameter_doc.all @@ -790,6 +790,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -964,6 +966,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1483,6 +1488,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1515,10 +1523,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/double_gyre/MOM_parameter_doc.all b/ocean_only/double_gyre/MOM_parameter_doc.all index d3d91be56e..ab5071a44f 100644 --- a/ocean_only/double_gyre/MOM_parameter_doc.all +++ b/ocean_only/double_gyre/MOM_parameter_doc.all @@ -662,6 +662,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -822,6 +824,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1050,6 +1055,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1082,10 +1090,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/external_gwave/MOM_parameter_doc.all b/ocean_only/external_gwave/MOM_parameter_doc.all index 7a5b288423..9ee58d9c2b 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.all +++ b/ocean_only/external_gwave/MOM_parameter_doc.all @@ -768,6 +768,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -926,6 +928,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1409,6 +1414,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1441,10 +1449,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all index 98d74cb12e..9b4d5a8372 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all @@ -778,6 +778,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -936,6 +938,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1420,6 +1425,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1452,10 +1460,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all index 8e9f722ce9..790457bb30 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all @@ -934,6 +934,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1092,6 +1094,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1572,6 +1577,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1604,10 +1612,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all index 857a61fad6..cdf391f6bd 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all @@ -886,6 +886,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1044,6 +1046,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1524,6 +1529,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1556,10 +1564,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.all b/ocean_only/flow_downslope/z/MOM_parameter_doc.all index 777d5fde3c..7e943dc790 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.all @@ -886,6 +886,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1044,6 +1046,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1524,6 +1529,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1556,10 +1564,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all index ceb3f2dbe7..ecdf83e2f2 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all @@ -1140,6 +1140,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1385,6 +1387,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2160,6 +2165,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -2207,10 +2215,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.all b/ocean_only/global_ALE/layer/MOM_parameter_doc.all index 377d311933..4842255bfb 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.all @@ -1032,6 +1032,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1277,6 +1279,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2043,6 +2048,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -2075,10 +2083,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/global_ALE/layer/available_diags.000000 b/ocean_only/global_ALE/layer/available_diags.000000 index f6e31d5f9e..3e39e62766 100644 --- a/ocean_only/global_ALE/layer/available_diags.000000 +++ b/ocean_only/global_ALE/layer/available_diags.000000 @@ -737,6 +737,47 @@ ! long_name: Mixed Layer Thickness at Meridional Velocity Points for Viscosity ! units: m ! cell_methods: xh:mean yq:point +"FPw2x" [Unused] + ! modules: {ocean_model,ocean_model_d2} + ! long_name: Wind direction from x-axis + ! units: radians + ! cell_methods: xh:mean yh:mean area:mean +"tauFP_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: Stress Mag Profile (u-points) + ! units: m2 s-2 + ! cell_methods: xq:point yh:mean zi:point + ! variants: {tauFP_u,tauFP_u_xyave} +"tauFP_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: Stress Mag Profile (v-points) + ! units: m2 s-2 + ! cell_methods: xh:mean yq:point zi:point + ! variants: {tauFP_v,tauFP_v_xyave} +"FPtau2s_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from shear direction (u-points) + ! units: radians + ! cell_methods: xq:point yh:mean zi:point + ! variants: {FPtau2s_u,FPtau2s_u_xyave} +"FPtau2s_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from shear direction (v-points) + ! units: radians + ! cell_methods: xh:mean yq:point zi:point + ! variants: {FPtau2s_v,FPtau2s_v_xyave} +"FPtau2w_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from wind direction (u-points) + ! units: radians + ! cell_methods: xq:point yh:mean zi:point + ! variants: {FPtau2w_u,FPtau2w_u_xyave} +"FPtau2w_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from wind direction (v-points) + ! units: radians + ! cell_methods: xh:mean yq:point zi:point + ! variants: {FPtau2w_v,FPtau2w_v_xyave} "du_dt_visc" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Zonal Acceleration from Vertical Viscosity @@ -2235,21 +2276,23 @@ ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {opac_3,opac_3_xyave} "KHTR_u" [Used] - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at zonal faces of tracer cell ! units: m2 s-1 - ! cell_methods: xq:point yh:mean + ! cell_methods: xq:point yh:mean zi:point + ! variants: {KHTR_u,KHTR_u_xyave} "KHTR_v" [Used] - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at meridional faces of tracer cell ! units: m2 s-1 - ! cell_methods: xh:mean yq:point + ! cell_methods: xh:mean yq:point zi:point + ! variants: {KHTR_v,KHTR_v_xyave} "KHTR_h" [Used] (CMOR equivalent is "diftrelo") - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at tracer cell center ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean area:mean - ! variants: {KHTR_h,diftrelo} + ! cell_methods: xh:mean yh:mean zi:point area:mean + ! variants: {KHTR_h,KHTR_h_xyave,diftrelo,diftrelo_xyave} "KHDT_x" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Epipycnal tracer diffusivity operator at zonal faces of tracer cell @@ -2456,18 +2499,18 @@ ! units: W ! cell_methods: xh:sum yq:point zl:sum ! variants: {T_diffy,T_diffy_xyave} -"T_lbd_diffx" [Unused] +"T_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Zonal Flux of Heat + ! long_name: Horizontal Boundary Diffusive Zonal Flux of Heat ! units: W ! cell_methods: xq:point yh:sum zl:sum - ! variants: {T_lbd_diffx,T_lbd_diffx_xyave} -"T_lbd_diffy" [Unused] + ! variants: {T_hbd_diffx,T_hbd_diffx_xyave} +"T_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Meridional Flux of Heat + ! long_name: Horizontal Boundary Diffusive Meridional Flux of Heat ! units: W ! cell_methods: xh:sum yq:point zl:sum - ! variants: {T_lbd_diffy,T_lbd_diffy_xyave} + ! variants: {T_hbd_diffy,T_hbd_diffy_xyave} "T_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Heat @@ -2488,24 +2531,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Heat ! units: W ! cell_methods: xh:sum yq:point -"T_lbd_bulk_diffx" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Heat - ! units: W - ! cell_methods: xq:point yh:sum -"T_lbd_bulk_diffy" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Heat - ! units: W - ! cell_methods: xh:sum yq:point -"T_lbd_diffx_2d" [Unused] +"T_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Heat + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Heat ! units: W ! cell_methods: xq:point yh:sum -"T_lbd_diffy_2d" [Unused] +"T_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Heat + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Heat ! units: W ! cell_methods: xh:sum yq:point "T_advection_xy" [Used] @@ -2537,15 +2570,15 @@ ! units: W m-2 ! cell_methods: xh:sum yh:sum area:sum ! variants: {T_dfxy_cont_tendency_2d,opottemppmdiff_2d} -"T_lbdxy_cont_tendency" [Unused] +"T_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for T + ! long_name: Horizontal boundary diffusion tracer content tendency for T ! units: W m-2 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {T_lbdxy_cont_tendency,T_lbdxy_cont_tendency_xyave} -"T_lbdxy_cont_tendency_2d" [Unused] + ! variants: {T_hbdxy_cont_tendency,T_hbdxy_cont_tendency_xyave} +"T_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for T + ! long_name: Depth integrated horizontal boundary diffusion of tracer content tendency for T ! units: W m-2 ! cell_methods: xh:sum yh:sum area:sum "T_dfxy_conc_tendency" [Unused] @@ -2554,12 +2587,12 @@ ! units: degC s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {T_dfxy_conc_tendency,T_dfxy_conc_tendency_xyave} -"T_lbdxy_conc_tendency" [Unused] +"T_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for T + ! long_name: Horizontal diffusion tracer concentration tendency for T ! units: degC s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {T_lbdxy_conc_tendency,T_lbdxy_conc_tendency_xyave} + ! variants: {T_hbdxy_conc_tendency,T_hbdxy_conc_tendency_xyave} "Th_tendency" [Used] (CMOR equivalent is "opottemptend") ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for heat @@ -2608,18 +2641,18 @@ ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point zl:sum ! variants: {S_diffy,S_diffy_xyave} -"S_lbd_diffx" [Unused] +"S_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Zonal Flux of Salt + ! long_name: Horizontal Boundary Diffusive Zonal Flux of Salt ! units: psu m3 s-1 ! cell_methods: xq:point yh:sum zl:sum - ! variants: {S_lbd_diffx,S_lbd_diffx_xyave} -"S_lbd_diffy" [Unused] + ! variants: {S_hbd_diffx,S_hbd_diffx_xyave} +"S_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Meridional Flux of Salt + ! long_name: Horizontal Boundary Diffusive Meridional Flux of Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point zl:sum - ! variants: {S_lbd_diffy,S_lbd_diffy_xyave} + ! variants: {S_hbd_diffy,S_hbd_diffy_xyave} "S_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Salt @@ -2640,24 +2673,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point -"S_lbd_bulk_diffx" [Unused] +"S_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Salt + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Salt ! units: psu m3 s-1 ! cell_methods: xq:point yh:sum -"S_lbd_bulk_diffy" [Unused] +"S_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Salt - ! units: psu m3 s-1 - ! cell_methods: xh:sum yq:point -"S_lbd_diffx_2d" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Salt - ! units: psu m3 s-1 - ! cell_methods: xq:point yh:sum -"S_lbd_diffy_2d" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Salt + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point "S_advection_xy" [Used] @@ -2689,15 +2712,15 @@ ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum area:sum ! variants: {S_dfxy_cont_tendency_2d,osaltpmdiff_2d} -"S_lbdxy_cont_tendency" [Unused] +"S_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for S + ! long_name: Horizontal boundary diffusion tracer content tendency for S ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {S_lbdxy_cont_tendency,S_lbdxy_cont_tendency_xyave} -"S_lbdxy_cont_tendency_2d" [Unused] + ! variants: {S_hbdxy_cont_tendency,S_hbdxy_cont_tendency_xyave} +"S_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for S + ! long_name: Depth integrated horizontal boundary diffusion of tracer content tendency for S ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum area:sum "S_dfxy_conc_tendency" [Unused] @@ -2706,12 +2729,12 @@ ! units: psu s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {S_dfxy_conc_tendency,S_dfxy_conc_tendency_xyave} -"S_lbdxy_conc_tendency" [Unused] +"S_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for S + ! long_name: Horizontal diffusion tracer concentration tendency for S ! units: psu s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {S_lbdxy_conc_tendency,S_lbdxy_conc_tendency_xyave} + ! variants: {S_hbdxy_conc_tendency,S_hbdxy_conc_tendency_xyave} "Sh_tendency" [Used] (CMOR equivalent is "osalttend") ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for salt @@ -2760,18 +2783,18 @@ ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point zl:sum ! variants: {age_dfy,age_dfy_xyave} -"age_lbd_diffx" [Unused] +"age_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Ideal Age Tracer diffusive zonal flux from the lateral boundary diffusion scheme + ! long_name: Ideal Age Tracer diffusive zonal flux from the horizontal boundary diffusion scheme ! units: yr m3 s-1 ! cell_methods: xq:point yh:sum zl:sum - ! variants: {age_lbd_diffx,age_lbd_diffx_xyave} -"age_lbd_diffy" [Unused] + ! variants: {age_hbd_diffx,age_hbd_diffx_xyave} +"age_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Ideal Age Tracer diffusive meridional flux from the lateral boundary diffusion scheme + ! long_name: Ideal Age Tracer diffusive meridional flux from the horizontal boundary diffusion scheme ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point zl:sum - ! variants: {age_lbd_diffy,age_lbd_diffy_xyave} + ! variants: {age_hbd_diffy,age_hbd_diffy_xyave} "age_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Ideal Age Tracer @@ -2792,24 +2815,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point -"age_lbd_bulk_diffx" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Ideal Age Tracer - ! units: yr m3 s-1 - ! cell_methods: xq:point yh:sum -"age_lbd_bulk_diffy" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Ideal Age Tracer - ! units: yr m3 s-1 - ! cell_methods: xh:sum yq:point -"age_lbd_diffx_2d" [Unused] +"age_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Ideal Age Tracer + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xq:point yh:sum -"age_lbd_diffy_2d" [Unused] +"age_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Ideal Age Tracer + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point "age_advection_xy" [Unused] @@ -2840,15 +2853,15 @@ ! long_name: Depth integrated neutral diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum area:sum -"age_lbdxy_cont_tendency" [Unused] +"age_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for age + ! long_name: Horizontal boundary diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {age_lbdxy_cont_tendency,age_lbdxy_cont_tendency_xyave} -"age_lbdxy_cont_tendency_2d" [Unused] + ! variants: {age_hbdxy_cont_tendency,age_hbdxy_cont_tendency_xyave} +"age_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for age + ! long_name: Depth integrated horizontal boundary diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum area:sum "age_dfxy_conc_tendency" [Unused] @@ -2857,12 +2870,12 @@ ! units: yr s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {age_dfxy_conc_tendency,age_dfxy_conc_tendency_xyave} -"age_lbdxy_conc_tendency" [Unused] +"age_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for age + ! long_name: Horizontal diffusion tracer concentration tendency for age ! units: yr s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {age_lbdxy_conc_tendency,age_lbdxy_conc_tendency_xyave} + ! variants: {age_hbdxy_conc_tendency,age_hbdxy_conc_tendency_xyave} "ageh_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for ideal age tracer diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.all b/ocean_only/global_ALE/z/MOM_parameter_doc.all index 031b1a4d69..d6f7a078ad 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.all @@ -1087,6 +1087,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1332,6 +1334,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -2107,6 +2112,9 @@ TRACER_ADVECTION_SCHEME = "PPM:H3" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -2154,10 +2162,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/global_ALE/z/available_diags.000000 b/ocean_only/global_ALE/z/available_diags.000000 index 66f5f3f43e..e7d0941f86 100644 --- a/ocean_only/global_ALE/z/available_diags.000000 +++ b/ocean_only/global_ALE/z/available_diags.000000 @@ -759,6 +759,47 @@ ! long_name: Mixed Layer Thickness at Meridional Velocity Points for Viscosity ! units: m ! cell_methods: xh:mean yq:point +"FPw2x" [Unused] + ! modules: {ocean_model,ocean_model_d2} + ! long_name: Wind direction from x-axis + ! units: radians + ! cell_methods: xh:mean yh:mean area:mean +"tauFP_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: Stress Mag Profile (u-points) + ! units: m2 s-2 + ! cell_methods: xq:point yh:mean zi:point + ! variants: {tauFP_u,tauFP_u_xyave} +"tauFP_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: Stress Mag Profile (v-points) + ! units: m2 s-2 + ! cell_methods: xh:mean yq:point zi:point + ! variants: {tauFP_v,tauFP_v_xyave} +"FPtau2s_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from shear direction (u-points) + ! units: radians + ! cell_methods: xq:point yh:mean zi:point + ! variants: {FPtau2s_u,FPtau2s_u_xyave} +"FPtau2s_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from shear direction (v-points) + ! units: radians + ! cell_methods: xh:mean yq:point zi:point + ! variants: {FPtau2s_v,FPtau2s_v_xyave} +"FPtau2w_u" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from wind direction (u-points) + ! units: radians + ! cell_methods: xq:point yh:mean zi:point + ! variants: {FPtau2w_u,FPtau2w_u_xyave} +"FPtau2w_v" [Unused] + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} + ! long_name: stress from wind direction (v-points) + ! units: radians + ! cell_methods: xh:mean yq:point zi:point + ! variants: {FPtau2w_v,FPtau2w_v_xyave} "du_dt_visc" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Zonal Acceleration from Vertical Viscosity @@ -2299,21 +2340,23 @@ ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {opac_3,opac_3_xyave} "KHTR_u" [Used] - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at zonal faces of tracer cell ! units: m2 s-1 - ! cell_methods: xq:point yh:mean + ! cell_methods: xq:point yh:mean zi:point + ! variants: {KHTR_u,KHTR_u_xyave} "KHTR_v" [Used] - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at meridional faces of tracer cell ! units: m2 s-1 - ! cell_methods: xh:mean yq:point + ! cell_methods: xh:mean yq:point zi:point + ! variants: {KHTR_v,KHTR_v_xyave} "KHTR_h" [Used] (CMOR equivalent is "diftrelo") - ! modules: {ocean_model,ocean_model_d2} + ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Epipycnal tracer diffusivity at tracer cell center ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean area:mean - ! variants: {KHTR_h,diftrelo} + ! cell_methods: xh:mean yh:mean zi:point area:mean + ! variants: {KHTR_h,KHTR_h_xyave,diftrelo,diftrelo_xyave} "KHDT_x" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Epipycnal tracer diffusivity operator at zonal faces of tracer cell @@ -2520,18 +2563,18 @@ ! units: W ! cell_methods: xh:sum yq:point zl:sum ! variants: {T_diffy,T_diffy_xyave} -"T_lbd_diffx" [Unused] +"T_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Zonal Flux of Heat + ! long_name: Horizontal Boundary Diffusive Zonal Flux of Heat ! units: W ! cell_methods: xq:point yh:sum zl:sum - ! variants: {T_lbd_diffx,T_lbd_diffx_xyave} -"T_lbd_diffy" [Unused] + ! variants: {T_hbd_diffx,T_hbd_diffx_xyave} +"T_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Meridional Flux of Heat + ! long_name: Horizontal Boundary Diffusive Meridional Flux of Heat ! units: W ! cell_methods: xh:sum yq:point zl:sum - ! variants: {T_lbd_diffy,T_lbd_diffy_xyave} + ! variants: {T_hbd_diffy,T_hbd_diffy_xyave} "T_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Heat @@ -2552,24 +2595,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Heat ! units: W ! cell_methods: xh:sum yq:point -"T_lbd_bulk_diffx" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Heat - ! units: W - ! cell_methods: xq:point yh:sum -"T_lbd_bulk_diffy" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Heat - ! units: W - ! cell_methods: xh:sum yq:point -"T_lbd_diffx_2d" [Unused] +"T_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Heat + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Heat ! units: W ! cell_methods: xq:point yh:sum -"T_lbd_diffy_2d" [Unused] +"T_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Heat + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Heat ! units: W ! cell_methods: xh:sum yq:point "T_advection_xy" [Used] @@ -2601,15 +2634,15 @@ ! units: W m-2 ! cell_methods: xh:sum yh:sum area:sum ! variants: {T_dfxy_cont_tendency_2d,opottemppmdiff_2d} -"T_lbdxy_cont_tendency" [Unused] +"T_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for T + ! long_name: Horizontal boundary diffusion tracer content tendency for T ! units: W m-2 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {T_lbdxy_cont_tendency,T_lbdxy_cont_tendency_xyave} -"T_lbdxy_cont_tendency_2d" [Unused] + ! variants: {T_hbdxy_cont_tendency,T_hbdxy_cont_tendency_xyave} +"T_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for T + ! long_name: Depth integrated horizontal boundary diffusion of tracer content tendency for T ! units: W m-2 ! cell_methods: xh:sum yh:sum area:sum "T_dfxy_conc_tendency" [Unused] @@ -2618,12 +2651,12 @@ ! units: degC s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {T_dfxy_conc_tendency,T_dfxy_conc_tendency_xyave} -"T_lbdxy_conc_tendency" [Unused] +"T_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for T + ! long_name: Horizontal diffusion tracer concentration tendency for T ! units: degC s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {T_lbdxy_conc_tendency,T_lbdxy_conc_tendency_xyave} + ! variants: {T_hbdxy_conc_tendency,T_hbdxy_conc_tendency_xyave} "Th_tendency" [Used] (CMOR equivalent is "opottemptend") ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for heat @@ -2695,18 +2728,18 @@ ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point zl:sum ! variants: {S_diffy,S_diffy_xyave} -"S_lbd_diffx" [Unused] +"S_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Zonal Flux of Salt + ! long_name: Horizontal Boundary Diffusive Zonal Flux of Salt ! units: psu m3 s-1 ! cell_methods: xq:point yh:sum zl:sum - ! variants: {S_lbd_diffx,S_lbd_diffx_xyave} -"S_lbd_diffy" [Unused] + ! variants: {S_hbd_diffx,S_hbd_diffx_xyave} +"S_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral Boundary Diffusive Meridional Flux of Salt + ! long_name: Horizontal Boundary Diffusive Meridional Flux of Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point zl:sum - ! variants: {S_lbd_diffy,S_lbd_diffy_xyave} + ! variants: {S_hbd_diffy,S_hbd_diffy_xyave} "S_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Salt @@ -2727,24 +2760,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point -"S_lbd_bulk_diffx" [Unused] +"S_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Salt + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Salt ! units: psu m3 s-1 ! cell_methods: xq:point yh:sum -"S_lbd_bulk_diffy" [Unused] +"S_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Salt - ! units: psu m3 s-1 - ! cell_methods: xh:sum yq:point -"S_lbd_diffx_2d" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Salt - ! units: psu m3 s-1 - ! cell_methods: xq:point yh:sum -"S_lbd_diffy_2d" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Salt + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Salt ! units: psu m3 s-1 ! cell_methods: xh:sum yq:point "S_advection_xy" [Used] @@ -2776,15 +2799,15 @@ ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum area:sum ! variants: {S_dfxy_cont_tendency_2d,osaltpmdiff_2d} -"S_lbdxy_cont_tendency" [Unused] +"S_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for S + ! long_name: Horizontal boundary diffusion tracer content tendency for S ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {S_lbdxy_cont_tendency,S_lbdxy_cont_tendency_xyave} -"S_lbdxy_cont_tendency_2d" [Unused] + ! variants: {S_hbdxy_cont_tendency,S_hbdxy_cont_tendency_xyave} +"S_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for S + ! long_name: Depth integrated horizontal boundary diffusion of tracer content tendency for S ! units: kg m-2 s-1 ! cell_methods: xh:sum yh:sum area:sum "S_dfxy_conc_tendency" [Unused] @@ -2793,12 +2816,12 @@ ! units: psu s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {S_dfxy_conc_tendency,S_dfxy_conc_tendency_xyave} -"S_lbdxy_conc_tendency" [Unused] +"S_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for S + ! long_name: Horizontal diffusion tracer concentration tendency for S ! units: psu s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {S_lbdxy_conc_tendency,S_lbdxy_conc_tendency_xyave} + ! variants: {S_hbdxy_conc_tendency,S_hbdxy_conc_tendency_xyave} "Sh_tendency" [Used] (CMOR equivalent is "osalttend") ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for salt @@ -2870,18 +2893,18 @@ ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point zl:sum ! variants: {age_dfy,age_dfy_xyave} -"age_lbd_diffx" [Unused] +"age_hbd_diffx" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Ideal Age Tracer diffusive zonal flux from the lateral boundary diffusion scheme + ! long_name: Ideal Age Tracer diffusive zonal flux from the horizontal boundary diffusion scheme ! units: yr m3 s-1 ! cell_methods: xq:point yh:sum zl:sum - ! variants: {age_lbd_diffx,age_lbd_diffx_xyave} -"age_lbd_diffy" [Unused] + ! variants: {age_hbd_diffx,age_hbd_diffx_xyave} +"age_hbd_diffy" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Ideal Age Tracer diffusive meridional flux from the lateral boundary diffusion scheme + ! long_name: Ideal Age Tracer diffusive meridional flux from the horizontal boundary diffusion scheme ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point zl:sum - ! variants: {age_lbd_diffy,age_lbd_diffy_xyave} + ! variants: {age_hbd_diffy,age_hbd_diffy_xyave} "age_adx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} ! long_name: Vertically Integrated Advective Zonal Flux of Ideal Age Tracer @@ -2902,24 +2925,14 @@ ! long_name: Vertically Integrated Diffusive Meridional Flux of Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point -"age_lbd_bulk_diffx" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Zonal Flux of Ideal Age Tracer - ! units: yr m3 s-1 - ! cell_methods: xq:point yh:sum -"age_lbd_bulk_diffy" [Unused] - ! modules: {ocean_model,ocean_model_d2} - ! long_name: Total Bulk Diffusive Meridional Flux of Ideal Age Tracer - ! units: yr m3 s-1 - ! cell_methods: xh:sum yq:point -"age_lbd_diffx_2d" [Unused] +"age_hbd_diffx_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated zonal diffusive flux from the lateral boundary diffusion scheme for Ideal Age Tracer + ! long_name: Vertically-integrated zonal diffusive flux from the horizontal boundary diffusion scheme for Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xq:point yh:sum -"age_lbd_diffy_2d" [Unused] +"age_hbd_diffy_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Vertically-integrated meridional diffusive flux from the lateral boundary diffusion scheme for Ideal Age Tracer + ! long_name: Vertically-integrated meridional diffusive flux from the horizontal boundary diffusion scheme for Ideal Age Tracer ! units: yr m3 s-1 ! cell_methods: xh:sum yq:point "age_advection_xy" [Unused] @@ -2950,15 +2963,15 @@ ! long_name: Depth integrated neutral diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum area:sum -"age_lbdxy_cont_tendency" [Unused] +"age_hbdxy_cont_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer content tendency for age + ! long_name: Horizontal boundary diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum zl:sum area:sum - ! variants: {age_lbdxy_cont_tendency,age_lbdxy_cont_tendency_xyave} -"age_lbdxy_cont_tendency_2d" [Unused] + ! variants: {age_hbdxy_cont_tendency,age_hbdxy_cont_tendency_xyave} +"age_hbdxy_cont_tendency_2d" [Unused] ! modules: {ocean_model,ocean_model_d2} - ! long_name: Depth integrated lateral diffusion tracer content tendency for age + ! long_name: Depth integrated horizontal boundary diffusion tracer content tendency for age ! units: yr m s-1 ! cell_methods: xh:sum yh:sum area:sum "age_dfxy_conc_tendency" [Unused] @@ -2967,12 +2980,12 @@ ! units: yr s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean ! variants: {age_dfxy_conc_tendency,age_dfxy_conc_tendency_xyave} -"age_lbdxy_conc_tendency" [Unused] +"age_hbdxy_conc_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} - ! long_name: Lateral diffusion tracer concentration tendency for age + ! long_name: Horizontal diffusion tracer concentration tendency for age ! units: yr s-1 ! cell_methods: xh:mean yh:mean zl:mean area:mean - ! variants: {age_lbdxy_conc_tendency,age_lbdxy_conc_tendency_xyave} + ! variants: {age_hbdxy_conc_tendency,age_hbdxy_conc_tendency_xyave} "ageh_tendency" [Unused] ! modules: {ocean_model,ocean_model_z,ocean_model_d2,ocean_model_z_d2} ! long_name: Net time tendency for ideal age tracer diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.all b/ocean_only/lock_exchange/MOM_parameter_doc.all index 7d24fdc460..8675c25b06 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.all +++ b/ocean_only/lock_exchange/MOM_parameter_doc.all @@ -771,6 +771,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -929,6 +931,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1412,6 +1417,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1444,10 +1452,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all index 6092154162..fbd251d2b3 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all @@ -871,6 +871,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1029,6 +1031,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1562,6 +1567,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1594,10 +1602,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.all b/ocean_only/nonBous_global/MOM_parameter_doc.all index 4bea911280..f82f856fa6 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.all +++ b/ocean_only/nonBous_global/MOM_parameter_doc.all @@ -869,6 +869,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1106,6 +1108,9 @@ SMAGORINSKY_AH = True ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -1862,6 +1867,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 10.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 50.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 900.0 ! [m2 s-1] default = 0.0 @@ -1897,10 +1905,10 @@ ML_KHTR_SCALE = 0.0 ! [nondim] default = 1.0 USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/resting/layer/MOM_parameter_doc.all b/ocean_only/resting/layer/MOM_parameter_doc.all index 112bff7270..6f1433bb1b 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.all +++ b/ocean_only/resting/layer/MOM_parameter_doc.all @@ -763,6 +763,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -921,6 +923,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1405,6 +1410,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1437,10 +1445,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/resting/z/MOM_parameter_doc.all b/ocean_only/resting/z/MOM_parameter_doc.all index 6f92f34122..4be777f576 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.all +++ b/ocean_only/resting/z/MOM_parameter_doc.all @@ -871,6 +871,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1029,6 +1031,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1509,6 +1514,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1541,10 +1549,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.all b/ocean_only/seamount/layer/MOM_parameter_doc.all index faf4c5f7ad..1ad5e00586 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.all +++ b/ocean_only/seamount/layer/MOM_parameter_doc.all @@ -796,6 +796,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -954,6 +956,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1438,6 +1443,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1470,10 +1478,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.all b/ocean_only/seamount/rho/MOM_parameter_doc.all index 746239de51..66bada0018 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.all +++ b/ocean_only/seamount/rho/MOM_parameter_doc.all @@ -950,6 +950,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1108,6 +1110,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1588,6 +1593,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1620,10 +1628,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.all b/ocean_only/seamount/sigma/MOM_parameter_doc.all index bd96e91a5a..6768ff9bd4 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.all +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.all @@ -899,6 +899,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1057,6 +1059,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1537,6 +1542,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1569,10 +1577,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/seamount/z/MOM_parameter_doc.all b/ocean_only/seamount/z/MOM_parameter_doc.all index 2ff86db078..bd2f1a45df 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.all +++ b/ocean_only/seamount/z/MOM_parameter_doc.all @@ -899,6 +899,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1057,6 +1059,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1537,6 +1542,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1569,10 +1577,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.all b/ocean_only/single_column/BML/MOM_parameter_doc.all index 2ccbdc50c1..f7b122fbe5 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.all +++ b/ocean_only/single_column/BML/MOM_parameter_doc.all @@ -910,6 +910,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1443,6 +1446,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1475,10 +1481,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.all b/ocean_only/single_column/EPBL/MOM_parameter_doc.all index 0c69d839af..4a27794432 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.all +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.all @@ -972,6 +972,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1577,6 +1580,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1609,10 +1615,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.all b/ocean_only/single_column/KPP/MOM_parameter_doc.all index caf0034d60..8c853073af 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.all +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.all @@ -972,6 +972,9 @@ LAPLACIAN = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1502,6 +1505,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 600.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1534,10 +1540,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.all b/ocean_only/sloshing/layer/MOM_parameter_doc.all index 6d6103898f..5eb7ee052a 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.all +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.all @@ -777,6 +777,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -937,6 +939,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1421,6 +1426,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1453,10 +1461,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.all b/ocean_only/sloshing/rho/MOM_parameter_doc.all index 690fa3f0fe..c36fff7ad5 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.all +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.all @@ -933,6 +933,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1093,6 +1095,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1573,6 +1578,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1605,10 +1613,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.all b/ocean_only/sloshing/z/MOM_parameter_doc.all index 713f6d9e8d..98fcbb4a54 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.all +++ b/ocean_only/sloshing/z/MOM_parameter_doc.all @@ -885,6 +885,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1045,6 +1047,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1525,6 +1530,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1557,10 +1565,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.all b/ocean_only/torus_advection_test/MOM_parameter_doc.all index 383cd9ef71..aef24e068f 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.all +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.all @@ -760,6 +760,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -918,6 +920,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1386,6 +1391,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1418,10 +1426,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all index c1d6a8541c..497ad68895 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all @@ -934,6 +934,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1094,6 +1096,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1574,6 +1579,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 1.0E+04 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1621,10 +1629,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all index 1c914493f8..c9210953ac 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all @@ -886,6 +886,8 @@ BT_USE_LAYER_FLUXES = True ! [Boolean] default = True 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 ! === module MOM_continuity === CONTINUITY_SCHEME = "PPM" ! default = "PPM" @@ -1046,6 +1048,9 @@ ADD_LES_VISCOSITY = False ! [Boolean] default = False BIHARMONIC = False ! [Boolean] default = True ! If true, use a biharmonic horizontal viscosity. BIHARMONIC may be used with ! LAPLACIAN. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. USE_LAND_MASK_FOR_HVISC = True ! [Boolean] default = True ! If true, use the land mask for the computation of thicknesses at velocity ! locations. This eliminates the dependence on arbitrary values over land or @@ -1526,6 +1531,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 1.0E+04 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -1573,10 +1581,10 @@ NDIFF_USE_UNMASKED_TRANSPORT_BUG = False ! [Boolean] default = False ! transports that were unmasked, as used prior to Jan 2018. This is not ! recommended. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/ocean_only/unit_tests/MOM_parameter_doc.all b/ocean_only/unit_tests/MOM_parameter_doc.all index 2561c82157..0959bfc678 100644 --- a/ocean_only/unit_tests/MOM_parameter_doc.all +++ b/ocean_only/unit_tests/MOM_parameter_doc.all @@ -775,6 +775,9 @@ SMAGORINSKY_AH = False ! [Boolean] default = False ! If true, use a biharmonic Smagorinsky nonlinear eddy viscosity. LEITH_AH = False ! [Boolean] default = False ! If true, use a biharmonic Leith nonlinear eddy viscosity. +USE_LEITHY = False ! [Boolean] default = False + ! If true, use a biharmonic Leith nonlinear eddy viscosity together with a + ! harmonic backscatter. BOUND_AH = True ! [Boolean] default = True ! If true, the biharmonic coefficient is locally limited to be stable. BETTER_BOUND_AH = True ! [Boolean] default = True @@ -894,6 +897,9 @@ TRACER_ADVECTION_SCHEME = "PLM" ! default = "PLM" ! === module MOM_tracer_hor_diff === KHTR = 0.0 ! [m2 s-1] default = 0.0 ! The background along-isopycnal tracer diffusivity. +KHTR_USE_EBT_STRUCT = False ! [Boolean] default = False + ! If true, uses the equivalent barotropic structure as the vertical structure of + ! the tracer diffusivity. KHTR_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum along-isopycnal tracer diffusivity. KHTR_MAX = 0.0 ! [m2 s-1] default = 0.0 @@ -926,10 +932,10 @@ RECALC_NEUTRAL_SURF = False ! [Boolean] default = False USE_NEUTRAL_DIFFUSION = False ! [Boolean] default = False ! If true, enables the neutral diffusion module. -! === module MOM_lateral_boundary_diffusion === -! This module implements lateral diffusion of tracers near boundaries -USE_LATERAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False - ! If true, enables the lateral boundary tracer's diffusion module. +! === module MOM_hor_bnd_diffusion === +! This module implements horizontal diffusion of tracers near boundaries +USE_HORIZONTAL_BOUNDARY_DIFFUSION = False ! [Boolean] default = False + ! If true, enables the horizonal boundary tracer's diffusion module. OBSOLETE_DIAGNOSTIC_IS_FATAL = True ! [Boolean] default = True ! If an obsolete diagnostic variable appears in the diag_table, cause a FATAL ! error rather than issue a WARNING. diff --git a/src/MOM6 b/src/MOM6 index ac66061e14..e5b64f91cc 160000 --- a/src/MOM6 +++ b/src/MOM6 @@ -1 +1 @@ -Subproject commit ac66061e14a670b0112f1790b53046fcca4a9276 +Subproject commit e5b64f91cc6a86d88c5ba34974e39b30697ec660