sr_beverton_holt.hpp

Go to the documentation of this file.

 
#ifndef FIMS_POPULATION_DYNAMICS_RECRUITMENT_SR_BEVERTON_HOLT_HPP
#define FIMS_POPULATION_DYNAMICS_RECRUITMENT_SR_BEVERTON_HOLT_HPP
 
#include "recruitment_base.hpp"
#include "../../../common/fims_vector.hpp"
 
namespace fims_popdy {
 
template <typename Type>
struct SRBevertonHolt : public RecruitmentBase<Type> {
  // Here we define the members that will be used in the Beverton--Holt
  // stock--recruitment function. These members are needed by the Beverton--Holt
  // stock--recruitment function but will not be common to all recruitment
  // functions like spawners is below.
  fims::Vector<Type> logit_steep; 
  SRBevertonHolt() : RecruitmentBase<Type>() {}
 
  virtual ~SRBevertonHolt() {}
 
  virtual const Type evaluate_mean(const Type& spawners, const Type& phi_0) {
    Type recruits;
    Type steep;
    Type steep_lo = static_cast<Type>(0.2);
    Type steep_hi = static_cast<Type>(1.0);
    Type rzero;
 
    // Transform input parameters
    steep = fims_math::inv_logit(steep_lo, steep_hi, this->logit_steep[0]);
    rzero = fims_math::exp(this->log_rzero[0]);
 
    recruits = (static_cast<Type>(0.8) * rzero * steep * spawners) /
               (static_cast<Type>(0.2) * phi_0 * rzero *
                    (static_cast<Type>(1.0) - steep) +
                spawners * (steep - static_cast<Type>(0.2)));
 
    return recruits;
  }
 
  virtual const Type evaluate_process(size_t pos) { return 0; }
 
  virtual void create_report_vectors(
      std::map<std::string, fims::Vector<fims::Vector<Type>>>& report_vectors) {
    report_vectors["logit_steep"].emplace_back(this->logit_steep);
    report_vectors["log_rzero"].emplace_back(this->log_rzero);
    report_vectors["log_r"].emplace_back(this->log_r);
    report_vectors["log_devs"].emplace_back(this->log_recruit_devs);
  }
 
  virtual void get_report_vector_count(
      std::map<std::string, size_t>& report_vector_count) {
    report_vector_count["logit_steep"] += 1;
    report_vector_count["log_rzero"] += 1;
    report_vector_count["log_r"] += 1;
    report_vector_count["log_recruit_devs"] += 1;
  }
};
 
}  // namespace fims_popdy
 
#endif /* FIMS_POPULATION_DYNAMICS_RECRUITMENT_SR_BEVERTON_HOLT_HPP */