climate/climate.h

Go to the documentation of this file.

#ifndef _CLIMATE_H
#define _CLIMATE_H

#include <stdarg.h>
#include "gridlabd.h"
#include "solar_angles.h"
#include "weather_reader.h"
#include "csv_reader.h"
#include <vector>

typedef enum{
    CP_H    = 0,
    CP_N    = 1,
    CP_NE   = 2,
    CP_E    = 3,
    CP_SE   = 4,
    CP_S    = 5,
    CP_SW   = 6,
    CP_W    = 7,
    CP_NW   = 8,
    CP_LAST = 9
} COMPASS_PTS;

typedef enum{
    CI_NONE = 0,
    CI_LINEAR,
    CI_QUADRATIC
};

typedef enum{
    CM_NONE = 0,
    CM_CUMULUS = 1
} CLOUDMODEL;


typedef struct s_tmy {
    double temp; // F
    double temp_raw; // C
    double rh; // %rh
    double dnr;
    double dhr;
    double ghr;
    double solar[CP_LAST]; // W/sf
    double solar_raw;
    double direct_normal_extra;
    double pressure;
    double windspeed;
    double rainfall; // in/h
    double snowdepth; // in
    double solar_azimuth;
    double solar_elevation;
    double solar_zenith;
    double global_horizontal_extra;
    double wind_dir;
    double tot_sky_cov;
    double opq_sky_cov;
} TMYDATA;

/* published functions */
EXPORT int64 calculate_solar_radiation_degrees(OBJECT *obj, double tilt, double orientation, double *value);
EXPORT int64 calculate_solar_radiation_radians(OBJECT *obj, double tilt, double orientation, double *value);
EXPORT int64 calculate_solar_radiation_shading_degrees(OBJECT *obj, double tilt, double orientation, double shading_value, double *value);
EXPORT int64 calculate_solar_radiation_shading_position_radians(OBJECT *obj, double tilt, double orientation, double latitude, double longitude, double shading_value, double *value);
EXPORT int64 calculate_solar_radiation_shading_radians(OBJECT *obj, double tilt, double orientation, double shading_value, double *value);
EXPORT int64 calc_solar_solpos_shading_deg(OBJECT *obj, double tilt, double orientation, double shading_value, double *value);
EXPORT int64 calc_solar_solpos_shading_position_rad(OBJECT *obj, double tilt, double orientation, double latitude, double longitude, double shading_value, double *value);
EXPORT int64 calc_solar_solpos_shading_rad(OBJECT *obj, double tilt, double orientation, double shading_value, double *value);
EXPORT int64 calc_solar_ideal_shading_position_radians(OBJECT *obj, double tilt, double latitude, double longitude, double shading_value, double *value);

class tmy2_reader{
private:
    // Header information
    char data_city[75];
    char data_state[3];
    int lat_degrees;
    int lat_minutes;
    int long_degrees;
    int long_minutes;

    double low_temp;
    double high_temp;
    double peak_solar;  

    FILE *fp;
    //char buf[500]; // buffer to hold line data.

public:
    int tz_offset;
    char buf[500]; // buffer to hold line data.
    tmy2_reader(){}

    int elevation;

    void close();

    int open(const char *file);

    int next();

    int header_info(char* city, char* state, int* degrees, int* minutes, int* long_deg, int* long_min);

    int read_data(double *dnr, double *dhr, double *ghr, double *tdb, double *rh, int* month, int* day, int* hour, double *wind=0, double *winddir=0, double *precip=0, double *snowDepth=0, double *pressure = 0, double *extra_terr_dni=0, double *extra_terr_ghi=0, double *tot_sky_cov=0, double *opq_sky_cov=0);

    double calc_solar(COMPASS_PTS cpt, short doy, double lat, double sol_time, double dnr, double dhr, double ghr, double gnd_ref, double vert_angle);

};

typedef struct {
    double low;
    double low_day;
    double high;
    double high_day;
    double solar;
} CLIMATERECORD;

typedef enum {
        RT_NONE,
        RT_TMY2,
        RT_CSV,
};

class climate : public gld_object {
    
    // get_/set_ accessors for classes in this module only (non-atomic data need locks on access)
    GL_STRING(char32,city); 
    GL_ATOMIC(double,temperature); 
    GL_ATOMIC(double,humidity); 
    GL_ATOMIC(double,wind_speed); 
    GL_ATOMIC(double,tz_meridian); 
    GL_ATOMIC(double,solar_global); 
    GL_ATOMIC(double,solar_direct); 
    GL_ATOMIC(double,solar_diffuse); 
    GL_ATOMIC(double,solar_cloud_global); //< READ ONLY: global solar flux after modification by the cloud model(W/sf)
    GL_ATOMIC(double,solar_cloud_direct); 
    GL_ATOMIC(double,solar_cloud_diffuse); 
    GL_ATOMIC(double,cloud_alpha); //Determines the distance between the shading layers of the normalized patterns.
                                            //Smaller values lead to a larger distance between shading layers and greater variation within a cloud, closer to continuous.
                                            //Larger values lead to a smaller distance between shading layers and less variation within a cloud, closer to binary.
                                            //Minimum value is num_cloud_layers.
    GL_ATOMIC(double,cloud_num_layers); //Higher number of layers makes for the possibility of wispier clouds.
    GL_ATOMIC(double,cloud_aerosol_transmissivity); //Attenuation factor of no-cloud (clear-sky) radiation due to aerosols
    GL_ATOMIC(double,ground_reflectivity); // flux reflectivity of ground (W/sf)
    GL_STRUCT(CLIMATERECORD,record); 
    GL_ATOMIC(double,rainfall); 
    GL_ATOMIC(double,snowdepth); 
    GL_STRING(char1024,forecast_spec); 
    GL_STRING(char1024,tmyfile); 
    GL_ATOMIC(OBJECT*,reader); 
    GL_ATOMIC(double,temperature_raw); 
    GL_ARRAY(double,solar_flux,CP_LAST); 
    GL_ATOMIC(double,solar_raw);
    GL_ATOMIC(double,wind_dir);
    GL_ATOMIC(double,wind_gust);
    GL_ATOMIC(enumeration,interpolate);
    GL_ATOMIC(double,solar_elevation);
    GL_ATOMIC(double,solar_azimuth);
    GL_ATOMIC(double,solar_zenith);
    GL_ATOMIC(double,direct_normal_extra);
    GL_ATOMIC(double,pressure);
    GL_ATOMIC(double,tz_offset_val);
    GL_ATOMIC(double,global_horizontal_extra);
    GL_ATOMIC(double,tot_sky_cov);
    GL_ATOMIC(double,opq_sky_cov);
    GL_ATOMIC(double,cloud_opacity);
    GL_ATOMIC(double,cloud_reflectivity);
    GL_ATOMIC(double,cloud_speed_factor);
    GL_ATOMIC(enumeration,cloud_model);
    GL_ATOMIC(double,update_time);

    // data not shared with classes in this module (no locks needed)
private:
    SolarAngles *sa;
    tmy2_reader file;
    weather_reader *reader_hndl;
    TMYDATA *tmy;
public:
    enumeration reader_type;
    static CLASS *oclass;
    static climate *defaults;
public:
    void update_forecasts(TIMESTAMP t0);
    void init_cloud_pattern(void);
    void update_cloud_pattern(TIMESTAMP dt);
    int get_solar_for_location(double latitude, double longitude, double *direct, double *global, double *diffuse);
private:
    int calc_cloud_pattern_size(std::vector<std::vector<double> > &location_list);
    void build_cloud_pattern(int col_min, int col_max, int row_min, int row_max);
    void write_out_cloud_pattern(char pattern);
    void write_out_pattern_shift(int row_shift, int col_shift);
    void rebuild_cloud_pattern_edge( char edge_needing_rebuilt);
    void trim_pattern_edge( char rebuilt_edge);
    void erase_off_screen_pattern( char edge_to_erase);
    int get_fuzzy_cloud_value_for_location(double latitude, double longitude, double *cloud);
    int get_binary_cloud_value_for_location(double latitude, double longitude, int *cloud);
    double convert_to_binary_cloud();
    void convert_to_fuzzy_cloud( double cut_elevation, int num_fuzzy_layers, double alpha);
    TIMESTAMP prev_NTime;
    int MIN_LAT_INDEX;
    int MAX_LAT_INDEX;
    double MIN_LAT;
    double MAX_LAT;
    int MIN_LON_INDEX;
    int MAX_LON_INDEX;
    double MIN_LON;
    double MAX_LON;
    double global_transmissivity;
public:
    climate(MODULE *module);
    int create(void);
    int init(OBJECT *parent);
    int isa(char *classname);
    TIMESTAMP presync(TIMESTAMP t0);
    inline TIMESTAMP sync(TIMESTAMP t0) { return TS_NEVER; };
    inline TIMESTAMP postsync(TIMESTAMP t0) { return TS_NEVER; };
}; 

#endif

---

GridLAB-D™ Version 4.1

An open-source smart grid simulator created by PNNL for the US Department of Energy Office of Electricity