dragonfly_energy.properties.room2d module

Room2D Energy Properties.

class dragonfly_energy.properties.room2d.Room2DEnergyProperties(host, program_type=None, construction_set=None, hvac=None, shw=None)[source]

Bases: object

Energy Properties for Dragonfly Room2D.

Parameters

  • host – A dragonfly_core Room2D object that hosts these properties.

  • program_type – A honeybee ProgramType object to specify all default schedules and loads for the Room2D. If None, the Room2D will have a Plenum program (with no loads or setpoints). Default: None.

  • construction_set – A honeybee ConstructionSet object to specify all default constructions for the Faces of the Room2D. If None, the Room2D will use the honeybee default construction set, which is not representative of a particular building code or climate zone. Default: None.

  • hvac – A honeybee HVAC object (such as an IdealAirSystem) that specifies how the Room2D is conditioned. If None, it will be assumed that the Room2D is not conditioned. Default: None.

Properties:

  • host

  • program_type

  • construction_set

  • hvac

  • shw

  • window_vent_control

  • window_vent_opening

  • process_loads

  • total_process_load

  • is_conditioned

  • has_window_opening

ToString()[source]
add_default_ideal_air()[source]

Add a default IdealAirSystem to this Room2D.

The identifier of this system will be derived from the room identifier and will align with the naming convention that EnergyPlus uses for templates Ideal Air systems.

add_process_load(process_load)[source]

Add a Process load to this Room2D.

Parameters

process_load – A Process load to add to this Room.

apply_properties_from_dict(abridged_data, construction_sets, program_types, hvacs, shws, schedules)[source]

Apply properties from a Room2DEnergyPropertiesAbridged dictionary.

Parameters

  • abridged_data – A Room2DEnergyPropertiesAbridged dictionary (typically coming from a Model).

  • construction_sets – A dictionary of ConstructionSets with identifiers of the sets as keys, which will be used to re-assign construction_sets.

  • program_types – A dictionary of ProgramTypes with identifiers of the types ask keys, which will be used to re-assign program_types.

  • hvacs – A dictionary of HVACSystems with the identifiers of the systems as keys, which will be used to re-assign hvac to the Room.

  • shws – A dictionary of SHWSystems with the identifiers of the systems as keys, which will be used to re-assign shw to the Room.

  • schedules – A dictionary of Schedules with identifiers of the schedules as keys, which will be used to re-assign schedules.

duplicate(new_host=None)[source]

Get a copy of this object.

Parameters

new_host – A new Room2D object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]

Create Room2DEnergyProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

  • data – A dictionary representation of Room2DEnergyProperties in the format below.

  • host – A Room2D object that hosts these properties.

{
"type": 'Room2DEnergyProperties',
"construction_set": {},  # A ConstructionSet dictionary
"program_type": {},  # A ProgramType dictionary
"hvac": {}, # A HVACSystem dictionary
"shw": {}, # A SHWSystem dictionary
"daylighting_control": {},  # A DaylightingControl dictionary
"window_vent_control": {}  # A VentilationControl dictionary
"process_loads": []  # An array of Process dictionaries
}
from_honeybee(hb_properties)[source]

Transfer energy attributes from a Honeybee Room to Dragonfly Room2D.

Parameters

hb_properties – The RoomEnergyProperties of the honeybee Room that is being translated to a Dragonfly Room2D.

remove_process_loads()[source]

Remove all Process loads from the Room.

to_dict(abridged=False)[source]

Return Room2D energy properties as a dictionary.

Parameters

abridged – Boolean for whether the full dictionary of the Room2D should be written (False) or just the identifier of the the individual properties (True). Default: False.

to_honeybee(new_host)[source]

Get a honeybee version of this object.

Parameters

new_host – A honeybee-core Room object that will host these properties.

property construction_set

Get or set the Room2D ConstructionSet object.

If not set, it will be set by the parent Story or will be the Honeybee default generic ConstructionSet.

property has_window_opening

Boolean to note whether the Room has operable windows with controls.

property host

Get the Room2D object hosting these properties.

property hvac

Get or set the HVAC object for the Room2D.

If None, it will be assumed that the Room2D is not conditioned.

property is_conditioned

Boolean to note whether the Room is conditioned.

property process_loads

Get or set an array of Process objects for process loads within the Room2D.

property program_type

Get or set the ProgramType object for the Room2D.

If not set, it will default to a plenum ProgramType (with no loads assigned).

property shw

Get or set the SHWSystem object for the Room2D.

If None, all hot water loads will be met with a system that doesn’t compute fuel or electricity usage.

property total_process_load

Get a number for the total process load in W within the room.

property window_vent_control

Get or set a VentilationControl object to dictate the opening of windows.

If None or no window_vent_opening object is assigned to this Room2D, the windows will never open.

property window_vent_opening

Get or set a VentilationOpening object for the operability of all windows.

If None or no window_vent_control object is assigned to this Room2D, the windows will never open.