powerflow/pqload.cpp

Go to the documentation of this file.

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <math.h>

#include "node.h"
#include "meter.h"
#include "pqload.h"

SCHED_LIST *new_slist(){
    SCHED_LIST *l = (SCHED_LIST *)malloc(sizeof(SCHED_LIST));
    memset(l, 0, sizeof(SCHED_LIST));
    return l;
}

int delete_slist(SCHED_LIST *l){
    int rv = 0;
    if(l == NULL){
        return -1; /* error */
    }
    if(l->next != NULL){
        rv = delete_slist(l->next); /* shouldn't be non-negative but check anyway */
    }
    free(l);
    return rv;
}

CLASS *pqload::oclass = NULL;
CLASS *pqload::pclass = NULL;
pqload *pqload::defaults = NULL;
double pqload::zero_F = -459.67; /* absolute zero, give or take */

pqload::pqload(MODULE *mod) : load(mod)
{
    if(oclass == NULL){
        pclass = load::oclass;

        oclass = gl_register_class(mod, "pqload", sizeof(pqload), PC_PRETOPDOWN | PC_BOTTOMUP | PC_POSTTOPDOWN | PC_UNSAFE_OVERRIDE_OMIT);
        if(oclass == NULL)
            GL_THROW("unable to register object class implemented by %s",__FILE__);

        if(gl_publish_variable(oclass,
            PT_INHERIT, "load",
            PT_object, "weather", PADDR(weather),
            PT_double, "T_nominal[degF]", PADDR(temp_nom),
            PT_double, "Zp_T[ohm/degF]", PADDR(imped_p[0]),
            PT_double, "Zp_H[ohm/%]", PADDR(imped_p[1]),
            PT_double, "Zp_S[ohm.h/Btu]", PADDR(imped_p[2]),
            PT_double, "Zp_W[ohm/mph]", PADDR(imped_p[3]),
            PT_double, "Zp_R[ohm.h/in]", PADDR(imped_p[4]),
            PT_double, "Zp[ohm]", PADDR(imped_p[5]),
            PT_double, "Zq_T[F/degF]", PADDR(imped_q[0]),
            PT_double, "Zq_H[F/%]", PADDR(imped_q[1]),
            PT_double, "Zq_S[F.h/Btu]", PADDR(imped_q[2]),
            PT_double, "Zq_W[F/mph]", PADDR(imped_q[3]),
            PT_double, "Zq_R[F.h/in]", PADDR(imped_q[4]),
            PT_double, "Zq[F]", PADDR(imped_q[5]),
            PT_double, "Im_T[A/degF]", PADDR(current_m[0]),
            PT_double, "Im_H[A/%]", PADDR(current_m[1]),
            PT_double, "Im_S[A.h/Btu]", PADDR(current_m[2]),
            PT_double, "Im_W[A/mph]", PADDR(current_m[3]),
            PT_double, "Im_R[A.h/in]", PADDR(current_m[4]),
            PT_double, "Im[A]", PADDR(current_m[5]),
            PT_double, "Ia_T[deg/degF]", PADDR(current_a[0]),
            PT_double, "Ia_H[deg/%]", PADDR(current_a[1]),
            PT_double, "Ia_S[deg.h/Btu]", PADDR(current_a[2]),
            PT_double, "Ia_W[deg/mph]", PADDR(current_a[3]),
            PT_double, "Ia_R[deg.h/in]", PADDR(current_a[4]),
            PT_double, "Ia[deg]", PADDR(current_a[5]),
            PT_double, "Pp_T[W/degF]", PADDR(power_p[0]),
            PT_double, "Pp_H[W/%]", PADDR(power_p[1]),
            PT_double, "Pp_S[W.h/Btu]", PADDR(power_p[2]),
            PT_double, "Pp_W[W/mph]", PADDR(power_p[3]),
            PT_double, "Pp_R[W.h/in]", PADDR(power_p[4]),
            PT_double, "Pp[W]", PADDR(power_p[5]),
            PT_double, "Pq_T[VAr/degF]", PADDR(power_q[0]),
            PT_double, "Pq_H[VAr/%]", PADDR(power_q[1]),
            PT_double, "Pq_S[VAr.h/Btu]", PADDR(power_q[2]),
            PT_double, "Pq_W[VAr/mph]", PADDR(power_q[3]),
            PT_double, "Pq_R[VAr.h/in]", PADDR(power_q[4]),
            PT_double, "Pq[VAr]", PADDR(power_q[5]),
            PT_double, "input_temp[degF]", PADDR(input[0]), PT_ACCESS, PA_REFERENCE,
            PT_double, "input_humid[%]", PADDR(input[1]), PT_ACCESS, PA_REFERENCE,
            PT_double, "input_solar[Btu/h]", PADDR(input[2]), PT_ACCESS, PA_REFERENCE,
            PT_double, "input_wind[mph]", PADDR(input[3]), PT_ACCESS, PA_REFERENCE,
            PT_double, "input_rain[in/h]", PADDR(input[4]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_imped_p[Ohm]", PADDR(output[0]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_imped_q[Ohm]", PADDR(output[1]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_current_m[A]", PADDR(output[2]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_current_a[deg]", PADDR(output[3]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_power_p[W]", PADDR(output[4]), PT_ACCESS, PA_REFERENCE,
            PT_double, "output_power_q[VAr]", PADDR(output[5]), PT_ACCESS, PA_REFERENCE,
            PT_complex, "output_impedance[ohm]", PADDR(kZ), PT_ACCESS, PA_REFERENCE,
            PT_complex, "output_current[A]", PADDR(kI), PT_ACCESS, PA_REFERENCE,
            PT_complex, "output_power[VA]", PADDR(kP), PT_ACCESS, PA_REFERENCE,
            NULL) < 1){
                GL_THROW("unable to publish properties in %s",__FILE__);
        }
    defaults = this;
    memset(this,0,sizeof(pqload));
    input[5] = 1.0; /* constant term */
    imped_p[5] = INFINITY;
    strcpy(schedule, "* * * * *:1.0;");
    temp_nom = zero_F;
    load_class = LC_UNKNOWN;
    sched_until = TS_NEVER;
    }
}

int pqload::build_sched(char *instr = NULL, SCHED_LIST *end = NULL){
    char *sc_end = 0;
    char *start = instr ? instr : schedule; /* doesn't copy but doesn't use strtok */
    int rv = 0, scanct = 0;
    SCHED_LIST *endptr = NULL;

    /* eat whitespace between schedules */
    while(*start == ' '){
        ++start;
    }

    /* check schedule string end */
    if(*start == '\n' || *start == 0){
        return 1; /* end of schedule ~ success */
    }

    /* extend list */
    if(sched == NULL){
        sched = endptr = new_slist();
    } else {
        endptr = new_slist();
    }

    /* find bounds */
    sc_end = strchr(start, ';');
    if(sc_end == NULL){
        gl_error("schedule token \"%s\" not semicolon terminated", start);
    }
    char256 moh_v, moh_w, hod_v, hod_w, dom_v, dom_w, moy_v, moy_w, dow_v, lpu, sc;
    scanct = sscanf(start, "%[-0-9*]%[ \t]%[-0-9*]%[ \t]%[-0-9*]%[ \t]%[-0-9*]%[ \t]%[-0-9*]:%[0-9\\.]%[;]",
        moh_v, moh_w, hod_v, hod_w, dom_v, dom_w, moy_v, moy_w, dow_v, lpu, sc);

    /* parse the individual fields */

    rv = build_sched(sc_end + 1, endptr);
    if(rv > 0)
        return rv + 1;
    else
        return rv - 1; /* error depth */
}

int pqload::create(void)
{
    int res = 0;
    
    memcpy(this, defaults, sizeof(pqload));

    res = node::create();

    return res;
}

int pqload::init(OBJECT *parent){
    int rv = 0;
    int w_rv = 0;

    if(weather != NULL){
        temperature = gl_get_property(weather, "temperature");
        if(temperature == NULL){
            gl_error("Unable to find temperature property in weather object!");
            ++w_rv;
        }
        
        humidity = gl_get_property(weather, "humidity");
        if(humidity == NULL){
            gl_error("Unable to find humidity property in weather object!");
            ++w_rv;
        }

        solar = gl_get_property(weather, "solar_flux");
        if(solar == NULL){
            gl_error("Unable to find solar_flux property in weather object!");
            ++w_rv;
        }

        wind = gl_get_property(weather, "wind_speed");
        if(wind == NULL){
            gl_error("Unable to find wind_speed property in weather object!");
            ++w_rv;
        }

        rain = gl_get_property(weather, "rainfall"); /* not yet implemented in climate */
        if(rain == NULL){
            gl_error("Unable to find rainfall property in weather object!");
            //++w_rv;
        }
    }

    rv = load::init(parent);

    return w_rv ? 0 : rv;
}

TIMESTAMP pqload::presync(TIMESTAMP t0)
{
    TIMESTAMP result = 0;

    //Must be at the bottom, or the new values will be calculated after the fact
    result = load::presync(t0);

    return result;
}

TIMESTAMP pqload::sync(TIMESTAMP t0)
{
    TIMESTAMP result = TS_NEVER;
    double SysFreq = 376.991118431;     //System frequency in radians/sec, nominalized 60 Hz for now.

    int i = 0;

    /* must take place in sync in order to let the climate update itself */
    if(weather != NULL){
        if(temperature != NULL){
            input[0] = *gl_get_double(weather, temperature);
        } else {
            input[0] = 0.0;
        }
        if(humidity != NULL){
            input[1] = *gl_get_double(weather, humidity);
        } else {
            input[1] = 0.0;
        }
        if(solar != NULL){
            input[2] = *gl_get_double(weather, solar);
        } else {
            input[2] = 0.0;
        }
        if(wind != NULL){
            input[3] = *gl_get_double(weather, wind);
        } else {
            input[3] = 0.0;
        }
        if(rain != NULL){
            input[4] = *gl_get_double(weather, rain);
        } else {
            input[4] = 0.0;
        }
    } else {
        input[0] = input[1] = input[2] = input[3] = input[4] = 0.0;
    }
    input[5] = 1.0;

    output[0] = output[1] = output[2] = output[3] = output[4] = output[5] = 0.0;
    for(i = 0; i < 6; ++i){
        output[0] += imped_p[i] * input[i];
        output[1] -= (imped_q[i]!=0.0) ? input[i] / (SysFreq*imped_q[i]) : 0;   //XC = 1/(jwc)
        output[2] += current_m[i] * input[i];
        output[3] += current_a[i] * input[i];
        output[4] += power_p[i] * input[i];
        output[5] += power_q[i] * input[i];
    }

    kZ.SetRect(output[0], output[1]);
    kI.SetPolar(output[2], output[3] * PI/180.0);
    kP.SetRect(output[4], output[5]);

    /* ---scale by schedule here--- */

    constant_power[0] = constant_power[1] = constant_power[2] = kP;
    constant_current[0] = constant_current[1] = constant_current[2] = kI;
    constant_impedance[0] = constant_impedance[1] = constant_impedance[2] = kZ;

    //Must be at the bottom, or the new values will be calculated after the fact
    result = load::sync(t0);
    
    return result;
}

int pqload::isa(char *classname)
{
    return strcmp(classname,"pqload")==0 || load::isa(classname);
}

// IMPLEMENTATION OF CORE LINKAGE: pqload

EXPORT int create_pqload(OBJECT **obj, OBJECT *parent)
{
    try
    {
        *obj = gl_create_object(pqload::oclass);
        if (*obj!=NULL)
        {
            pqload *my = OBJECTDATA(*obj,pqload);
            gl_set_parent(*obj,parent);
            return my->create();
        }
    }
    catch (const char *msg)
    {
        gl_error("create_pqload: %s", msg);
    }
    return 0;
}

EXPORT int init_pqload(OBJECT *obj)
{
    int result = 1;
    try {
        result = ((pqload*) (obj + 1))->init(obj->parent);
    } catch (const char *error) {
        GL_THROW("%s:%d: %s", obj->oclass->name, obj->id, error);
        return 0;
    } catch (...) {
        GL_THROW("%s:%d: %s", obj->oclass->name, obj->id, "unknown exception");
        return 0;
    }
    return result;
}

EXPORT TIMESTAMP sync_pqload(OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass)
{
    try {
        pqload *pObj = OBJECTDATA(obj,pqload);
        TIMESTAMP t1 = TS_NEVER;
        switch (pass) {
        case PC_PRETOPDOWN:
            return pObj->presync(t0);
        case PC_BOTTOMUP:
            return pObj->sync(t0);
        case PC_POSTTOPDOWN:
            t1 = pObj->postsync(t0);
            obj->clock = t0;
            return t1;
        default:
            throw "invalid pass request";
        }
    } catch (const char *error) {
        GL_THROW("%s (pqload:%d): %s", obj->name, obj->oclass->name, obj->id, error);
        return 0;
    } catch (...) {
        GL_THROW("%s (pqload:%d): %s", obj->name, obj->oclass->name, obj->id, "unknown exception");
        return 0;
    }
}

EXPORT int isa_pqload(OBJECT *obj, char *classname)
{
    return OBJECTDATA(obj,pqload)->isa(classname);
}

---

GridLAB-D^TM Version 2.0

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