Adds last_Δt to Clock

src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl

@@ -50,7 +50,7 @@ end
 
 """
     HydrostaticFreeSurfaceModel(; grid,
-                                             clock = Clock{eltype(grid)}(0, 0, 1),
+                                             clock = Clock{eltype(grid)}(time = 0),
                                 momentum_advection = CenteredSecondOrder(),
                                   tracer_advection = CenteredSecondOrder(),
                                           buoyancy = SeawaterBuoyancy(eltype(grid)),
@@ -94,7 +94,7 @@ Keyword arguments
   - `auxiliary_fields`: `NamedTuple` of auxiliary fields. Default: `nothing`.
 """
 function HydrostaticFreeSurfaceModel(; grid,
-                                             clock = Clock{eltype(grid)}(0, 0, 1),
+                                             clock = Clock{eltype(grid)}(time = 0),
                                 momentum_advection = CenteredSecondOrder(),
                                   tracer_advection = CenteredSecondOrder(),
                                           buoyancy = SeawaterBuoyancy(eltype(grid)),

src/Models/NonhydrostaticModels/nonhydrostatic_model.jl

@@ -52,7 +52,7 @@ end
 
 """
     NonhydrostaticModel(;           grid,
-                                    clock = Clock{eltype(grid)}(0, 0, 1),
+                                    clock = Clock{eltype(grid)}(time = 0),
                                 advection = CenteredSecondOrder(),
                                  buoyancy = nothing,
                                  coriolis = nothing,
@@ -105,7 +105,7 @@ Keyword arguments
   - `auxiliary_fields`: `NamedTuple` of auxiliary fields. Default: `nothing`         
 """
 function NonhydrostaticModel(; grid,
-                                    clock = Clock{eltype(grid)}(0, 0, 1),
+                                    clock = Clock{eltype(grid)}(time = 0),
                                 advection = CenteredSecondOrder(),
                                  buoyancy = nothing,
                                  coriolis = nothing,

src/Models/ShallowWaterModels/shallow_water_model.jl

@@ -61,7 +61,7 @@ struct VectorInvariantFormulation end
 """
     ShallowWaterModel(; grid,
                         gravitational_acceleration,
-                              clock = Clock{eltype(grid)}(0, 0, 1),
+                              clock = Clock{eltype(grid)}(time = 0),
                  momentum_advection = UpwindBiasedFifthOrder(),
                    tracer_advection = WENO(),
                      mass_advection = WENO(),
@@ -112,7 +112,7 @@ Keyword arguments
 function ShallowWaterModel(;
                            grid,
                            gravitational_acceleration,
-                               clock = Clock{eltype(grid)}(0, 0, 1),
+                               clock = Clock{eltype(grid), eltype(grid)}(0, Inf, 0, 1),
                   momentum_advection = UpwindBiasedFifthOrder(),
                     tracer_advection = WENO(),
                       mass_advection = WENO(),

src/Simulations/simulation.jl

@@ -161,7 +161,8 @@ run_wall_time(sim::Simulation) = prettytime(sim.run_wall_time)
 Reset `sim`ulation, `model.clock`, and `model.timestepper` to their initial state.
 """
 function reset!(sim::Simulation)
-    sim.model.clock.time = 0.0
+    sim.model.clock.time = 0
+    sim.model.clock.last_Δt = Inf
     sim.model.clock.iteration = 0
     sim.model.clock.stage = 1
     sim.stop_iteration = Inf

src/TimeSteppers/clock.jl

@@ -6,30 +6,39 @@ import Base: show
 import Oceananigans.Units: Time
 
 """
-    mutable struct Clock{T<:Number}
+    mutable struct Clock{T, FT}
 
-Keeps track of the current `time`, `iteration` number, and time-stepping `stage`.
+Keeps track of the current `time`, `last_Δt`, `iteration` number, and time-stepping `stage`.
 The `stage` is updated only for multi-stage time-stepping methods. The `time::T` is
 either a number or a `DateTime` object.
 """
-mutable struct Clock{T}
-         time :: T
+mutable struct Clock{TT, DT}
+         time :: TT
+      last_Δt :: DT
     iteration :: Int
         stage :: Int
 end
 
 """
-    Clock(; time, iteration=0, stage=1)
+    Clock(; time, last_Δt = Inf, iteration=0, stage=1)
 
 Returns a `Clock` object. By default, `Clock` is initialized to the zeroth `iteration`
-and first time step `stage`.
+and first time step `stage` with `last_Δt`.
 """
-Clock(; time::T, iteration=0, stage=1) where T = Clock{T}(time, iteration, stage)
+Clock(; time::TT, last_Δt::DT=Inf, iteration=0, stage=1) where {TT, DT} = Clock{TT, DT}(time, last_Δt, iteration, stage)
+# TODO: when supporting DateTime, this function will have to be extended
+time_step_type(TT) = TT
+
+function Clock{TT}(; time, last_Δt=Inf, iteration=0, stage=1) where TT
+    DT = time_step_type(TT)
+    last_Δt = convert(DT, last_Δt)
+    return Clock{TT, DT}(time, last_Δt, iteration, stage)
+end
 
-Base.summary(clock::Clock) = string("Clock(time=$(prettytime(clock.time)), iteration=$(clock.iteration))")
+Base.summary(clock::Clock) = string("Clock(time=$(prettytime(clock.time)), iteration=$(clock.iteration), last_Δt=$(prettytime(clock.last_Δt)))")
 
-Base.show(io::IO, c::Clock{T}) where T =
-    println(io, "Clock{$T}: time = $(prettytime(c.time)), iteration = $(c.iteration), stage = $(c.stage)")
+Base.show(io::IO, c::Clock{TT, DT}) where {TT, DT} =
+    println(io, "Clock{$TT, $DT}: time = $(prettytime(c.time)), last_Δt = $(prettytime(c.last_Δt)), iteration = $(c.iteration), stage = $(c.stage)")
 
 next_time(clock, Δt) = clock.time + Δt
 next_time(clock::Clock{<:AbstractTime}, Δt) = clock.time + Nanosecond(round(Int, 1e9 * Δt))
@@ -52,6 +61,8 @@ function tick!(clock, Δt; stage=false)
 
     tick_time!(clock, Δt)
 
+    clock.last_Δt = Δt
+
     if stage # tick a stage update
         clock.stage += 1
     else # tick an iteration and reset stage
@@ -63,4 +74,4 @@ function tick!(clock, Δt; stage=false)
 end
 
 "Adapt `Clock` to work on the GPU via CUDAnative and CUDAdrv."
-Adapt.adapt_structure(to, clock::Clock) = (time=clock.time, iteration=clock.iteration, stage=clock.stage)
+Adapt.adapt_structure(to, clock::Clock) = (time=clock.time, last_Δt=clock.last_Δt, iteration=clock.iteration, stage=clock.stage)