pyidf.daylighting module

Data objects in group “Daylighting”

class pyidf.daylighting.DaylightingControls

Bases: pyidf.helper.DataObject

Corresponds to IDD object Daylighting:Controls Dimming of overhead electric lighting is determined from interior daylight illuminance calculated at one or two reference points. reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field Glare from daylighting is also calculated.

availability_schedule_name

field Availability Schedule Name

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

fraction_of_zone_controlled_by_first_reference_point

field Fraction of Zone Controlled by First Reference Point

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Zone Controlled by First Reference Point Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_zone_controlled_by_first_reference_point or None if not set Return type:float

fraction_of_zone_controlled_by_second_reference_point

field Fraction of Zone Controlled by Second Reference Point

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Zone Controlled by Second Reference Point Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_zone_controlled_by_second_reference_point or None if not set Return type:float

glare_calculation_azimuth_angle_of_view_direction_clockwise_from_zone_yaxis

field Glare Calculation Azimuth Angle of View Direction Clockwise from Zone y-Axis

Units: deg

value <= 360.0

Parameters:value (float) – value for IDD Field Glare Calculation Azimuth Angle of View Direction Clockwise from Zone y-Axis Raises:ValueError – if value is not a valid value Returns:the value of glare_calculation_azimuth_angle_of_view_direction_clockwise_from_zone_yaxis or None if not set Return type:float

illuminance_setpoint_at_first_reference_point

field Illuminance Setpoint at First Reference Point

Units: lux

Default value: 500.0

Parameters:value (float) – value for IDD Field Illuminance Setpoint at First Reference Point Raises:ValueError – if value is not a valid value Returns:the value of illuminance_setpoint_at_first_reference_point or None if not set Return type:float

illuminance_setpoint_at_second_reference_point

field Illuminance Setpoint at Second Reference Point

Units: lux

Default value: 500.0

Parameters:value (float) – value for IDD Field Illuminance Setpoint at Second Reference Point Raises:ValueError – if value is not a valid value Returns:the value of illuminance_setpoint_at_second_reference_point or None if not set Return type:float

lighting_control_type

field Lighting Control Type

1=continuous,2=stepped,3=continuous/off

Default value: 1

value >= 1

value <= 3

Parameters:value (int) – value for IDD Field Lighting Control Type Raises:ValueError – if value is not a valid value Returns:the value of lighting_control_type or None if not set Return type:int

maximum_allowable_discomfort_glare_index

field Maximum Allowable Discomfort Glare Index

The default is for general office work

Default value: 22.0

value >= 1.0

Parameters:value (float) – value for IDD Field Maximum Allowable Discomfort Glare Index Raises:ValueError – if value is not a valid value Returns:the value of maximum_allowable_discomfort_glare_index or None if not set Return type:float

minimum_input_power_fraction_for_continuous_dimming_control

field Minimum Input Power Fraction for Continuous Dimming Control

Default value: 0.3

value <= 0.6

Parameters:value (float) – value for IDD Field Minimum Input Power Fraction for Continuous Dimming Control Raises:ValueError – if value is not a valid value Returns:the value of minimum_input_power_fraction_for_continuous_dimming_control or None if not set Return type:float

minimum_light_output_fraction_for_continuous_dimming_control

field Minimum Light Output Fraction for Continuous Dimming Control

Default value: 0.2

value <= 0.6

Parameters:value (float) – value for IDD Field Minimum Light Output Fraction for Continuous Dimming Control Raises:ValueError – if value is not a valid value Returns:the value of minimum_light_output_fraction_for_continuous_dimming_control or None if not set Return type:float

number_of_stepped_control_steps

field Number of Stepped Control Steps

for Lighting Control Type=2, this field cannot be zero.

Default value: 1

Parameters:value (int) – value for IDD Field Number of Stepped Control Steps Raises:ValueError – if value is not a valid value Returns:the value of number_of_stepped_control_steps or None if not set Return type:int

probability_lighting_will_be_reset_when_needed_in_manual_stepped_control

field Probability Lighting will be Reset When Needed in Manual Stepped Control

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Probability Lighting will be Reset When Needed in Manual Stepped Control Raises:ValueError – if value is not a valid value Returns:the value of probability_lighting_will_be_reset_when_needed_in_manual_stepped_control or None if not set Return type:float

total_daylighting_reference_points

field Total Daylighting Reference Points

Default value: 1

value >= 1

value <= 2

Parameters:value (int) – value for IDD Field Total Daylighting Reference Points Raises:ValueError – if value is not a valid value Returns:the value of total_daylighting_reference_points or None if not set Return type:int

xcoordinate_of_first_reference_point

field X-Coordinate of First Reference Point

Units: m

Parameters:value (float) – value for IDD Field X-Coordinate of First Reference Point Raises:ValueError – if value is not a valid value Returns:the value of xcoordinate_of_first_reference_point or None if not set Return type:float

xcoordinate_of_second_reference_point

field X-Coordinate of Second Reference Point

Required if Total Daylighting Reference Points = 2

Units: m

Parameters:value (float) – value for IDD Field X-Coordinate of Second Reference Point Raises:ValueError – if value is not a valid value Returns:the value of xcoordinate_of_second_reference_point or None if not set Return type:float

ycoordinate_of_first_reference_point

field Y-Coordinate of First Reference Point

Units: m

Parameters:value (float) – value for IDD Field Y-Coordinate of First Reference Point Raises:ValueError – if value is not a valid value Returns:the value of ycoordinate_of_first_reference_point or None if not set Return type:float

ycoordinate_of_second_reference_point

field Y-Coordinate of Second Reference Point

Required if Total Daylighting Reference Points = 2

Units: m

Parameters:value (float) – value for IDD Field Y-Coordinate of Second Reference Point Raises:ValueError – if value is not a valid value Returns:the value of ycoordinate_of_second_reference_point or None if not set Return type:float

zcoordinate_of_first_reference_point

field Z-Coordinate of First Reference Point

Units: m

Default value: 0.8

Parameters:value (float) – value for IDD Field Z-Coordinate of First Reference Point Raises:ValueError – if value is not a valid value Returns:the value of zcoordinate_of_first_reference_point or None if not set Return type:float

zcoordinate_of_second_reference_point

field Z-Coordinate of Second Reference Point

Units: m

Default value: 0.8

Parameters:value (float) – value for IDD Field Z-Coordinate of Second Reference Point Raises:ValueError – if value is not a valid value Returns:the value of zcoordinate_of_second_reference_point or None if not set Return type:float

zone_name

field Zone Name

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.daylighting.DaylightingDelightComplexFenestration

Bases: pyidf.helper.DataObject

Corresponds to IDD object Daylighting:DELight:ComplexFenestration Used for DElight Complex Fenestration of all types

building_surface_name

field Building Surface Name

This is a reference to a valid surface object (such as BuildingSurface:Detailed) hosting

this complex fenestration, analogous to the base surface Name

field for subsurfaces such as Windows.

Parameters:value (str) – value for IDD Field Building Surface Name Raises:ValueError – if value is not a valid value Returns:the value of building_surface_name or None if not set Return type:str

complex_fenestration_type

field Complex Fenestration Type

Used to select the appropriate Complex Fenestration BTDF data

Parameters:value (str) – value for IDD Field Complex Fenestration Type Raises:ValueError – if value is not a valid value Returns:the value of complex_fenestration_type or None if not set Return type:str

fenestration_rotation

field Fenestration Rotation

In-plane counter-clockwise rotation angle of the Complex Fenestration

optical reference direction and the base edge of the Complex Fenestration.

The Rotation will typically be zero when the host and CFS surfaces

are rectangular and height and width edges are aligned.

Units: deg

Parameters:value (float) – value for IDD Field Fenestration Rotation Raises:ValueError – if value is not a valid value Returns:the value of fenestration_rotation or None if not set Return type:float

name

field Name

Only used for user reference

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

window_name

field Window Name

This is a reference to a valid FenestrationSurface:Detailed window object

used to account for the geometry, and the solar and thermal gains/losses,

of the Complex Fenestration

Parameters:value (str) – value for IDD Field Window Name Raises:ValueError – if value is not a valid value Returns:the value of window_name or None if not set Return type:str

class pyidf.daylighting.DaylightingDelightControls

Bases: pyidf.helper.DataObject

Corresponds to IDD object Daylighting:DELight:Controls Dimming of overhead electric lighting is determined from DElight calculated interior daylight illuminance at one or more reference points.

gridding_resolution

field Gridding Resolution

Maximum surface area for nodes in gridding all surfaces in the DElight zone.

All reflective and transmitting surfaces will be subdivided

into approximately square nodes that do not exceed this maximum.

Higher resolution subdivisions require greater calculation times,

but generally produce more accurate results.

Units: m2

Parameters:value (float) – value for IDD Field Gridding Resolution Raises:ValueError – if value is not a valid value Returns:the value of gridding_resolution or None if not set Return type:float

lighting_control_type

field Lighting Control Type

1=continuous,2=stepped,3=continuous/off

Default value: 1

value >= 1

value <= 3

Parameters:value (int) – value for IDD Field Lighting Control Type Raises:ValueError – if value is not a valid value Returns:the value of lighting_control_type or None if not set Return type:int

minimum_input_power_fraction_for_continuous_dimming_control

field Minimum Input Power Fraction for Continuous Dimming Control

Default value: 0.3

value <= 0.6

Parameters:value (float) – value for IDD Field Minimum Input Power Fraction for Continuous Dimming Control Raises:ValueError – if value is not a valid value Returns:the value of minimum_input_power_fraction_for_continuous_dimming_control or None if not set Return type:float

minimum_light_output_fraction_for_continuous_dimming_control

field Minimum Light Output Fraction for Continuous Dimming Control

Default value: 0.2

value <= 0.6

Parameters:value (float) – value for IDD Field Minimum Light Output Fraction for Continuous Dimming Control Raises:ValueError – if value is not a valid value Returns:the value of minimum_light_output_fraction_for_continuous_dimming_control or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_stepped_control_steps

field Number of Stepped Control Steps

for Lighting Control Type=2, this field cannot be zero.

Default value: 1

Parameters:value (int) – value for IDD Field Number of Stepped Control Steps Raises:ValueError – if value is not a valid value Returns:the value of number_of_stepped_control_steps or None if not set Return type:int

probability_lighting_will_be_reset_when_needed_in_manual_stepped_control

field Probability Lighting will be Reset When Needed in Manual Stepped Control

value <= 1.0

Parameters:value (float) – value for IDD Field Probability Lighting will be Reset When Needed in Manual Stepped Control Raises:ValueError – if value is not a valid value Returns:the value of probability_lighting_will_be_reset_when_needed_in_manual_stepped_control or None if not set Return type:float

zone_name

field Zone Name

Name of Thermal Zone hosting the given DElight Zone

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.daylighting.DaylightingDelightReferencePoint

Bases: pyidf.helper.DataObject

Corresponds to IDD object Daylighting:DELight:ReferencePoint DElight reference point for illuminance calculation and electric lighting dimming. reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field There is a maximum number of 100 reference points per DElight daylighting zone.

delight_name

field DElight Name

Parameters:value (str) – value for IDD Field DElight Name Raises:ValueError – if value is not a valid value Returns:the value of delight_name or None if not set Return type:str

fraction_of_zone_controlled_by_reference_point

field Fraction of Zone Controlled by Reference Point

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Zone Controlled by Reference Point Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_zone_controlled_by_reference_point or None if not set Return type:float

illuminance_setpoint_at_reference_point

field Illuminance Setpoint at Reference Point

Units: lux

Default value: 500.0

Parameters:value (float) – value for IDD Field Illuminance Setpoint at Reference Point Raises:ValueError – if value is not a valid value Returns:the value of illuminance_setpoint_at_reference_point or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

xcoordinate_of_reference_point

field X-coordinate of Reference Point

Units: m

Parameters:value (float) – value for IDD Field X-coordinate of Reference Point Raises:ValueError – if value is not a valid value Returns:the value of xcoordinate_of_reference_point or None if not set Return type:float

ycoordinate_of_reference_point

field Y-coordinate of Reference Point

Units: m

Parameters:value (float) – value for IDD Field Y-coordinate of Reference Point Raises:ValueError – if value is not a valid value Returns:the value of ycoordinate_of_reference_point or None if not set Return type:float

zcoordinate_of_reference_point

field Z-coordinate of Reference Point

Units: m

Parameters:value (float) – value for IDD Field Z-coordinate of Reference Point Raises:ValueError – if value is not a valid value Returns:the value of zcoordinate_of_reference_point or None if not set Return type:float

class pyidf.daylighting.DaylightingDeviceLightWell

Bases: pyidf.helper.DataObject

Corresponds to IDD object DaylightingDevice:LightWell Applies only to exterior windows in daylighting-controlled zones or in zones that share an interior window with a daylighting-controlled zone. Generally used with skylights.

area_of_bottom_of_well

field Area of Bottom of Well

Units: m2

Parameters:value (float) – value for IDD Field Area of Bottom of Well Raises:ValueError – if value is not a valid value Returns:the value of area_of_bottom_of_well or None if not set Return type:float

exterior_window_name

field Exterior Window Name

Parameters:value (str) – value for IDD Field Exterior Window Name Raises:ValueError – if value is not a valid value Returns:the value of exterior_window_name or None if not set Return type:str

height_of_well

field Height of Well

Distance from Bottom of Window to Bottom of Well

Units: m

Parameters:value (float) – value for IDD Field Height of Well Raises:ValueError – if value is not a valid value Returns:the value of height_of_well or None if not set Return type:float

perimeter_of_bottom_of_well

field Perimeter of Bottom of Well

Units: m

Parameters:value (float) – value for IDD Field Perimeter of Bottom of Well Raises:ValueError – if value is not a valid value Returns:the value of perimeter_of_bottom_of_well or None if not set Return type:float

visible_reflectance_of_well_walls

field Visible Reflectance of Well Walls

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Visible Reflectance of Well Walls Raises:ValueError – if value is not a valid value Returns:the value of visible_reflectance_of_well_walls or None if not set Return type:float

class pyidf.daylighting.DaylightingDeviceShelf

Bases: pyidf.helper.DataObject

Corresponds to IDD object DaylightingDevice:Shelf Defines a daylighting which can have an inside shelf, an outside shelf, or both. The inside shelf is defined as a building surface and the outside shelf is defined as a shading surface.

inside_shelf_name

field Inside Shelf Name

This must refer to a BuildingSurface:Detailed or equivalent object

This surface must be its own Surface for other side boundary conditions.

Parameters:value (str) – value for IDD Field Inside Shelf Name Raises:ValueError – if value is not a valid value Returns:the value of inside_shelf_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

outside_shelf_construction_name

field Outside Shelf Construction Name

Required if outside shelf is specified

Parameters:value (str) – value for IDD Field Outside Shelf Construction Name Raises:ValueError – if value is not a valid value Returns:the value of outside_shelf_construction_name or None if not set Return type:str

outside_shelf_name

field Outside Shelf Name

This must refer to a Shading:Zone:Detailed object

Parameters:value (str) – value for IDD Field Outside Shelf Name Raises:ValueError – if value is not a valid value Returns:the value of outside_shelf_name or None if not set Return type:str

view_factor_to_outside_shelf

field View Factor to Outside Shelf

value <= 1.0

Parameters:value (float) – value for IDD Field View Factor to Outside Shelf Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_outside_shelf or None if not set Return type:float

window_name

field Window Name

Parameters:value (str) – value for IDD Field Window Name Raises:ValueError – if value is not a valid value Returns:the value of window_name or None if not set Return type:str

class pyidf.daylighting.DaylightingDeviceTubular

Bases: pyidf.helper.DataObject

Corresponds to IDD object DaylightingDevice:Tubular Defines a tubular daylighting device (TDD) consisting of three components: a dome, a pipe, and a diffuser. The dome and diffuser are defined separately using the FenestrationSurface:Detailed object.

add_extensible(transition_zone_1_name=None, transition_zone_1_length=None)

Add values for extensible fields

Parameters:

• transition_zone_1_name (str) – value for IDD Field Transition Zone 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• transition_zone_1_length (float) – value for IDD Field Transition Zone 1 Length Units: m if value is None it will not be checked against the specification and is assumed to be a missing value

construction_name

field Construction Name

Parameters:value (str) – value for IDD Field Construction Name Raises:ValueError – if value is not a valid value Returns:the value of construction_name or None if not set Return type:str

diameter

field Diameter

Units: m

Parameters:value (float) – value for IDD Field Diameter Raises:ValueError – if value is not a valid value Returns:the value of diameter or None if not set Return type:float

diffuser_name

field Diffuser Name

This must refer to a subsurface object of type TubularDaylightDiffuser

Delivery zone is specified in the diffuser object

Parameters:value (str) – value for IDD Field Diffuser Name Raises:ValueError – if value is not a valid value Returns:the value of diffuser_name or None if not set Return type:str

dome_name

field Dome Name

This must refer to a subsurface object of type TubularDaylightDome

Parameters:value (str) – value for IDD Field Dome Name Raises:ValueError – if value is not a valid value Returns:the value of dome_name or None if not set Return type:str

effective_thermal_resistance

field Effective Thermal Resistance

R value between TubularDaylightDome and TubularDaylightDiffuser

Units: m2-K/W

Default value: 0.28

Parameters:value (float) – value for IDD Field Effective Thermal Resistance Raises:ValueError – if value is not a valid value Returns:the value of effective_thermal_resistance or None if not set Return type:float

extensibles

Get list of all extensibles

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

total_length

field Total Length

The exterior exposed length is the difference between total and sum of zone lengths

Units: m

Parameters:value (float) – value for IDD Field Total Length Raises:ValueError – if value is not a valid value Returns:the value of total_length or None if not set Return type:float

class pyidf.daylighting.OutputControlIlluminanceMapStyle

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutputControl:IlluminanceMap:Style default style for the Daylighting Illuminance Map is comma – this works well for importing into spreadsheet programs such as Excel(tm) but not so well for word processing programs – there tab may be a better choice. fixed puts spaces between the “columns”

column_separator

field Column Separator

Default value: Comma

Parameters:value (str) – value for IDD Field Column Separator Raises:ValueError – if value is not a valid value Returns:the value of column_separator or None if not set Return type:str

class pyidf.daylighting.OutputDaylightFactors

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:DaylightFactors Reports hourly daylight factors for each exterior window for four sky types (clear, turbid clear, intermediate, and overcast).

reporting_days

field Reporting Days

Parameters:value (str) – value for IDD Field Reporting Days Raises:ValueError – if value is not a valid value Returns:the value of reporting_days or None if not set Return type:str

class pyidf.daylighting.OutputIlluminanceMap

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:IlluminanceMap reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_x_grid_points

field Number of X Grid Points

Maximum number of total grid points must be <= 2500 (X*Y)

Default value: 2

Parameters:value (int) – value for IDD Field Number of X Grid Points Raises:ValueError – if value is not a valid value Returns:the value of number_of_x_grid_points or None if not set Return type:int

number_of_y_grid_points

field Number of Y Grid Points

Maximum number of total grid points must be <= 2500 (X*Y)

Default value: 2

Parameters:value (int) – value for IDD Field Number of Y Grid Points Raises:ValueError – if value is not a valid value Returns:the value of number_of_y_grid_points or None if not set Return type:int

x_maximum_coordinate

field X Maximum Coordinate

Units: m

Default value: 1.0

Parameters:value (float) – value for IDD Field X Maximum Coordinate Raises:ValueError – if value is not a valid value Returns:the value of x_maximum_coordinate or None if not set Return type:float

x_minimum_coordinate

field X Minimum Coordinate

Units: m

Parameters:value (float) – value for IDD Field X Minimum Coordinate Raises:ValueError – if value is not a valid value Returns:the value of x_minimum_coordinate or None if not set Return type:float

y_maximum_coordinate

field Y Maximum Coordinate

Units: m

Default value: 1.0

Parameters:value (float) – value for IDD Field Y Maximum Coordinate Raises:ValueError – if value is not a valid value Returns:the value of y_maximum_coordinate or None if not set Return type:float

y_minimum_coordinate

field Y Minimum Coordinate

Units: m

Parameters:value (float) – value for IDD Field Y Minimum Coordinate Raises:ValueError – if value is not a valid value Returns:the value of y_minimum_coordinate or None if not set Return type:float

z_height

field Z height

Units: m

Parameters:value (float) – value for IDD Field Z height Raises:ValueError – if value is not a valid value Returns:the value of z_height or None if not set Return type:float

zone_name

field Zone Name

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str