Merge pull request #1191 from CliMA/kp/itime2

Add ITime

Author: ph-kev

Project.toml

@@ -16,8 +16,8 @@ Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 
 [compat]
 ClimaComms = "0.6.2"
-ClimaCore = "0.14.17"
-ClimaUtilities = "0.1.9"
+ClimaCore = "0.14.23"
+ClimaUtilities = "0.1.22"
 Dates = "1"
 Logging = "1"
 SciMLBase = "2.11"

config/ci_configs/amip_component_dts.yml

@@ -6,7 +6,7 @@ dt_land: "50secs"
 dt_ocean: "30secs"
 dt_rad: "1hours"
 dt_save_to_sol: "1days"
-dt_seaice: "75secs"
+dt_seaice: "37.5secs"
 dz_bottom: 30
 dz_top: 3000
 energy_check: false

config/ci_configs/amip_default.yml

@@ -16,3 +16,4 @@ t_end: "300secs"
 vert_diff: "true"
 z_elem: 50
 z_stretch: false
+use_itime: true

docs/src/timemanager.md

@@ -12,3 +12,17 @@ ClimaCoupler.TimeManager.strdate_to_datetime
 ClimaCoupler.TimeManager.datetime_to_strdate
 ClimaCoupler.TimeManager.maybe_trigger_callback
 ```
+
+## ITime
+
+`ITime`, or _integer time_, is a time type used by CliMA simulations to keep
+track of simulation time. For more information, refer to the
+[TimeManager section](https://clima.github.io/ClimaUtilities.jl/dev/timemanager/)
+in ClimaUtilities and the [ITime section](https://clima.github.io/ClimaAtmos.jl/dev/itime/)
+in ClimaAtmos.
+
+### How do I use ITime?
+
+If you are running a simulation from a YAML file, you can simply set `use_itime`
+to true to enable `ITime`. If you do not want to use `ITime` and want to use
+floating point numbers, then set `use_itime` to false to not use `ITime`.

experiments/ClimaCore/sea_breeze/run.jl

@@ -117,7 +117,7 @@ system before executing the simulation.
 
 t_start, t_end = (0.0, 1e4)
 Δt_coupled = 0.1
-saveat = t_start:10.0:t_end
+saveat = collect(t_start:10.0:t_end)
 atm_nsteps, ocn_nsteps, lnd_nsteps = (5, 1, 1)
 
 ## Initialize Models

experiments/ClimaEarth/cli_options.jl

@@ -159,6 +159,10 @@ function argparse_settings()
         help = "Boolean flag indicating whether to compute and output land model diagnostics [`true` (default), `false`]"
         arg_type = Bool
         default = true
+        "--use_itime"
+        help = "Boolean flag indicating whether to use ITime (integer time) or not (will use Float64) [`true` (default), `false`]"
+        arg_type = Bool
+        default = true
     end
     return s
 end

experiments/ClimaEarth/components/atmosphere/climaatmos.jl

@@ -10,6 +10,7 @@ import ClimaCore.Geometry: ⊗
 import SurfaceFluxes as SF
 import Thermodynamics as TD
 import ClimaCoupler: Checkpointer, FieldExchanger, FluxCalculator, Interfacer, Utilities
+import ClimaUtilities.TimeManager: ITime
 
 include("climaatmos_extra_diags.jl")
 
@@ -140,7 +141,8 @@ function Interfacer.get_field(atmos_sim::ClimaAtmosSimulation, ::Val{:energy})
         ᶜS_ρq_tot = p.precipitation.ᶜS_ρq_tot
         thermo_params = get_thermo_params(atmos_sim)
         return integrator.u.c.ρe_tot .-
-               ᶜS_ρq_tot .* CA.e_tot_0M_precipitation_sources_helper.(Ref(thermo_params), ᶜts, ᶜΦ) .* integrator.dt
+               ᶜS_ρq_tot .* CA.e_tot_0M_precipitation_sources_helper.(Ref(thermo_params), ᶜts, ᶜΦ) .*
+               float(integrator.dt)
     else
         return integrator.u.c.ρe_tot
     end
@@ -249,7 +251,14 @@ function Interfacer.update_field!(sim::ClimaAtmosSimulation, ::Val{:turbulent_fl
 end
 
 # extensions required by FieldExchanger
-Interfacer.step!(sim::ClimaAtmosSimulation, t) = Interfacer.step!(sim.integrator, t - sim.integrator.t, true)
+Interfacer.step!(sim::ClimaAtmosSimulation, t::Real) = Interfacer.step!(sim.integrator, t - sim.integrator.t, true)
+function Interfacer.step!(sim::ClimaAtmosSimulation, t::ITime)
+    while sim.integrator.t < t
+        Interfacer.step!(sim.integrator)
+    end
+    return nothing
+end
+
 Interfacer.reinit!(sim::ClimaAtmosSimulation) = Interfacer.reinit!(sim.integrator)
 
 function FieldExchanger.update_sim!(atmos_sim::ClimaAtmosSimulation, csf, turbulent_fluxes)

experiments/ClimaEarth/components/land/climaland_bucket.jl

@@ -49,23 +49,23 @@ Initializes the bucket model variables.
 """
 function BucketSimulation(
     ::Type{FT},
-    tspan::Tuple{Float64, Float64},
+    tspan::Tuple{TT, TT},
     config::String,
     albedo_type::String,
     land_initial_condition::String,
     land_temperature_anomaly::String,
     output_dir::String;
     space,
-    dt::Float64,
-    saveat::Vector{Float64},
+    dt::TT,
+    saveat::Vector{TT},
     area_fraction,
     stepper = CTS.RK4(),
     date_ref::Dates.DateTime,
-    t_start::Float64,
+    t_start::TT,
     energy_check::Bool,
     surface_elevation,
     use_land_diagnostics::Bool,
-) where {FT}
+) where {FT, TT <: Union{Float64, ITime}}
     if config != "sphere"
         println(
             "Currently only spherical shell domains are supported; single column set-up will be addressed in future PR.",
@@ -102,7 +102,7 @@ function BucketSimulation(
     d_soil = FT(3.5) # soil depth
     z_0m = FT(1e-3) # roughness length for momentum over smooth bare soil
     z_0b = FT(1e-3) # roughness length for tracers over smooth bare soil
-    τc = FT(dt) # This is the timescale on which snow exponentially damps to zero, in the case where all
+    τc = FT(float(dt)) # This is the timescale on which snow exponentially damps to zero, in the case where all
     # the snow would melt in time `τc`. It prevents us from having to specially time step in cases where
     # all the snow melts in a single timestep.
     σS_c = FT(0.2) # critical snow water equivalent

experiments/ClimaEarth/components/ocean/eisenman_seaice.jl

@@ -44,7 +44,7 @@ Base.@kwdef struct EisenmanOceanParameters{FT <: AbstractFloat}
 end
 
 """
-    EisenmanIceSimulation(::Type{FT}, tspan; space = nothing, area_fraction = nothing, thermo_params = nothing, stepper = CTS.RK4(), dt = 0.02, saveat = 1.0e10)
+    EisenmanIceSimulation(::Type{FT}, tspan; space = nothing, area_fraction = nothing, thermo_params = nothing, stepper = CTS.RK4(), dt, saveat = 1.0e10)
 
 Initialize the Eisenman-Zhang sea ice model and simulation.
 """
@@ -55,7 +55,7 @@ function EisenmanIceSimulation(
     area_fraction = nothing,
     thermo_params = nothing,
     stepper = CTS.RK4(),
-    dt = 0.02,
+    dt,
     saveat = [1.0e10],
 ) where {FT}
 
@@ -79,8 +79,13 @@ function EisenmanIceSimulation(
         thermo_params = thermo_params,
         dss_buffer = CC.Spaces.create_dss_buffer(Y),
     )
-    problem = SciMLBase.ODEProblem(ode_function, Y, Float64.(tspan), cache)
-    integrator = SciMLBase.init(problem, ode_algo, dt = Float64(dt), saveat = Float64.(saveat), adaptive = false)
+    if typeof(dt) isa Number
+        dt = Float64(dt)
+        tspan = Float64.(tspan)
+        saveat = Float64.(saveat)
+    end
+    problem = SciMLBase.ODEProblem(ode_function, Y, tspan, cache)
+    integrator = SciMLBase.init(problem, ode_algo, dt = dt, saveat = saveat, adaptive = false)
 
     sim = EisenmanIceSimulation(params, space, integrator)
     return sim
@@ -130,7 +135,7 @@ function Interfacer.get_field(sim::EisenmanIceSimulation, ::Val{:energy})
 
     e_ml = @. p_o.h * p_o.ρ * p_o.c * sim.integrator.u.T_ml # heat
     e_ice = @. p_i.L_ice * sim.integrator.u.h_ice # phase
-    e_qflux = @. ocean_qflux * FT(sim.integrator.t)
+    e_qflux = @. ocean_qflux * FT(float(sim.integrator.t))
 
     return @. e_ml + e_ice + e_qflux + e_base
 end
@@ -340,7 +345,7 @@ Calculate the tendencies for the Eisenman-Zhang sea ice model.
 """
 function ∑tendencies(dY, Y, cache, _)
     FT = eltype(dY)
-    Δt = cache.Δt
+    Δt = float(cache.Δt)
     Ya = cache.Ya
     thermo_params = cache.thermo_params
     p = cache.params

experiments/ClimaEarth/components/ocean/prescr_seaice.jl

@@ -138,9 +138,13 @@ function PrescribedIceSimulation(
 
     ode_algo = CTS.ExplicitAlgorithm(stepper)
     ode_function = CTS.ClimaODEFunction(T_exp! = ice_rhs!, dss! = (Y, p, t) -> CC.Spaces.weighted_dss!(Y, p.dss_buffer))
-
-    problem = SciMLBase.ODEProblem(ode_function, Y, Float64.(tspan), (; cache..., params = params))
-    integrator = SciMLBase.init(problem, ode_algo, dt = Float64(dt), saveat = Float64.(saveat), adaptive = false)
+    if typeof(dt) isa Number
+        dt = Float64(dt)
+        tspan = Float64.(tspan)
+        saveat = Float64.(saveat)
+    end
+    problem = SciMLBase.ODEProblem(ode_function, Y, tspan, (; cache..., params = params))
+    integrator = SciMLBase.init(problem, ode_algo, dt = dt, saveat = saveat, adaptive = false)
 
     sim = PrescribedIceSimulation(params, space, integrator)
 
@@ -234,7 +238,7 @@ function ice_rhs!(dY, Y, p, t)
     F_conductive = @. params.k_ice / (params.h) * (params.T_base - Y.T_sfc) # fluxes are defined to be positive when upward
     rhs = @. (-p.F_turb_energy - p.F_radiative + F_conductive) / (params.h * params.ρ * params.c)
     # If tendencies lead to temperature above freezing, set temperature to freezing
-    @. rhs = min(rhs, (params.T_freeze - Y.T_sfc) / p.dt)
+    @. rhs = min(rhs, (params.T_freeze - Y.T_sfc) / float(p.dt))
     # mask out no-ice areas
     area_mask = Utilities.binary_mask.(p.area_fraction)
     dY.T_sfc .= rhs .* area_mask