RegionHandler.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//
//  Thomas Berger (main author), Pepijn Schreinemachers, and Thorsten Arnold
//
//
//  Hohenheim University (490d)
//  Professorship for Land Use Economics in the Tropics and Subtropics
//
//  May not be distributed without permission by main author
//
//  File:       RegionHandler.h (formerly region.h)
//
//  Contents:   Handles all input files needed to initialize the cellular and
//              agent-based component
//
//
//------------------------------------------------------------------------------


#ifndef _RegionHandler_h
#define _RegionHandler_h

// Libraries C++
#include <iostream>
//using namespace std; // for C++-Compiler, so that cin is not read as std::cin
//#include <fstream>   // new 2005
//#include <string>    // new 2005

#include "BasicData.h"

#include "BasicStrings.h"
#include "CatchmentSector.h"
#include "CatchmentSectorSpecific.h"
#include "AgentPopulationHandler.h"
#include "PopulationNetworkSegmentList.h"
#include <sstream>

#ifdef LP_OLD
        //Few things that are only needed when bulit without COIN libraries
        #include "lp9.h"

#endif /* LP_OLD */

#include "MarketTradablesHandler.h"
#include "CropGrowthHandler.h"
#include "PermanentCropsHandler.h"
#include "PopulationClusterList.h"
#include "LivestockHandler.h"
#include "AgentUserAssociation.h"
class ausgabe;

// Help class, used to initialize sectors from REGION.dat
class classSectorReadInfoLine
{  public:
   string sectorName;
   bool active;
   bool hasSubsector;
   int CatchmentID;
        int positionInRegionFile; // not read, but number of file that was read
        int strahlerOrder; // currently not read
        int routingOrder; // not read, as curently corresponds to order in file
        int GISID;
        int sectorSeed;
        int NumberOfParcels;
        bool hasHydroData;

        // EDIC matters
        double ReUseCoefficient;
        double WaterSystemEfficiency;
   double canalEfficiency;
        double mergeB;
        double mergeG;
        MatrixDouble canalCapacity;
        MatrixDouble waterRightsByInflow;


        int numLotteryValues;


   classSectorReadInfoLine();
   virtual ~classSectorReadInfoLine()
   {    deallocateAll();
   };


   virtual bool readLine(ifstream& in, int HydroModel, int numInflows,
      int valuesPerInflow);

   virtual void printToScreen();

   virtual void writeToFile_Line(ofstream& outStream);
   virtual void deallocateAll();

};


class region
{
   public:
   //
   //region(char*, char*);
   region();

   virtual ~region()
   {  deallocateRegion();
      deallocOtherObjects();
   }

   virtual void initializeRegionFromFiles(TimeHandler& timeHandle_const);
   virtual void initializeRegionStandalone();
   
   virtual void checkMapAndExportConsistentMaps(double factor, double cutoffsize);
   virtual void analyseAllSectorsByContentAndExportHistogram(Content cont);

   // Arnold 080808 -- For Ghana model
   virtual void rectifySectorBoundariesFromInflows();

   
   virtual void initGlobalPointers();
   virtual void readDatFiles();
   virtual void readLandscapeFromFiles();
   
   virtual void createAgents();



   virtual void allocateCatchmentsAndSectors(void);

   //virtual void initializeCatchmentEdicAndInflows(void);
   // ... updated time handling, otherwise clone
   virtual void initializeCatchmentEdicAndInflows_new(void);
   


        virtual void readMonthlyInflowsFromFile(string filename, int mTot, MatrixDouble& infl);
        virtual void readMonthlyInflowsFromFile(string filename, int mTot);
        virtual void checkConsistencyCatchmentInflows(int mTot, MatrixDouble& infl);
        virtual void checkConsistencyRegion();
        virtual void analyseAllSectorsAndExportAgentInfo(string fn);



   virtual bool readRegionDatFileAndInitSectors(string filename);
   
   virtual void initializeSectorFromAuxiliaryClass(classSectorReadInfoLine& lineRead);
        virtual void initializeUserAssociation(int agentID_, int catchmentID_, int sectorID_,
                 int numLotteryValues);

   virtual void writeToFile_RegionTableFrontMatter(ofstream& out, 
        int NumSectors, int HydroModel, int OtherModel, int numInflows, int valuesPerInflow);
        
   virtual void readAllCatchmentsFromRasterFiles();

   // Export monthly and yearly maps
   void ExportMapsMonthly(TimeHandler& timeHandle_const);
   void ExportMapsAnnual(TimeHandler& timeHandle_const);
   void ExportMapsGeneric(bool flagIsAnnual, TimeHandler& timeHandle_const);



        //virtual void computeStartValuesForAgentWaterExpectations();// ## H2O
        //Arnold2008_0812    
   // Local time loop
        virtual void computeStartValuesForAgentWaterExpectations_new(TimeHandler& timeHandle_const);// ## H2O
   virtual void assignResourcesToAgents();
   virtual void writeMapsOnScreen();
   virtual void writeSubcatchmentMatrixDimsOnScreen();   

   virtual void deallocateRegion();
   virtual void deallocOtherObjects();

   // Calls core function <betriebe[i]->uebergang_periode()>
   int AgentsDoExpectationAndPlanning(int year);


   // ... contains the EDIC function
        virtual void wasser_periode(TimeHandler& timeHandle_const);
   // ... contains wasim coupling functions
   virtual void couplingHydrologyWasimAnnual(TimeHandler& timeHandle_const, ausgabe& outfiles);
        virtual void couplingHydrologyWasimMonthly(TimeHandler& timeHandle_const, ausgabe& outfiles);

   void resetEdicAnnualData(TimeHandler& timeHandle_const);
      
        virtual void updateDynamicInflows(TimeHandler& timeHandle_const);
   // From agents SolutionVector, land use is allocated in space
        virtual void agentsAllocateSpatiallyLanduse();
   // WaterInfo, using CrpMixClass defined in <agentsAllocateSpatiallyLanduse>,
   // irrigation water is allocated in space
   virtual void agentsIrrigationWater2Landscape(int m);


   // Test function.
   // .. takes content-values from landscape (eventually from sector!), writes them into parcels, 
   // .. then into cells (!!) and returns them as joined raster
   virtual void allocateSpatiallyContentFromLdsAndReportCells_test(Content cont, Raster2D& rasterLanduse);

        //Arnold2006_31
   virtual void joinRegionMap(Content cont, Raster2D& rasterRegion);
   virtual void joinRegionMap(Content cont, Raster2D& rasterRegion, int m);
   virtual void joinRegionMap(Content cont, Raster2D& rasterRegion, int m, bool flag_foreCell);

   virtual void translateFromParcelCallToRaster(Content cont, Raster2D& test);
   //Arnold2006

   // Delete all lands without agents, and
   // agents that own area bellow factor_HRB * cutoffsize
   virtual void checkConsistencyOfMaps(double factor_HRB, double cutoffsize);

   virtual void printListOfAllAgents();
   virtual void print_AllSubcatchs();

   virtual void writeLandMarketsToFile(ausgabe& outfiles);
        virtual void outputLanduseByUserAssociation(int type);  //Daten zum Simulationsende

        virtual void printAllAgentsProductions();

protected:
   // If spatial, writes yearly land use map here.
   bool landuseWasAllocated;
   Raster2D rasterLanduse;
   Raster2D rasterIrrigWaterMonthly;
   
   CropGrowthHandler* p_cropGrowthHandler;
};





#endif

---