Internal API

Internal API#

This page provides an auto-generated summary of the feisty API.

Model components#

benthic_prey_type(group_ind, mod_params, ...)

Data structure containing benthic prey parameters.

fish_type(group_ind, domain_params, ...)

fishing(domain_params, fishing_rate_per_year)

Data structure containing fishing parameters

food_web(feeding_settings, member_obj_list, ...)

Data structure defining feeding relationships.

food_web_link(food_web, i)

Information describing an individual feeding link.

reproduction_link(ndx_from, i_fish_from, ...)

Data structure with the information pertaining to a specific link in reproduction routing list.

reproduction_routing(routing_settings, ...)

Data structure to store reproduction routing information.

zooplankton_type(group_ind, mod_params, ...)

Data structure containing zooplankton parameters.

Process#

compute_rate_T_mass_scaling(T, mass, k, a, b)

compute_t_frac_pelagic(t_frac_pelagic, ...)

Return the fraction of time spent in the pelagic.

t_weighted_mean_temp(T_pelagic, T_bottom, ...)

Compute the time-weighted mean temperature.

compute_metabolism(metabolism_rate, ...)

Compute metabolic rate.

compute_pred_encounter_consumption_max(...)

Compute predator encounter and maximum consumption rates.

compute_encounter(encounter_rate_link, ...)

Compute encounter rates.

compute_consumption(consumption_rate_link, ...)

Consumption rates.

compute_rescale_zoo_consumption(...)

Limit zooplankton consumption by mortality term.

compute_ingestion(ingestion_rate, ...)

Compute ingestion.

compute_predation(predation_flux, ...)

Compute predation.

compute_natural_mortality(mortality_rate, ...)

Compute natural mortality.

compute_energy_avail(energy_avail_rate, ...)

Compute energy available for growth (nu).

compute_growth(growth_rate, ...)

Compute energy available for somatic growth (gamma).

compute_reproduction(reproduction_rate, ...)

Compute reproduction from energy available for growth and reproduction (nu) and energy available for somatic growth (gamma).

compute_recruitment(recruitment_flux, ...)

Compute "recruitment" from reproduction (i.e., larval production) or growth.

compute_total_tendency(total_tendency, ...)

Compute the total time tendency of fish.

compute_fish_catch(fish_catch_rate, ...)

Compute fishing rate.