Skip to content

MOM6: Rename VISC_REM bugfix parameters #478

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2024
Merged

MOM6: Rename VISC_REM bugfix parameters #478

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,13 @@ 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.
! for in two places. This parameter controls the defaults of two individual
! flags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and
! VISC_REM_BT_WEIGHT_BUG in MOM_barotropic.
VISC_REM_TIMESTEP_BUG = True ! [Boolean] default = True
! If true, recover a bug that uses dt_pred rather than dt in vertvisc_remnant()
! at the end of predictor stage for the following continuity() and btstep()
! calls in the corrector step. Default of this flag is set by VISC_REM_BUG

! === module MOM_continuity_PPM ===
MONOTONIC_CONTINUITY = False ! [Boolean] default = False
Expand Down Expand Up @@ -1018,9 +1016,6 @@ 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
Expand Down Expand Up @@ -1316,10 +1311,10 @@ 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 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.
VISC_REM_BT_WEIGHT_BUG = True ! [Boolean] default = True
! If true, recover a bug in barotropic solver that uses an unnormalized weight
! function for vertical averages of baroclinic velocity and forcing. Default of
! this flag is set by VISC_REM_BUG.
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
Expand Down
27 changes: 11 additions & 16 deletions coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,13 @@ 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.
! for in two places. This parameter controls the defaults of two individual
! flags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and
! VISC_REM_BT_WEIGHT_BUG in MOM_barotropic.
VISC_REM_TIMESTEP_BUG = True ! [Boolean] default = True
! If true, recover a bug that uses dt_pred rather than dt in vertvisc_remnant()
! at the end of predictor stage for the following continuity() and btstep()
! calls in the corrector step. Default of this flag is set by VISC_REM_BUG

! === module MOM_continuity_PPM ===
MONOTONIC_CONTINUITY = False ! [Boolean] default = False
Expand Down Expand Up @@ -1018,9 +1016,6 @@ 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
Expand Down Expand Up @@ -1316,10 +1311,10 @@ 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 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.
VISC_REM_BT_WEIGHT_BUG = True ! [Boolean] default = True
! If true, recover a bug in barotropic solver that uses an unnormalized weight
! function for vertical averages of baroclinic velocity and forcing. Default of
! this flag is set by VISC_REM_BUG.
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
Expand Down
27 changes: 11 additions & 16 deletions coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,13 @@ 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.
! for in two places. This parameter controls the defaults of two individual
! flags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and
! VISC_REM_BT_WEIGHT_BUG in MOM_barotropic.
VISC_REM_TIMESTEP_BUG = True ! [Boolean] default = True
! If true, recover a bug that uses dt_pred rather than dt in vertvisc_remnant()
! at the end of predictor stage for the following continuity() and btstep()
! calls in the corrector step. Default of this flag is set by VISC_REM_BUG

! === module MOM_continuity_PPM ===
MONOTONIC_CONTINUITY = False ! [Boolean] default = False
Expand Down Expand Up @@ -1018,9 +1016,6 @@ 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
Expand Down Expand Up @@ -1316,10 +1311,10 @@ 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 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.
VISC_REM_BT_WEIGHT_BUG = True ! [Boolean] default = True
! If true, recover a bug in barotropic solver that uses an unnormalized weight
! function for vertical averages of baroclinic velocity and forcing. Default of
! this flag is set by VISC_REM_BUG.
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
Expand Down
27 changes: 11 additions & 16 deletions ice_ocean_SIS2/Baltic/MOM_parameter_doc.all
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,15 +968,13 @@ 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.
! for in two places. This parameter controls the defaults of two individual
! flags, VISC_REM_TIMESTEP_BUG in MOM_dynamics_split_RK2(b) and
! VISC_REM_BT_WEIGHT_BUG in MOM_barotropic.
VISC_REM_TIMESTEP_BUG = True ! [Boolean] default = True
! If true, recover a bug that uses dt_pred rather than dt in vertvisc_remnant()
! at the end of predictor stage for the following continuity() and btstep()
! calls in the corrector step. Default of this flag is set by VISC_REM_BUG

! === module MOM_continuity_PPM ===
MONOTONIC_CONTINUITY = False ! [Boolean] default = False
Expand Down Expand Up @@ -1018,9 +1016,6 @@ 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
Expand Down Expand Up @@ -1316,10 +1311,10 @@ 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 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.
VISC_REM_BT_WEIGHT_BUG = True ! [Boolean] default = True
! If true, recover a bug in barotropic solver that uses an unnormalized weight
! function for vertical averages of baroclinic velocity and forcing. Default of
! this flag is set by VISC_REM_BUG.
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
Expand Down
Loading
Loading