PoecilusCupreus_All.h

Go to the documentation of this file.

/*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ****
Copyright (c) 2023, Christopher John Topping, Aarhus University
Developed from a version by Andrey Chuhutin 2022.
All rights reserved.
 
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
 
Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* * * * * * * * * ** * * * * * * * * ** * * * * * * * * ** * * * * * * * * ** * * * * * * * * *****
*/
 
#ifndef POECILUS_CUPREUS_ALL_H
#define POECILUS_CUPREUS_ALL_H
 
#include <unordered_map>
 
extern const char* g_simulationName;
 
#include "Beetle_BaseClasses.h"
 
// Forward Declarations
class PoecilusCupreus_Population_Manager;
class Landscape;
class MovementMap;
class SimplePositionMap;
class probability_distribution;
 
using TTreatmentvsMortalityList = std::unordered_map<FarmToDo, double>;
 
// ------------------------------------------------------------------------------------------
//                            Start Beetle_Base Class                           
// ------------------------------------------------------------------------------------------
// - - - - - - - - - - Start Static Member Access - - - - - - - - - -
// - - - - - - - - - - End Static Member Access - - - - - - - - - -
// - - - - - - - - - -Start public functions with forced override - - - - - - - - - -
// - - - - - - - - - - End public functions with forced override - - - - - - - - - -
// + + + + + + + + + + Start Attributes + + + + + + + + + +
// - - - - - - - - - - Static members used for parameter input - - - - - - - - - -
// - - - - - - - - - - End Static Members - - - - - - - - - -
// + + + + + + + + + + End Attributes + + + + + + + + + +
// - - - - - - - - - -Start functions with forced override - - - - - - - - - -
// - - - - - - - - - - End functions with forced override - - - - - - - - - -
// -------------------- End Beetle_Base class --------------------
//---------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Egg_List class
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Egg_List : public Beetle_Egg_List {
public:
    PoecilusCupreus_Egg_List(int a_today, PoecilusCupreus_Population_Manager* a_bpm_ptr, Landscape* a_l_ptr);
};
 
// -------------------- End PoecilusCupreus_Egg_List class --------------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Larvae1 class                            
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Larvae1 : public Beetle_Larvae {
public:
    PoecilusCupreus_Larvae1(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    virtual void ReInit(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
};
 
// -------------------- End PoecilusCupreus_Larvae1 class --------------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Larvae2 class                            
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Larvae2 : public PoecilusCupreus_Larvae1 {
public:
    PoecilusCupreus_Larvae2(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    void ReInit(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr) override;
};
 
// -------------------- End PoecilusCupreus_Larvae2 class --------------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Larvae3 class                            
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Larvae3 : public PoecilusCupreus_Larvae2 {
public:
    PoecilusCupreus_Larvae3(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    void ReInit(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr) override;
};
 
// -------------------- End PoecilusCupreus_Larvae3 class --------------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Pupae class                            
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Pupae final : public Beetle_Pupae {
public:
    PoecilusCupreus_Pupae(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    void ReInit(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    bool CheckManagementBeetle() override {
        FarmToDo event;
        int i = 0;
        while ((event = static_cast<FarmToDo>(m_OurLandscape->SupplyLastTreatment(m_Location_x, m_Location_y, &i))) !=
            sleep_all_day) { return m_OurPopulation->OnFarmEventPupae(event, this); }
        return false;
    }
};
 
// -------------------- End PoecilusCupreus_Pupae class --------------------
 
// ------------------------------------------------------------------------------------------
//                            Start PoecilusCupreus_Adult class                            
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Adult final : virtual public Beetle_Adult {
protected:
    // + + + + + + + + + + Start Attributes + + + + + + + + + +
    PoecilusCupreus_Population_Manager* m_OurPopulation{nullptr}; // NOLINT(clang-diagnostic-shadow-field)
    double m_EggFormationProgress{0.0};
    int m_FirstActiveDay{364};
    bool m_postOvi_bool{ false };
    // - - - - - - - - - - Static members used for parameter input - - - - - - - - - -
    static vector<double> m_DailyAdultMortalityWithSeason;
    static double m_EggFormationThreshold;
    static double m_PoecilusTempShadowThreshold;
    static double m_PoecilusTempMoveThreshold;
    static double m_PoecilusCoverThreshold;
    // - - - - - - - - - - End Static Members - - - - - - - - - --
    // + + + + + + + + + + End Attributes + + + + + + + + + +
    TTypesOfBeetleState Ageing() override;
    TTypesOfBeetleState CheckDormancy() override;
    bool CheckDormancyExit() override;
    void CheckReproduction() override;
    int MoveTo_Quality_Assess() override;
    void TryToReproduce() override {
        if (m_postOvi_bool) return;
        Beetle_Adult::TryToReproduce();
    }
 
public:
    PoecilusCupreus_Adult(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    void ReInit(int a_x, int a_y, Landscape* a_l_ptr, PoecilusCupreus_Population_Manager* a_bpm_ptr);
    bool WinterMort() const override { return false; }
    // - - - - - - - - - - Start Static Member Set - - - - - - - - - -
    static void SetEggFormationThreshold(double a_value) { m_EggFormationThreshold = a_value; }
    static void SetPoecilusTempShadowThreshold(double a_value) { m_PoecilusTempShadowThreshold = a_value; }
    static void SetPoecilusLaiCoverThreshold(double a_value) { m_PoecilusCoverThreshold = a_value; }
    // - - - - - - - - - - End Static Member Set - - - - - - - - - -
};
 
// -------------------- End PoecilusCupreus_Adult class --------------------
 
// ------------------------------------------------------------------------------------------
//                  Start PoecilusCupreus_Population_Manager class 
// ------------------------------------------------------------------------------------------
class PoecilusCupreus_Population_Manager final : public Beetle_Population_Manager {
protected:
    // + + + + + + + + + + Start Attributes + + + + + + + + + +
    double m_CurrentEggFormationProgress{0.0};
    double m_DailyEggVariance{0.0};
    double m_DormancyChance{0.0};
    double m_DormancyExitChance{0.0};
    std::array<double, 365> m_EggFormationProgress{};
    std::array<double, 365> m_OvipostitionlengthProgress{};
    // - - - - - - - - - - Start attributes used for parameter input - - - - - - - - - -
    double m_Dormancy_threshold{5.0};
    double m_Dormancy_multiplier{1.2};
    double m_Dormancy_exit_threshold{8.0};
    double m_Dormancy_exit_multiplier{1.2};
    double m_PoecilusDailyEggFactorA{0.0};
    double m_PoecilusDailyEggFactorB{0.0};
    double m_PoecilusDailyEggFactorC{0.0};
    double m_PoecilusDailyVarianceEggFactorA{0.0};
    double m_PoecilusDailyVarianceEggFactorB{0.0};
    double m_PoecilusDailyVarianceEggFactorC{0.0};
    int m_PoecilusDormancyStartDateEarly{};
    int m_PoecilusDormancyStartDate{};
    int m_PoecilusDormancyExitDateEarly{};
    int m_PoecilusDormancyExitDate{};
    double m_PoecilusStandardDormancyChance{};
    double m_PoecilusStandardDormancyExitChance{};
    double m_PreOviRate;
    // - - - - - - - - - - End attributes used for parameter input - - - - - - - - - -
    // + + + + + + + + + + End Attributes + + + + + + + + + +
    void DayDegreeCalculations(int a_dayinyear, bool a_usehourly) override;
    static void SetMeanDistance(double a_temp);
 
public:
    PoecilusCupreus_Population_Manager(Landscape* a_l_ptr);
    ~PoecilusCupreus_Population_Manager() override = default;
    void CreateObjects(int ob_type, TAnimal* a_pvo_ptr, void* null, Struct_Beetle* a_data, int a_number) override;
    bool OnFarmEvent(FarmToDo a_event, Beetle_Base* a_caller) override;
    bool OnFarmEventPupae(FarmToDo event, Beetle_Base* a_caller) override;
    void CalculateDailyEggProduction(double a_temp) override;
    static double CalcOvipositionLength(double a_temp);
    double GetEggFormationProgress(int a_day) const { return m_EggFormationProgress[a_day]; }
    double GetOvipositionPeriodProgress(int a_day) const { return m_OvipostitionlengthProgress[a_day]; }
    double CalcDailyEggFormationProgress(double a_temp);
    void CalcDailyRandomEggFactor(double a_temp);
    void CalcDormancyChance(double a_temp, int a_day);
    void CalcDormancyExitChance(double a_temp, int a_day);
    TTreatmentvsMortalityList m_Pc_Treatment_Mortalities;
    bool FertilizerMortality(FarmToDo a_event);
    void SetPc_Treatment_Mortalities();
    double GetDormancyChance() const { return m_DormancyChance; }
    double GetDormancyExitChance() const { return m_DormancyExitChance; }
    void DoLast() override {
#ifdef CATASTROPHE2
        Catastrophe2();
#else
        Catastrophe(); // This method must be overidden in descendent classes
#endif
        DoBeetleActiveProbe(bob_Adult);
    }
};
 
// -------------------- End PoecilusCupreus_Population_Manager class -------------------- 
#endif