migration.h

Go to the documentation of this file.

#ifndef migration_h
#define migration_h
 
#include "livesonareas.h"
#include "actionattimes.h"
#include "keeper.h"
#include "intmatrix.h"
#include "modelvariable.h"
#include "rectangle.h"
#include "doublematrixptrvector.h"
#include "formulamatrixptrvector.h"
#include "migrationareaptrvector.h"
 
class Migration : public HasName, protected LivesOnAreas {
public:
  Migration(const IntVector& areas, const char* givenname);
  virtual ~Migration() {};
  virtual void Reset() = 0;
  virtual void Print(ofstream& outfile) = 0;
  virtual const DoubleMatrix& getMigrationMatrix(const TimeClass* const TimeInfo) = 0;
  const DoubleVector& getPenalty() const { return penalty; };
  virtual int isMigrationStep(const TimeClass* const TimeInfo) = 0;
protected:
  DoubleVector penalty;
};
 
class MigrationNumbers : public Migration {
public:
  MigrationNumbers(CommentStream& infile, const IntVector& areas,
    const AreaClass* const Area, const TimeClass* const TimeInfo,
    const char* givenname, Keeper* const keeper);
  ~MigrationNumbers();
  void Reset();
  void Print(ofstream& outfile);
  const DoubleMatrix& getMigrationMatrix(const TimeClass* const TimeInfo);
  virtual int isMigrationStep(const TimeClass* const TimeInfo);
private:
  void readTimeStepData(CommentStream& infile, const TimeClass* const TimeInfo);
  void readGivenRatios(CommentStream& infile, Keeper* const keeper, const AreaClass* const Area);
  void readGivenMatrices(CommentStream& infile, Keeper* const keeper);
  void setMatrixName(char* name);
  int useMatrix(char* name);
  void checkMatrixIndex();
  CharPtrVector allmatrixnames;
  CharPtrVector usedmatrixnames;
  IntVector timeindex;
  IntMatrix checkvalues;
  DoubleMatrixPtrVector calcMigration;
  FormulaMatrixPtrVector readMigration;
};
 
class MigrationFunction : public Migration {
public:
  MigrationFunction(CommentStream& infile, const IntVector& areas,
    const AreaClass* const Area, const TimeClass* const TimeInfo,
    const char* givenname, Keeper* const keeper);
  ~MigrationFunction();
  void Reset();
  void Print(ofstream& outfile);
  const DoubleMatrix& getMigrationMatrix(const TimeClass* const TimeInfo);
  virtual int isMigrationStep(const TimeClass* const TimeInfo);
private:
  void readAreaData(CommentStream& infile, const AreaClass* const Area,
    const TimeClass* const TimeInfo, Keeper* const keeper);
  int updateVariables(const TimeClass* const TimeInfo);
  void recalcMatrix();
  double getMigrationFunction(Rectangle* fromRec, Rectangle* toRec);
  double f1x(double w, double u, double D, double beta);
  double f2x(double w, double u, double D, double beta);
  DoubleMatrix calcMigration;
  ModelVariable diffusion;
  ModelVariable driftx;
  ModelVariable drifty;
  double lambda;
  double delta;
  MigrationAreaPtrVector oceanareas;
};
 
#endif