sim_size_rate: Build a 'MizerSim' rate getter that resolves the rate...

In mizer: Dynamic Multi-Species Size Spectrum Modelling

Build a MizerSim rate getter that resolves the rate functions once

Description

Internal helper capturing the pattern shared by the MizerSim rate getters that return a species-by-size array. It validates the params and resolves the rate functions a single time, then for each saved time step calculates only the required target rate with mizer_rates_subset() and extracts the element named slot from the result.

Usage

sim_size_rate(
  sim,
  time_range,
  drop,
  target,
  slot,
  value_name,
  units = NULL,
  type = NULL,
  use_sim_effort = FALSE,
  representation = "point",
  ...
)

Arguments

sim	A MizerSim object.
time_range	Passed to the sim iteration helper.
drop	Passed to the sim iteration helper.
target	Name of the rate to calculate (as in params@rates_funcs).
slot	Name of the element to extract from the mizer_rates_subset() result (e.g. "e_growth" for the EGrowth rate).
value_name, units	Metadata for the returned array.
use_sim_effort	If TRUE, the saved effort at each time step is used; otherwise the initial effort is used (matching the behaviour of the corresponding MizerParams getter).
...	Passed on to the rate functions.

Value

An ArrayTimeBySpeciesBySize object (or a reduced array if drop).

mizer documentation built on Aug. 24, 2026, 9:08 a.m.