mizer (version 2.0.3)

setMaxIntakeRate: Set maximum intake rate

Description

Set maximum intake rate

Usage

setMaxIntakeRate(params, intake_max = NULL, ...)
getMaxIntakeRate(params)

Arguments

params

MizerParams

intake_max

Optional. An array (species x size) holding the maximum intake rate for each species at size. If not supplied, a default is set as described in the section "Setting maximum intake rate".

...

Unused

Value

A MizerParams object with updated maximum intake rate. Because of the way the R language works, setMaxIntakeRate() does not make the changes to the params object that you pass to it but instead returns a new params object. So to affect the change you call the function in the form params <- setMaxIntakeRate(params, ...).

Setting maximum intake rate

The maximum intake rate \(h_i(w)\) of an individual of species \(i\) and weight \(w\) determines the feeding level, calculated with getFeedingLevel(). It is measured in grams/year.

If the intake_max argument is not supplied, then the maximum intake rate is set to $$h_i(w) = h_i w^n_i.$$ The values of \(h_i\) (the maximum intake rate of an individual of size 1 gram) and \(n_i\) (the allometric exponent for the intake rate) are taken from the h and n columns in the species parameter dataframe. If the h column is not supplied in the species parameter dataframe, it is calculated by the get_h_default() function, using f0 and the k_vb column, if they are supplied.

If \(h_i\) is set to Inf, fish will consume all encountered food.

See Also

Other functions for setting parameters: setExtMort(), setFishing(), setInitialValues(), setInteraction(), setMetabolicRate(), setPredKernel(), setReproduction(), setResource(), setSearchVolume(), species_params()

Examples

# NOT RUN {
params <- NS_params
params@species_params$h[3] <- 35
params <- setMaxIntakeRate(params)
# }