honeybee_energy.construction.dynamic module

Window Construction with any number of dynamic states.

class honeybee_energy.construction.dynamic.WindowConstructionDynamic(identifier, constructions, schedule)[source]

Bases: object

Window Construction with any number of dynamic states.

Parameters:

  • identifier – Text string for a unique Construction ID. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

  • constructions – A list of WindowConstruction objects that define the various states that the dynamic window can assume.

  • schedule – A ScheduleRuleset or ScheduleFixedInterval composed of integers that correspond to the indices of the constructions that are active at given times throughout the simulation.

Properties:

  • identifier

  • display_name

  • constructions

  • schedule

  • materials

  • layers

  • unique_materials

  • frame

  • r_value

  • u_value

  • u_factor

  • r_factor

  • is_symmetric

  • has_frame

  • has_shade

  • is_dynamic

  • inside_emissivity

  • outside_emissivity

  • solar_transmittance

  • visible_transmittance

  • shgc

  • thickness

  • glazing_count

  • gap_count

  • user_data

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this construction.

classmethod from_dict(data)[source]

Create a WindowConstructionDynamic from a dictionary.

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

Parameters:

data – A python dictionary in the following format

{
"type": 'WindowConstructionDynamic',
"identifier": 'Double Pane Electrochromic 0.4-0.12',
"display_name": 'Electrochromic Window',
"constructions": [],  # a list of WindowConstruction dictionaries
"schedule": {}  # a ScheduleRuleset or ScheduleFixedInterval dictionary
}
classmethod from_dict_abridged(data, materials, schedules)[source]

Create a WindowConstructionDynamic from an abridged dictionary.

Parameters:

  • data – An WindowConstructionDynamic dictionary with the format below.

  • materials – A dictionary with identifiers of materials as keys and Python material objects as values.

  • schedules – A dictionary with schedule identifiers as keys and honeybee schedule objects as values.

{
"type": 'WindowConstructionDynamicAbridged',
"identifier": 'Double Pane Electrochromic 0.4-0.12',
"display_name": 'Electrochromic Window',
"constructions": [],  # a list of WindowConstructionAbridged dictionaries
"schedule": 'DayNight_Schedule'  # a schedule identifier
}
static idf_program_manager(constructions)[source]

Get an IDF string representation of the EMS program calling manager.

Parameters:

constructions – A list of WindowConstructionDynamic objects to be written into a program manager.

lock()[source]

The lock() method will also lock the constructions.

to_dict(abridged=False)[source]

Window construction dictionary representation.

Parameters:

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True), which only specifies the identifiers of material layers and schedules. (Default: False).

to_idf()[source]

Get an IDF string representation of this construction object.

Note that writing this string is not enough to add everything needed for the construction to the IDF. The construction’s materials also have to be added as well as the schedule. The to_program_idf method must also be called in order to add the EMS program that controls the constructions.

Returns:

Text string that includes the following EnergyPlus objects.

  • Construction definitions for each state

  • The EMS Construction Index Variable object for each state

  • The EMS Sensor linked to the schedule

Construction,
    TCwindow_25,   !- Name
    Clear3PPG,     !- Outside Layer
    AIR 3MM,       !- Layer 2
    WO18RT25,      !- Layer 3
    AIR 8MM,       !- Layer 4
    SB60Clear3PPG; !- Layer 5

    EnergyManagementSystem:ConstructionIndexVariable,
    TCwindow_25_obj,
    TCwindow_25;
to_program_idf(aperture_identifiers)[source]

Get an IDF string representation of the EMS program.

Parameters:

aperture_identifiers – A list of Aperture identifiers to which this construction is assigned.

Returns:

Text string that includes the following EnergyPlus objects.

  • The EMS Actuators linked to the apertures

  • The EMS Program definition

to_radiance_solar()[source]

Honeybee Radiance material for the first construction.

to_radiance_visible()[source]

Honeybee Radiance material for the first construction.

unlock()[source]

The unlock() method will also unlock the constructions.

property constructions

Get or set a list of WindowConstructions that define the dynamic states.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property frame

Get a window frame for the frame material surrounding the construction.

property gap_count

The number of gas gaps contained within the first construction.

property glazing_count

The number of glazing materials contained within the first construction.

property has_frame

Get a boolean noting whether the construction has a frame assigned to it.

property has_shade

Get a boolean noting whether dynamic shade materials are in the construction.

property identifier

Get or set the text string for construction identifier.

property inside_emissivity

“The emissivity of the inside face of the first construction.

property inside_material

The the inside material layer of the first construction.

Useful for checking that an asymmetric construction is correctly assigned.

property is_dynamic

Get a boolean noting whether the construction is dynamic.

This will always be True for this class.

property is_symmetric

Get a boolean for whether all of the construction layers are symmetric.

Symmetric means that the materials in reversed order are equal to those in the current order (eg. ‘Glass’, ‘Air Gap’, ‘Glass’). This is particularly helpful for interior constructions, which need to have matching materials in reversed order between adjacent Faces.

property layers

Get a list of material identifiers for the constituent constructions.

Materials will be listed from outside to inside and will move from the first construction to the last.

property materials

Get a list of materials for the constituent constructions.

Materials will be listed from outside to inside and will move from the first construction to the last.

property outside_emissivity

“The emissivity of the outside face of the first construction.

property outside_material

The the outside material layer of the first construction.

Useful for checking that an asymmetric construction is correctly assigned.

property r_factor

First window construction R-factor [m2-K/W] (with standard air films).

Formulas for film coefficients come from EN673 / ISO10292.

property r_value

R-value of the first window construction [m2-K/W] (excluding air films).

property schedule

Get or set a control schedule for the constructions active at given time.

The values of the schedule should be integers and range from 0 to one less then the number of constructions. Zero indicates that the first construction is active, one indicates that the second on is active, etc. The schedule type limits of this schedule should be “Discrete” and the unit type should be “Mode,” “Control,” or some other fractional unit.

property shgc

The solar heat gain coefficient (SHGC) of the first window construction.

property solar_transmittance

The solar transmittance of the first window construction at normal incidence.

property thickness

Thickness of the first construction [m].

property u_factor

First window construction U-factor [W/m2-K] (with standard air films).

Formulas for film coefficients come from EN673 / ISO10292.

property u_value

U-value of the first window construction [W/m2-K] (excluding air films).

property unique_materials

A list of only unique material objects in the construction.

This will include the materials across all dynamic states of the construction.

property user_data

Get or set an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

property visible_transmittance

Visible transmittance of the first window construction at normal incidence.