Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Add Option to Specify Tracer Advection Time Step #757

Open
wants to merge 4 commits into
base: dev/gfdl
Choose a base branch
from
Open

Add Option to Specify Tracer Advection Time Step #757

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97c9aeb
Add option to set tracer advection timestep
Oct 23, 2024
e13b134
Add error warning if diabatic_first is true
Nov 20, 2024
9bd5340
Change variable, add do advection before thermo step
Nov 27, 2024
d1f89fb
Merge branch 'dev/gfdl' into add_dt_tadvect
Hallberg-NOAA Nov 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 58 additions & 16 deletions src/core/MOM.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,9 +275,11 @@ module MOM

type(time_type), pointer :: Time !< pointer to the ocean clock
real :: dt !< (baroclinic) dynamics time step [T ~> s]
real :: dt_therm !< thermodynamics time step [T ~> s]
real :: dt_therm !< diabatic time step [T ~> s]
real :: dt_tr_adv !< tracer advection time step [T ~> s]
logical :: thermo_spans_coupling !< If true, thermodynamic and tracer time
!! steps can span multiple coupled time steps.
logical :: tradv_spans_coupling !< If true, thermodynamic and tracer time
integer :: nstep_tot = 0 !< The total number of dynamic timesteps taken
!! so far in this run segment
logical :: count_calls = .false. !< If true, count the calls to step_MOM, rather than the
Expand Down Expand Up @@ -534,7 +536,8 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
type(verticalGrid_type), pointer :: GV => NULL() ! Pointer to the vertical grid structure
type(unit_scale_type), pointer :: US => NULL() ! Pointer to a structure containing
! various unit conversion factors
integer :: ntstep ! time steps between tracer updates or diabatic forcing
integer :: ntstep ! number of time steps between diabatic forcing updates
integer :: ntastep ! number of time steps between tracer advection updates
integer :: n_max ! number of steps to take in this call
integer :: halo_sz, dynamics_stencil

Expand All @@ -544,6 +547,7 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
real :: time_interval ! time interval covered by this run segment [T ~> s].
real :: dt ! baroclinic time step [T ~> s]
real :: dtdia ! time step for diabatic processes [T ~> s]
real :: dt_tr_adv ! time step for tracer advection [T ~> s]
real :: dt_therm ! a limited and quantized version of CS%dt_therm [T ~> s]
real :: dt_therm_here ! a further limited value of dt_therm [T ~> s]

Expand All @@ -554,9 +558,12 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
! if it is not to be calculated anew [T ~> s].
real :: rel_time = 0.0 ! relative time since start of this call [T ~> s].

logical :: do_advection ! If true, it is time to advect tracers.
logical :: thermo_does_span_coupling ! If true, thermodynamic forcing spans
! multiple dynamic timesteps.
logical :: do_advection ! If true, do tracer advection.
logical :: do_diabatic ! If true, do diabatic update.
logical :: thermo_does_span_coupling ! If true,thermodynamic (diabatic) forcing spans
! multiple coupling timesteps.
logical :: tradv_does_span_coupling ! If true, tracer advection spans
! multiple coupling timesteps.
logical :: do_dyn ! If true, dynamics are updated with this call.
logical :: do_thermo ! If true, thermodynamics and remapping may be applied with this call.
logical :: debug_redundant ! If true, check redundant values on PE boundaries when debugging.
Expand Down Expand Up @@ -662,6 +669,8 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
dt = time_interval / real(n_max)
thermo_does_span_coupling = (CS%thermo_spans_coupling .and. &
(CS%dt_therm > 1.5*cycle_time))
tradv_does_span_coupling = (CS%tradv_spans_coupling .and. &
(CS%dt_tr_adv > 1.5*cycle_time))
if (thermo_does_span_coupling) then
! Set dt_therm to be an integer multiple of the coupling time step.
dt_therm = cycle_time * floor(CS%dt_therm / cycle_time + 0.001)
Expand All @@ -674,6 +683,18 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
ntstep = MAX(1, MIN(n_max, floor(CS%dt_therm/dt + 0.001)))
dt_therm = dt*ntstep
endif
if (tradv_does_span_coupling) then
! Set dt_tr_adv to be an integer multiple of the coupling time step.
dt_tr_adv = cycle_time * floor(CS%dt_tr_adv / cycle_time + 0.001)
ntastep = floor(dt_tr_adv/dt + 0.001)
elseif (.not.do_thermo) then
dt_tr_adv = CS%dt_tr_adv
if (present(cycle_length)) dt_tr_adv = min(CS%dt_tr_adv, cycle_length)
! ntstep is not used.
else
ntastep = MAX(1, MIN(n_max, floor(CS%dt_tr_adv/dt + 0.001)))
dt_tr_adv = dt*ntastep
endif

!---------- Initiate group halo pass of the forcing fields
call cpu_clock_begin(id_clock_pass)
Expand Down Expand Up @@ -924,10 +945,11 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS
!===========================================================================
! This is the start of the tracer advection part of the algorithm.

if (thermo_does_span_coupling .or. .not.do_thermo) then
do_advection = (CS%t_dyn_rel_adv + 0.5*dt > dt_therm)
if (tradv_does_span_coupling .or. .not.do_thermo) then
do_advection = (CS%t_dyn_rel_adv + 0.5*dt > dt_tr_adv)
if (CS%t_dyn_rel_thermo + 0.5*dt > dt_therm) do_advection = .true.
else
do_advection = ((MOD(n,ntstep) == 0) .or. (n==n_max))
do_advection = ((MOD(n,ntastep) == 0) .or. (n==n_max))
endif

if (do_advection) then ! Do advective transport and lateral tracer mixing.
Expand All @@ -940,7 +962,12 @@ subroutine step_MOM(forces_in, fluxes_in, sfc_state, Time_start, time_int_in, CS

!===========================================================================
! This is the second place where the diabatic processes and remapping could occur.
if ((CS%t_dyn_rel_adv==0.0) .and. do_thermo .and. (.not.CS%diabatic_first)) then
if (thermo_does_span_coupling .or. .not.do_dyn) then
do_diabatic = (CS%t_dyn_rel_thermo + 0.5*dt > dt_therm)
else
do_diabatic = ((MOD(n,ntstep) == 0) .or. (n==n_max))
endif
if ((CS%t_dyn_rel_adv==0.0) .and. do_thermo .and. (.not.CS%diabatic_first) .and. do_diabatic) then

dtdia = CS%t_dyn_rel_thermo
! If the MOM6 dynamic and thermodynamic time stepping is being orchestrated
Expand Down Expand Up @@ -2336,19 +2363,34 @@ subroutine initialize_MOM(Time, Time_init, param_file, dirs, CS, &
"coupling timestep in coupled mode.)", units="s", scale=US%s_to_T, &
fail_if_missing=.true.)
call get_param(param_file, "MOM", "DT_THERM", CS%dt_therm, &
"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.", &
units="s", scale=US%s_to_T, default=US%T_to_s*CS%dt)
call get_param(param_file, "MOM", "THERMO_SPANS_COUPLING", CS%thermo_spans_coupling, &
"If true, the MOM will take thermodynamic and tracer "//&
"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.", default=.false.)
call get_param(param_file, "MOM", "DT_TRACER_ADVECT", CS%dt_tr_adv, &
"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.", &
units="s", scale=US%s_to_T, default=US%T_to_s*CS%dt_therm)
call get_param(param_file, "MOM", "TRADV_SPANS_COUPLING", CS%tradv_spans_coupling, &
"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.", default=.false.)
if ( CS%diabatic_first .and. (CS%dt_tr_adv /= CS%dt_therm) ) then
call MOM_error(FATAL,"MOM: If using DIABATIC_FIRST, DT_TRACER_ADVECT must equal DT_THERM.")
endif

if (bulkmixedlayer) then
CS%Hmix = -1.0 ; CS%Hmix_UV = -1.0
Expand Down