BasicData.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:       BasicData.h (formerly allgem9.h)
//
//  Contents:   Basic model data, such as model configuration switches
//
//
//
//------------------------------------------------------------------------------

#ifndef _BasicData_h
#define _BasicData_h


// The following (low-level) header should be included always
// Contains enums

// LINUX / WINDOWS specific definitions
#ifdef AIX
   #include <unistd.h>
#else
        #include <dos.h>
#endif /* AIX */

#include "BasicStrings.h"

#ifdef AIX
   long getTimeDiffInSecAIX(time_t t2, time_t t1);
#else
   
#ifndef _MSC_VER
        void zeitdifferenz(struct time* t2, struct time* t1); //Tbe Feb23
   double getTimeDiffInSecWIN(struct time* t2, struct time* t1);//Tbe Feb23
#endif

#endif


// This function needs to be declared in MAIN
void exitfun();


//General parameters, formerly defines
//Maximum number of catchments (formerly subcatchments)
int NUM_CATCHMENTS();     
void    setNUM_CATCHMENTS(int numC);


//Maximum number of catchment sectors
int NUM_SECTORS();     
void    setNUM_SECTORS(int numS);

//Maximum number of river inflows
int NUMINFLOWS(void);
void setNUMINFLOWS(int numInflows);

int MONATE();           //Maximum number of irrigation months
int NW_ANZAHL();        //Maximum number of innovation networks
int SEG_ANZAHL();       //Maximum number of segments per network
int POP_ANZAHL();       //Maximum number of agent populations
int CLU_ANZAHL();       //Maximum number of clusters per population
int MAXLOOP();          //Maximum number of loops before lottery is stopped
double SHARE_DEMAND_MET();      //Minimum share of water demand to be met in lottery

void setSHARE_DEMAND_MET(double share);

//Arnold2006_14
void NODATAVAL_def(int);  // Defines Not A Value within program
int NODATAVAL();        // Return NaValue

void set_MONATE(int maxM);

//flag for water rights assignment
void setWATER_RIGHTS(int flag);
int WATER_RIGHTS();


//Parameters for innovation decision
int MAXINVEST();        //Tentative number of investments per farm
int HOECHSTALTER();     //Maximum age of assets in period 0
int MINDESTALTER();     //Minimum age of assets in period 0
int KOMM();             //Type of communication process (Default = 0)
int KUMM();             //Cumulative adoption  ("classical" diffusion curve)
double LAMBDA();        //Parameter for expectations (Brandes et al., 1997: 382)
double MARGE();         //Safe rounding factor for indivisible assets (Default = 1.0)
double MINUMFANG();     //Minimum investment in permanent crops [ha]
double OVERLAP();       //Overlap of network thresholds (Default = 1.0)
double RESERVE();       //Liquidity reserve factor (Default = 0.0)
int SYM_ANZAHL();       //Number of "symbolic" investment objects
double WAEHRUNG();      //Currency units

//Parameters for rental markets
double MINPACHT();      //Minimum bid (relative to average shadow prices)
double PACHTABSCHLAG(); //Activity factor for renting-out decisions (< 1.0)
double PACHTZUSCHLAG(); //Activity factor for renting-in decisions  (> 1.0)

//Policy parameters
int BONUSALTER();       //Maximum age of subsidized permanent crops (Default = 0)
int BONUSDAUER();       //Duration of policy measure (Default = 0)
int IRRIGATIONPROJECTS();//initial number of irrigation infrastructure projects

//Switches for various modules (= components)
int CONS_MDL();         //Type of consumption module
int CROPG_MDL();        //Type of crop growth module
void setCROPG_MDL(int _crop_mdl);
//    0: EDIC
//    1: TSPC
//    2: Coupling with WASIM
int HYDRO_MDL();        //Type of hydrology module
void setHYDRO_MDL(int _hydro_mdl);
//    0: EDIC
//    1: No hydrology
//    2: Coupling with WASIM
int LIVST_MDL();        //Livestock module
int PERMC_MDL();        //Permanent crops module
int LANDM_MDL();        //Land markets module
int INPUT_GIS();        //Type of GIS input


int SPECL_MDL();        //Country-specific module

//Soil types and soil classes
double PLOTSIZE();      //Size of 1 gridcell (=parcel) [ha]
void    setPLOTSIZE(double _plotsize);

double  CELLLENGTH();  // Converts PLOTTSIZE to length of one cell
double DIST_COSTS();    //Unit transport costs [ZT$]
int TYPEN();            //Number of soil types
int KLASSEN();          //Number of soil classes

int DBG_INFOS();        //debug information (yes/no)
int DYNAMICS_OFF_ALL();                         //switches off all dynamics (aging, liquidity, soil porcesses)
int DYNAMICS_OFF_HOUSEHOLDS();  //switches off aging of household members
int DYNAMICS_OFF_LIVESTOCK();           //switches off aging of livestock
int DYNAMICS_OFF_ASSETS();                      //switches off aging of assets
int DYNAMICS_OFF_SOIL_PROCESSES();//switches off updating of soil processes

int get_NUMBER_SPIN_UP_ROUNDS();
void set_NUMBER_SPIN_UP_ROUNDS(int numSpinUpRounds);

//Special debug info for Milp
double MIN_OBJV();      //minimum objective value
int SAVE_MILP(int IdOfMilp);//returns 'true' if MILP has to be saved
int SAVE_AGENT(int farmsteadID);//returns 'true' if agent data have to be saved

//Fine-tuning of OSL Solver
int OSL_TUNE();         //fine tuning (yes/no)
double MAX_TIME();      //maximum time allowed for solving
void SET_MAX_TIME(double max_time_);//set maximum time
int MAX_ITER();         //maximum iterations
int MAX_NODE();         //maximum nodes


// GENERAL FUNCTIONS
// ===========================================================



//Arnold2006_93
//EDIC_RELEVANT
int   totMonth2actMonth(int mTot);






typedef struct
{
   char* sectorName;
   int lenDoubles;
   int lenInts;
   double* doubleVals;
   int* integerVals;
} EDICtable;

//Arnold2006
/*
int numSectorsTot();
void countUpSectorsOne();
*/




// SWITCH:
// read input flows from separate file at monthly timesteps,
// or from Catchment Fuile (EDIC version) ?
void setDYNAMICINFLOWS(bool);
int DYNAMICINFLOWS();

bool SPATIAL_ON();
void set_SPATIAL_ON(bool b);

bool DOPOSTPROCESSING();
void set_DOPOSTPROCESSING(bool);

int WASIM_DELTAMONTH(); // Shifts month from MAS (0: Okt) to WASIM (10: Okt)numeration




// Read WASIM filenames
void ReadWasimFilenames();
void PrintWasimFilenames();


//reads/writes basic constants them from/in a file and returns their values
void readBasicData();
void writeBasicData(char* filename);

void readAllDefaults(string fn);


// --> TESTFUN functions
// =====================================================================

//-------------------------------------

// This function returns TRUE if a certain output should be made.
// Internally, it uses a vector (of class MatrixDouble) which contains only zeros and ones (false / true)
// USE:
// 1) The vector is first initialized at the beginning of the program, by definint the dimension with
//        TestFunInit(int max);
//       By default, all entries are FALSE

// 2) Then, any test output level can be chosen and set to TRUE with
//          TestFun_setTrue(int testNr);
//
// 3) The optional function <getReturnIf99();> checks if TestFun(99) == true,
//    interrupts the program execution and promps for an input by the user
//    By convention, it is only used WITHIN other error outputs so the program runs through if only 99 is set TRUE!
//
// 4) Error outputs are optional now:
//      int val = 4;
//      if (TestFun(val))
//      {       cout << " blablabla" << endl;
//                 getReturnIf99();
//          exit(1);
//      }
//
bool TestFun(int testNr);
// This function is identical to above, but does not give warnings, for use in destructors (After TestFun was destructed, while closing the program)
bool TestFunDestr(int testNr);

void TestFunInit(int max);
int TestFun_getMax();
void TestFun_setFalse(int testNr);
void TestFun_setTrue(int testNr);
void TestFun_printAllActive();

// Function for spatial export. Clone of TestFun!
bool SpatialExport(int v_);
void SpatialExportDealloc();

void SpatialExportInit();
int SpatialExport_getMax();
void SpatialExport_setFalse(int v_);
void SpatialExport_setTrue(int v_);
void SpatialExport_printAllActive();

// Request return (iun Test-Files)
void getReturnIf99();
void getReturnIf99(int);

// Content 
string getCONTSTR(Content contIn);
void printContString(Content cont);
string returnContString(Content cont);

// ONLY RENAMED FROM ABOVE
string cont2string(Content cont);
string exptp2string(ExportType tp);

// Filter Function 
bool FilterFun(int filterNr);
void FilterFunInit(int max);
void FilterFunDealloc();
int FilterFun_getMax();
void FilterFun_setFalse(int filterNr);
void FilterFun_setTrue(int filterNr);
void FilterFun_printAllActive();

// --> STRING, FILE  AND DIRECTORY TREATMENT
// =====================================================================
char* const2char(const char* exp);
void const2char(const char* exp, char* out);


string getOnlyNums(string& fn);
string getOneToken(string& fn, string& rest);
string getOneToken(string& fn);


//Arnold2006_91
void makeCharFrom3Int(char* irrigIDstr, int crA, int irrTech, int clusterNum);



// --> SOME SMALL MISC FUNCTIONS
// =====================================================================



// --> ExportType functions (ExportViaTDT, ExportTable)
// =====================================================================

// The function <ExportViaTDT> is analogous to TestFun, but applies to an enum type ExportType.
// It is used to govern the import and exort of files via TDT in both the controller and the MPMAS
// INITIALIZE IN MAIN:
//      int maxExports = 7;
//      ExportViaTDT_Init(maxExports);
//           ExportViaTDT_readFromFile("./iniFiles/dataexchange.ini")
//
//      // IN PROGRAM:
//      if (ExportViaTDT(expSoilMoist))
//      {
//              Raster2D soilMoist;
//              soilMoist.receiveViaTDT(configName);
//              // [oder irgendein anderes Handling]
//      }
bool ExportViaTDT(ExportType tp);
void ExportViaTDT_readFromFile(string fn);

int ExportViaTDT_getMax();
void ExportViaTDT_setFalse(ExportType testNr);
void ExportViaTDT_setTrue(ExportType testNr);
void ExportViaTDT_printToScreen();
// The array "tableFlags" is used to decide which WASIM files are loaded and
// exported  into table format  
bool ExportTable(ExportType tp);
void ExportTable_printToScreen();

int ExportTable_getMax();
void ExportTable_setFalse(ExportType testNr);
void ExportTable_setTrue(ExportType testNr);
void ExportTable_printToScreen();

// First value which contains only WaSiM additional data
// --> Hard-wired, now: 5
int ExportType_firstAdditional();

// Factor used to convert irrigation quanitities into quantities used by
// ======================================================================
// TREAT OF IRRIGATION AND INFLOWS (globally)
void setIRRIGMETHOD(int in);
int IRRIGMETHOD();

void setIRRIGMETHOD(int in);
int IRRIGMETHOD();

string FILENAME_InflowKey();
void setFILENAME_InflowKey(string s);



// PASSED AS ARGUMENT TO MPMAS (-R## with TYPE)
// Currently, there are two "conversion types":
//    - Type 1: The conversion from MPMAS input (Activity-Key / LP-block on hydrology   --> Irrigation Table )
//    - Type 2: Conversion (WASIM abstractions / files as read from Disk  --> Sector inflows
//
// -->
//ARNOLD_IRRIGATIONFACTOR
enum enumIrrigationFactorType {
   typeIrrig_cropWat2WasimIrrigationTable, 
   typeIrrig_externalInflow2LiterPerSecond, 
   typeIrrig_cropWatGross2LiterPerSecond, 
   typeIrrig_cropWatExpected2LiterPerSecond,
   typeIrrig_activityKey2LiterPerSecond,
   typeIrrig_activityKey2mmPerDay,
   typeIrrig_CropKey2mmPerDay, // not used
   typeIrrig_MAX, 
   typeIrrig_ErrorOutput     
} ;

// output
void irrigationFactors_printOptions();
void irrigationFactors_printCurrentSetting();

// input
void setIrrigationDefaults();
int readIrrigationFactors(string fn);
void setIRRIGFACTOR(int unitType, enumIrrigationFactorType conversionType);

// access
double IRRIGFACTOR(enumIrrigationFactorType conversionType);
int getIrrigationUnitType(enumIrrigationFactorType conversionType);
int getIrrigUnitForWasimUnit(int conversionID); //int getIRRIGfactorValue(int unitType);
double getFactorFromUnitType(int conversionID);

// string
string irrigationUnitToString(int conversionID); // irrigationFactorUnitAsStringFromType
string getIrrigationFactorDescription(enumIrrigationFactorType);

// <--




// --> MEMORY ALLOCATION FUNCTIONS
// =====================================================================

// Quit program after deallocating
void deallocateUtilities();

//Misc.
void TestFunDealloc();




// ###############################
// ## allgHigher.h HIGHER
// ###############################



// Only destruction, to avoid inclusion within deallocateUtilities()

void ExportTable_readFromFile(string fn);

void setINFLOWINFO(int pos, int val, string name);


// Read from ABSTRFILE_fn();
int readInflowKey(string fn);

// Access to content of INFLOW KEY
// To a value of the inflow (as defined in InputKey.txt), the name
// is returned
string INFLOW_val2name(int val);

// To the index of the inflow (order of InputKey.txt), the name
// is returned
string INFLOW_pos2name(int pos);

// To the index of the inflow (order of InputKey.txt), value returned
int INFLOW_pos2val(int pos);

// To the value of an inflow (as defined in InputKey.txt or in
// MEDIAN_FLOW passed by data manager), the position in RegionFile
// (InputKey.txt or Region.dat) is returned
// If not found: _NODATADEF_
int INFLOW_val2pos(int pos);

void printINFLOWS(void);
// <--

// Translate soil type into soil suitabiltiy class 
bool checkClassCorrespondsWithType(int cl, int tp);


int soilClassOrder(int priority);
void set_soilClassOrder();

void readSoilclass(FILE* bdata);
void   writeSoilClass(FILE* bdata);


// Functions --> Header
string getFullMpmasFilename(
      EnumFileType fileTypeEnum_,
      Content cont,
      int CatchmentID, int year, int month);
string getTestFilename(string s, int CatchmentID);

int SEED();
void setSEED(int seed_);

// CFor controlling numbr of model runs  with flag Y
void setSTOPYEAR(int stopyear_);
int STOPYEAR();

void setIDUM(long idum_);
long IDUM();

int MAXPERIODIN();
void setMAXPERIODIN(int maxPeriodIn_);

string getTDTConfigFilename(TypeDataExchangeChannel,  TypeDataExchangeType);
string filenameConfigFile(TypeRoleInCoupling roleInCoupling);

void printAllIrrigationMethods();
string getStringIrrigationMethods(typeIrrigationMethod);

// --------------------------------------------
// ... Canal model
void setCANAL_MODEL(int _canalModelType);
int CANAL_MODEL();

// Used in Mode 0, 3, 4
void setCANAL_INTERNAL_REUSE(int _canalModelType);
int getCANAL_INTERNAL_REUSE();
// Used for mode 0,3,4
void setCANAL_BETA_SHARE(double _betaShare);
double getCANAL_BETA_SHARE();
// Used in Mode 1, 3, 4
void setCANAL_LOSSFACTOR(double _canalLosses);
double getCANAL_LOSSFACTOR();
// Used in Mode 1, 3, 4
void setCANAL_LAMBDA(double _canalLambda);
double getCANAL_LAMBDA();

void initializeCanalDefault();
void readCanalFile(string fn);

void setCanalFilename(string fn);
string getCanalFilename();

void setWASIM_SPINUP(string fn);
string WASIM_SPINUP();


#endif

---