From fdeb7908947b6d58cb2cfd9d4ce8444ba84ff0d8 Mon Sep 17 00:00:00 2001 From: MOM6 bot Date: Tue, 28 Jan 2025 19:21:45 -0500 Subject: [PATCH] MOM6: Add Option to Specify Tracer Advection Time Step (#757) - NOAA-GFDL/MOM6@a40bbb9b2 Add Option to Specify Tracer Advection Time Step (#757) - NOAA-GFDL/MOM6@2370f7c6c Rescale strat_floor - NOAA-GFDL/MOM6@35d7e7613 Revise rescaling in bulkmixedlayer - NOAA-GFDL/MOM6@9fd0eccb0 +Add alternate gravity variable GV%g_Earth_Z_T2 --- .../AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.short | 8 +++--- .../Concurrent_ice_1deg/MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.short | 8 +++--- .../MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.short | 8 +++--- ice_ocean_SIS2/Baltic/MOM_parameter_doc.all | 27 +++++++++++++------ ice_ocean_SIS2/Baltic/MOM_parameter_doc.short | 8 +++--- .../MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.short | 8 +++--- .../Baltic_OM4_025/MOM_parameter_doc.all | 27 +++++++++++++------ .../Baltic_OM4_025/MOM_parameter_doc.short | 16 +++++------ .../Baltic_OM4_05/MOM_parameter_doc.all | 27 +++++++++++++------ .../Baltic_OM4_05/MOM_parameter_doc.short | 16 +++++------ ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all | 27 +++++++++++++------ .../OM4_025/MOM_parameter_doc.short | 16 +++++------ ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all | 27 +++++++++++++------ ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short | 16 +++++------ ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all | 27 +++++++++++++------ .../OM_1deg/MOM_parameter_doc.short | 16 +++++------ ice_ocean_SIS2/SIS2/MOM_parameter_doc.all | 27 +++++++++++++------ ice_ocean_SIS2/SIS2/MOM_parameter_doc.short | 8 +++--- .../SIS2_bergs_cgrid/MOM_parameter_doc.all | 27 +++++++++++++------ .../SIS2_bergs_cgrid/MOM_parameter_doc.short | 8 +++--- .../SIS2_cgrid/MOM_parameter_doc.all | 27 +++++++++++++------ .../SIS2_cgrid/MOM_parameter_doc.short | 8 +++--- .../cooling_only/BML/MOM_parameter_doc.all | 27 +++++++++++++------ .../cooling_only/EPBL/MOM_parameter_doc.all | 27 +++++++++++++------ .../cooling_only/KPP/MOM_parameter_doc.all | 27 +++++++++++++------ .../mech_only/BML/MOM_parameter_doc.all | 27 +++++++++++++------ .../mech_only/EPBL/MOM_parameter_doc.all | 27 +++++++++++++------ .../mech_only/KPP/MOM_parameter_doc.all | 27 +++++++++++++------ .../BML/MOM_parameter_doc.all | 27 +++++++++++++------ .../EPBL/MOM_parameter_doc.all | 27 +++++++++++++------ .../KPP/MOM_parameter_doc.all | 27 +++++++++++++------ .../wind_only/BML/MOM_parameter_doc.all | 27 +++++++++++++------ .../wind_only/EPBL/MOM_parameter_doc.all | 27 +++++++++++++------ .../wind_only/KPP/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/DOME/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/DOME/MOM_parameter_doc.short | 8 +++--- .../Phillips_2layer/MOM_parameter_doc.all | 27 +++++++++++++------ .../Phillips_2layer/MOM_parameter_doc.short | 8 +++--- .../MOM_parameter_doc.all | 27 +++++++++++++------ .../adjustment2d/layer/MOM_parameter_doc.all | 27 +++++++++++++------ .../layer/MOM_parameter_doc.short | 8 +++--- .../adjustment2d/rho/MOM_parameter_doc.all | 27 +++++++++++++------ .../adjustment2d/rho/MOM_parameter_doc.short | 8 +++--- .../adjustment2d/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../adjustment2d/z/MOM_parameter_doc.short | 8 +++--- ocean_only/benchmark/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/benchmark/MOM_parameter_doc.short | 8 +++--- ocean_only/circle_obcs/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/double_gyre/MOM_parameter_doc.all | 27 +++++++++++++------ .../double_gyre/MOM_parameter_doc.short | 8 +++--- .../external_gwave/MOM_parameter_doc.all | 27 +++++++++++++------ .../external_gwave/MOM_parameter_doc.short | 8 +++--- .../layer/MOM_parameter_doc.all | 27 +++++++++++++------ .../layer/MOM_parameter_doc.short | 8 +++--- .../flow_downslope/rho/MOM_parameter_doc.all | 27 +++++++++++++------ .../rho/MOM_parameter_doc.short | 8 +++--- .../sigma/MOM_parameter_doc.all | 27 +++++++++++++------ .../sigma/MOM_parameter_doc.short | 8 +++--- .../flow_downslope/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../flow_downslope/z/MOM_parameter_doc.short | 8 +++--- .../global_ALE/hycom/MOM_parameter_doc.all | 27 +++++++++++++------ .../global_ALE/hycom/MOM_parameter_doc.short | 8 +++--- .../global_ALE/layer/MOM_parameter_doc.all | 27 +++++++++++++------ .../global_ALE/layer/MOM_parameter_doc.short | 8 +++--- ocean_only/global_ALE/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../global_ALE/z/MOM_parameter_doc.short | 8 +++--- .../lock_exchange/MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.all | 27 +++++++++++++------ .../nonBous_global/MOM_parameter_doc.all | 27 +++++++++++++------ .../nonBous_global/MOM_parameter_doc.short | 8 +++--- .../resting/layer/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/resting/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../seamount/layer/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/seamount/rho/MOM_parameter_doc.all | 27 +++++++++++++------ .../seamount/sigma/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/seamount/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../single_column/BML/MOM_parameter_doc.all | 27 +++++++++++++------ .../single_column/EPBL/MOM_parameter_doc.all | 27 +++++++++++++------ .../single_column/KPP/MOM_parameter_doc.all | 27 +++++++++++++------ .../sloshing/layer/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/sloshing/rho/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/sloshing/z/MOM_parameter_doc.all | 27 +++++++++++++------ .../MOM_parameter_doc.all | 27 +++++++++++++------ .../tracer_mixing/rho/MOM_parameter_doc.all | 27 +++++++++++++------ .../tracer_mixing/z/MOM_parameter_doc.all | 27 +++++++++++++------ ocean_only/unit_tests/MOM_parameter_doc.all | 27 +++++++++++++------ src/MOM6 | 2 +- 91 files changed, 1296 insertions(+), 625 deletions(-) diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all index 7e77b5e5d..4d0417dfe 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 @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short index bd7b05ab9..b5815c34a 100644 --- a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 ff1e7ee91..e1c9572d6 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 @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short index f91a0c56c..2060ad996 100644 --- a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 3a27a2d2f..9cee5e0cd 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 @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.short index 3ad2587d5..720ba8460 100644 --- a/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS2/Intersperse_ice_1deg/MOM_parameter_doc.short @@ -14,10 +14,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all index e74e7fe35..ee3f2bb93 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short index 214d591bd..a8f8f96fe 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 e541ad66d..12fdda453 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 @@ -73,15 +73,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short index 5c2b23b22..04f9a2414 100644 --- a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short @@ -18,10 +18,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 c82843db4..5bb73fb78 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = True ! [Boolean] default = True + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short index 9a530a397..fdfc7ab10 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short @@ -18,15 +18,15 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. FRAZIL = True ! [Boolean] default = False ! If true, water freezes if it gets too cold, and the accumulated heat deficit ! is returned in the surface state. FRAZIL is only used if 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 3d2e274e6..a569b4f92 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = True ! [Boolean] default = True + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short index dbedbdb71..bb454b52a 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short @@ -18,15 +18,15 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. FRAZIL = True ! [Boolean] default = False ! If true, water freezes if it gets too cold, and the accumulated heat deficit ! is returned in the surface state. FRAZIL is only used if diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all index be0e79ab5..b896d8ff5 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = True ! [Boolean] default = True + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short index e81104d46..8e70eef24 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short @@ -18,15 +18,15 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. FRAZIL = True ! [Boolean] default = False ! If true, water freezes if it gets too cold, and the accumulated heat deficit ! is returned in the surface state. FRAZIL is only used if diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all index 2f459b2f7..3a21e6da1 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = True ! [Boolean] default = True + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short index 636a99825..82ecc9826 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short @@ -18,15 +18,15 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. FRAZIL = True ! [Boolean] default = False ! If true, water freezes if it gets too cold, and the accumulated heat deficit ! is returned in the surface state. FRAZIL is only used if diff --git a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all index e5c856a19..503eba6ee 100644 --- a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = True ! [Boolean] default = True + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.short b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.short index 572ca65c8..f32a0bf8b 100644 --- a/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/OM_1deg/MOM_parameter_doc.short @@ -18,15 +18,15 @@ DT = 1800.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 1800.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = True ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. DTBT_RESET_PERIOD = -1.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all index 38e6c84f0..fc225aa1e 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short index eacc03967..ee7fba83a 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 a5d19b1d3..e328d6be5 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short index 873765013..d0d99217d 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all index 46e83c1da..246ffe6a6 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short index 98a456468..f3a5066b5 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at 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 0d79bd7e2..d48173ee2 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 @@ -59,15 +59,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the 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 7aa6c2501..b32a636ae 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 1ef5a38bc..42fe61976 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 41c6cbfe9..c3577413f 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 @@ -59,15 +59,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the 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 d0a22a81d..a3e3c179f 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 d6f5132f0..dfe32bf99 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 9b04a7147..b7a0e3d6a 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 @@ -59,15 +59,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the 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 984a10413..8777df4ab 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 94454155a..c2369c175 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 c23841bb6..af31b5615 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 @@ -59,15 +59,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the 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 b475b3dbb..10c148a96 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 147c86bce..3a0b92dff 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 @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/DOME/MOM_parameter_doc.all b/ocean_only/DOME/MOM_parameter_doc.all index 6175ea002..208d7e57d 100644 --- a/ocean_only/DOME/MOM_parameter_doc.all +++ b/ocean_only/DOME/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/DOME/MOM_parameter_doc.short b/ocean_only/DOME/MOM_parameter_doc.short index f010d4a77..a889ada9a 100644 --- a/ocean_only/DOME/MOM_parameter_doc.short +++ b/ocean_only/DOME/MOM_parameter_doc.short @@ -10,10 +10,10 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 8.64E+04 ! [s] default = 3600.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.all b/ocean_only/Phillips_2layer/MOM_parameter_doc.all index a240a6375..a93a606ef 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.all +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1800.0 ! [s] default = 600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1800.0 ! [s] default = 1800.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.short b/ocean_only/Phillips_2layer/MOM_parameter_doc.short index 42a6e5a71..e26eb9a18 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.short +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.short @@ -10,10 +10,10 @@ DT = 600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1800.0 ! [s] default = 600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 8.64E+04 ! [s] default = 1800.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all index ab3dc9b15..4daad5e31 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all @@ -68,15 +68,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all index 8f91645c4..e946a6d87 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 300.0 ! [s] default = 300.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.short b/ocean_only/adjustment2d/layer/MOM_parameter_doc.short index e868ea8e5..97b59ae6b 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all index 57d814466..08945b7ab 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 300.0 ! [s] default = 300.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.short b/ocean_only/adjustment2d/rho/MOM_parameter_doc.short index da79e51ae..7b9e18c47 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.short @@ -9,10 +9,10 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.all b/ocean_only/adjustment2d/z/MOM_parameter_doc.all index 22cd8437c..7aa16d2d6 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 300.0 ! [s] default = 300.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.short b/ocean_only/adjustment2d/z/MOM_parameter_doc.short index 53d991d4c..ae76e5e11 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.short @@ -9,10 +9,10 @@ DT = 150.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 300.0 ! [s] default = 150.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/benchmark/MOM_parameter_doc.all b/ocean_only/benchmark/MOM_parameter_doc.all index 5107bc8b9..2558e0be9 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.all +++ b/ocean_only/benchmark/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ocean_only/benchmark/MOM_parameter_doc.short b/ocean_only/benchmark/MOM_parameter_doc.short index c53e2c54f..0227c39f6 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.short +++ b/ocean_only/benchmark/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 3600.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.all b/ocean_only/circle_obcs/MOM_parameter_doc.all index a43987e1c..cd796dd26 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.all +++ b/ocean_only/circle_obcs/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 120.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 120.0 ! [s] default = 120.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 120.0 ! [s] default = 120.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/double_gyre/MOM_parameter_doc.all b/ocean_only/double_gyre/MOM_parameter_doc.all index 286731f7f..ab017ad67 100644 --- a/ocean_only/double_gyre/MOM_parameter_doc.all +++ b/ocean_only/double_gyre/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 2400.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 2400.0 ! [s] default = 2400.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/double_gyre/MOM_parameter_doc.short b/ocean_only/double_gyre/MOM_parameter_doc.short index ba09e0c85..92abdc09a 100644 --- a/ocean_only/double_gyre/MOM_parameter_doc.short +++ b/ocean_only/double_gyre/MOM_parameter_doc.short @@ -12,10 +12,10 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 2400.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = -1.0 ! [s] default = 2400.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/external_gwave/MOM_parameter_doc.all b/ocean_only/external_gwave/MOM_parameter_doc.all index c55b4c2c0..542760202 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.all +++ b/ocean_only/external_gwave/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 60.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 120.0 ! [s] default = 60.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 120.0 ! [s] default = 120.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/external_gwave/MOM_parameter_doc.short b/ocean_only/external_gwave/MOM_parameter_doc.short index 6cb5021d7..a71c8d96d 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.short +++ b/ocean_only/external_gwave/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 60.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 120.0 ! [s] default = 60.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all index 15ff65d05..9bc155496 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.short b/ocean_only/flow_downslope/layer/MOM_parameter_doc.short index f5287c157..2d88d3d73 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all index 0439fcf55..7e2fb0bfa 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.short b/ocean_only/flow_downslope/rho/MOM_parameter_doc.short index 93d0f58e9..4f5ceebba 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.short @@ -9,10 +9,10 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all index 2d7d9036a..275b7700a 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short index 464f255e9..81e7ccdd0 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short @@ -9,10 +9,10 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.all b/ocean_only/flow_downslope/z/MOM_parameter_doc.all index 7328c21c5..8a702fb16 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.short b/ocean_only/flow_downslope/z/MOM_parameter_doc.short index b441a302a..a98e6bc03 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.short @@ -9,10 +9,10 @@ DT = 300.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 300.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. C_P = 3925.0 ! [J kg-1 K-1] default = 3991.86795711963 ! The heat capacity of sea water, approximated as a constant. This is only used ! if ENABLE_THERMODYNAMICS is true. The default value is from the TEOS-10 diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all index ac958874a..bfe615957 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.short b/ocean_only/global_ALE/hycom/MOM_parameter_doc.short index e6b444ee3..8158e3577 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.short @@ -17,10 +17,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.all b/ocean_only/global_ALE/layer/MOM_parameter_doc.all index 1ef061c29..936427a85 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.short b/ocean_only/global_ALE/layer/MOM_parameter_doc.short index 575b2adc8..565fdfcb0 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.short @@ -14,10 +14,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.all b/ocean_only/global_ALE/z/MOM_parameter_doc.all index 858de6edd..b8351f3e9 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.all @@ -73,15 +73,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.short b/ocean_only/global_ALE/z/MOM_parameter_doc.short index 553c80264..9c17cd292 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.short @@ -17,10 +17,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.all b/ocean_only/lock_exchange/MOM_parameter_doc.all index c994050b8..24178407c 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.all +++ b/ocean_only/lock_exchange/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 250.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 250.0 ! [s] default = 250.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 250.0 ! [s] default = 250.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface 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 56974c95a..2f38c0010 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.all b/ocean_only/nonBous_global/MOM_parameter_doc.all index 71167f358..c0e1cdbc7 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.all +++ b/ocean_only/nonBous_global/MOM_parameter_doc.all @@ -64,15 +64,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 7200.0 ! [s] default = 7200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.short b/ocean_only/nonBous_global/MOM_parameter_doc.short index b3c7ecbed..2216fa62e 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.short +++ b/ocean_only/nonBous_global/MOM_parameter_doc.short @@ -11,10 +11,10 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 7200.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. DTBT_RESET_PERIOD = 0.0 ! [s] default = 7200.0 ! The period between recalculations of DTBT (if DTBT <= 0). If DTBT_RESET_PERIOD ! is negative, DTBT is set based only on information available at diff --git a/ocean_only/resting/layer/MOM_parameter_doc.all b/ocean_only/resting/layer/MOM_parameter_doc.all index e563ce794..53408bdeb 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.all +++ b/ocean_only/resting/layer/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/resting/z/MOM_parameter_doc.all b/ocean_only/resting/z/MOM_parameter_doc.all index c63cf6802..5dc8bcb86 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.all +++ b/ocean_only/resting/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 1200.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 1200.0 ! [s] default = 1200.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 1200.0 ! [s] default = 1200.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.all b/ocean_only/seamount/layer/MOM_parameter_doc.all index b854523c6..047cf0d2a 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.all +++ b/ocean_only/seamount/layer/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.all b/ocean_only/seamount/rho/MOM_parameter_doc.all index 83698de6b..1ac51ab19 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.all +++ b/ocean_only/seamount/rho/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.all b/ocean_only/seamount/sigma/MOM_parameter_doc.all index 644e006ad..62933210a 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.all +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/seamount/z/MOM_parameter_doc.all b/ocean_only/seamount/z/MOM_parameter_doc.all index 4c55d0ca2..bb4dcd79d 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.all +++ b/ocean_only/seamount/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.all b/ocean_only/single_column/BML/MOM_parameter_doc.all index 99959b72c..abc4f4432 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.all +++ b/ocean_only/single_column/BML/MOM_parameter_doc.all @@ -59,15 +59,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HFREEZE = -1.0 ! [m] default = -1.0 ! If HFREEZE > 0, melt potential will be computed. The actual depth over which ! melt potential is computed will be min(HFREEZE, OBLD), where OBLD is the diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.all b/ocean_only/single_column/EPBL/MOM_parameter_doc.all index 3ca1f5c4f..a96a1bab5 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.all +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.all @@ -68,15 +68,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.all b/ocean_only/single_column/KPP/MOM_parameter_doc.all index d8f13c7f1..7e2d7afa1 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.all +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.all @@ -68,15 +68,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.all b/ocean_only/sloshing/layer/MOM_parameter_doc.all index e36c7372b..1f7775e09 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.all +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.all b/ocean_only/sloshing/rho/MOM_parameter_doc.all index b52e2e918..0c91a120c 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.all +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.all b/ocean_only/sloshing/z/MOM_parameter_doc.all index c892ed467..59c73a985 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.all +++ b/ocean_only/sloshing/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 900.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 900.0 ! [s] default = 900.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 900.0 ! [s] default = 900.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.all b/ocean_only/torus_advection_test/MOM_parameter_doc.all index 56f4998f7..5dd118cd8 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.all +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.all @@ -61,15 +61,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all index 375c92cce..c015da0ea 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all index 49be3b4e9..6a3cfff0b 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all @@ -70,15 +70,26 @@ DT = 3600.0 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 3600.0 ! [s] default = 3600.0 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 3600.0 ! [s] default = 3600.0 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/ocean_only/unit_tests/MOM_parameter_doc.all b/ocean_only/unit_tests/MOM_parameter_doc.all index 79b81b7d7..1f8876589 100644 --- a/ocean_only/unit_tests/MOM_parameter_doc.all +++ b/ocean_only/unit_tests/MOM_parameter_doc.all @@ -59,15 +59,26 @@ DT = 8.64E+04 ! [s] ! be an integer fraction of the forcing time-step (DT_FORCING in ocean-only mode ! or the coupling timestep in coupled mode.) DT_THERM = 8.64E+04 ! [s] default = 8.64E+04 - ! The thermodynamic and tracer advection time step. Ideally DT_THERM should be - ! an integer multiple of DT and less than the forcing or coupling time-step, - ! unless THERMO_SPANS_COUPLING is true, in which case DT_THERM can be an integer - ! multiple of the coupling timestep. By default DT_THERM is set to DT. + ! The thermodynamic time step. Ideally DT_THERM should be an integer multiple of + ! DT and of DT_TRACER_ADVECT and less than the forcing or coupling time-step. + ! However, if THERMO_SPANS_COUPLING is true, DT_THERM can be an integer multiple + ! of the coupling timestep. By default DT_THERM is set to DT. THERMO_SPANS_COUPLING = False ! [Boolean] default = False - ! If true, the MOM will take thermodynamic and tracer timesteps that can be - ! longer than the coupling timestep. The actual thermodynamic timestep that is - ! used in this case is the largest integer multiple of the coupling timestep - ! that is less than or equal to DT_THERM. + ! If true, the MOM will take thermodynamic timesteps that can be longer than the + ! coupling timestep. The actual thermodynamic timestep that is used in this case + ! is the largest integer multiple of the coupling timestep that is less than or + ! equal to DT_THERM. +DT_TRACER_ADVECT = 8.64E+04 ! [s] default = 8.64E+04 + ! The tracer advection time step. Ideally DT_TRACER_ADVECT should be an integer + ! multiple of DT, less than DT_THERM, and less than the forcing or coupling + ! time-step. However, if TRADV_SPANS_COUPLING is true, DT_TRACER_ADVECT can be + ! longer than the coupling timestep. By default DT_TRACER_ADVECT is set to + ! DT_THERM. +TRADV_SPANS_COUPLING = False ! [Boolean] default = False + ! If true, the MOM will take tracer advection timesteps that can be longer than + ! the coupling timestep. The actual tracer advection timestep that is used in + ! this case is the largest integer multiple of the coupling timestep that is + ! less than or equal to DT_TRACER_ADVECT. HMIX_SFC_PROP = 1.0 ! [m] default = 1.0 ! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth over which to average ! to find surface properties like SST and SSS or density (but not surface diff --git a/src/MOM6 b/src/MOM6 index a645328be..a40bbb9b2 160000 --- a/src/MOM6 +++ b/src/MOM6 @@ -1 +1 @@ -Subproject commit a645328be33e7d3db3d2433eba58eb86d16f25d8 +Subproject commit a40bbb9b20b04a7d23648497aacc71dada633a02