use ClimaUtilities CallbackManager

docs/make.jl

@@ -65,7 +65,6 @@ interface_pages = [
     "interfacer.md",
     "postprocessor.md",
     "regridder.md",
-    "timemanager.md",
     "utilities.md",
 ]
 performance_pages = ["performance.md"]

experiments/ClimaEarth/run_amip.jl

@@ -48,19 +48,12 @@ import ClimaCore as CC
 # ## Coupler specific imports
 import ClimaCoupler
 import ClimaCoupler:
-    ConservationChecker,
-    Checkpointer,
-    Diagnostics,
-    FieldExchanger,
-    FluxCalculator,
-    Interfacer,
-    Regridder,
-    TimeManager,
-    Utilities
+    ConservationChecker, Checkpointer, Diagnostics, FieldExchanger, FluxCalculator, Interfacer, Regridder, Utilities
 
 import ClimaUtilities.SpaceVaryingInputs: SpaceVaryingInput
 import ClimaUtilities.TimeVaryingInputs: TimeVaryingInput, evaluate!
 import ClimaUtilities.ClimaArtifacts: @clima_artifact
+import ClimaUtilities: CallbackManager
 import Interpolations
 
 pkg_dir = pkgdir(ClimaCoupler)
@@ -460,7 +453,7 @@ Utilities.show_memory_usage(comms_ctx)
 model_sims = (atmos_sim = atmos_sim, ice_sim = ice_sim, land_sim = land_sim, ocean_sim = ocean_sim);
 
 ## dates
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)])
 
 #=
 ### Online Diagnostics
@@ -472,7 +465,7 @@ if use_coupler_diagnostics
     monthly_3d_diags = Diagnostics.init_diagnostics(
         (:T, :u, :q_tot, :q_liq_ice),
         atmos_sim.domain.center_space;
-        save = TimeManager.Monthly(),
+        save = CallbackManager.Monthly(),
         operations = (; accumulate = Diagnostics.TimeMean([Int(0)])),
         output_dir = dir_paths.output,
         name_tag = "monthly_mean_3d_",
@@ -481,7 +474,7 @@ if use_coupler_diagnostics
     monthly_2d_diags = Diagnostics.init_diagnostics(
         (:precipitation_rate, :toa_fluxes, :T_sfc, :turbulent_energy_fluxes),
         boundary_space;
-        save = TimeManager.Monthly(),
+        save = CallbackManager.Monthly(),
         operations = (; accumulate = Diagnostics.TimeMean([Int(0)])),
         output_dir = dir_paths.output,
         name_tag = "monthly_mean_2d_",
@@ -517,7 +510,8 @@ end
 #=
 ## Initialize Callbacks
 Callbacks are used to update at a specified interval. The callbacks are initialized here and
-saved in a global `Callbacks` struct, `callbacks`. The `trigger_callback!` function is used to call the callback during the simulation below.
+saved in a global `Callbacks` struct, `callbacks`. The `trigger_callback!` function is used to call the callback
+when required during the simulation below.
 
 The frequency of the callbacks is specified in the `HourlyCallback` and `MonthlyCallback` structs. The `func` field specifies the function to be called,
 the `ref_date` field specifies the first date for the callback, and the `active` field specifies whether the callback is active or not.
@@ -530,20 +524,20 @@ The currently implemented callbacks are:
   NB: Eventually, we will call all of radiation from the coupler, in addition to the albedo calculation.
 =#
 
-checkpoint_cb = TimeManager.HourlyCallback(
+checkpoint_cb = CallbackManager.HourlyCallback(
     dt = hourly_checkpoint_dt,
     func = checkpoint_sims,
     ref_date = [dates.date[1]],
     active = hourly_checkpoint,
 ) # 20 days
-update_firstdayofmonth!_cb = TimeManager.MonthlyCallback(
+update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
-    func = TimeManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    func = Interfacer.update_firstdayofmonth!,
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
-albedo_cb = TimeManager.HourlyCallback(
+albedo_cb = CallbackManager.HourlyCallback(
     dt = dt_water_albedo,
     func = FluxCalculator.water_albedo_from_atmosphere!,
     ref_date = [dates.date[1]],
@@ -683,10 +677,10 @@ function solve_coupler!(cs)
     ## step in time
     for t in ((tspan[begin] + Δt_cpl):Δt_cpl:tspan[end])
 
-        cs.dates.date[1] = TimeManager.current_date(cs, t)
+        cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 
@@ -717,8 +711,7 @@ function solve_coupler!(cs)
 
         ## update water albedo from wind at dt_water_albedo
         ## (this will be extended to a radiation callback from the coupler)
-        TimeManager.trigger_callback!(cs, cs.callbacks.water_albedo)
-
+        CallbackManager.trigger_callback!(cs.callbacks.water_albedo, cs.dates.date[1])
 
         ## update the surface fractions for surface models,
         ## and update all component model simulations with the current fluxes stored in the coupler
@@ -752,10 +745,10 @@ function solve_coupler!(cs)
         FieldExchanger.import_atmos_fields!(cs.fields, cs.model_sims, cs.boundary_space, cs.turbulent_fluxes) # radiative and/or turbulent
 
         ## callback to update the fist day of month if needed
-        TimeManager.trigger_callback!(cs, cs.callbacks.update_firstdayofmonth!)
+        CallbackManager.trigger_callback!(cs.callbacks.update_firstdayofmonth!, cs.dates.date[1])
 
         ## callback to checkpoint model state
-        TimeManager.trigger_callback!(cs, cs.callbacks.checkpoint)
+        CallbackManager.trigger_callback!(cs.callbacks.checkpoint, cs.dates.date[1])
     end
     return nothing
 end

experiments/ClimaEarth/run_cloudless_aquaplanet.jl

@@ -32,7 +32,7 @@ import ClimaCoupler:
     FluxCalculator,
     Interfacer,
     Regridder,
-    TimeManager,
+    CallbackManager,
     Utilities
 
 pkg_dir = pkgdir(ClimaCoupler)
@@ -211,26 +211,26 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)])
 
 #=
 ## Initialize Callbacks
 =#
 
-checkpoint_cb = TimeManager.HourlyCallback(
+checkpoint_cb = CallbackManager.HourlyCallback(
     dt = FT(480),
     func = checkpoint_sims,
     ref_date = [dates.date[1]],
     active = hourly_checkpoint,
 ) # 20 days
-update_firstdayofmonth!_cb = TimeManager.MonthlyCallback(
+update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
-    func = TimeManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    func = Interfacer.update_firstdayofmonth!,
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
-albedo_cb = TimeManager.HourlyCallback(
+albedo_cb = CallbackManager.HourlyCallback(
     dt = dt_water_albedo,
     func = FluxCalculator.water_albedo_from_atmosphere!,
     ref_date = [dates.date[1]],
@@ -325,17 +325,17 @@ function solve_coupler!(cs)
     ## step in time
     for t in ((tspan[begin] + Δt_cpl):Δt_cpl:tspan[end])
 
-        cs.dates.date[1] = TimeManager.current_date(cs, t)
+        cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 
         ClimaComms.barrier(comms_ctx)
 
         ## update water albedo from wind at dt_water_albedo (this will be extended to a radiation callback from the coupler)
-        TimeManager.trigger_callback!(cs, cs.callbacks.water_albedo)
+        CallbackManager.trigger_callback!(cs.callbacks.water_albedo, cs.dates.date[1])
 
         ## run component models sequentially for one coupling timestep (Δt_cpl)
         FieldExchanger.update_model_sims!(cs.model_sims, cs.fields, cs.turbulent_fluxes)
@@ -350,10 +350,10 @@ function solve_coupler!(cs)
         FieldExchanger.import_atmos_fields!(cs.fields, cs.model_sims, cs.boundary_space, cs.turbulent_fluxes) # radiative and/or turbulent
 
         ## callback to update the fist day of month if needed
-        TimeManager.trigger_callback!(cs, cs.callbacks.update_firstdayofmonth!)
+        CallbackManager.trigger_callback!(cs.callbacks.update_firstdayofmonth!, cs.dates.date[1])
 
         ## callback to checkpoint model state
-        TimeManager.trigger_callback!(cs, cs.callbacks.checkpoint)
+        CallbackManager.trigger_callback!(cs.callbacks.checkpoint, cs.dates.date[1])
 
     end
 

experiments/ClimaEarth/run_cloudy_aquaplanet.jl

@@ -32,7 +32,7 @@ import ClimaCoupler:
     FluxCalculator,
     Interfacer,
     Regridder,
-    TimeManager,
+    CallbackManager,
     Utilities
 
 pkg_dir = pkgdir(ClimaCoupler)
@@ -232,22 +232,22 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)])
 
 #=
 ## Initialize Callbacks
 =#
 
-checkpoint_cb = TimeManager.HourlyCallback(
+checkpoint_cb = CallbackManager.HourlyCallback(
     dt = FT(480),
     func = checkpoint_sims,
     ref_date = [dates.date[1]],
     active = hourly_checkpoint,
 ) # 20 days
-update_firstdayofmonth!_cb = TimeManager.MonthlyCallback(
+update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
-    func = TimeManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    func = Interfacer.update_firstdayofmonth!,
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 callbacks = (; checkpoint = checkpoint_cb, update_firstdayofmonth! = update_firstdayofmonth!_cb)
@@ -337,10 +337,10 @@ function solve_coupler!(cs)
     ## step in time
     for t in ((tspan[begin] + Δt_cpl):Δt_cpl:tspan[end])
 
-        cs.dates.date[1] = TimeManager.current_date(cs, t)
+        cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 
@@ -359,10 +359,10 @@ function solve_coupler!(cs)
         FieldExchanger.import_atmos_fields!(cs.fields, cs.model_sims, cs.boundary_space, cs.turbulent_fluxes) # radiative and/or turbulent
 
         ## callback to update the fist day of month if needed
-        TimeManager.trigger_callback!(cs, cs.callbacks.update_firstdayofmonth!)
+        CallbackManager.trigger_callback!(cs.callbacks.update_firstdayofmonth!, cs.dates.date[1])
 
         ## callback to checkpoint model state
-        TimeManager.trigger_callback!(cs, cs.callbacks.checkpoint)
+        CallbackManager.trigger_callback!(cs.callbacks.checkpoint, cs.dates.date[1])
 
     end
 

experiments/ClimaEarth/run_cloudy_slabplanet.jl

@@ -32,7 +32,7 @@ import ClimaCoupler:
     FluxCalculator,
     Interfacer,
     Regridder,
-    TimeManager,
+    CallbackManager,
     Utilities
 
 pkg_dir = pkgdir(ClimaCoupler)
@@ -175,7 +175,7 @@ land_mask_data = artifact_data(mask_dataset_path(), "seamask")
 
 ## dates
 date0 = date = Dates.DateTime(start_date, Dates.dateformat"yyyymmdd")
-dates = (; date = [date], date0 = [date0], date1 = [Dates.firstdayofmonth(date0)], new_month = [false])
+dates = (; date = [date], date0 = [date0], first_day_of_month = [Dates.firstdayofmonth(date0)])
 
 
 #=
@@ -284,20 +284,20 @@ model_sims = (atmos_sim = atmos_sim, ocean_sim = ocean_sim);
 ## Initialize Callbacks
 =#
 
-checkpoint_cb = TimeManager.HourlyCallback(
+checkpoint_cb = CallbackManager.HourlyCallback(
     dt = FT(480),
     func = checkpoint_sims,
     ref_date = [dates.date[1]],
     active = hourly_checkpoint,
 ) # 20 days
-update_firstdayofmonth!_cb = TimeManager.MonthlyCallback(
+update_firstdayofmonth!_cb = CallbackManager.MonthlyCallback(
     dt = FT(1),
-    func = TimeManager.update_firstdayofmonth!,
-    ref_date = [dates.date1[1]],
+    func = Interfacer.update_firstdayofmonth!,
+    ref_date = [dates.first_day_of_month[1]],
     active = true,
 )
 dt_water_albedo = parse(FT, filter(x -> !occursin(x, "hours"), dt_rad))
-albedo_cb = TimeManager.HourlyCallback(
+albedo_cb = CallbackManager.HourlyCallback(
     dt = dt_water_albedo,
     func = FluxCalculator.water_albedo_from_atmosphere!,
     ref_date = [dates.date[1]],
@@ -389,17 +389,17 @@ function solve_coupler!(cs)
     ## step in time
     for t in ((tspan[begin] + Δt_cpl):Δt_cpl:tspan[end])
 
-        cs.dates.date[1] = TimeManager.current_date(cs, t)
+        cs.dates.date[1] = Interfacer.current_date(cs, t)
 
         ## print date on the first of month
-        if cs.dates.date[1] >= cs.dates.date1[1]
+        if cs.dates.date[1] >= cs.dates.first_day_of_month[1]
             ClimaComms.iamroot(comms_ctx) && @show(cs.dates.date[1])
         end
 
         ClimaComms.barrier(comms_ctx)
 
         ## update water albedo from wind at dt_water_albedo (this will be extended to a radiation callback from the coupler)
-        TimeManager.trigger_callback!(cs, cs.callbacks.water_albedo)
+        CallbackManager.trigger_callback!(cs.callbacks.water_albedo, cs.dates.date[1])
 
         ## run component models sequentially for one coupling timestep (Δt_cpl)
         FieldExchanger.update_model_sims!(cs.model_sims, cs.fields, cs.turbulent_fluxes)
@@ -414,10 +414,10 @@ function solve_coupler!(cs)
         FieldExchanger.import_atmos_fields!(cs.fields, cs.model_sims, cs.boundary_space, cs.turbulent_fluxes) # radiative and/or turbulent
 
         ## callback to update the fist day of month if needed
-        TimeManager.trigger_callback!(cs, cs.callbacks.update_firstdayofmonth!)
+        CallbackManager.trigger_callback!(cs.callbacks.update_firstdayofmonth!, cs.dates.date[1])
 
         ## callback to checkpoint model state
-        TimeManager.trigger_callback!(cs, cs.callbacks.checkpoint)
+        CallbackManager.trigger_callback!(cs.callbacks.checkpoint, cs.dates.date[1])
 
     end