Determines if juveniles stay in the region (Sections of Mainstem Sacramento River or San Joaquin River) or out migrate during a simulated month

route_regional(
  month,
  year,
  migrants,
  inchannel_habitat,
  floodplain_habitat,
  prop_pulse_flows,
  migration_survival_rate,
  proportion_flow_bypass,
  filling_fn = fallRunDSM::fill_regional,
  filling_args = NULL,
  movement_fn = NULL,
  movement_months = NULL,
  movement_args = NULL,
  detour = NULL,
  territory_size,
  freeport_flows,
  vernalis_flows,
  stochastic
)

Source

IP-117068

Arguments

month

The current simulation month, 1-8

year

The current simulation year, 1-20

migrants

An n by 4 matrix of juvenile fish by watershed and size class

inchannel_habitat

A vector of available habitat in square meters

floodplain_habitat

A vector of available floodplain habitat in square meters

prop_pulse_flows

The proportion of pulse flows

migration_survival_rate

The outmigration survival rate

proportion_flow_bypass

Variable describing the proportion of flows routed through the bypasses, more details at proportion_flow_bypasses

filling_fn

optional filling function to use in routing procedure, by default it uses fallRunDSM::fill_regional

filling_args

when passing custom filling function, pass function specific arguments as a list here

movement_fn

optional movement function to use in routing procedure

movement_months

when passing custom movement function, pass movement months here

movement_args

when passing custom movement function, pass function specific arguments as a list here

detour

Values can be 'sutter' or 'yolo' if some juveniles are detoured on to that bypass, otherwise NULL

territory_size

Array of juvenile fish territory requirements for fill_regional

stochastic

TRUE FALSE value indicating if model is being run stochastically

freeport_flow

Monthly mean flow at freeport in cubic feet per second

vernalis_flow

Monthly mean flow at vernalis in cubic feet per second