Skip to content

Commit

Permalink
doc: logit_steep correction
Browse files Browse the repository at this point in the history
Updated documentation to reflect that steepness is now input as a logit transformed value so no longer between 0.2 and 1
  • Loading branch information
nathanvaughan-NOAA committed Jul 27, 2023
1 parent a96a987 commit a00c530
Showing 1 changed file with 2 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace fims {
/** @brief BevertonHolt class that returns the Beverton Holt SR
* from fims_math.
*
* @param steep Recruitment relative to unfished recruitment at
* @param logit_steep Recruitment relative to unfished recruitment at
* 20% of unfished spawning biomass. Should be a value between 0.2 and 1.0.
*/
template <typename Type>
Expand All @@ -29,8 +29,7 @@ struct SRBevertonHolt : public RecruitmentBase<Type> {
// function. These members are needed by Beverton Holt but will not be common
// to all recruitment functions like spawners is below.
Type logit_steep; /*!< Transformed value of recruitment relative to unfished
recruitment at 20% of unfished spawning biomass. Should be a
value between 0.2 and 1.0.*/
recruitment at 20% of unfished spawning biomass.*/

SRBevertonHolt() : RecruitmentBase<Type>() {}

Expand Down

0 comments on commit a00c530

Please sign in to comment.