residential/residential_enduse.cpp

Go to the documentation of this file.

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <math.h>
#include "residential.h"
#include "residential_enduse.h"

// CLASS FUNCTIONS
CLASS* residential_enduse::oclass = NULL;

// the constructor registers the class and properties and sets the defaults
residential_enduse::residential_enduse(MODULE *mod) 
{
    // first time init
    if (oclass==NULL)
    {
        // register the class definition
        oclass = gl_register_class(mod,"residential_enduse",sizeof(residential_enduse),PC_BOTTOMUP);
        if (oclass==NULL)
            GL_THROW("unable to register object class implemented by %s",__FILE__);
            /* TROUBLESHOOT
                The registration for the residential_enduse class failed.   This is usually caused
                by a coding error in the core implementation of classes or the module implementation.
                Please report this error to the developers.
             */

        // publish the class properties
        if (gl_publish_variable(oclass,
            PT_loadshape,"shape",PADDR(shape),
            PT_enduse,"",PADDR(load),
            PT_enumeration,"override",PADDR(override),
                PT_KEYWORD,"ON",OV_ON,
                PT_KEYWORD,"NORMAL",OV_NORMAL,
                PT_KEYWORD,"OFF",OV_OFF,
            PT_enumeration, "power_state", PADDR(power_state),
                PT_KEYWORD, "UNKNOWN", PS_UNKNOWN,
                PT_KEYWORD, "OFF", PS_OFF,
                PT_KEYWORD, "ON", PS_ON,
            NULL)<1) GL_THROW("unable to publish properties in %s",__FILE__);
            /* TROUBLESHOOT
                The registration for the residential_enduse properties failed.   This is usually caused
                by a coding error in the core implementation of classes or the module implementation.
                Please report this error to the developers.
             */
    }
}

// create is called every time a new object is loaded
int residential_enduse::create(bool connect_shape) 
{
    // attach loadshape 
    load.end_obj = OBJECTHDR(this);
    if (connect_shape) load.shape = &shape;
    load.breaker_amps = 20;
    load.config = 0;
    load.heatgain_fraction = 1.0; /* power has no effect on heat loss */
    override = OV_NORMAL;
    power_state = PS_UNKNOWN;
    return 1;
}

int residential_enduse::init(OBJECT *parent)
{
    OBJECT *hdr = OBJECTHDR(this);
    hdr->flags |= OF_SKIPSAFE;
    ATTACHFUNCTION attach = 0;

    //  pull parent attach_enduse and attach the enduseload
    if(parent)
        attach = (ATTACHFUNCTION)(gl_get_function(parent, "attach_enduse"));
    if(parent && attach)
        pCircuit = (*attach)(parent, &load, load.breaker_amps, (load.config&EUC_IS220)!=0);
    else if (parent)
        gl_warning("%s (%s:%d) parent %s (%s:%d) does not export attach_enduse function so voltage response cannot be modeled", hdr->name?hdr->name:"(unnamed)", hdr->oclass->name, hdr->id, parent->name?parent->name:"(unnamed)", parent->oclass->name, parent->id);
        /* TROUBLESHOOT
            Enduses must have a voltage source from a parent object that exports an attach_enduse function.  
            The residential_enduse object references a parent object that does not conform with this requirement.
            Fix the parent reference and try again.
         */

    if (load.shape!=NULL) {
        if (load.shape->schedule==NULL)
        {
            gl_verbose("%s (%s:%d) schedule is not specified so the load may be inactive", hdr->name?hdr->name:"(unnamed)", hdr->oclass->name, hdr->id);
            /* TROUBLESHOOT
                The residential_enduse object requires a schedule that defines how
                the load behaves.  Omitting this schedule effectively shuts the enduse
                load off and this is not typically intended.
             */
        }
    }

    return 1;
}

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

TIMESTAMP residential_enduse::sync(TIMESTAMP t0, TIMESTAMP t1) 
{
    OBJECT *obj = OBJECTHDR(this);
    gl_debug("%s shape load = %8g", obj->name, gl_get_loadshape_value(&shape));
    if (load.voltage_factor>1.2 || load.voltage_factor<0.8)
        gl_verbose("%s voltage is out of normal +/- 20%% range of nominal (vf=%.2f)", obj->name, load.voltage_factor);
        /* TROUBLESHOOTING
           The voltage on the enduse circuit is outside the expected range for that enduse.
           This is usually caused by an impropely configure circuit (e.g., 110V on 220V or vice versa).
           Fix the circuit configuration for that enduse and try again.
         */
    return shape.t2>t1 ? shape.t2 : TS_NEVER; 
}

// IMPLEMENTATION OF CORE LINKAGE

EXPORT int create_residential_enduse(OBJECT **obj, OBJECT *parent)
{
    *obj = gl_create_object(residential_enduse::oclass);
    if (*obj!=NULL)
    {
        residential_enduse *my = OBJECTDATA(*obj,residential_enduse);
        gl_set_parent(*obj,parent);
        try {
            my->create();
        }
        catch (char *msg)
        {
            gl_error("%s::%s.create(OBJECT **obj={name='%s', id=%d},...): %s", (*obj)->oclass->module->name, (*obj)->oclass->name, (*obj)->name, (*obj)->id, msg);
            return 0;
        }
        return 1;
    }
    return 0;
}

EXPORT int init_residential_enduse(OBJECT *obj)
{
    residential_enduse *my = OBJECTDATA(obj,residential_enduse);
    try {
        return my->init(obj->parent);
    }
    catch (char *msg)
    {
        gl_error("%s::%s.init(OBJECT *obj={name='%s', id=%d}): %s", obj->oclass->module->name, obj->oclass->name, obj->name, obj->id, msg);
        return 0;
    }
}

EXPORT int isa_residential_enduse(OBJECT *obj, char *classname)
{
    if(obj != 0 && classname != 0){
        return OBJECTDATA(obj,residential_enduse)->isa(classname);
    } else {
        return 0;
    }
}

EXPORT TIMESTAMP sync_residential_enduse(OBJECT *obj, TIMESTAMP t1)
{
    residential_enduse *my = OBJECTDATA(obj,residential_enduse);
    try {
        TIMESTAMP t2 = my->sync(obj->clock, t1);
        obj->clock = t1;
        return t2;
    }
    catch (char *msg)
    {
        DATETIME dt;
        char ts[64];
        gl_localtime(t1,&dt);
        gl_strtime(&dt,ts,sizeof(ts));
        gl_error("%s::%s.init(OBJECT **obj={name='%s', id=%d},TIMESTAMP t1='%s'): %s", obj->oclass->module->name, obj->oclass->name, obj->name, obj->id, ts, msg);
        return 0;
    }
}

---

GridLAB-D^TM Version 2.0

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