SubPopulation.h

Go to the documentation of this file.

/*
*******************************************************************************************************
Copyright (c) 2021, Xiaodong Duan, Aarhus University
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 SubPopulationAnimalH
#define SubPopulationAnimalH
//---------------------------------------------------------------------------
 
//---------------------------------------------------------------------------
class SubPopulation;
class SubPopulation_Population_Manager;
//------------------------------------------------------------------------------
 
 enum SubPopulation_Object : int{
   tos_Egg=0,
   tos_Larva,
    tos_Pupa,
    tos_Adult,
   tos_Adult_no_wing,
    count
} ;
 
 
class SubPopulation : public TAnimal
{
private:
   bool m_empty_cell;
   unsigned m_SpeciesID;
   blitz::Array<double, 2> temp_mortality_array;
   
 
protected:
   int m_index_x;
   int m_index_y;
   SubPopulation_Population_Manager*  m_OurPopulationManager;
   double *m_popu_density;
   double *m_suitability;
   double m_whole_population_in_cell;
   blitz::Array<double, 1> m_population_each_life_stage;
   blitz::Array<double, 2> m_animal_num_array;
   blitz::Array<double, 2> m_temp_animal_num_array;
 
   blitz::Array<double, 1> m_temp_droping_wings_array;
   blitz::Array<double, 1> m_died_number_each_life_stage;
   blitz::Array<double, 2> m_flying_array;
   blitz::Array<double, 2> m_local_moving_array;
   TTypesOfLandscapeElement m_winter_landscape_host;
   TTypesOfLandscapeElement m_summer_landscape_host;
   std::vector<int> m_winter_landscape_host_period;
   std::vector<int> m_summer_landscape_host_period;
   bool m_farm_flag;
   double m_parasitoid_num;
   double m_parasitoid_egg_num;
   bool m_landing_local_move_flag;
 
public:
   SubPopulation(int p_x, int p_y, Landscape* p_L, SubPopulation_Population_Manager* p_NPM, bool a_empty_flag, int a_index_x, int a_index_y, double* p_suitability=NULL, double* p_weight_density=NULL, int number=-1, int a_SpeciesID=999, TTypesOfLandscapeElement p_winter_landscape_host=tole_Foobar, TTypesOfLandscapeElement p_summer_landscape_host=tole_Foobar, bool p_farm_flag=false);
   virtual ~SubPopulation()=default;
   unsigned getSpeciesID() { return m_SpeciesID; }
   void setSpeciesID(unsigned a_spID) { m_SpeciesID = a_spID; }
   double getNumforOneLifeStage(int source_type);
   double getTotalSubpopulation(void) {return m_whole_population_in_cell;}
   void addAnimalNumGivenStageColumn(int source_type, int a_column, double a_num);
   void addAnimalNumGivenStage(int source_type, blitz::Array<double, 1>* a_animal_num_array);
   void removeAnimalNumGivenStage(int source_type);
   double removeAnimalPortionGivenStageColumn(int source_type, int a_column, double a_prop);
   void addAnimalFromAnotherCell(int source_type, int a_column, double a_num);
   blitz::Array<double, 1> getArrayForOneLifeStage(int life_stage);
   virtual void calPopuDensity(void);
   virtual void calSuitability(void);
   virtual void Step();
   virtual void doDevelopment();
   virtual void doMovement();
   virtual void doReproduction();
   virtual void doDropingWings() {};
   virtual void doMortality();
   virtual double calCellRelatedMortalityWeight() {return 0.0;};
   blitz::Array<double, 1> getFlyingArray( int ind) {return m_flying_array(ind, blitz::Range::all());}
   double getFlyingNum(int ind) {return sum(m_flying_array(ind, blitz::Range::all()));}
   void setWinterHostPeriod(int start_month, int end_month) {m_winter_landscape_host_period.at(0) = start_month; m_winter_landscape_host_period.at(1)=end_month;}
   void setSummerHostPeriod(int start_month, int end_month) {m_summer_landscape_host_period.at(0) = start_month; m_summer_landscape_host_period.at(1)=end_month;}
   virtual double calBioticMortalityRate(int a_life_stage) {return 0.0;}
   virtual void setParasitoidNum(double a_num) {;}
   virtual void setParasitoidEggNum(double a_num) {;}
   virtual void giveBirthParasitoidEgg(double a_egg_num) {;}
   virtual void killByParasitoid(){;}
   virtual void hatchParasitoidEggs(){;}
   double getPrasitoidNum() {return m_parasitoid_num;}
   double getPrasitoidEggNum() {return m_parasitoid_egg_num;}
   int supplySuitability() {return *m_suitability;}
   void setFlyLocalMovFlag(bool a_flag) {m_landing_local_move_flag = a_flag;}
   bool isNewlyLanded() {return m_landing_local_move_flag;}
   bool isFarm() {return m_farm_flag;}
   virtual void BeginStep(){;}
};
 
#endif