uwg.BEMDef module¶

Building Energy Model (BEM) class definition.

class uwg.BEMDef.BEMDef(building, mass, wall, roof, bldtype, builtera)[source]¶

Bases: object

Building Energy Model (BEM) definition.

Parameters:

building – Building object.
mass – Element object representing building internal mass.
wall – Element object representing building wall.
roof – Element object representing building roof.
bldtype – Text referring to a building type. By default, 16 building types are defined in the UWG according to models from the Department of Energy (DOE). Custom building types can also be defined with a new name. Note that this value along with the BEMDef builtera must exactly match the identifiers in the UWG bld list in order to specify the fraction of total built stock the building occupies in the UWG simulation. Choose from the following to reference or overwrite a BEM associated with a DOE reference building type: ‘fullservicerestaurant’, ‘hospital’, ‘largehotel’, ‘largeoffice’, ‘mediumoffice’, ‘midriseapartment’, ‘outpatient’, ‘primaryschool’, ‘quickservicerestaurant’, ‘secondaryschool’, ‘smallhotel’, ‘smalloffice’, ‘standaloneretail’, ‘stripmall’, ‘supermarket’, or ‘warehouse’.
builtera – Text defining building built era. Must be one of the following: “pre80” (pre-1980s), “pst80” (post-1980s), or “new” (new construction). This value along with the bldtype must exactly match the identifiers in the bld array in order to specify the fraction of total built stock the building occupies in the UWG simulation.

Properties:

building – Building object
mass – Element object representing building internal mass.
wall – Element object representing building wall.
roof – Element object representing building roof.
frac – fraction of the urban floor space of this building typology.
bldtype – number for building type
builtera – number for built era
fl_area – building typology urban floor area [m2]
elec – actual electricity consumption [W/m2]
gas – actual gas consumption [W/m2]
light – actual light [W/m2]
Qocc – actual heat load from occupant [W/m2]
swh – actual hot water usage
Nocc – number of occupants
ElecTotal – actual total electricity [W/m2]
T_wallex – wall surface temp (ext) [K]
T_wallin – wall surface temp (int) [K]
T_roofex – roof surface temp (ext) [K]
T_roofin – roof surface temp (int) [K]

classmethod from_dict(data)[source]¶

Create a BEMDef object from a dictionary.

Parameters:: data – A BEMDef dictionary following the format below.

to_dict()[source]¶: BEMDef dictionary representation.

property bldtype¶

Get or set text for building type.

By default, 16 building types are defined in the UWG according to models from the Department of Energy (DOE). Choose from the following to reference or overwrite a BEM associated with a DOE reference building type:

‘fullservicerestaurant’
‘hospital’
‘largehotel’
‘largeoffice’
‘medoffice’
‘midriseapartment’
‘outpatient’
‘primaryschool’
‘quickservicerestaurant’
‘secondaryschool’
‘smallhotel’
‘smalloffice’
‘standaloneretail’
‘stripmall’
‘supermarket’
‘warehouse’

Custom building types can also be defined with a new name. If a custom BEMDef is defined with the same name as a reference DOE building type from the list above, the reference BEMDef will be overwritten by the custom BEMDef. Note that this value along with the BEMDef builtera must exactly match the identifiers in the UWG bld list in order to specify the fraction of total built stock the building occupies in the UWG simulation.

property building¶: Get or set Building object.

property builtera¶

Get or set text for built era.

Must be one of the following:

‘pre80’ - pre-1980s
‘pst80’ - post-1980s
‘new’ - new construction

This value along with the bldtype must exactly match the identifiers in the bld array in order to specify the fraction of total built stock the building occupies in the UWG simulation.

property mass¶: Get or set Element as representative building internal mass.

property roof¶: Get or set Element as representative building roof.

property wall¶: Get or set Element as representative building wall.