Drive a shelf model to steady state

Extends mizer::tuneSteadyState() for mizerShelf objects: after the consumer abundances have converged, tune_carrion_detritus() is called so that the carrion and detritus components are at steady state too.

Usage

# S3 method for class 'mizerShelf'
tuneSteadyState(
  params,
  solver = c("project", "newton"),
  effort = params@initial_effort,
  preserve = c("reproduction_level", "erepro", "R_max"),
  info_level = default_info_level(),
  ...
)

Arguments

params

A mizerShelf params object.

solver

The solver to use: "project" to run the dynamics until they settle, "newton" to solve the steady-state equation directly. See Choosing a solver.

effort

The fishing effort to use throughout. By default the initial effort stored in params.

preserve

Specifies whether the reproduction_level should be preserved (default) or the maximum reproduction rate R_max or the reproductive efficiency erepro. See setBevertonHolt() for an explanation of the reproduction_level.

info_level

Controls the amount of information messages that are shown. Higher levels lead to more messages, info_level = 0 gives silence. The default is taken from the mizer_info_level option, see default_info_level().

...

Passed to mizer::tuneSteadyState(), for example t_max, dt, distance_tol or method.

Value

An updated mizerShelf object.

Details

Mizer's own steady-state machinery covers the consumers and the resource and holds any component registered with mizer::setComponent() at its stored value, which is why it warns about the carrion component. This method takes responsibility for that component, so the warning is suppressed here.

See also

tune_carrion_detritus()