MOM6: Use Adcroft_reciprocal for Iwt_[uv]_tot

- NOAA-GFDL/MOM6@09774d410 Use Adcroft_reciprocal for Iwt_[uv]_tot - NOAA-GFDL/MOM6@1d2911f33 Remove visc_rem from h_[uv] in continuity solver - NOAA-GFDL/MOM6@337ee7315 Fix a typo in USE_CONT_THICKNESS description - NOAA-GFDL/MOM6@66e8891a9 Use dt for vertvisc_remnant() in predictor - NOAA-GFDL/MOM6@a29608011 Normalize wt_[uv] in MOM_barotropic - NOAA-GFDL/MOM6@85212229c Fix warning message indices in MOM_barotropic - NOAA-GFDL/MOM6@b56a6400f Deallocate eta_av_bc in MOM_end() - NOAA-GFDL/MOM6@270ba597a +(*)Fix rotation of coupler_type variables
ElizabethYankovsky · Jun 6, 2024 · ba078fc · ba078fc
1 parent c178c22
commit ba078fc
Show file tree

Hide file tree

Showing 62 changed files with 1,009 additions and 166 deletions.
diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all
@@ -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
@@ -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
@@ -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
@@ -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