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 e0aea6a84..0ce52ffc2 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 @@ -630,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -767,6 +771,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1399,6 +1407,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 7894f9503..1c5ff75fb 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 @@ -630,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -767,6 +771,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1399,6 +1407,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 d2df7e732..8e2f8fab0 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 @@ -630,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -767,6 +771,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1399,6 +1407,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all index 98e0d656e..2521663af 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all @@ -630,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -767,6 +771,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1399,6 +1407,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 e137837aa..43376d8ac 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 @@ -553,6 +553,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -624,6 +629,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -670,6 +679,10 @@ ODA_INCUPD = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -929,6 +942,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1657,6 +1674,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 d81a01a6e..4c904f1bf 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all @@ -605,6 +605,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -671,6 +676,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -720,6 +729,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR", "rho2 RHO2 RHO" ! @@ -1023,6 +1036,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1684,6 +1701,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 3b8846437..e3380f439 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all @@ -605,6 +605,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -671,6 +676,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -720,6 +729,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR", "rho2 RHO2 RHO" ! @@ -1027,6 +1040,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1703,6 +1720,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all index d4ec994d7..752e87d9e 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all @@ -605,6 +605,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -671,6 +676,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -720,6 +729,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR", "rho2 RHO2 RHO" ! @@ -1023,6 +1036,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1684,6 +1701,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all index 5b7ef5611..80380f586 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all @@ -605,6 +605,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -671,6 +676,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -720,6 +729,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR", "rho2 RHO2 RHO" ! @@ -1027,6 +1040,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1703,6 +1720,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all index 4eee4d902..141694ed7 100644 --- a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all @@ -596,6 +596,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -662,6 +667,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -711,6 +720,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 2 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR", "rho2 RHO2 RHO" ! @@ -1014,6 +1027,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1674,6 +1691,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all index cdccaaafa..90ee0b8ae 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all @@ -596,6 +596,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -733,6 +737,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1365,6 +1373,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 1fcd49e8f..78e692ece 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all @@ -596,6 +596,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -733,6 +737,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1365,6 +1373,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all index 286630504..aadf9fdc2 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all @@ -596,6 +596,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -733,6 +737,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1365,6 +1373,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 1e715a638..c04a61b06 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 @@ -508,6 +508,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -973,6 +977,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 187e8f71a..e313ec74f 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 2dc5cc741..5b2ccc2a0 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 74bb0c33b..c2c583bc8 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 @@ -508,6 +508,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -973,6 +977,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 b849a401b..18caa4b3f 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 3b2f717bc..fcf6e7496 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 acd07de5d..8f3a17b8d 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 @@ -508,6 +508,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -973,6 +977,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 44348cb99..6b91e1c57 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 afcc44093..8ce140753 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 230476a51..69faefc68 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 @@ -508,6 +508,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -973,6 +977,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 677a593e7..39de37ac7 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 29bd71233..cb6d0ff56 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 @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/DOME/MOM_parameter_doc.all b/ocean_only/DOME/MOM_parameter_doc.all index bbac41107..a2b2cf840 100644 --- a/ocean_only/DOME/MOM_parameter_doc.all +++ b/ocean_only/DOME/MOM_parameter_doc.all @@ -296,6 +296,10 @@ REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! Values below 20190101 result in the use of older, less accurate expressions ! that were in use at the end of 2018. Higher values result in the use of more ! robust and accurate forms of mathematically equivalent expressions. +OBC_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for neutral diffusion. + ! See REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this + ! option to false. MASKING_DEPTH = -9999.0 ! [m] default = -9999.0 ! The depth below which to mask points as land points, for which all fluxes are ! zeroed out. MASKING_DEPTH is ignored if it has the special default value. @@ -550,6 +554,10 @@ DOME_INFLOW_F = 1.0E-04 ! [s-1] default = 1.0E-04 NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1171,6 +1179,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.all b/ocean_only/Phillips_2layer/MOM_parameter_doc.all index aafb711a0..e74d6421e 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.all +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.all @@ -450,6 +450,10 @@ SPONGE_RATE = 1.157407407407407E-06 ! [s-1] default = 1.157407407407407E-06 NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -569,6 +573,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1101,6 +1109,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all index cb1b68daa..671aa1b40 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all @@ -487,6 +487,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -625,6 +630,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1094,6 +1103,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all index d9a85f594..f0250a19e 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all @@ -524,6 +524,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1180,6 +1184,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all index 03692a292..597bff3f5 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all @@ -549,6 +549,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -686,6 +691,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1337,6 +1346,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.all b/ocean_only/adjustment2d/z/MOM_parameter_doc.all index c73f39b24..d38c9e0d1 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.all @@ -496,6 +496,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -638,6 +643,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1289,6 +1298,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/benchmark/MOM_parameter_doc.all b/ocean_only/benchmark/MOM_parameter_doc.all index 8b65d2690..0d03edf65 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.all +++ b/ocean_only/benchmark/MOM_parameter_doc.all @@ -553,6 +553,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -690,6 +694,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1278,6 +1286,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.all b/ocean_only/circle_obcs/MOM_parameter_doc.all index 66b5ef768..d4542d4bd 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.all +++ b/ocean_only/circle_obcs/MOM_parameter_doc.all @@ -302,6 +302,10 @@ REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! Values below 20190101 result in the use of older, less accurate expressions ! that were in use at the end of 2018. Higher values result in the use of more ! robust and accurate forms of mathematically equivalent expressions. +OBC_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for neutral diffusion. + ! See REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this + ! option to false. MASKING_DEPTH = -9999.0 ! [m] default = -9999.0 ! The depth below which to mask points as land points, for which all fluxes are ! zeroed out. MASKING_DEPTH is ignored if it has the special default value. @@ -548,6 +552,10 @@ OBC_USER_CONFIG = "none" ! default = "none" NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1236,6 +1244,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/double_gyre/MOM_parameter_doc.all b/ocean_only/double_gyre/MOM_parameter_doc.all index 5dd0b3088..e7925ae69 100644 --- a/ocean_only/double_gyre/MOM_parameter_doc.all +++ b/ocean_only/double_gyre/MOM_parameter_doc.all @@ -417,6 +417,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1063,6 +1067,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/external_gwave/MOM_parameter_doc.all b/ocean_only/external_gwave/MOM_parameter_doc.all index 8aed6bb76..3e07164be 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.all +++ b/ocean_only/external_gwave/MOM_parameter_doc.all @@ -513,6 +513,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1166,6 +1170,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all index 34396744d..5b2701053 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all @@ -523,6 +523,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1177,6 +1181,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all index 08e122150..bbdfb0f78 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all @@ -560,6 +560,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -687,6 +692,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1336,6 +1345,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all index 33b929965..c5070e106 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all @@ -507,6 +507,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -639,6 +644,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1288,6 +1297,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.all b/ocean_only/flow_downslope/z/MOM_parameter_doc.all index 622634c5c..a8bb0d606 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.all @@ -507,6 +507,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -639,6 +644,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1288,6 +1297,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all index 2bee0fca5..374fe8ecd 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all @@ -595,6 +595,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -661,6 +666,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -710,6 +719,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -969,6 +982,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1707,6 +1724,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.all b/ocean_only/global_ALE/layer/MOM_parameter_doc.all index 9537094e0..b346c92e5 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.all @@ -591,6 +591,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -861,6 +865,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1559,6 +1567,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.all b/ocean_only/global_ALE/z/MOM_parameter_doc.all index 974b8ac7c..0ad36e452 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.all @@ -537,6 +537,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -608,6 +613,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -657,6 +666,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -916,6 +929,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1654,6 +1671,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.all b/ocean_only/lock_exchange/MOM_parameter_doc.all index f07be9955..335bffb0e 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.all +++ b/ocean_only/lock_exchange/MOM_parameter_doc.all @@ -516,6 +516,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1169,6 +1173,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. 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 35e7d3bbb..beee2967e 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all @@ -496,6 +496,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -624,6 +629,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1326,6 +1335,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.all b/ocean_only/nonBous_global/MOM_parameter_doc.all index afbb38e7a..c9d635d8e 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.all +++ b/ocean_only/nonBous_global/MOM_parameter_doc.all @@ -557,6 +557,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -689,6 +693,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = False ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +EBT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. USE_QG_LEITH_GM = False ! [Boolean] default = False ! If true, use the QG Leith viscosity as the GM coefficient. @@ -1376,6 +1384,10 @@ DIAG_EBT_MONO_N2_COLUMN_FRACTION = 0.0 ! [nondim] default = 0.0 DIAG_EBT_MONO_N2_DEPTH = -1.0 ! [m] default = -1.0 ! The depth below which N2 is limited as monotonic for the purposes of ! calculating the equivalent barotropic wave speed. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/resting/layer/MOM_parameter_doc.all b/ocean_only/resting/layer/MOM_parameter_doc.all index 2fe7e148b..027e46146 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.all +++ b/ocean_only/resting/layer/MOM_parameter_doc.all @@ -508,6 +508,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1162,6 +1166,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/resting/z/MOM_parameter_doc.all b/ocean_only/resting/z/MOM_parameter_doc.all index 13379195d..3f287753e 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.all +++ b/ocean_only/resting/z/MOM_parameter_doc.all @@ -496,6 +496,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -624,6 +629,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1273,6 +1282,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.all b/ocean_only/seamount/layer/MOM_parameter_doc.all index 671b5f365..9106a6702 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.all +++ b/ocean_only/seamount/layer/MOM_parameter_doc.all @@ -541,6 +541,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1195,6 +1199,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.all b/ocean_only/seamount/rho/MOM_parameter_doc.all index 5843c25da..e294a79ad 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.all +++ b/ocean_only/seamount/rho/MOM_parameter_doc.all @@ -574,6 +574,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -703,6 +708,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1352,6 +1361,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.all b/ocean_only/seamount/sigma/MOM_parameter_doc.all index 7b6b69eef..21e69967a 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.all +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.all @@ -521,6 +521,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -652,6 +657,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1301,6 +1310,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/seamount/z/MOM_parameter_doc.all b/ocean_only/seamount/z/MOM_parameter_doc.all index 47180dcf7..18672146c 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.all +++ b/ocean_only/seamount/z/MOM_parameter_doc.all @@ -521,6 +521,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -652,6 +657,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1301,6 +1310,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.all b/ocean_only/single_column/BML/MOM_parameter_doc.all index 2fe395f81..47b72eeff 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.all +++ b/ocean_only/single_column/BML/MOM_parameter_doc.all @@ -539,6 +539,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1004,6 +1008,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.all b/ocean_only/single_column/EPBL/MOM_parameter_doc.all index b983294ef..372d681cb 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.all +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.all @@ -483,6 +483,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -554,6 +559,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -603,6 +612,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1072,6 +1085,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.all b/ocean_only/single_column/KPP/MOM_parameter_doc.all index 345ff032d..c34280619 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.all +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.all @@ -483,6 +483,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -554,6 +559,10 @@ TEMP_SALT_INIT_VERTICAL_REMAP_ONLY = False ! [Boolean] default = False ! If true, initial conditions are on the model horizontal grid. Extrapolation ! over missing ocean values is done using an ICE-9 procedure with vertical ALE ! remapping . +Z_INIT_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for initialization. See + ! REMAPPING_USE_OM4_SUBCELLS for more details. We recommend setting this option + ! to false. HOR_REGRID_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the order of arithmetic for horizontal regridding. Dates ! before 20190101 give the same answers as the code did in late 2018, while @@ -603,6 +612,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1072,6 +1085,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.all b/ocean_only/sloshing/layer/MOM_parameter_doc.all index b096c2d1f..ed877c6d0 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.all +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.all @@ -522,6 +522,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1178,6 +1182,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.all b/ocean_only/sloshing/rho/MOM_parameter_doc.all index 112f1a662..a7fcef90e 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.all +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.all @@ -552,6 +552,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -686,6 +691,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1337,6 +1346,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.all b/ocean_only/sloshing/z/MOM_parameter_doc.all index dc5d4cada..17d3da37a 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.all +++ b/ocean_only/sloshing/z/MOM_parameter_doc.all @@ -499,6 +499,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -638,6 +643,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1289,6 +1298,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.all b/ocean_only/torus_advection_test/MOM_parameter_doc.all index 94a829c83..6af281582 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.all +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.all @@ -526,6 +526,10 @@ ODA_INCUPD = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -1161,6 +1165,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all index f16bb6655..67996e5c3 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all @@ -549,6 +549,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. PARTIAL_CELL_VELOCITY_REMAP = False ! [Boolean] default = False ! If true, use partial cell thicknesses at velocity points that are masked out ! where they extend below the shallower of the neighboring bathymetry for @@ -687,6 +692,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1338,6 +1347,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all index 66d9a8c57..e8bcec16a 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all @@ -496,6 +496,11 @@ REMAP_BOUNDARY_EXTRAP = False ! [Boolean] default = False INIT_BOUNDARY_EXTRAP = False ! [Boolean] default = False ! If true, values at the interfaces of boundary cells are extrapolated instead ! of piecewise constant during initialization.Defaults to REMAP_BOUNDARY_EXTRAP. +REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! This selects the remapping algorithm used in OM4 that does not use the full + ! reconstruction for the top- and lower-most sub-layers, but instead assumes + ! they are always vanished (untrue) and so just uses their edge values. We + ! recommend setting this option to false. REMAPPING_ANSWER_DATE = 99991231 ! default = 99991231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -639,6 +644,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. USE_INDEX_DIAGNOSTIC_AXES = False ! [Boolean] default = False ! If true, use a grid index coordinate convention for diagnostic axes. DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR" @@ -1290,6 +1299,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/ocean_only/unit_tests/MOM_parameter_doc.all b/ocean_only/unit_tests/MOM_parameter_doc.all index 1f7d97afd..6300feb79 100644 --- a/ocean_only/unit_tests/MOM_parameter_doc.all +++ b/ocean_only/unit_tests/MOM_parameter_doc.all @@ -411,6 +411,10 @@ SPONGE = False ! [Boolean] default = False NUM_DIAG_COORDS = 1 ! default = 1 ! The number of diagnostic vertical coordinates to use. For each coordinate, an ! entry in DIAG_COORDS must be provided. +DIAG_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for diagnostics. See + ! REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting this option to + ! false. REMAPPING_ANSWER_DATE = 20181231 ! default = 20181231 ! The vintage of the expressions and order of arithmetic to use for remapping. ! Values below 20190101 result in the use of older, less accurate expressions @@ -886,6 +890,10 @@ INTERNAL_WAVE_SPEED_MIN = 0.0 ! [m s-1] default = 0.0 INTERNAL_WAVE_SPEED_BETTER_EST = True ! [Boolean] default = True ! If true, use a more robust estimate of the first mode wave speed as the ! starting point for iterations. +INTWAVE_REMAPPING_USE_OM4_SUBCELLS = True ! [Boolean] default = True + ! If true, use the OM4 remapping-via-subcells algorithm for calculating EBT + ! structure. See REMAPPING_USE_OM4_SUBCELLS for details. We recommend setting + ! this option to false. ! === module MOM_diabatic_driver === ! The following parameters are used for diabatic processes. diff --git a/src/MOM6 b/src/MOM6 index f79879687..88d9eb79f 160000 --- a/src/MOM6 +++ b/src/MOM6 @@ -1 +1 @@ -Subproject commit f798796872a618d5179f6360984119b026d0e316 +Subproject commit 88d9eb79fc60ddd07269aa5fd641c9c101df9515