powerflow/powerflow_object.h

#ifndef _POWERFLOWOBJECT_H
#define _POWERFLOWOBJECT_H

#include "gridlabd.h"

// DPC: this is to remain undefined until GS solver method is reconciled with reliability module
//#define SUPPORT_OUTAGES /**< defined when reliability module is supported */

#ifdef SUPPORT_OUTAGES

#define OC_NORMAL           0x0000  
/* contact flags */
#define OC_CONTACT          0x1000  
#define OC_PHASE_A_CONTACT  0x1001  
#define OC_PHASE_B_CONTACT  0x1002  
#define OC_PHASE_C_CONTACT  0x1004  
#define OC_NEUTRAL_CONTACT  0x1008  
#define OC_SPLIT_1_CONTACT  0x1010  
#define OC_SPLIT_2_CONTACT  0x1020  
#define OC_SPLIT_N_CONTACT  0x1040  
#define OC_GROUND_CONTACT   0x1080  
#define OC_CONTACT_ALL      0x10ff  
/* open flags */
#define OC_OPEN             0x2000  
#define OC_PHASE_A_OPEN     0x2001  
#define OC_PHASE_B_OPEN     0x2002  
#define OC_PHASE_C_OPEN     0x2004  
#define OC_NEUTRAL_OPEN     0x2008  
#define OC_SPLIT_1_OPEN     0x2010  
#define OC_SPLIT_2_OPEN     0x2020  
#define OC_SPLIT_N_OPEN     0x2040  
#define OC_GROUND_OPEN      0x2080  
#define OC_OPEN_ALL         0x20ff  
/* condition mask */
#define OC_INFO             0x3000  
#endif

#define NO_PHASE    0x0000      
/* three phase configurations */
#define PHASE_A     0x0001      
#define PHASE_B     0x0002      
#define PHASE_C     0x0004      
#define PHASE_ABC   0x0007      
#define PHASE_N     0x0008      
#define PHASE_ABCN  0x000f      
/* split phase configurations */
#define PHASE_S1    0x0010      
#define PHASE_S2    0x0020      
#define PHASE_SN    0x0040      
#define PHASE_S     0x0070      
#define GROUND      0x0080      
/* delta configuration */
#define PHASE_D     0x0100      
/* phase info mask */
#define PHASE_INFO  0x01ff      
#define PS_NORMAL   0x00        
#ifdef SUPPORT_OUTAGES
#define PS_OUTAGE   0x01        
#endif
/* Note: Only define solution modes that are known to ALL objects.
   Add object specific modes to the appropriate objects 
   */

class powerflow_object
{
public:
    set phases;             
    double nominal_voltage; 
#ifdef SUPPORT_OUTAGES
    set condition;          
    enumeration solution;   
#endif
public:
    static CLASS *oclass; 
    static CLASS *pclass;
#ifdef SUPPORT_OUTAGES
    /* is_normal checks whether the current operating condition is normal */
    inline bool is_normal(void) const { return condition==OC_NORMAL;};
    
    /* is_open checks whether particulars phases are open (no connection when there should be one) */
    inline bool is_open(set ph=PHASE_INFO) const { return (condition&OC_OPEN)!=0 && (condition&ph)==ph;};

    /* is_open_any checks whether any phase is open (no connection when there should be one) */
    inline bool is_open_any(set ph=PHASE_INFO) const { return (condition&OC_OPEN)!=0 && (condition&ph)!=0;};

    /* is_contact_any checks whether particulars phases are contacting another */
    inline bool is_contact(set ph=PHASE_INFO) const { return (condition&OC_CONTACT)!=0 && (condition&ph)==ph;};
    
    /* is_contact_any checks whether any phase is contacting another */
    inline bool is_contact_any(set ph=PHASE_INFO) const { return (condition&OC_CONTACT)!=0 && (condition&ph)!=0;};
#endif
    /* get_name acquires the name of an object or 'unnamed' if non set */
    inline const char *get_name(void) const { static char tmp[64]; OBJECT *obj=OBJECTHDR(this); return obj->name?obj->name:(sprintf(tmp,"%s:%d",obj->oclass->name,obj->id)>0?tmp:"(unknown)");};
    
    /* get_id acquires the object's id */
    inline unsigned int get_id(void) const {return OBJECTHDR(this)->id;};
    
    /* has_phase checks whether a particular phase is configured */
    inline bool has_phase(set ph, set flags=0) const { return ((flags?flags:phases)& ph)==ph; };
    
    /* phase_index returns the array index of a phase if configured (use flags to test another variable) */
    inline unsigned int phase_index(set ph=0) const { return ((unsigned int)((ph?ph:phases)&PHASE_ABC)>>2)%3;};
    
    /* get_phases acquires the phase part of the flags given */
    inline set get_phases(set flags) const { return flags&PHASE_INFO;};

    inline OBJECT* objecthdr() const { return OBJECTHDR(this);}
public:
    int create(void);
    int init(OBJECT *parent);
    TIMESTAMP presync(TIMESTAMP t0);
    TIMESTAMP sync(TIMESTAMP t0);
    TIMESTAMP postsync(TIMESTAMP t0);
    powerflow_object(MODULE *mod);
    powerflow_object(CLASS *cl=oclass);
    int isa(char *classname);

    int kmldump(FILE *fp);
};

#endif // _POWERFLOWOBJECT_H

---

GridLAB-D^TM Version 2.0

An open-source project initiated by the US Department of Energy