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 b2139177e..30a767ede 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 @@ -964,6 +964,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1005,6 +1016,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1086,8 +1100,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1270,8 +1284,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 02861b6cf..a002ee261 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 @@ -964,6 +964,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1005,6 +1016,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1086,8 +1100,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1270,8 +1284,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 bc8169aa6..45ee60e08 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 @@ -964,6 +964,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1005,6 +1016,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1086,8 +1100,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1270,8 +1284,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all index f0c9ab4ab..0604cd82f 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all @@ -964,6 +964,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1005,6 +1016,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1086,8 +1100,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1270,8 +1284,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 b8d3e3829..72ea067fc 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 @@ -1102,6 +1102,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1143,6 +1154,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1294,8 +1308,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1490,8 +1504,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. BAROTROPIC_TIDAL_SAL_BUG = False ! [Boolean] default = False ! If true, the tidal self-attraction and loading anomaly in the barotropic ! solver has the wrong sign, replicating a long-standing bug with a scalar 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 6c98cf5f0..de2626dd8 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all @@ -1196,6 +1196,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1237,6 +1248,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1318,8 +1332,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1524,8 +1538,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 43f7add4c..259096e04 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all @@ -1210,6 +1210,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1251,6 +1262,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1332,8 +1346,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1543,8 +1557,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all index 1f14f7eed..d30ceb9b3 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all @@ -1196,6 +1196,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1237,6 +1248,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1318,8 +1332,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1524,8 +1538,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all index fd4c7ceca..a2599794b 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all @@ -1210,6 +1210,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1251,6 +1262,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1332,8 +1346,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1543,8 +1557,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all index 9a234f5c0..0055575fd 100644 --- a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all @@ -1187,6 +1187,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1228,6 +1239,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1309,8 +1323,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1514,8 +1528,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all index 921dc0f91..2457784fc 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all @@ -930,6 +930,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -971,6 +982,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1052,8 +1066,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1236,8 +1250,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 4173c46ef..c94878600 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all @@ -930,6 +930,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -971,6 +982,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1052,8 +1066,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1236,8 +1250,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all index ca5b651a2..9359c45a1 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all @@ -930,6 +930,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -971,6 +982,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1052,8 +1066,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1236,8 +1250,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 26c30d589..eb63d7d60 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 @@ -793,6 +793,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -874,8 +877,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 fe62bb45f..150c3df70 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 f8c7df38d..5e29faed9 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 43e445d7d..2a1e86411 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 @@ -793,6 +793,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -874,8 +877,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 3ddd5191e..2ef91bcdf 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 e0c34c8f7..5f509cace 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 68f0ee8c7..ef0b1f8f9 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 @@ -793,6 +793,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -874,8 +877,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 2b219dc7b..d123ae2b6 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 10f3a5565..ca768b57b 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 2db656ea5..4cd86fbf5 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 @@ -793,6 +793,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -874,8 +877,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 2f2f12976..76c990223 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True 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 7842d0b25..731202a37 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 @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True diff --git a/ocean_only/DOME/MOM_parameter_doc.all b/ocean_only/DOME/MOM_parameter_doc.all index 8a77461aa..dc853bdfd 100644 --- a/ocean_only/DOME/MOM_parameter_doc.all +++ b/ocean_only/DOME/MOM_parameter_doc.all @@ -798,6 +798,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -839,6 +850,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -894,8 +908,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = True ! [Boolean] default = True @@ -1061,8 +1075,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.all b/ocean_only/Phillips_2layer/MOM_parameter_doc.all index 5d5d61fae..7e45c1b25 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.all +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.all @@ -735,6 +735,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -776,6 +787,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -831,8 +845,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = True ! [Boolean] default = True @@ -998,8 +1012,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all index 676e93c6d..77b76c0d8 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all @@ -905,6 +905,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -986,8 +989,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all index a22212fdc..7689b6554 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all @@ -785,6 +785,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -826,6 +837,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -907,8 +921,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1070,8 +1084,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all index bc09a26cf..8b1c3e288 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all @@ -942,6 +942,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -983,6 +994,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1064,8 +1078,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1227,8 +1241,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.all b/ocean_only/adjustment2d/z/MOM_parameter_doc.all index cee9ddbbd..3703e29ec 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.all @@ -894,6 +894,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -935,6 +946,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1016,8 +1030,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1179,8 +1193,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/benchmark/MOM_parameter_doc.all b/ocean_only/benchmark/MOM_parameter_doc.all index 507aa8362..cbdcf03a9 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.all +++ b/ocean_only/benchmark/MOM_parameter_doc.all @@ -874,6 +874,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -915,6 +926,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -996,8 +1010,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = True ! [Boolean] default = True @@ -1156,8 +1170,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.all b/ocean_only/circle_obcs/MOM_parameter_doc.all index 856faedbf..3b954adee 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.all +++ b/ocean_only/circle_obcs/MOM_parameter_doc.all @@ -796,6 +796,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -837,6 +848,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -918,8 +932,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 25.0 ! [m2 s-1] default = 0.0 @@ -1119,8 +1133,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/double_gyre/MOM_parameter_doc.all b/ocean_only/double_gyre/MOM_parameter_doc.all index 245b7413b..5c5bd9b43 100644 --- a/ocean_only/double_gyre/MOM_parameter_doc.all +++ b/ocean_only/double_gyre/MOM_parameter_doc.all @@ -668,6 +668,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -709,6 +720,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -790,8 +804,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -953,8 +967,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/external_gwave/MOM_parameter_doc.all b/ocean_only/external_gwave/MOM_parameter_doc.all index d8575a496..079ee7e31 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.all +++ b/ocean_only/external_gwave/MOM_parameter_doc.all @@ -774,6 +774,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -815,6 +826,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -896,8 +910,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.01 ! [m2 s-1] default = 0.0 @@ -1056,8 +1070,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all index 75b5c552c..a882bbca7 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all @@ -784,6 +784,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -825,6 +836,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -906,8 +920,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -1067,8 +1081,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all index 51b5a71a8..a821ba9d1 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all @@ -943,6 +943,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -984,6 +995,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1065,8 +1079,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -1226,8 +1240,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all index 9b8cb2d03..9563f6021 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all @@ -895,6 +895,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -936,6 +947,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1017,8 +1031,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -1178,8 +1192,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.all b/ocean_only/flow_downslope/z/MOM_parameter_doc.all index ff49df0e0..ce1671afa 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.all @@ -895,6 +895,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -936,6 +947,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1017,8 +1031,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -1178,8 +1192,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all index 37a527d36..5e9f79ea0 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all @@ -1152,6 +1152,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1193,6 +1204,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1344,8 +1358,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1540,8 +1554,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. BAROTROPIC_TIDAL_SAL_BUG = False ! [Boolean] default = False ! If true, the tidal self-attraction and loading anomaly in the barotropic ! solver has the wrong sign, replicating a long-standing bug with a scalar diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.all b/ocean_only/global_ALE/layer/MOM_parameter_doc.all index d61461a23..5467f21c9 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.all @@ -1047,6 +1047,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1088,6 +1099,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1239,8 +1253,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1426,8 +1440,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. BAROTROPIC_TIDAL_SAL_BUG = False ! [Boolean] default = False ! If true, the tidal self-attraction and loading anomaly in the barotropic ! solver has the wrong sign, replicating a long-standing bug with a scalar diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.all b/ocean_only/global_ALE/z/MOM_parameter_doc.all index c508fccab..d7b121611 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.all @@ -1099,6 +1099,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1140,6 +1151,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1291,8 +1305,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1487,8 +1501,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. BAROTROPIC_TIDAL_SAL_BUG = False ! [Boolean] default = False ! If true, the tidal self-attraction and loading anomaly in the barotropic ! solver has the wrong sign, replicating a long-standing bug with a scalar diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.all b/ocean_only/lock_exchange/MOM_parameter_doc.all index 65a4b3ea1..d2fbcdacc 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.all +++ b/ocean_only/lock_exchange/MOM_parameter_doc.all @@ -777,6 +777,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -818,6 +829,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -899,8 +913,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.01 ! [m2 s-1] default = 0.0 @@ -1059,8 +1073,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to 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 692ef6e22..e1d589498 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all @@ -880,6 +880,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -921,6 +932,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1002,8 +1016,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0E+04 ! [m2 s-1] default = 0.0 @@ -1163,8 +1177,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.all b/ocean_only/nonBous_global/MOM_parameter_doc.all index de7d0ab4d..cd7ae40b3 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.all +++ b/ocean_only/nonBous_global/MOM_parameter_doc.all @@ -878,6 +878,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -919,6 +930,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1065,8 +1079,8 @@ USE_ZB2020 = False ! [Boolean] default = False ! === module MOM_hor_visc === USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1245,6 +1259,10 @@ DYNAMIC_SURFACE_PRESSURE = False ! [Boolean] default = False ! If true, add a dynamic pressure due to a viscous ice shelf, for instance. BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. BAROTROPIC_TIDAL_SAL_BUG = False ! [Boolean] default = False ! If true, the tidal self-attraction and loading anomaly in the barotropic ! solver has the wrong sign, replicating a long-standing bug with a scalar diff --git a/ocean_only/resting/layer/MOM_parameter_doc.all b/ocean_only/resting/layer/MOM_parameter_doc.all index a463475bb..bf7958b75 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.all +++ b/ocean_only/resting/layer/MOM_parameter_doc.all @@ -769,6 +769,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -810,6 +821,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -891,8 +905,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0 ! [m2 s-1] default = 0.0 @@ -1052,8 +1066,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/resting/z/MOM_parameter_doc.all b/ocean_only/resting/z/MOM_parameter_doc.all index a2ec8c296..f373e7bab 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.all +++ b/ocean_only/resting/z/MOM_parameter_doc.all @@ -880,6 +880,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -921,6 +932,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1002,8 +1016,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1.0 ! [m2 s-1] default = 0.0 @@ -1163,8 +1177,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.all b/ocean_only/seamount/layer/MOM_parameter_doc.all index b83503936..ced49ae39 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.all +++ b/ocean_only/seamount/layer/MOM_parameter_doc.all @@ -802,6 +802,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -843,6 +854,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -924,8 +938,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1000.0 ! [m2 s-1] default = 0.0 @@ -1085,8 +1099,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.all b/ocean_only/seamount/rho/MOM_parameter_doc.all index 06bc90161..63c3c7b55 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.all +++ b/ocean_only/seamount/rho/MOM_parameter_doc.all @@ -959,6 +959,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -1000,6 +1011,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1081,8 +1095,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1000.0 ! [m2 s-1] default = 0.0 @@ -1242,8 +1256,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.all b/ocean_only/seamount/sigma/MOM_parameter_doc.all index f3141e912..fc5b45c56 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.all +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.all @@ -908,6 +908,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -949,6 +960,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1030,8 +1044,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1000.0 ! [m2 s-1] default = 0.0 @@ -1191,8 +1205,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/seamount/z/MOM_parameter_doc.all b/ocean_only/seamount/z/MOM_parameter_doc.all index b022ea2c4..722ec7bda 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.all +++ b/ocean_only/seamount/z/MOM_parameter_doc.all @@ -908,6 +908,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -949,6 +960,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1030,8 +1044,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 1000.0 ! [m2 s-1] default = 0.0 @@ -1191,8 +1205,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.all b/ocean_only/single_column/BML/MOM_parameter_doc.all index 7e7cf1f3d..e029c6e80 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.all +++ b/ocean_only/single_column/BML/MOM_parameter_doc.all @@ -824,6 +824,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -905,8 +908,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.all b/ocean_only/single_column/EPBL/MOM_parameter_doc.all index b5de26b8c..1796503fa 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.all +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.all @@ -883,6 +883,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -964,8 +967,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.all b/ocean_only/single_column/KPP/MOM_parameter_doc.all index ab2ea90d2..45ca91867 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.all +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.all @@ -883,6 +883,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -964,8 +967,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = False ! [Boolean] default = True diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.all b/ocean_only/sloshing/layer/MOM_parameter_doc.all index 47566e51e..175acb620 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.all +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.all @@ -783,6 +783,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -824,6 +835,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -905,8 +919,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1068,8 +1082,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.all b/ocean_only/sloshing/rho/MOM_parameter_doc.all index 48388399b..b31999fe3 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.all +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.all @@ -942,6 +942,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -983,6 +994,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1064,8 +1078,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1227,8 +1241,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.all b/ocean_only/sloshing/z/MOM_parameter_doc.all index 30eb3e4cb..1c5db7491 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.all +++ b/ocean_only/sloshing/z/MOM_parameter_doc.all @@ -894,6 +894,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -935,6 +946,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1016,8 +1030,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1179,8 +1193,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.all b/ocean_only/torus_advection_test/MOM_parameter_doc.all index 24e4c7391..b9fdd9e32 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.all +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.all @@ -766,6 +766,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -807,6 +818,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -888,8 +902,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.01 ! [m2 s-1] default = 0.0 @@ -1051,8 +1065,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all index be23a4c64..0ed27c955 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all @@ -943,6 +943,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -984,6 +995,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1065,8 +1079,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1228,8 +1242,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all index b41051bc9..ef856daec 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all @@ -895,6 +895,17 @@ STORE_CORIOLIS_ACCEL = True ! [Boolean] default = True ! 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 +VISC_REM_BUG = True ! [Boolean] default = True + ! If true, visc_rem_[uv] in split mode is incorrectly calculated or accounted + ! for in three places. This parameter controls the defaults of three individual + ! flags, VISC_REM_TIMESTEP_FIX in MOM_dynamics_split_RK2(b), + ! VISC_REM_BT_WEIGHT_FIX in MOM_barotropic, and VISC_REM_CONT_HVEL_FIX in + ! MOM_continuity_PPM. Eventually, the three individual flags should be removed + ! after tests and the default of VISC_REM_BUG should be to False. +VISC_REM_TIMESTEP_FIX = False ! [Boolean] default = False + ! If true, use dt rather than dt_pred in vertvisc_remnant() at the end of + ! predictor stage for the following continuity() call and btstep() call in the + ! corrector step. This flag should be used with VISC_REM_BT_WEIGHT_FIX. ! === module MOM_continuity_PPM === MONOTONIC_CONTINUITY = False ! [Boolean] default = False @@ -936,6 +947,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -1017,8 +1031,8 @@ HOR_VISC_ANSWER_DATE = 99991231 ! default = 99991231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = True ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. KH = 0.0 ! [m2 s-1] default = 0.0 @@ -1180,8 +1194,12 @@ BT_CORIOLIS_SCALE = 1.0 ! [nondim] default = 1.0 ! A factor by which the barotropic Coriolis anomaly terms are scaled. BAROTROPIC_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions in the barotropic solver. Values below 20190101 - ! recover the answers from the end of 2018, while higher values uuse more + ! recover the answers from the end of 2018, while higher values use more ! efficient or general expressions. +VISC_REM_BT_WEIGHT_FIX = False ! [Boolean] default = False + ! If true, use a normalized weight function for vertical averages of baroclinic + ! velocity and forcing. Default of this flag is set by VISC_REM_BUG. This flag + ! should be used with VISC_REM_TIMESTEP_FIX. TIDAL_SAL_FLATHER = False ! [Boolean] default = False ! If true, then apply adjustments to the external gravity wave speed used with ! the Flather OBC routine consistent with the barotropic solver. This applies to diff --git a/ocean_only/unit_tests/MOM_parameter_doc.all b/ocean_only/unit_tests/MOM_parameter_doc.all index 10dd98ad8..60b6e41f1 100644 --- a/ocean_only/unit_tests/MOM_parameter_doc.all +++ b/ocean_only/unit_tests/MOM_parameter_doc.all @@ -669,6 +669,9 @@ CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True ! If true, use the marginal face areas from the continuity solver for use as the ! weights in the barotropic solver. Otherwise use the transport averaged areas. +VISC_REM_CONT_HVEL_FIX = False ! [Boolean] default = False + ! If true, velocity cell thickness h_[uv] from the continuity solver is not + ! multiplied by visc_rem_[uv]. Default of this flag is set by VISC_REM_BUG. ! === module MOM_CoriolisAdv === NOSLIP = False ! [Boolean] default = False @@ -750,8 +753,8 @@ HOR_VISC_ANSWER_DATE = 20181231 ! default = 20181231 ! end of 2018, while higher values use updated and more robust forms of the same ! expressions. USE_CONT_THICKNESS = False ! [Boolean] default = False - ! If true, use thickness at velocity points from continuity solver. This - ! optioncurrently only works with split mode. + ! If true, use thickness at velocity points from continuity solver. This option + ! currently only works with split mode. LAPLACIAN = False ! [Boolean] default = False ! If true, use a Laplacian horizontal viscosity. BIHARMONIC = True ! [Boolean] default = True diff --git a/src/MOM6 b/src/MOM6 index 9ab5f3483..09774d410 160000 --- a/src/MOM6 +++ b/src/MOM6 @@ -1 +1 @@ -Subproject commit 9ab5f3483b35a39d15d4d294b9a2a8f6c577ac67 +Subproject commit 09774d410007b98e4ebcf938ed39d138213c5ab7