archetypal.template.ZoneLoad

class archetypal.template.ZoneLoad(Name, EquipmentPowerDensity=0, EquipmentAvailabilitySchedule=None, LightingPowerDensity=0, LightsAvailabilitySchedule=None, PeopleDensity=0, OccupancySchedule=None, IsEquipmentOn=True, IsLightingOn=True, IsPeopleOn=True, DimmingType=DimmingTypes.Continuous, IlluminanceTarget=500, area=1, volume=1, **kwargs)

Zone Loads.

Important

Please note that the calculation of the equipment power density will sum up the electric equipment objects as well as the gas equipment objects.

Initialize a new ZoneLoad object.

Parameters

• DimmingType (int) –

  Different types to dim the lighting to respect the IlluminanceTarget and taking into account the daylight illuminance:

  • Continuous = 0, the overhead lights dim continuously and linearly from (maximum electric power, maximum light output) to ( minimum electric power, minimum light output) as the daylight illuminance increases. The lights stay on at the minimum point with further increase in the daylight illuminance.

  • Off = 1, Lights switch off completely when the minimum dimming point is reached.

  • Stepped = 2, the electric power input and light output vary in discrete, equally spaced steps.

• EquipmentAvailabilitySchedule (UmiSchedule) – The name of the schedule (Day | Week | Year) that modifies the design level parameter for electric equipment.

• EquipmentPowerDensity (float) – Equipment Power Density in the zone (W/m²).

• IlluminanceTarget (float) – Number of lux to be respected in the zone

• LightingPowerDensity (float) – Lighting Power Density in the zone (W/m²).

• LightsAvailabilitySchedule (UmiSchedule) – The name of the schedule (Day | Week | Year) that modifies the design level parameter for lighting.

• OccupancySchedule (UmiSchedule) – The name of the schedule (Day | Week | Year) that modifies the number of people parameter for electric equipment.

• IsEquipmentOn (bool) – If True, heat gains from Equipment are taken into account for the zone’s load calculation.

• IsLightingOn (bool) – If True, heat gains from Lights are taken into account for the zone’s load calculation.

• IsPeopleOn (bool) – If True, heat gains from People are taken into account for the zone’s load calculation.

• PeopleDensity (float) – Density of people in the zone (people/m²).

• area (float) – The floor area assiciated to this zone load object.

• **kwargs – Other keywords passed to the parent constructor UmiBase.

property DimmingType

Get or set the dimming type.

Hint

To set the value an int or a string is supported. Choices are (<DimmingTypes.Continuous: 0>, <DimmingTypes.Off: 1>, <DimmingTypes.Stepped: 2>)

property EquipmentAvailabilitySchedule

Get or set the equipment availability schedule.

property EquipmentPowerDensity

Get or set the equipment power density [W/m²].

property IlluminanceTarget

Get or set the illuminance target [lux].

property LightingPowerDensity

Get or set the lighting power density [W/m²].

property LightsAvailabilitySchedule: archetypal.template.schedule.UmiSchedule

Get or set the lights availability schedule.

property OccupancySchedule: archetypal.template.schedule.UmiSchedule

Get or set the occupancy schedule.

property Category

Get or set the Category attribute.

property Comments

Get or set the object comments.

property DataSource

Get or set the datasource of the object.

property Name

Get or set the name of the object.

property allow_duplicates

Get or set the use of duplicates [bool].

duplicate()

Get copy of self.

extend(other, allow_duplicates)

Append other to self. Modify and return self.

Parameters

other (UmiBase) –

Returns

self

Return type

UmiBase

float_mean(other, attr, weights=None)

Calculates the average attribute value of two floats. Can provide weights.

Parameters

• other (UmiBase) – The other UmiBase object to calculate average value with.

• attr (str) – The attribute of the UmiBase object.

• weights (iterable, optional) – Weights of [self, other] to calculate weighted average.

get_unique()

Return first object matching equality in the list of instantiated objects.

property id

Get or set the id.

property predecessors

Get or set the predecessors of self.

Of which objects is self made of. If from nothing else then self, return self.

rename(name)

renames self as well as the cached object

Parameters

name (str) – the name.

to_ref()

Return a ref pointer to self.

property PeopleDensity

Get or set the people density [ppl/m²].

property IsEquipmentOn

Get or set the use of equipment [bool].

property IsLightingOn

Get or set the use of lighting [bool].

property IsPeopleOn

Get or set people [bool].

property area

Get or set the floor area of the zone associated to this zone load [m²].

property volume

Get or set the volume of the zone associated to this zone load [m³].

classmethod from_dict(data, schedules, **kwargs)

Create a ZoneLoad from a dictionary.

Parameters

• data (dict) – A python dictionary with the structure shown bellow.

• schedules (dict) – A python dictionary of UmiSchedules with their id as keys.

• **kwargs – keywords passed to parent constructors.

{
  "$id": "172",
  "DimmingType": 1,
  "EquipmentAvailabilitySchedule": {
    "$ref": "147"
  },
  "EquipmentPowerDensity": 8.0,
  "IlluminanceTarget": 500.0,
  "LightingPowerDensity": 12.0,
  "LightsAvailabilitySchedule": {
    "$ref": "146"
  },
  "OccupancySchedule": {
    "$ref": "145"
  },
  "IsEquipmentOn": true,
  "IsLightingOn": true,
  "IsPeopleOn": true,
  "PeopleDensity": 0.055,
  "Category": "Office Spaces",
  "Comments": null,
  "DataSource": "MIT_SDL",
  "Name": "B_Off_0 loads"
},

combine(other, weights=None)

Combine two ZoneLoad objects together. Returns a new object.

Parameters

• other (ZoneLoad) – The other ZoneLoad object.

• weights (list-like, optional) – A list-like object of len 2. If None, the settings.zone_weight of the objects is used.

Returns

the combined ZoneLoad object.

Return type

(ZoneLoad)

validate()

Validate object and fill in missing values.

mapping(validate=True)

Get a dict based on the object properties, useful for dict repr.

Parameters

validate (bool) – If True, try to validate object before returning the mapping.

to_dict()

Return ZoneLoad dictionary representation.

to_epbunch(idf, zone_name)

Convert the zone load to epbunch given an idf model and a zone name.

Parameters

• idf (IDF) – The idf model. epbunches will be added to this model.

• zone_name (str) – The name of the zone in the idf model.

People,
    People Perim,             !- Name
    Perim,                    !- Zone or ZoneList Name
    B_Off_Y_Occ,              !- Number of People Schedule Name
    People/Area,              !- Number of People Calculation Method
    ,                         !- Number of People
    0.055,                    !- People per Zone Floor Area
    ,                         !- Zone Floor Area per Person
    0.3,                      !- Fraction Radiant
    AUTOCALCULATE,            !- Sensible Heat Fraction
    PerimPeopleActivity,      !- Activity Level Schedule Name
    3.82e-08,                 !- Carbon Dioxide Generation Rate
    No,                       !- Enable ASHRAE 55 Comfort Warnings
    ZoneAveraged,             !- Mean Radiant Temperature Calculation Type
    ,                         !- Surface NameAngle Factor List Name
    PerimWorkEfficiency,      !- Work Efficiency Schedule Name
    DynamicClothingModelASHRAE55,    !- Clothing Insulation Calculation Method
    ,                         !- Clothing Insulation Calculation Method Schedule Name
    ,                         !- Clothing Insulation Schedule Name
    PerimAirVelocity,         !- Air Velocity Schedule Name
    AdaptiveASH55;            !- Thermal Comfort Model 1 Type

Lights,
    Perim General lighting,    !- Name
    Perim,                    !- Zone or ZoneList Name
    B_Off_Y_Lgt,              !- Schedule Name
    Watts/Area,               !- Design Level Calculation Method
    ,                         !- Lighting Level
    12,                       !- Watts per Zone Floor Area
    ,                         !- Watts per Person
    0,                        !- Return Air Fraction
    0.42,                     !- Fraction Radiant
    0.18,                     !- Fraction Visible
    1,                        !- Fraction Replaceable
    ;                         !- EndUse Subcategory

ElectricEquipment,
    Perim Equipment 1,        !- Name
    Perim,                    !- Zone or ZoneList Name
    B_Off_Y_Plg,              !- Schedule Name
    Watts/Area,               !- Design Level Calculation Method
    ,                         !- Design Level
    8,                        !- Watts per Zone Floor Area
    ,                         !- Watts per Person
    0,                        !- Fraction Latent
    0.2,                      !- Fraction Radiant
    0,                        !- Fraction Lost
    ;                         !- EndUse Subcategory

Returns

The EpBunch object added to the idf model.

Return type

EpBunch