recruitment.hpp File Reference

Go to the source code of this file.

Functions
template<class Type>
Type	calculate_recruitment (int srr_fun, Type R0, Type ssb, Type srr_alpha, Type srr_beta, Type rec_dev, Type spr0)
	Calculates the recruitment for a given species and year.

Function Documentation

calculate_recruitment()

template<class Type>

Type calculate_recruitment	(	int	srr_fun,
		Type	R0,
		Type	ssb,
		Type	srr_alpha,
		Type	srr_beta,
		Type	rec_dev,
		Type	spr0 )

Calculates the recruitment for a given species and year.

Parameters

srr_fun	Stock-recruit relationship (SRR) type: 0 = random about mean (the default), 2 = Beverton-Holt, 4 = Ricker. Codes 1, 3 and 5 are retired aliases of 0, 2 and 4 that compute the same curve here; build_srr() refuses them, because the environmental effect now comes from a recruitment linkage on R0 (code 1) or alpha (3 and 5).
R0	Equilibrium or mean recruitment level (thousands of fish); read by the random-about-mean forms only.
ssb	Female spawning-stock biomass (mt), lagged by minage by the caller.
srr_alpha	SRR productivity parameter.
srr_beta	SRR density-dependence parameter.
rec_dev	Annual recruitment deviation, log scale.
spr0	Equilibrium spawning biomass per recruit at F = 0 (M of year 1). Unused here: both curves are functions of srr_alpha, srr_beta and ssb, and the caller derives the unfished recruitment they imply – (alpha - 1/spr0)/beta for Beverton-Holt, a posfun()-guarded log for Ricker.

Returns

Expected recruitment (thousands of fish).

Definition at line 25 of file recruitment.hpp.