honeybee_energy.material.shade module

Shade materials representing shades, blinds, or screens in a window construction.

They can exist in only one of three possible locations in a window construction:

  1. On the innermost material layer.

  2. On the outermost material layer.

  3. In between two glazing materials. In the case of window constructions with multiple glazing surfaces, the shade material must be between the two inner glass layers.

Note that shade materials should never be bounded by gas gap layers in honeybee-energy.

class honeybee_energy.material.shade.EnergyWindowMaterialBlind(*args, **kwargs)[source]

Bases: honeybee_energy.material.shade._EnergyWindowMaterialShadeBase

A material for a blind layer in a window construction.

Window blind properties consist of flat, equally-spaced slats.

Parameters
  • identifier – Text string for a unique Material 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.

  • slat_orientation – Text describing the orientation of the slats. Only the following two options are acceptable: “Horizontal”, “Vertical”. Default: “Horizontal”

  • slat_width – The width of slat measured from edge to edge [m]. Default: 0.025 m (25 mm).

  • slat_separation – The distance between each of the slats [m]. Default: 0.01875 m (18.75 mm).

  • slat_thickness – A number between 0 and 0.1 for the thickness of the slat [m]. Default: 0.001 m (1 mm).

  • slat_angle – A number between 0 and 180 for the angle between the slats and the glazing normal in degrees. 90 signifies slats that are perpendicular to the glass. Default: 45.

  • slat_conductivity – The thermal conductivity of the blind material [W/m-K]. Default is 221, which is characteristic of metal blinds.

  • solar_transmittance – Number between 0 and 1 for the transmittance of solar radiation through the blind material. Default: 0.

  • solar_reflectance – Number between 0 and 1 for the front reflectance of solar radiation off of the blind, averaged over the solar spectrum. Default: 0.5.

  • visible_transmittance – Number between 0 and 1 for the transmittance of visible light through the blind material. Default : 0.

  • visible_reflectance – Number between 0 and 1 for the reflectance of visible light off of the blind. Default: 0.5.

  • infrared_transmittance – Long-wave hemispherical transmittance of the blind. Default value is 0.

  • emissivity – Number between 0 and 1 for the infrared hemispherical emissivity of the blind. Default is 0.9.

  • distance_to_glass – A number between 0.001 and 1.0 for the distance from the mid-plane of the blind to the adjacent glass layers [m]. Default is 0.05 (50 mm).

  • opening_multiplier – Factor between 0 and 1 that is multiplied by the area at the top, bottom and sides of the shade for air flow calculations. Default: 0.5.

Properties:
  • identifier

  • display_name

  • slat_orientation

  • slat_width

  • slat_separation

  • slat_thickness

  • slat_angle

  • slat_conductivity

  • beam_solar_transmittance

  • beam_solar_reflectance

  • beam_solar_reflectance_back

  • diffuse_solar_transmittance

  • diffuse_solar_reflectance

  • diffuse_solar_reflectance_back

  • beam_visible_transmittance

  • beam_visible_reflectance

  • beam_visible_reflectance_back

  • diffuse_visible_transmittance

  • diffuse_visible_reflectance

  • diffuse_visible_reflectance_back

  • infrared_transmittance

  • emissivity

  • emissivity_back

  • distance_to_glass

  • top_opening_multiplier

  • bottom_opening_multiplier

  • left_opening_multiplier

  • right_opening_multiplier

  • slat_resistivity

  • u_value

  • r_value

  • user_data

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this construction.

classmethod from_dict(data)[source]

Create a EnergyWindowMaterialBlind from a dictionary.

Parameters

data – A python dictionary in the following format

{
"type": 'EnergyWindowMaterialBlind',
"identifier": 'Plastic_Blind_Horiz_0040_0030_0002_90',
"display_name": 'Plastic Blind',
"slat_orientation": 'Horizontal',
"slat_width": 0.04,
"slat_separation": 0.03,
"slat_thickness": 0.002,
"slat_angle": 90,
"slat_conductivity": 0.2
}
classmethod from_idf(idf_string)[source]

Create EnergyWindowMaterialBlind from an EnergyPlus text string.

Parameters

idf_string – A text string fully describing an EnergyPlus material.

lock()
r_value_between(delta_t=7.5, emissivity_1=0.84, emissivity_2=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is interior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity_1 – The emissivity of the glazing surface on one side of the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • emissivity_2 – The emissivity of the glazing surface on the other side of the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

r_value_exterior(delta_t=7.5, emissivity=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is exterior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity – The emissivity of the glazing surface adjacent to the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

r_value_interior(delta_t=7.5, emissivity=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is interior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity – The emissivity of the glazing surface adjacent to the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

set_all_opening_multipliers(multiplier)

Set all opening multipliers to the same value at once.

set_all_solar_reflectance(reflectance)[source]

Set all solar reflectance to the same value at once.

set_all_solar_transmittance(transmittance)[source]

Set all solar transmittance to the same value at once.

set_all_visible_reflectance(reflectance)[source]

Set all visible reflectance to the same value at once.

set_all_visible_transmittance(transmittance)[source]

Set all solar transmittance to the same value at once.

to_dict()[source]

Energy Window Material Blind dictionary representation.

to_idf()[source]

Get an EnergyPlus string representation of the material.

unlock()
ORIENTATIONS = ('Horizontal', 'Vertical')
property beam_solar_reflectance

Get or set the front beam solar reflectance of the blind.

property beam_solar_reflectance_back

Get or set the back beam solar reflectance of the blind.

property beam_solar_transmittance

Get or set the beam solar transmittance of the blind material.

property beam_visible_reflectance

Get or set the front beam visible reflectance of the blind.

property beam_visible_reflectance_back

Get or set the back beam visible reflectance of the blind.

property beam_visible_transmittance

Get or set the beam visible transmittance of the blind material.

property bottom_opening_multiplier

Get or set the bottom opening multiplier.

property diffuse_solar_reflectance

Get or set the front diffuse solar reflectance of the blind.

property diffuse_solar_reflectance_back

Get or set the back diffuse solar reflectance of the blind.

property diffuse_solar_transmittance

Get or set the diffuse solar transmittance of the blind material.

property diffuse_visible_reflectance

Get or set the front diffuse visible reflectance of the blind.

property diffuse_visible_reflectance_back

Get or set the back diffuse visible reflectance of the blind.

property diffuse_visible_transmittance

Get or set the diffuse visible transmittance of the blind material.

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 distance_to_glass

Get or set the shade distance to the glass [m].

property emissivity

Get or set the hemispherical emissivity of the shade.

property emissivity_back

Get or set the hemispherical emissivity of the back side of the glass.

property identifier

Get or set the text string for material identifier.

property infrared_transmittance

Get or set the infrared transmittance of the shade.

property is_gas_material

Boolean to note whether the material is a gas gap layer.

property is_glazing_material

Boolean to note whether the material is a glazing layer.

property is_shade_material

Boolean to note whether the material is a shade layer.

property is_window_material

Boolean to note whether the material can be used for window surfaces.

property left_opening_multiplier

Get or set the left opening multiplier.

property r_value

R-value of the blind slats [m2-K/W] (excluding air film resistance).

Note that this value assumes that blinds are completely closed (at 0 degrees).

property right_opening_multiplier

Get or set the right opening multiplier.

property slat_angle

Get or set the angle between the slats and the glazing normal.

property slat_conductivity

Get or set the conductivity of the blind material [W/m-K].

property slat_orientation

Get or set text describing the slat orientation.

Must be one of the following: [“Horizontal”, “Vertical”].

property slat_resistivity

Get or set the resistivity of the blind layer [m-K/W].

property slat_separation

Get or set the distance between each of the slats [m]

property slat_thickness

Get or set the thickness of the slat [m].

property slat_width

Get or set the width of slat measured from edge to edge [m]

property top_opening_multiplier

Get or set the top opening multiplier.

property u_value

U-value of the blind slats [W/m2-K] (excluding air film resistance).

Note that this value assumes that blinds are completely closed (at 0 degrees).

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)

class honeybee_energy.material.shade.EnergyWindowMaterialShade(*args, **kwargs)[source]

Bases: honeybee_energy.material.shade._EnergyWindowMaterialShadeBase

A material for a shade layer in a window construction.

Reflectance and emissivity properties are assumed to be the same on both sides of the shade. Shades are considered to be perfect diffusers.

Parameters
  • identifier – Text string for a unique Material 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.

  • thickness – Number for the thickness of the shade layer [m]. Default: 0.005 meters (5 mm).

  • solar_transmittance – Number between 0 and 1 for the transmittance of solar radiation through the shade. Default: 0.4, which is typical of a white diffusing shade.

  • solar_reflectance – Number between 0 and 1 for the reflectance of solar radiation off of the shade, averaged over the solar spectrum. Default: 0.5, which is typical of a white diffusing shade.

  • visible_transmittance – Number between 0 and 1 for the transmittance of visible light through the shade. Default: 0.4, which is typical of a white diffusing shade.

  • visible_reflectance – Number between 0 and 1 for the reflectance of visible light off of the shade. Default: 0.4, which is typical of a white diffusing shade.

  • infrared_transmittance – Long-wave hemispherical transmittance of the shade. Default: 0, which is typical of diffusing shades.

  • emissivity – Number between 0 and 1 for the infrared hemispherical emissivity of the front side of the shade. Default: 0.9, which is typical of most diffusing shade materials.

  • conductivity – Number for the thermal conductivity of the shade [W/m-K]. Default: 0.05, typical of cotton shades.

  • distance_to_glass – A number between 0.001 and 1.0 for the distance between the shade and neighboring glass layers [m]. Default: 0.05 (50 mm).

  • opening_multiplier – Factor between 0 and 1 that is multiplied by the area at the top, bottom and sides of the shade for air flow calculations. Default: 0.5.

  • airflow_permeability – The fraction of the shade surface that is open to air flow. Must be between 0 and 0.8. Default: 0 for no permeability.

Properties:
  • identifier

  • display_name

  • thickness

  • solar_transmittance

  • solar_reflectance

  • visible_transmittance

  • visible_reflectance

  • infrared_transmittance

  • emissivity

  • conductivity

  • distance_to_glass

  • top_opening_multiplier

  • bottom_opening_multiplier

  • left_opening_multiplier

  • right_opening_multiplier

  • airflow_permeability

  • resistivity

  • u_value

  • r_value

  • user_data

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this construction.

classmethod from_dict(data)[source]

Create a EnergyWindowMaterialShade from a dictionary.

Parameters

data – A python dictionary in the following format

{
"type": 'EnergyWindowMaterialShade',
"identifier": 'Insulating_Shade_0020_005_020_010',
"identifier": 'Dark Insulating Shade',
"thickness": 0.02,
"solar_transmittance": 0.05,
"solar_reflectance": 0.2,
"visible_transmittance": 0.05,
"visible_reflectance": 0.15,
"emissivity": 0.9,
"infrared_transmittance": 0,
"conductivity": 0.1
}
classmethod from_idf(idf_string)[source]

Create EnergyWindowMaterialShade from an EnergyPlus text string.

Parameters

idf_string – A text string fully describing an EnergyPlus material.

lock()
r_value_between(delta_t=7.5, emissivity_1=0.84, emissivity_2=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is interior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity_1 – The emissivity of the glazing surface on one side of the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • emissivity_2 – The emissivity of the glazing surface on the other side of the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

r_value_exterior(delta_t=7.5, emissivity=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is exterior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity – The emissivity of the glazing surface adjacent to the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

r_value_interior(delta_t=7.5, emissivity=0.84, height=1.0, angle=90, t_kelvin=273.15, pressure=101325)

Get an estimate of the R-value of the shade + air gap when it is interior.

Parameters
  • delta_t – The temperature difference across the air gap [C]. This influences how strong the convection is within the air gap. Default is 7.5C, which is consistent with the NFRC standard for double glazed units.

  • emissivity – The emissivity of the glazing surface adjacent to the shade. Default is 0.84, which is typical of clear, uncoated glass.

  • height – An optional height for the cavity between the shade and the glass in meters. Default is 1.0.

  • angle

    An angle in degrees between 0 and 180.

    • 0 = A horizontal surface with downward heat flow through the layer.

    • 90 = A vertical surface

    • 180 = A horizontal surface with upward heat flow through the layer.

  • t_kelvin – The average temperature of the gas cavity in Kelvin. Default: 273.15 K (0C).

  • pressure – The average air pressure in Pa. Default is 101325 Pa for sea level.

set_all_opening_multipliers(multiplier)

Set all opening multipliers to the same value at once.

to_dict()[source]

Energy Window Material Shade dictionary representation.

to_idf()[source]

Get an EnergyPlus string representation of the material.

unlock()
property airflow_permeability

Get or set the fraction of the shade surface open to air flow.

property bottom_opening_multiplier

Get or set the bottom opening multiplier.

property conductivity

Get or set the conductivity of the shade layer [W/m-K].

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 distance_to_glass

Get or set the shade distance to the glass [m].

property emissivity

Get or set the hemispherical emissivity of the shade.

property identifier

Get or set the text string for material identifier.

property infrared_transmittance

Get or set the infrared transmittance of the shade.

property is_gas_material

Boolean to note whether the material is a gas gap layer.

property is_glazing_material

Boolean to note whether the material is a glazing layer.

property is_shade_material

Boolean to note whether the material is a shade layer.

property is_window_material

Boolean to note whether the material can be used for window surfaces.

property left_opening_multiplier

Get or set the left opening multiplier.

property r_value

R-value of the material layer [m2-K/W] (excluding air film resistance).

property resistivity

Get or set the resistivity of the shade layer [m-K/W].

property right_opening_multiplier

Get or set the right opening multiplier.

property solar_reflectance

Get or set the front solar reflectance of the shade.

property solar_transmittance

Get or set the solar transmittance of the shade.

property thickness

Get or set the thickess of the shade material layer [m].

property top_opening_multiplier

Get or set the top opening multiplier.

property u_value

U-value of the material layer [W/m2-K] (excluding air film resistance).

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_reflectance

Get or set the front visible reflectance of the shade.

property visible_transmittance

Get or set the visible transmittance of the shade.