gdrs.h

Go to the documentation of this file.

/***************************************************
Apache License Version 2.0

Copyright 2007-2011 EcoEquity and Stockholm Environment Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the specific language governing
permissions and limitations under the License.
****************************************************/

#ifndef GDRSHEADER
#define GDRSHEADER

#include "mainpage.h"
#include "datastruct.h"
#include "blockmath.h"
#include "sqlite3/sqlite3.h"

#define GDRS_OK 0
#define GDRS_CFGREADERROR 255
#define GDRS_CFGCLOSEERROR 256
#define GDRS_FREADERROR 258
#define GDRS_FCLOSEERROR 259
#define GDRS_NOMEM 260
#define GDRS_DIDNOTRUN 261
#define GDRS_TOO_MANY_TAX_ENTRIES 262

#define GDRS_ID_TABLE "id='gdrstable'"
#define GDRS_ROW_ID "calcrow"
#define GDRS_CLASS_REGION "class='gdrsregion'"
#define GDRS_ID_WORLD "class='gdrsregion' id='gdrsworld'"
#define GDRS_TEXT_COL "class='gdrstextcol'"

#define GDRS_SQLITE_OFFSET 1024
#define GDRS_SQLITE_CANTDELETEDB 1023
#define GDRS_SQLITE_BUFSIZE 2048
#define GDRS_SQLITE_HALFBUFSIZE 1024
#define GDRS_NUM_PARAMS 12
#define GDRS_NUM_TAX_PARAMS 6

#define EPS_NEWTON 1.0e-9
// Initial value of income for finding quintiles
#define INIT_Y 500

#define PER_BEFORE_EP 0
#define PER_SEQUENCE 1
#define PER_GDRS 2
#define ANNEX1 1
#define ANNEX2 2

#define XR_PPP 0
#define XR_MER 1

#define TAX_MAX_ENTRIES 100
#define TAX_TYPE_VALUE 0
#define TAX_TYPE_NATL_QUINTILE 1
#define TAX_TYPE_GLOBAL_QUINTILE 2

#define GAP_COMBINE_NONE 0
#define GAP_COMBINE_ADD 1
#define GAP_COMBINE_MAX 2
#define GAP_COMBINE_MIN 3

struct tax_entry {
    int seq_no;
    int is_ppp;
    int type;
    double value;
    double quintile;
};

struct gdrs_struct {
   struct appdata ad; 
   char **iso3; 
   int thisyear; 
   int cumsince; 
   int emergstart; 
   float billpercgwp; 
   float respweight; 
   float dt_low; 
   float dt_high; 
   float lux_thresh_mult; 
   int interp_between_thresholds; 
   float capfrac; 
   float emisselast; 
   int usesequence; 
   int sequenceyear; 
   float a1_perc_rdxn; 
   int a1refyear; 
   int use_lag; 
   float a1_shape_param; 
   int assign_mitgap_to; 
   struct fixedfactor annex1; 
   struct fixedfactor annex2; 
   struct fixedfactor frozen; 
   struct datablock bl_fossil; 
   int use_lulucf; 
   struct datablock bl_lulucf; 
   int use_nonco2; 
   struct datablock bl_nonco2; 
   int use_netexports; 
   struct datablock bl_netexports; 
   int do_luxcap; 
   int use_kab; 
   int kab_only_ratified; 
   struct datablock baseline; 
   struct datablock volrdxn; 
   struct datablock a1domrdxn; 
   struct datablock gdp; 
   struct datablock pop; 
   struct datablock scalpop; 
   struct datablock ppp2mer; 
   struct datablock ybar_ppp; 
   struct datablock gini; 
   struct datablock sdlog; 
   int emerg_path_id; 
   struct timeseries emergpath; 
   struct datablock r; 
   struct datablock c; 
   struct datablock rci; 
   struct fixedfactor rci_lagged; 
   struct datablock lux_emiss; 
   struct datablock lux_emiss_applied; 
   struct datablock alloc_gdrs; 
   struct datablock pop_above_dl; 
   struct datablock pop_above_lux; 
   struct datablock zl; 
   struct datablock zu; 
   struct timeseries yu_adj; 
   struct datablock zu_adj; 
   struct datablock kab_gap; 
   struct fixedfactor kyoto_startep_frac_1990; 
   struct fixedfactor kyoto_startep_frac; 
   struct fixedfactor kyoto_ratified; 
   int num_tax_levels; 
   struct tax_entry tax_levels[TAX_MAX_ENTRIES]; 
   struct datablock tax_revenue_mer_dens[TAX_MAX_ENTRIES]; 
   struct datablock tax_revenue_ppp_dens[TAX_MAX_ENTRIES]; 
   struct datablock tax_income_mer_dens[TAX_MAX_ENTRIES]; 
   struct datablock tax_income_ppp_dens[TAX_MAX_ENTRIES]; 
   struct datablock tax_pop_dens[TAX_MAX_ENTRIES]; 
   struct datablock tax_pop_below[TAX_MAX_ENTRIES]; 
};

void handle_sql3error(sqlite3 *db, sqlite3_stmt *stmt);
int loadgdrs(struct gdrs_struct *gdrs, const char *fname);
int readtable(sqlite3 *db, const char *column, struct datablock *table, struct appdata ad);
void cleargdrs(struct gdrs_struct gdrs);
void nextrci(int year, struct gdrs_struct *gdrs);
double luxcap(int year, struct gdrs_struct *gdrs);
void combine_gap(struct fixedfactor* gap, int i, double newgap, int combine);
void calc_luxemiss(struct fixedfactor* gap, double* totgap, int year, int period, int combine, struct gdrs_struct *gdrs);
void calc_kab(struct fixedfactor* gap, double* totgap, int year, int period, int combine, struct gdrs_struct *gdrs);
void calcallocs(struct gdrs_struct *gdrs);
void calcybar(struct gdrs_struct *gdrs);
// Note that formally z can be calculated from y, ybar, and sigma, but for speed
//    the value of z is calculated once for each country and then reused
struct datablock z(double y, struct gdrs_struct *gdrs, int ppp_or_mer);
double M(double a, double zc, double ybar, double sigma);
double globaldist(double y, int year, struct gdrs_struct *gdrs, int ppp_or_mer, double *dist_deriv);
double globalquintile(double q, int year, struct gdrs_struct *gdrs, int ppp_or_mer);
double a_gamma(double gamma, double y, double a, double b);
double b_gamma(double gamma, double y, double b);
double A_gamma(double gamma, double za, double zb, double yl, double yu, double ybar, double sigma);
double B_gamma(double gamma, double za, double zb, double yu, double ybar, double sigma);
double capbetween(double za, double zb, double zl, double zu, double yl, double yu_ppp, double ybar, double sigma, double pi, double luxmult);
double respbetween(double gamma, double za, double zb, double zl, double zu, double yl, double yu_ppp, double ybar, double sigma, double A);
double rhat(double E, double gamma, double sigma, double ybar);
double c_indiv(double y, double yl, double yu, int do_interp);
double r_indiv(double gamma, double y, double yl, double yu, double A, int do_interp);

// sqlite3 output
int dump2sql3(const char *fname, struct gdrs_struct gdrs);

#endif