residential/range.cpp

Go to the documentation of this file.

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

#include "house.h"
#include "range.h"

// range CLASS FUNCTIONS
CLASS* range::oclass = NULL;
range *range::defaults = NULL;

range::range(MODULE *module) 
{
    // first time init
    if (oclass==NULL)
    {
        // register the class definition
        oclass = gl_register_class(module,"range",PC_BOTTOMUP);
        if (oclass==NULL)
            GL_THROW("unable to register object class implemented by %s",__FILE__);

        // publish the class properties
        if (gl_publish_variable(oclass,
            PT_double,"installed_power[W]",PADDR(installed_power),
            PT_double,"circuit_split",PADDR(circuit_split),
            PT_double,"demand[%]",PADDR(demand),
            PT_complex,"power[kW]",PADDR(power_kw),
            PT_double,"internal_heat",PADDR(internal_heat),
            PT_complex,"meter[kWh]",PADDR(kwh_meter),
            NULL)<1) 
            GL_THROW("unable to publish properties in %s",__FILE__);

        // setup the default values
        defaults = this;
        
        // other derived properties
        power_kw =0;
        power_factor = 0.95;
        kwh_meter = 0;
        internal_heat = 0;
    }
}

range::~range()
{
}

int range::create() 
{
    // copy the defaults
    memcpy(this,defaults,sizeof(*this));

    // defult properties
    installed_power = gl_random_uniform(2500,4500); // range size [W]
    demand = gl_random_uniform(0, 1.0);
    return 1;
}

int range::init(OBJECT *parent)
{
    if (parent==NULL)
    {
        gl_error("range must have a parent house");
        return 0;
    }
    house *pHouse = OBJECTDATA(parent,house);

    // attach object to house panel
    pVoltage = (pHouse->attach(OBJECTHDR(this),20,false))->pV;

    // initial demand
    power_kw = installed_power * demand / 1000;

    return 1;
}

TIMESTAMP range::sync(TIMESTAMP t0, TIMESTAMP t1) 
{
    // get demand fraction as an average per hour since the last synch time
    // a function  prototype will be 'get_average_demand(t0, t1)' which will be used to set 'demand' 
    // by default 'demand' is 1.0, now provided by the tape
//  demand = 1.0;
        if (t0 <= 0)
        return TS_NEVER;

    power_kw.SetPolar(installed_power * demand / 1000.0, acos(power_factor), J);
    double energy = power_kw.Mag() * (gl_tohours(t1)-gl_tohours(t0));
    internal_heat = energy * BTUPHPKW;
    kwh_meter += energy;

    house *pHouse = OBJECTDATA((OBJECTHDR(this))->parent,house);
    pHouse->range_heat_energy += internal_heat;
    pHouse->power_kw += power_kw;

    return TS_NEVER; 
}

// IMPLEMENTATION OF CORE LINKAGE


EXPORT int create_range(OBJECT **obj, OBJECT *parent)
{
    *obj = gl_create_object(range::oclass,sizeof(range));
    if (*obj!=NULL)
    {
        range *my = OBJECTDATA(*obj,range);;
        gl_set_parent(*obj,parent);
        my->create();
        return 1;
    }
    return 0;
}

EXPORT int init_range(OBJECT *obj)
{
    range *my = OBJECTDATA(obj,range);
    return my->init(obj->parent);
}

EXPORT TIMESTAMP sync_range(OBJECT *obj, TIMESTAMP t0)
{
    range *my = OBJECTDATA(obj, range);
    TIMESTAMP t1 = my->sync(obj->clock, t0);
    obj->clock = t0;
    return t1;
}

---

GridLAB-D^TM Version 1.0

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