setMaxIntakeRate: Set maximum intake rate

View source: R/setMaxIntakeRate.R

setMaxIntakeRateR Documentation

Set maximum intake rate

Description

Set maximum intake rate

Usage

setMaxIntakeRate(params, intake_max = NULL, reset = FALSE, ...)

getMaxIntakeRate(params)

intake_max(params)

intake_max(params) <- value

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".

reset

[Experimental] If set to TRUE, then the intake rate will be reset to the value calculated from the species parameters, even if it was previously overwritten with a custom value. If set to FALSE (default) then a recalculation from the species parameters will take place only if no custom value has been set.

...

Unused

value

intake_max

Value

setReproduction(): A MizerParams object with updated maximum intake rate.

getMaxIntakeRate() or equivalently intake_max(): An array (species x size) with the maximum intake rate.

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.

If h_i is set to Inf, fish of species i will consume all encountered food.

See Also

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


mizer documentation built on Oct. 17, 2024, 9:07 a.m.