TimeManager

current_date(cs::Interfacer.CoupledSimulation, t::Int)

Return the model date at the current timestep.

Arguments

• cs: [CoupledSimulation] containing info about the simulation
• t: [Real] number of seconds since simulation began

strdate_to_datetime(strdate::String)

Convert from String ("YYYYMMDD") to Date format, required by the official AMIP input files.

Arguments

• strdate: [String] to be converted to Date type

datetime_to_strdate(datetime::DateTime)

Convert from Date to String ("YYYYMMDD") format.

Arguments

• datetime: [Dates.DateTime] object to be converted to string

trigger_callback(cs, ::Monthly)

Returns true if the current date is equal to or exceeds the saved first of the month at time of 00:00:00.

Arguments

• cs: [CoupledSimulation] containing info about the simulation

AbstractFrequency

This is an abstract type for the frequency of the callback function.

Monthly

A concrete type for the monthly frequency of the callback function.

EveryTimestep

A concrete type for the every-timestep frequency of the callback function.

trigger_callback!(cs::Interfacer.CoupledSimulation, cb::CouplerCallback)

This function triggers a callback function if the current date is equal to or exceeds the saved callback reference date. As well as executing the functions func, it automatically updates the reference date, ref_date, for the next callback interval.

CouplerCallback

This is an abstract type for ClimaCoupler's callback functions.

HourlyCallback{FT}

This is a callback type that triggers at intervals of 1h or multiple hours.

Fields

• dt
• func
• ref_date
• active
• `data

MonthlyCallback{FT}

This is a callback type that triggers at intervals of 1 month or multiple months.

Fields

• dt
• func
• ref_date
• active
• data

update_firstdayofmonth!(cs::Interfacer.CoupledSimulation, _)

This function updates the first of the month reference date.

dt_cb(cb::HourlyCallback)
dt_cb(cb::MonthlyCallback)

This function returns the time interval for the callback function.

do_nothing(::Interfacer.CoupledSimulation, _)

This is a helper callback function that does nothing.