herbivore_base.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020 W. Traylor <wolfgang.traylor@senckenberg.de>
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef FAUNA_HERBIVORE_BASE_H
#define FAUNA_HERBIVORE_BASE_H
 
#include <memory>
#include "breeding_season.h"
#include "environment.h"
#include "fatmass_energy_budget.h"
#include "get_forage_demands.h"
#include "herbivore_data.h"
#include "herbivore_interface.h"
 
namespace Fauna {
 
enum class Sex { Female, Male };
 
 
class HerbivoreBase : public HerbivoreInterface {
 public:
  // -------- HerbivoreInterface ----------
  virtual void eat(const ForageMass& kg_per_km2,
                   const Digestibility& digestibility,
                   const ForageMass& N_kg_per_km2);
  virtual ForageMass get_forage_demands(const HabitatForage& available_forage);
  virtual std::string get_output_group() const;
  virtual double get_kg_per_km2() const;
  virtual const Output::HerbivoreData& get_todays_output() const {
    return current_output;
  }
  virtual void simulate_day(const int day,
                            const HabitatEnvironment& environment,
                            double& offspring);
 
 public:
  int get_age_days() const { return age_days; }
 
  double get_age_years() const { return age_days / 365.0; }
 
 
  double get_bodyfat() const;
 
 
  virtual double get_bodymass() const;
 
 
  double get_bodymass_adult() const;
 
 
  double get_conductance() const;
 
 
  double get_fatmass() const;
 
  const Hft& get_hft() const {
    assert(hft);
    return *hft;
  }
 
 
  double get_max_fatmass() const;
 
 
  double get_structural_mass() const;
 
 
  int get_today() const;
 
  Sex get_sex() const { return sex; }
 
 protected:
 
  HerbivoreBase(const int age_days, const double body_condition,
                std::shared_ptr<const Hft> hft, const Sex sex,
                const ForageEnergyContent& forage_gross_energy);
 
 
  HerbivoreBase(std::shared_ptr<const Hft> hft, const Sex sex,
                const ForageEnergyContent& forage_gross_energy);
 
  virtual ~HerbivoreBase() = default;
 
 
  virtual void apply_mortality(const double mortality) = 0;
 
  FatmassEnergyBudget& get_energy_budget() { return energy_budget; }
 
  const FatmassEnergyBudget& get_energy_budget() const { return energy_budget; }
 
 
  const HabitatEnvironment& get_environment() const { return environment; }
 
  Output::HerbivoreData& get_todays_output() { return current_output; }
 
  bool constant_members_match(const HerbivoreBase& other) const {
    return sex == other.sex && hft.get() == other.hft.get() &&
           forage_gross_energy == other.forage_gross_energy &&
           breeding_season == other.breeding_season;
  }
 
 private:  // private member functions
 
  void apply_mortality_factors_today();
 
 
  std::shared_ptr<const Hft> check_hft_pointer(std::shared_ptr<const Hft>);
 
 
  ForageEnergyContent get_net_energy_content(Digestibility digestibility) const;
 
 
  double get_todays_expenditure() const;
 
 
  double get_todays_offspring_proportion() const;
 
 private:
  // pointer to const Hft; initialized first!
  const std::shared_ptr<const Hft> hft;
  const Sex sex;
  const BreedingSeason breeding_season;
  const ForageEnergyContent forage_gross_energy;  // constants
 
  int age_days;
  FatmassEnergyBudget energy_budget;
  HabitatEnvironment environment;  // set in simulate_day()
  int today;  // state variables
 
 
  PeriodAverage body_condition_gestation;
 
  Output::HerbivoreData current_output;
  GetForageDemands get_forage_demands_per_ind;  // Helper Classes
};
 
}  // namespace Fauna
#endif  // FAUNA_HERBIVORE_BASE_H