LCEdisperse.h

Go to the documentation of this file.

 
#ifndef LCEDISPERSE_H
#define LCEDISPERSE_H
#include <vector>
#include "lifecycleevent.h"
#include "param.h"
 
#ifdef HAS_GSL
 #include <gsl/gsl_rng.h>
 #include <gsl/gsl_randist.h>
#endif
 
class LCE_Disperse_base: public virtual LifeCycleEvent
{
  
  int    _disp_model;
  double _disp_propagule_prob;
  vector<unsigned int> _PropaguleTargets;
  double _fem_rate, _mal_rate;
  bool _isForward;
  bool _isByNumber;
  
  TMatrix* _DispMatrix[2]; 
 
  string _prefix;
  
  friend class LCE_Disperse_ConstDisp;
  friend class LCE_Disperse_EvolDisp;
  
protected:
  unsigned int _npatch;
 
  vector< vector<double> >  _reducedDispMat[2];
  vector< vector<double> >  _reducedDispMatProba[2];
 
public:
  
  LCE_Disperse_base();
  
  virtual ~LCE_Disperse_base(); 
  
  bool setBaseParameters(string prefix);
  void setParamPrefix (string pref) {_prefix = pref;}
  void addParameters  (string prefix, ParamUpdaterBase* updater);
  void setIndentityDispMatrix          (TMatrix* mat);
 
  void set_isForward                   (bool val) {_isForward = val;}
  bool checkForwardDispersalMatrix     (TMatrix* mat);
  bool checkBackwardDispersalMatrix    (TMatrix* mat);
  void allocateDispMatrix              (sex_t sex, unsigned int dim);
  bool updateDispMatrix                ();
  bool setDispMatrix                   ();
  bool setReducedMatricesBySex         (sex_t SEX, Param& connectivity, Param& rate); //new
  bool setReducedDispMatrix            ();
  bool setIsland_MigrantPool_Matrix    ();
  bool setIsland_PropagulePool_Matrix  ();
  bool setSteppingStone1DMatrix        ();
  bool setLatticeMatrix                ();
  bool setBasicLatticeMatrix           (int rows, int cols, double phi_mal, double phi_fem, double disp_mal, double disp_fem);
  bool setLatticeTorrusMatrix          (int rows, int cols, double disp_mal, double disp_fem, TMatrix* grid);
  bool setLatticeAbsorbingMatrix       ( );
  bool setLatticeReflectingMatrix      (int rows, int cols, TMatrix* grid);
 
  unsigned int   getMigrationPatchForward   (sex_t SEX, unsigned int LocalPatch);
  unsigned int   getMigrationPatchBackward  (sex_t SEX, unsigned int LocalPatch);
  unsigned int   getMigrationIndex          (vector<double>& rates);
  unsigned int   getMigrationIndexGSLdiscrete  (gsl_ran_discrete_t* rates);
  void           setPropaguleTargets        ( );
  void           swapPostDisp               ( );
  void           reset_counters             ( );
 
  bool           isForward                  ( ) {return _isForward;}
  bool           isByNumber                 ( ) {return _isByNumber;}
  unsigned int   getDispersalModel          ( ) {return _disp_model;}
  double         getPropaguleProb           ( ) {return _disp_propagule_prob;}
  unsigned int   getPropaguleTarget         (unsigned int home) {return _PropaguleTargets[home];}
  vector<double> getConnectedPatches        (sex_t SEX, unsigned int local_patch);  // excludes local patch
  vector<double> getConnectedRates          (sex_t SEX, unsigned int local_patch);  // excludes phylopatry
  double         getReducedDispersalRate    (sex_t SEX, unsigned int row, unsigned int col);
  unsigned int   getReducedDispersalPatchID (sex_t SEX, unsigned int row, unsigned int col);
 
 
//  virtual void init(Metapop* popPtr);
  //virtual bool setParameters ( );
  virtual void loadFileServices ( FileServices* loader ) {}
  virtual void loadStatServices ( StatServices* loader ) {}
  virtual bool resetParameterFromSource (std::string param, SimComponent* cmpt) {return false;}
  virtual age_t removeAgeClass ( ) {return NONE;}
  virtual age_t addAgeClass ( ) {return NONE;}
  virtual age_t requiredAgeClass () {return OFFSPRG;}
};
 
class LCE_Disperse_ConstDisp: public virtual LCE_Disperse_base 
{
  void (LCE_Disperse_ConstDisp::* doMigration) (void);
  void (LCE_Disperse_ConstDisp::* doPatchMigration) (sex_t SEX, unsigned int local_patch);
  
public:
        
  LCE_Disperse_ConstDisp (); // : LifeCycleEvent ("disperse","") {}  
  virtual ~LCE_Disperse_ConstDisp(){}
 
  bool setParameters (string prefix);
  
  void Migrate                      ( );
  void Migrate_propagule            ( );
  void MigratePatch                 (sex_t SEX, unsigned int LocalPatch);
  void MigratePatch_AbsorbingBorder (sex_t SEX, unsigned int LocalPatch);
  void MigratePatchByNumber         (sex_t SEX, unsigned int LocalPatch);
 
  virtual bool setParameters () {return setParameters("dispersal");}
  virtual void execute ();
  virtual LifeCycleEvent* clone () {return new LCE_Disperse_ConstDisp();}
};
 
 
 
class LCE_SeedDisp : public LCE_Disperse_ConstDisp {
  
 
public:
  LCE_SeedDisp ();
  virtual ~LCE_SeedDisp(){}
  virtual bool setParameters () {return LCE_Disperse_ConstDisp::setParameters("seed_disperse");}
  virtual LifeCycleEvent* clone () {return new LCE_SeedDisp();}
};
 
 
 
class LCE_Disperse_EvolDisp: public virtual LCE_Disperse_base
{
  
  double _fem_cost, _mal_cost, _fixed_disp_rate;
  unsigned int (LCE_Disperse_EvolDisp::* getAimedPatch) (unsigned int);
  void (LCE_Disperse_EvolDisp::* exec) ();
  
  unsigned int Migrate_Island (unsigned int home);
  unsigned int Migrate_Island_Propagule (unsigned int home);
  unsigned int Migrate_SteppingStone1D (unsigned int home);
  unsigned int Migrate_Lattice (unsigned int home);
  void exec_evolmale ();
  void exec_evolfemale ();
  void exec_evol2sex ();
  void evoldisp (sex_t SEX, int trait_link, double cost);
  void fixdisp (sex_t SEX, double rate, double cost);
  
  int _fdisp_trait_link, _mdisp_trait_link;
  
public:
        
    LCE_Disperse_EvolDisp();
  
  virtual ~LCE_Disperse_EvolDisp(){}
    
  virtual bool setParameters ();
  virtual void execute ();
  virtual LifeCycleEvent* clone () {return new LCE_Disperse_EvolDisp();}
};
 
#endif //LCEDISPERSE_H