Local Hydrological Balance — hb

Simulates the local hydrological balance of a set of clusters of rice paddies on a daily basis, under a set of ideal assumptions.

Prominently, paddies are assumed to be managed - i.e. irrigated and drained

in such a way to stick as closely as possible to an established yearly ideal plan for draining and irrigation (with corresponding ideal water levels), while satisfying the constraint imposed by the fact that the total daily outflow from all clusters is fixed (and known by independent measurements).

More details on the concrete algorithm used in the simulations can be found at TODO #46.

For analyzing Albufera data, you should not need to directly run this function, and you can instead use the albufera_hb_local wrapper, that calls hb_local() with the right arguments, extracted from the built-in datasets.

Usage

hb_local(
  date,
  cluster_id,
  ditch,
  ideal_height_cm,
  petp_cm,
  ideal_irrigation,
  ideal_draining,
  area_m2,
  total_inflow_lake,
  ...,
  ideal_flow_rate_cm = 5
)

Arguments

date: vector. Can be either a character, formatted as YYYY-MM-DD, or a Date object.
cluster_id: character vector.
ditch: character vector. Ditch to which the cluster specified by cluster_id corresponds.
ideal_height_cm: numeric vector. Ideal height of the cluster specified by cluster_id, on the day specified by date.
petp_cm: numeric vector. Precipitation minus evapotranspiration (in cm), relevant for the cluster_id/date pair.
ideal_irrigation: logical. Irrigation plan for the cluster specified by cluster_id, on the day specified by date (is this cluster supposed to be irrigated on this day?).
ideal_draining: logical. Draining plan for the cluster specified by cluster_id, on the day specified by date (is this cluster supposed to be drained on this day?).
area_m2: numeric vector. Area of the cluster specified by cluster_id.
total_inflow_lake: numeric vector. Total inflow of lake (or, equivalently, total outflow of clusters) on the day specified by date.
...: additional columns to be appended in the returned data-frame. Each of these additional (named) arguments should be a vector of the same length implied by the previous arguments.
ideal_flow_rate_cm: a positive number. Ideal inflow for days such that ideal_irrigation and ideal_draining are both TRUE.

Value

An object of class hb_local, a lightweight wrapper of data.frame with a few additional visualization methods (most prominently plot.hb_local).

Details

All arguments of this function should be conceptually thought as the columns of a data-frame, each row of which corresponds to data for a given cluster (specified by cluster_id) on a given day (specified by date). For this reason, there should be a certain consistency among these vectors, which is currently not being enforced, and left to the correct specification from the side of the user. To name some examples: ditch should be consistent among cluster_id; petp_cm should be consistent among date; etc.etc..