TimeManager

This module contains functions that handle dates and times in simulations. The functions in this module often call functions from Julia's Dates module.

TimeManager API

ClimaUtilities.TimeManager.to_datetimeFunction
to_datetime(date)

Convert a DateTime-like object (e.g. DateTimeNoLeap) to a DateTime. We need this since some data files we use contain DateTimeNoLeap objects for dates, which can't be used for math with DateTimes. The DateTimeNoLeap type uses the Gregorian calendar without leap years, while the DateTime type uses Gregorian calendar with leap years.

For consistency, all input data files should have dates converted to DateTime before being used in a simulation.

This function is similar to reinterpret in CFTime.jl.

Arguments

  • date: DateTime-like object to be converted to DateTime
ClimaUtilities.TimeManager.trigger_callbackFunction
trigger_callback(date_nextcall::Dates.DateTime,
    date_current::Dates.DateTime,
    ::Monthly,
    func::Function,)

If the current date is equal to or later than the "next call" date at time 00:00:00, call the callback function and increment the next call date by one month. Otherwise, do nothing and leave the next call date unchanged.

The tuple of arguments func_args must match the types, number, and order of arguments expected by func.

Arguments

  • date_nextcall::DateTime the next date to call the callback function at or after
  • date_current::DateTime the current date of the simulation
  • save_freq::AbstractFrequency frequency with which to trigger callback
  • func::Function function to be triggered if date is at or past the next call date
  • func_args::Tuple a tuple of arguments to be passed into the callback function
Missing docstring.

Missing docstring for ClimaUtilities.TimeManager.Monthly. Check Documenter's build log for details.

Missing docstring.

Missing docstring for ClimaUtilities.TimeManager.EveryTimestep. Check Documenter's build log for details.