residential/residential.h

/* residential.h
    Copyright (C) 2008 Battelle Memorial Institute
 * contains all utility functions and common definitions for the residential module
 */

#ifndef _RESIDENTIAL_H
#define _RESIDENTIAL_H

#include "gridlabd.h"
#include "module.h"

#ifdef _RESIDENTIAL_CPP
#define GLOBAL
#define INIT(A) = (A)
#else
#define GLOBAL extern
#define INIT(A)
#endif

/* useful constants */
#define RHOWATER    (62.4)          // lb/cf
#define CFPGAL      (0.133681)      // cf/gal
#define GALPCF      (7.4805195)     // gal/cf
#define CWATER      (0.9994)        // BTU/lb/F
#define BTUPHPW     (3.4120)        // BTUPH/W
#define BTUPHPKW    (1e3 * 3.4120)      // BTUPH/kW
#define KWPBTUPH    (1e-3/BTUPHPW)  // kW/BTUPH
#define MWPBTUPH    (1e-6/BTUPHPW)  // MW/BTUPH
#define ROUNDOFF    1e-6            // numerical accuracy for zero in float comparisons

const double pi = 3.1415926535897931;
const double Cp = 1;                    // Btu/lbm-F
#define TSNVRDBL 9223372036854775808.0  //TS_NEVER in double form - for deltamode

/* approximate tests */
#define AEQ(A,B,C) (fabs(A-B)<C)
#define ANE(A,B,C) (fabs(A-B)>=C)
#define ALT(A,B,C) (A<=B+C)
#define AGT(Ak,B,C) (A>=B-C)

#define MAX(A,B) ((A)>(B)?(A):(B))
#define MIN(A,B) ((A)<(B)?(A):(B))

typedef enum {  BRK_OPEN=0,     
                BRK_CLOSED=1,   
                BRK_FAULT=-1,   
} BREAKERSTATUS; 
typedef enum {  X12=0,  
                X23=1,  
                X13=2,  
} CIRCUITTYPE; 

typedef struct s_circuit {
    CIRCUITTYPE type;   
    enduse *pLoad;  
    gld_property *pfrequency; 
    gld_property *pV; 
    double max_amps; 
    int id; 
    BREAKERSTATUS status; 
    TIMESTAMP reclose; 
    unsigned short tripsleft; 
    struct s_circuit *next; 
    // DPC: commented this out until the rest of house_e is updated
} CIRCUIT; 

typedef struct s_panel {
    double max_amps; 
    BREAKERSTATUS status; 
    TIMESTAMP reclose; 
    CIRCUIT *circuits; 
} PANEL; 

typedef CIRCUIT *(*ATTACHFUNCTION)(OBJECT *, enduse *, double , int is220); 

typedef enum {HORIZONTAL, NORTH, NORTH_EAST, EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST,N_SOLAR_SURFACES} ORIENTATION;

//Globals
GLOBAL double default_line_voltage INIT(120.0);         //Value for the default nominal_voltage
GLOBAL bool ANSI_voltage_check INIT(true);              //Flag to enable/disable ANSI voltage violation checks
GLOBAL double default_outdoor_temperature INIT(74.0);   //Value for default outdoor air temperature
GLOBAL double default_humidity INIT(75.0);              //Value for default humidity
GLOBAL int64 default_etp_iterations INIT(100);          //Value for etp solution iterations
GLOBAL double default_horizontal_solar INIT(0.0);       //Value for horizontal solar gains
GLOBAL double default_grid_frequency INIT(60.0);        //Value for frequency

//Deltamode inclusion
GLOBAL bool enable_subsecond_models INIT(false);            /* normally not operating in delta mode */
GLOBAL bool all_house_delta INIT(false);                    /* Cheater flag -- may not make it into the merge -- basically allows all houses to use deltamode */
GLOBAL double deltamode_timestep_publish INIT(10000000.0);  /* 10 ms timestep */
GLOBAL unsigned long deltamode_timestep INIT(10000000);     /* 10 ms timestep */
GLOBAL OBJECT **delta_objects INIT(NULL);                       /* Array pointer objects that need deltamode interupdate calls */
GLOBAL FUNCTIONADDR *delta_functions INIT(NULL);                /* Array pointer functions for objects that need deltamode interupdate calls */
GLOBAL FUNCTIONADDR *post_delta_functions INIT(NULL);           /* Array pointer functions for objects that need deltamode postupdate calls */
GLOBAL int res_object_count INIT(0);                            /* deltamode object count */
GLOBAL int res_object_current INIT(-1);                     /* Index of current deltamode object */
GLOBAL TIMESTAMP deltamode_starttime INIT(TS_NEVER);            /* Tracking variable for next desired instance of deltamode */

//Function definitions
void schedule_deltamode_start(TIMESTAMP tstart);    /* Anticipated time for a deltamode start, even if it is now */
void allocate_deltamode_arrays(void);               /* Overall function to allocate deltamode capabilities - rather than having to edit everything */


#endif  /* _RESIDENTIAL_H */

---

GridLAB-D™ Version 4.1

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