pyidf.thermal_zones_and_surfaces module

Data objects in group “Thermal Zones and Surfaces”

class pyidf.thermal_zones_and_surfaces.BuildingSurfaceDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object BuildingSurface:Detailed Allows for detailed entry of building heat transfer surfaces. Does not include subsurfaces such as windows or doors.

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate 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

To be matched with a construction in this input file

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

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

number_of_vertices

field Number of Vertices

shown with 120 vertex coordinates – extensible object

“extensible” – duplicate last set of x,y,z coordinates (last 3 fields),

remembering to remove ; from “inner” fields.

for clarity in any error messages, renumber the fields as well.

(and changing z terminator to a comma ”,” for all but last one which needs a semi-colon ”;”)

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. If world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

outside_boundary_condition

field Outside Boundary Condition

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

outside_boundary_condition_object

field Outside Boundary Condition Object

Non-blank only if the field Outside Boundary Condition is Surface,

Zone, OtherSideCoefficients or OtherSideConditionsModel

If Surface, specify name of corresponding surface in adjacent zone or

specify current surface name for internal partition separating like zones

If Zone, specify the name of the corresponding zone and

the program will generate the corresponding interzone surface

If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients

If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

sun_exposure

field Sun Exposure

Default value: SunExposed

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

surface_type

field Surface Type

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

view_factor_to_ground

field View Factor to Ground

From the exterior of the surface

Unused if one uses the “reflections” options in Solar Distribution in Building input

unless a DaylightingDevice:Shelf or DaylightingDevice:Tubular object has been specified.

autocalculate will automatically calculate this value from the tilt of the surface

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field View Factor to Ground Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_ground or None if not set Return type:float or “Autocalculate”

wind_exposure

field Wind Exposure

Default value: WindExposed

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.CeilingAdiabatic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Ceiling:Adiabatic Allows for simplified entry of interior ceilings.

azimuth_angle

field Azimuth Angle

Facing direction of outside of Ceiling

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

If not Flat, Starting coordinate is the Lower Left Corner of the Ceiling

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Ceilings are usually tilted 0 degrees

Units: deg

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.CeilingInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Ceiling:Interzone Allows for simplified entry of ceilings using adjacent zone (interzone) heat transfer - adjacent surface should be a floor

azimuth_angle

field Azimuth Angle

Facing direction of outside of wall (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior floors

Specify a zone name of an adjacent zone to automatically generate

the interior floor in the adjacent zone.

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

If not Flat, should be Lower Left Corner (from outside)

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Ceilings are usually tilted 0 degrees

Units: deg

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone for the inside of the surface

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.thermal_zones_and_surfaces.Door

Bases: pyidf.helper.DataObject

Corresponds to IDD object Door Allows for simplified entry of opaque Doors.

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Door is on (i.e., Base Surface)

Door assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

starting_x_coordinate

field Starting X Coordinate

Door starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.DoorInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Door:Interzone Allows for simplified entry of interzone (opaque interior) doors (adjacent to other zones).

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Door is on (i.e., Base Surface)

Door assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior doors.

Specify a zone name of an adjacent zone to automatically generate

the interior door in the adjacent zone.

a blank field will set up a Window in an adjacent zone

(same zone as adjacent to base surface)

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

Door starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.FenestrationSurfaceDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object FenestrationSurface:Detailed Allows for detailed entry of subsurfaces (windows, doors, glass doors, tubular daylighting devices).

building_surface_name

field Building Surface Name

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

frame_and_divider_name

field Frame and Divider Name

Enter the name of a WindowProperty:FrameAndDivider object

Used only for exterior windows (rectangular) and glass doors.

Unused for triangular windows.

If not specified (blank), window or glass door has no frame or divider

and no beam solar reflection from reveal surfaces.

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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_vertices

field Number of Vertices

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. If world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

value <= 4.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

outside_boundary_condition_object

field Outside Boundary Condition Object

Non-blank only if base surface field Outside Boundary Condition is

Surface or OtherSideCoefficients

If Base Surface’s Surface, specify name of corresponding subsurface in adjacent zone or

specify current subsurface name for internal partition separating like zones

If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients

or leave blank to inherit Base Surface’s OtherSide Coefficients

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

shading_control_name

field Shading Control Name

enter the name of a WindowProperty:ShadingControl object

used for windows and glass doors only

If not specified, window or glass door has no shading (blind, roller shade, etc.)

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

surface_type

field Surface Type

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

vertex_1_xcoordinate

field Vertex 1 X-coordinate

Units: m

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

vertex_1_ycoordinate

field Vertex 1 Y-coordinate

Units: m

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

vertex_1_zcoordinate

field Vertex 1 Z-coordinate

Units: m

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

vertex_2_xcoordinate

field Vertex 2 X-coordinate

Units: m

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

vertex_2_ycoordinate

field Vertex 2 Y-coordinate

Units: m

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

vertex_2_zcoordinate

field Vertex 2 Z-coordinate

Units: m

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

vertex_3_xcoordinate

field Vertex 3 X-coordinate

Units: m

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

vertex_3_ycoordinate

field Vertex 3 Y-coordinate

Units: m

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

vertex_3_zcoordinate

field Vertex 3 Z-coordinate

Units: m

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

vertex_4_xcoordinate

field Vertex 4 X-coordinate

Not used for triangles

Units: m

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

vertex_4_ycoordinate

field Vertex 4 Y-coordinate

Not used for triangles

Units: m

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

vertex_4_zcoordinate

field Vertex 4 Z-coordinate

Not used for triangles

Units: m

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

view_factor_to_ground

field View Factor to Ground

From the exterior of the surface

Unused if one uses the “reflections” options in Solar Distribution in Building input

unless a DaylightingDevice:Shelf or DaylightingDevice:Tubular object has been specified.

autocalculate will automatically calculate this value from the tilt of the surface

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field View Factor to Ground Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_ground or None if not set Return type:float or “Autocalculate”

class pyidf.thermal_zones_and_surfaces.FloorAdiabatic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Floor:Adiabatic Allows for simplified entry of exterior floors ignoring ground contact or interior floors. View Factor to Ground is automatically calculated.

azimuth_angle

field Azimuth Angle

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

if not flat, should be lower left corner (from outside)

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Floors are usually tilted 180 degrees

Units: deg

Default value: 180.0

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.FloorDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Floor:Detailed Allows for detailed entry of floor heat transfer surfaces.

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate 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

To be matched with a construction in this input file

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

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

number_of_vertices

field Number of Vertices

shown with 10 vertex coordinates – extensible object

“extensible” – duplicate last set of x,y,z coordinates, renumbering please

(and changing z terminator to a comma ”,” for all but last one which needs a semi-colon ”;”)

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. If world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

outside_boundary_condition

field Outside Boundary Condition

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

outside_boundary_condition_object

field Outside Boundary Condition Object

Non-blank only if the field Outside Boundary Condition is Surface,

Zone, OtherSideCoefficients or OtherSideConditionsModel

If Surface, specify name of corresponding surface in adjacent zone or

specify current surface name for internal partition separating like zones

If Zone, specify the name of the corresponding zone and

the program will generate the corresponding interzone surface

If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients

If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

sun_exposure

field Sun Exposure

Default value: SunExposed

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

view_factor_to_ground

field View Factor to Ground

From the exterior of the surface

Unused if one uses the “reflections” options in Solar Distribution in Building input

unless a DaylightingDevice:Shelf or DaylightingDevice:Tubular object has been specified.

autocalculate will automatically calculate this value from the tilt of the surface

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field View Factor to Ground Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_ground or None if not set Return type:float or “Autocalculate”

wind_exposure

field Wind Exposure

Default value: WindExposed

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.FloorGroundContact

Bases: pyidf.helper.DataObject

Corresponds to IDD object Floor:GroundContact Allows for simplified entry of exterior floors with ground contact. View Factors to Ground is automatically calculated.

azimuth_angle

field Azimuth Angle

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

If the construction is type “Construction:FfactorGroundFloor”,

then the GroundFCfactorMethod will be used.

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

if not flat, should be lower left corner (from outside)

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Floors are usually tilted 180 degrees

Units: deg

Default value: 180.0

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.FloorInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Floor:Interzone Allows for simplified entry of floors using adjacent zone (interzone) heat transfer - adjacent surface should be a ceiling.

azimuth_angle

field Azimuth Angle

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior ceilings.

Specify a zone name of an adjacent zone to automatically generate

the interior ceiling in the adjacent zone.

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

If not Flat, should be Lower Left Corner (from outside)

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Floors are usually tilted 180 degrees

Units: deg

Default value: 180.0

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone for the inside of the surface

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.thermal_zones_and_surfaces.GeometryTransform

Bases: pyidf.helper.DataObject

Corresponds to IDD object GeometryTransform Provides a simple method of altering the footprint geometry of a model. The intent is to provide a single parameter that can be used to reshape the building description contained in the rest of the input file.

current_aspect_ratio

field Current Aspect Ratio

Aspect ratio of building as described in idf

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

new_aspect_ratio

field New Aspect Ratio

Aspect ratio to transform to during run

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

plane_of_transform

field Plane of Transform

only current allowed value is “XY”

Default value: XY

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

class pyidf.thermal_zones_and_surfaces.GlazedDoor

Bases: pyidf.helper.DataObject

Corresponds to IDD object GlazedDoor Allows for simplified entry of glass Doors.

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Door is on (i.e., Base Surface)

Door assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

frame_and_divider_name

field Frame and Divider Name

Enter the name of a WindowProperty:FrameAndDivider object

Used only for exterior windows (rectangular) and glass doors.

Unused for triangular windows.

If not specified (blank), window or glass door has no frame or divider

and no beam solar reflection from reveal surfaces.

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

shading_control_name

field Shading Control Name

enter the name of a WindowProperty:ShadingControl object

used for windows and glass doors only

If not specified, window or glass door has no shading (blind, roller shade, etc.)

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

starting_x_coordinate

field Starting X Coordinate

Door starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.GlazedDoorInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object GlazedDoor:Interzone Allows for simplified entry of interzone (glass interior) doors (adjacent to other zones).

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Door is on (i.e., Base Surface)

Door assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior doors.

Specify a zone name of an adjacent zone to automatically generate

the interior door in the adjacent zone.

a blank field will set up a Window in an adjacent zone

(same zone as adjacent to base surface)

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

Door starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.GlobalGeometryRules

Bases: pyidf.helper.DataObject

Corresponds to IDD object GlobalGeometryRules Specifies the geometric rules used to describe the input of surface vertices and daylighting reference points.

coordinate_system

field Coordinate System

relative – coordinates are entered relative to zone origin

world – all coordinates entered are “absolute” for this facility

absolute – same as world

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

daylighting_reference_point_coordinate_system

field Daylighting Reference Point Coordinate System

Relative – coordinates are entered relative to zone origin

World – all coordinates entered are “absolute” for this facility

absolute – same as world

Default value: Relative

Parameters:value (str) – value for IDD Field Daylighting Reference Point Coordinate System Raises:ValueError – if value is not a valid value Returns:the value of daylighting_reference_point_coordinate_system or None if not set Return type:str

rectangular_surface_coordinate_system

field Rectangular Surface Coordinate System

Relative – Starting corner is entered relative to zone origin

World – Starting corner is entered in “absolute”

absolute – same as world

Default value: Relative

Parameters:value (str) – value for IDD Field Rectangular Surface Coordinate System Raises:ValueError – if value is not a valid value Returns:the value of rectangular_surface_coordinate_system or None if not set Return type:str

starting_vertex_position

field Starting Vertex Position

Specified as entry for a 4 sided surface/rectangle

Surfaces are specified as viewed from outside the surface

Shading surfaces as viewed from behind. (towards what they are shading)

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

vertex_entry_direction

field Vertex Entry Direction

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

class pyidf.thermal_zones_and_surfaces.InternalMass

Bases: pyidf.helper.DataObject

Corresponds to IDD object InternalMass Used to describe internal zone surface area that does not need to be part of geometric representation. This should be the total surface area exposed to the zone air.

construction_name

field Construction Name

To be matched with a construction in this input file

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

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

surface_area

field Surface Area

Units: m2

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

zone_name

field Zone Name

Zone the surface is a part of

used to be Interior Environment

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.thermal_zones_and_surfaces.Roof

Bases: pyidf.helper.DataObject

Corresponds to IDD object Roof Allows for simplified entry of roofs (exterior). View Factor to Ground is automatically calculated.

azimuth_angle

field Azimuth Angle

Facing direction of outside of Roof

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

length

field Length

Along X Axis

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

If not Flat, Starting coordinate is the Lower Left Corner of the Roof

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Flat Roofs are tilted 0 degrees

Units: deg

value <= 180.0

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

width

field Width

Along Y Axis

Units: m

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.RoofCeilingDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoofCeiling:Detailed Allows for detailed entry of roof/ceiling heat transfer surfaces.

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate 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

To be matched with a construction in this input file

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

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

number_of_vertices

field Number of Vertices

shown with 10 vertex coordinates – extensible object

“extensible” – duplicate last set of x,y,z coordinates, renumbering please

(and changing z terminator to a comma ”,” for all but last one which needs a semi-colon ”;”)

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. If world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

outside_boundary_condition

field Outside Boundary Condition

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

outside_boundary_condition_object

field Outside Boundary Condition Object

Non-blank only if the field Outside Boundary Condition is Surface,

Zone, OtherSideCoefficients or OtherSideConditionsModel

If Surface, specify name of corresponding surface in adjacent zone or

specify current surface name for internal partition separating like zones

If Zone, specify the name of the corresponding zone and

the program will generate the corresponding interzone surface

If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients

If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

sun_exposure

field Sun Exposure

Default value: SunExposed

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

view_factor_to_ground

field View Factor to Ground

From the exterior of the surface

Unused if one uses the “reflections” options in Solar Distribution in Building input

unless a DaylightingDevice:Shelf or DaylightingDevice:Tubular object has been specified.

autocalculate will automatically calculate this value from the tilt of the surface

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field View Factor to Ground Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_ground or None if not set Return type:float or “Autocalculate”

wind_exposure

field Wind Exposure

Default value: WindExposed

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.ShadingBuilding

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Building used for shading elements such as trees, other buildings, parts of this building not being modeled these items are relative to the current building and would move with relative geometry

azimuth_angle

field Azimuth Angle

Facing direction of outside of shading device (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

Starting coordinate is the Lower Left Corner of the Shade

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Units: deg

Default value: 90.0

value <= 180.0

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

class pyidf.thermal_zones_and_surfaces.ShadingBuildingDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Building:Detailed used for shading elements such as trees, other buildings, parts of this building not being modeled these items are relative to the current building and would move with relative geometry

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value

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

number_of_vertices

field Number of Vertices

shown with 6 vertex coordinates – extensible object

Rules for vertices are given in GlobalGeometryRules coordinates –

For this object all surface coordinates are relative to the building origin (0,0,0)

and will rotate with the BUILDING north axis.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

transmittance_schedule_name

field Transmittance Schedule Name

Transmittance schedule for the shading device, defaults to zero (always opaque)

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

class pyidf.thermal_zones_and_surfaces.ShadingFin

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Fin Fins are usually shading surfaces that are perpendicular to a window or door.

left_depth

field Left Depth

Units: m

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

left_distance_above_top_of_window

field Left Distance Above Top of Window

Units: m

Parameters:value (float) – value for IDD Field Left Distance Above Top of Window Raises:ValueError – if value is not a valid value Returns:the value of left_distance_above_top_of_window or None if not set Return type:float

left_distance_below_bottom_of_window

field Left Distance Below Bottom of Window

N2 + N3 + height of Window/Door is height of Fin

Units: m

Parameters:value (float) – value for IDD Field Left Distance Below Bottom of Window Raises:ValueError – if value is not a valid value Returns:the value of left_distance_below_bottom_of_window or None if not set Return type:float

left_extension_from_window_or_door

field Left Extension from Window/Door

Units: m

Parameters:value (float) – value for IDD Field Left Extension from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of left_extension_from_window_or_door or None if not set Return type:float

left_tilt_angle_from_window_or_door

field Left Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Left Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of left_tilt_angle_from_window_or_door 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

right_depth

field Right Depth

Units: m

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

right_distance_above_top_of_window

field Right Distance Above Top of Window

Units: m

Parameters:value (float) – value for IDD Field Right Distance Above Top of Window Raises:ValueError – if value is not a valid value Returns:the value of right_distance_above_top_of_window or None if not set Return type:float

right_distance_below_bottom_of_window

field Right Distance Below Bottom of Window

N7 + N8 + height of Window/Door is height of Fin

Units: m

Parameters:value (float) – value for IDD Field Right Distance Below Bottom of Window Raises:ValueError – if value is not a valid value Returns:the value of right_distance_below_bottom_of_window or None if not set Return type:float

right_extension_from_window_or_door

field Right Extension from Window/Door

Units: m

Parameters:value (float) – value for IDD Field Right Extension from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of right_extension_from_window_or_door or None if not set Return type:float

right_tilt_angle_from_window_or_door

field Right Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Right Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of right_tilt_angle_from_window_or_door or None if not set Return type:float

window_or_door_name

field Window or Door Name

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

class pyidf.thermal_zones_and_surfaces.ShadingFinProjection

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Fin:Projection Fins are usually shading surfaces that are perpendicular to a window or door.

left_depth_as_fraction_of_window_or_door_width

field Left Depth as Fraction of Window/Door Width

Units: dimensionless

Parameters:value (float) – value for IDD Field Left Depth as Fraction of Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of left_depth_as_fraction_of_window_or_door_width or None if not set Return type:float

left_distance_above_top_of_window

field Left Distance Above Top of Window

Units: m

Parameters:value (float) – value for IDD Field Left Distance Above Top of Window Raises:ValueError – if value is not a valid value Returns:the value of left_distance_above_top_of_window or None if not set Return type:float

left_distance_below_bottom_of_window

field Left Distance Below Bottom of Window

N2 + N3 + height of Window/Door is height of Fin

Units: m

Parameters:value (float) – value for IDD Field Left Distance Below Bottom of Window Raises:ValueError – if value is not a valid value Returns:the value of left_distance_below_bottom_of_window or None if not set Return type:float

left_extension_from_window_or_door

field Left Extension from Window/Door

Units: m

Parameters:value (float) – value for IDD Field Left Extension from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of left_extension_from_window_or_door or None if not set Return type:float

left_tilt_angle_from_window_or_door

field Left Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Left Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of left_tilt_angle_from_window_or_door 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

right_depth_as_fraction_of_window_or_door_width

field Right Depth as Fraction of Window/Door Width

Units: dimensionless

Parameters:value (float) – value for IDD Field Right Depth as Fraction of Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of right_depth_as_fraction_of_window_or_door_width or None if not set Return type:float

right_distance_above_top_of_window

field Right Distance Above Top of Window

Units: m

Parameters:value (float) – value for IDD Field Right Distance Above Top of Window Raises:ValueError – if value is not a valid value Returns:the value of right_distance_above_top_of_window or None if not set Return type:float

right_distance_below_bottom_of_window

field Right Distance Below Bottom of Window

N7 + N8 + height of Window/Door is height of Fin

Units: m

Parameters:value (float) – value for IDD Field Right Distance Below Bottom of Window Raises:ValueError – if value is not a valid value Returns:the value of right_distance_below_bottom_of_window or None if not set Return type:float

right_extension_from_window_or_door

field Right Extension from Window/Door

Units: m

Parameters:value (float) – value for IDD Field Right Extension from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of right_extension_from_window_or_door or None if not set Return type:float

right_tilt_angle_from_window_or_door

field Right Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Right Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of right_tilt_angle_from_window_or_door or None if not set Return type:float

window_or_door_name

field Window or Door Name

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

class pyidf.thermal_zones_and_surfaces.ShadingOverhang

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Overhang Overhangs are usually flat shading surfaces that reference a window or door.

depth

field Depth

Units: m

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

height_above_window_or_door

field Height above Window or Door

Units: m

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

left_extension_from_window_or_door_width

field Left extension from Window/Door Width

Units: m

Parameters:value (float) – value for IDD Field Left extension from Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of left_extension_from_window_or_door_width 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

right_extension_from_window_or_door_width

field Right extension from Window/Door Width

N3 + N4 + Window/Door Width is Overhang Length

Units: m

Parameters:value (float) – value for IDD Field Right extension from Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of right_extension_from_window_or_door_width or None if not set Return type:float

tilt_angle_from_window_or_door

field Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of tilt_angle_from_window_or_door or None if not set Return type:float

window_or_door_name

field Window or Door Name

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

class pyidf.thermal_zones_and_surfaces.ShadingOverhangProjection

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Overhang:Projection Overhangs are typically flat shading surfaces that reference a window or door.

depth_as_fraction_of_window_or_door_height

field Depth as Fraction of Window/Door Height

Units: dimensionless

Parameters:value (float) – value for IDD Field Depth as Fraction of Window/Door Height Raises:ValueError – if value is not a valid value Returns:the value of depth_as_fraction_of_window_or_door_height or None if not set Return type:float

height_above_window_or_door

field Height above Window or Door

Units: m

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

left_extension_from_window_or_door_width

field Left extension from Window/Door Width

Units: m

Parameters:value (float) – value for IDD Field Left extension from Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of left_extension_from_window_or_door_width 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

right_extension_from_window_or_door_width

field Right extension from Window/Door Width

N3 + N4 + Window/Door Width is Overhang Length

Units: m

Parameters:value (float) – value for IDD Field Right extension from Window/Door Width Raises:ValueError – if value is not a valid value Returns:the value of right_extension_from_window_or_door_width or None if not set Return type:float

tilt_angle_from_window_or_door

field Tilt Angle from Window/Door

Units: deg

Default value: 90.0

value <= 180.0

Parameters:value (float) – value for IDD Field Tilt Angle from Window/Door Raises:ValueError – if value is not a valid value Returns:the value of tilt_angle_from_window_or_door or None if not set Return type:float

window_or_door_name

field Window or Door Name

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

class pyidf.thermal_zones_and_surfaces.ShadingPropertyReflectance

Bases: pyidf.helper.DataObject

Corresponds to IDD object ShadingProperty:Reflectance If this object is not defined for a shading surface the default values listed in following fields will be used in the solar reflection calculation.

diffuse_solar_reflectance_of_unglazed_part_of_shading_surface

field Diffuse Solar Reflectance of Unglazed Part of Shading Surface

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Diffuse Solar Reflectance of Unglazed Part of Shading Surface Raises:ValueError – if value is not a valid value Returns:the value of diffuse_solar_reflectance_of_unglazed_part_of_shading_surface or None if not set Return type:float

diffuse_visible_reflectance_of_unglazed_part_of_shading_surface

field Diffuse Visible Reflectance of Unglazed Part of Shading Surface

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Diffuse Visible Reflectance of Unglazed Part of Shading Surface Raises:ValueError – if value is not a valid value Returns:the value of diffuse_visible_reflectance_of_unglazed_part_of_shading_surface or None if not set Return type:float

fraction_of_shading_surface_that_is_glazed

field Fraction of Shading Surface That Is Glazed

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Shading Surface That Is Glazed Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_shading_surface_that_is_glazed or None if not set Return type:float

glazing_construction_name

field Glazing Construction Name

Required if Fraction of Shading Surface That Is Glazed > 0.0

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

shading_surface_name

field Shading Surface Name

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

class pyidf.thermal_zones_and_surfaces.ShadingSite

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Site used for shading elements such as trees these items are fixed in space and would not move with relative geometry

azimuth_angle

field Azimuth Angle

Facing direction of outside of shading device (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

Starting coordinate is the Lower Left Corner of the Shade

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Units: deg

Default value: 90.0

value <= 180.0

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

class pyidf.thermal_zones_and_surfaces.ShadingSiteDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Site:Detailed used for shading elements such as trees these items are fixed in space and would not move with relative geometry

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value

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

number_of_vertices

field Number of Vertices

shown with 6 vertex coordinates – extensible object

Rules for vertices are given in GlobalGeometryRules coordinates –

For this object all surface coordinates are in world coordinates.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

transmittance_schedule_name

field Transmittance Schedule Name

Transmittance schedule for the shading device, defaults to zero (always opaque)

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

class pyidf.thermal_zones_and_surfaces.ShadingZoneDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Shading:Zone:Detailed used For fins, overhangs, elements that shade the building, are attached to the building but are not part of the heat transfer calculations

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value

base_surface_name

field Base Surface Name

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

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

number_of_vertices

field Number of Vertices

shown with 6 vertex coordinates – extensible object

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. if world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

transmittance_schedule_name

field Transmittance Schedule Name

Transmittance schedule for the shading device, defaults to zero (always opaque)

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

class pyidf.thermal_zones_and_surfaces.WallAdiabatic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Wall:Adiabatic Allows for simplified entry of interior walls.

azimuth_angle

field Azimuth Angle

Facing direction of outside of wall (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

Starting (x,y,z) coordinate is the Lower Left Corner of the Wall

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Walls are usually tilted 90 degrees

Units: deg

Default value: 90.0

value <= 180.0

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.WallDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Wall:Detailed Allows for detailed entry of wall heat transfer surfaces.

add_extensible(vertex_1_xcoordinate=None, vertex_1_ycoordinate=None, vertex_1_zcoordinate=None)

Add values for extensible fields

Parameters:

• vertex_1_xcoordinate (float) – value for IDD Field Vertex 1 X-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_ycoordinate (float) – value for IDD Field Vertex 1 Y-coordinate Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• vertex_1_zcoordinate (float) – value for IDD Field Vertex 1 Z-coordinate 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

To be matched with a construction in this input file

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

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

number_of_vertices

field Number of Vertices

shown with 10 vertex coordinates – extensible object

“extensible” – duplicate last set of x,y,z coordinates, renumbering please

(and changing z terminator to a comma ”,” for all but last one which needs a semi-colon ”;”)

vertices are given in GlobalGeometryRules coordinates – if relative, all surface coordinates

are “relative” to the Zone Origin. If world, then building and zone origins are used

for some internal calculations, but all coordinates are given in an “absolute” system.

Default value: “autocalculate”

value >= 3.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Number of Vertices Raises:ValueError – if value is not a valid value Returns:the value of number_of_vertices or None if not set Return type:float or “Autocalculate”

outside_boundary_condition

field Outside Boundary Condition

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

outside_boundary_condition_object

field Outside Boundary Condition Object

Non-blank only if the field Outside Boundary Condition is Surface,

Zone, OtherSideCoefficients or OtherSideConditionsModel

If Surface, specify name of corresponding surface in adjacent zone or

specify current surface name for internal partition separating like zones

If Zone, specify the name of the corresponding zone and

the program will generate the corresponding interzone surface

If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients

If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

sun_exposure

field Sun Exposure

Default value: SunExposed

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

view_factor_to_ground

field View Factor to Ground

From the exterior of the surface

Unused if one uses the “reflections” options in Solar Distribution in Building input

unless a DaylightingDevice:Shelf or DaylightingDevice:Tubular object has been specified.

autocalculate will automatically calculate this value from the tilt of the surface

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field View Factor to Ground Raises:ValueError – if value is not a valid value Returns:the value of view_factor_to_ground or None if not set Return type:float or “Autocalculate”

wind_exposure

field Wind Exposure

Default value: WindExposed

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.WallExterior

Bases: pyidf.helper.DataObject

Corresponds to IDD object Wall:Exterior Allows for simplified entry of exterior walls. View Factor to Ground is automatically calculated.

azimuth_angle

field Azimuth Angle

Facing direction of outside of wall (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

Starting (x,y,z) coordinate is the Lower Left Corner of the Wall

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Walls are usually tilted 90 degrees

Units: deg

Default value: 90.0

value <= 180.0

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.WallInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Wall:Interzone Allows for simplified entry of interzone walls (walls between zones).

azimuth_angle

field Azimuth Angle

Facing direction of outside of wall (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior walls.

Specify a zone name of an adjacent zone to automatically generate

the interior wall in the adjacent zone.

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

Starting (x,y,z) coordinate is the Lower Left Corner of the Wall

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Walls are usually tilted 90 degrees

Units: deg

Default value: 90.0

value <= 180.0

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

zone_name

field Zone Name

Zone for the inside of the surface

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.thermal_zones_and_surfaces.WallUnderground

Bases: pyidf.helper.DataObject

Corresponds to IDD object Wall:Underground Allows for simplified entry of underground walls.

azimuth_angle

field Azimuth Angle

Facing direction of outside of wall (S=180,N=0,E=90,W=270)

Units: deg

value <= 360.0

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

construction_name

field Construction Name

To be matched with a construction in this input file.

If the construction is type “Construction:CfactorUndergroundWall”,

then the GroundFCfactorMethod will be used.

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

height

field Height

Units: m

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

length

field Length

Units: m

Parameters:value (float) – value for IDD Field Length Raises:ValueError – if value is not a valid value Returns:the value of length 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

starting_x_coordinate

field Starting X Coordinate

Starting (x,y,z) coordinate is the Lower Left Corner of the Wall

Units: m

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

starting_y_coordinate

field Starting Y Coordinate

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

Units: m

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

tilt_angle

field Tilt Angle

Walls are usually tilted 90 degrees

Units: deg

Default value: 90.0

value <= 180.0

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

zone_name

field Zone Name

Zone the surface is a part of

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.thermal_zones_and_surfaces.Window

Bases: pyidf.helper.DataObject

Corresponds to IDD object Window Allows for simplified entry of Windows.

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Window is on (i.e., Base Surface)

Window assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

frame_and_divider_name

field Frame and Divider Name

Enter the name of a WindowProperty:FrameAndDivider object

Used only for exterior windows (rectangular) and glass doors.

Unused for triangular windows.

If not specified (blank), window or glass door has no frame or divider

and no beam solar reflection from reveal surfaces.

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

shading_control_name

field Shading Control Name

enter the name of a WindowProperty:ShadingControl object

used for windows and glass doors only

If not specified, window or glass door has no shading (blind, roller shade, etc.)

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

starting_x_coordinate

field Starting X Coordinate

Window starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Window starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.WindowInterzone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Window:Interzone Allows for simplified entry of interzone windows (adjacent to other zones).

building_surface_name

field Building Surface Name

Name of Surface (Wall, usually) the Window is on (i.e., Base Surface)

Window assumes the azimuth and tilt angles of the surface it is on.

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

construction_name

field Construction Name

To be matched with a construction in this input file

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

height

field Height

Units: m

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

length

field Length

Units: m

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

multiplier

field Multiplier

Used only for Surface Type = WINDOW, GLASSDOOR or DOOR

Non-integer values will be truncated to integer

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Multiplier Raises:ValueError – if value is not a valid value Returns:the value of multiplier 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

outside_boundary_condition_object

field Outside Boundary Condition Object

Specify a surface name in an adjacent zone for known interior windows.

Specify a zone name of an adjacent zone to automatically generate

the interior window in the adjacent zone.

a blank field will set up a Window in an adjacent zone

(same zone as adjacent to base surface)

Parameters:value (str) – value for IDD Field Outside Boundary Condition Object Raises:ValueError – if value is not a valid value Returns:the value of outside_boundary_condition_object or None if not set Return type:str

starting_x_coordinate

field Starting X Coordinate

Window starting coordinate is specified relative to the Base Surface origin.

Units: m

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

starting_z_coordinate

field Starting Z Coordinate

How far up the wall the Window starts. (in 2-d, this would be a Y Coordinate)

Units: m

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

class pyidf.thermal_zones_and_surfaces.WindowPropertyAirflowControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowProperty:AirflowControl Used to control forced airflow through a gap between glass layers

airflow_control_type

field Airflow Control Type

ScheduledOnly requires that Airflow Has Multiplier Schedule Name = Yes

and that Airflow Multiplier Schedule Name is specified.

Default value: AlwaysOnAtMaximumFlow

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

airflow_destination

field Airflow Destination

Default value: OutdoorAir

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

airflow_is_scheduled

field Airflow Is Scheduled

If Yes, then Airflow Multiplier Schedule Name must be specified

Default value: No

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

airflow_multiplier_schedule_name

field Airflow Multiplier Schedule Name

Required if Airflow Is Scheduled = Yes.

Schedule values are 0.0 or 1.0 and multiply Maximum Air Flow.

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

airflow_source

field Airflow Source

Default value: IndoorAir

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

maximum_flow_rate

field Maximum Flow Rate

Above is m3/s per m of glazing width

Units: m3/s-m

IP-Units: ft3/min-ft

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

name

field Name

Name must be that of an exterior window with two or three glass layers.

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

class pyidf.thermal_zones_and_surfaces.WindowPropertyFrameAndDivider

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowProperty:FrameAndDivider Specifies the dimensions of a window frame, dividers, and inside reveal surfaces. Referenced by the surface objects for exterior windows and glass doors (ref: FenestrationSurface:Detailed, Window, and GlazedDoor).

divider_conductance

field Divider Conductance

Effective conductance of divider

Excludes air films

Obtained from WINDOW 5 or other 2-D calculation

Units: W/m2-K

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

divider_inside_projection

field Divider Inside Projection

Amount that divider projects inward from the inside face of the glazing

Inside projection assumed the same for all divider elements

Units: m

value <= 0.5

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

divider_outside_projection

field Divider Outside Projection

Amount that divider projects outward from the outside face of the glazing

Outside projection assumed the same for all divider elements

Units: m

value <= 0.5

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

divider_solar_absorptance

field Divider Solar Absorptance

Assumed same on outside and inside of divider

value <= 1.0

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

divider_thermal_hemispherical_emissivity

field Divider Thermal Hemispherical Emissivity

Assumed same on outside and inside of divider

Default value: 0.9

value < 1.0

Parameters:value (float) – value for IDD Field Divider Thermal Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of divider_thermal_hemispherical_emissivity or None if not set Return type:float

divider_type

field Divider Type

Default value: DividedLite

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

divider_visible_absorptance

field Divider Visible Absorptance

Assumed same on outside and inside of divider

value <= 1.0

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

divider_width

field Divider Width

Width of dividers in plane of window

Width assumed the same for all dividers

Units: m

value <= 0.5

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

frame_conductance

field Frame Conductance

Effective conductance of frame

Excludes air films

Obtained from WINDOW 5 or other 2-D calculation

Units: W/m2-K

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

frame_inside_projection

field Frame Inside Projection

Amount that frame projects inward from the inside face of the glazing

Units: m

value <= 0.5

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

frame_outside_projection

field Frame Outside Projection

Amount that frame projects outward from the outside face of the glazing

Units: m

value <= 0.5

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

frame_solar_absorptance

field Frame Solar Absorptance

Assumed same on outside and inside of frame

Default value: 0.7

value <= 1.0

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

frame_thermal_hemispherical_emissivity

field Frame Thermal Hemispherical Emissivity

Assumed same on outside and inside of frame

Default value: 0.9

Parameters:value (float) – value for IDD Field Frame Thermal Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of frame_thermal_hemispherical_emissivity or None if not set Return type:float

frame_visible_absorptance

field Frame Visible Absorptance

Assumed same on outside and inside of frame

Default value: 0.7

value <= 1.0

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

frame_width

field Frame Width

Width of frame in plane of window

Frame width assumed the same on all sides of window

Units: m

value <= 1.0

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

inside_reveal_depth

field Inside Reveal Depth

Distance from plane of inside surface of glazing

to plane of inside surface of wall.

Outside reveal depth is determined from the geometry

of the window and the wall it is on; it is non-zero if the plane of

the outside surface of the glazing is set back from the plane of the

outside surface of the wall.

Units: m

value <= 2.0

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

inside_reveal_solar_absorptance

field Inside Reveal Solar Absorptance

value <= 1.0

Parameters:value (float) – value for IDD Field Inside Reveal Solar Absorptance Raises:ValueError – if value is not a valid value Returns:the value of inside_reveal_solar_absorptance or None if not set Return type:float

inside_sill_depth

field Inside Sill Depth

Units: m

value <= 2.0

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

inside_sill_solar_absorptance

field Inside Sill Solar Absorptance

value <= 1.0

Parameters:value (float) – value for IDD Field Inside Sill Solar Absorptance Raises:ValueError – if value is not a valid value Returns:the value of inside_sill_solar_absorptance or None if not set Return type:float

name

field Name

Referenced by surfaces that are exterior windows

Not used by interzone windows

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_horizontal_dividers

field Number of Horizontal Dividers

“Horizontal” means parallel to local window X-axis

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

number_of_vertical_dividers

field Number of Vertical Dividers

“Vertical” means parallel to local window Y-axis

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

outside_reveal_solar_absorptance

field Outside Reveal Solar Absorptance

value <= 1.0

Parameters:value (float) – value for IDD Field Outside Reveal Solar Absorptance Raises:ValueError – if value is not a valid value Returns:the value of outside_reveal_solar_absorptance or None if not set Return type:float

ratio_of_divideredge_glass_conductance_to_centerofglass_conductance

field Ratio of Divider-Edge Glass Conductance to Center-Of-Glass Conductance

Excludes air films

Obtained from WINDOW 5 or other 2-D calculation

Default value: 1.0

value <= 4.0

Parameters:value (float) – value for IDD Field Ratio of Divider-Edge Glass Conductance to Center-Of-Glass Conductance Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_divideredge_glass_conductance_to_centerofglass_conductance or None if not set Return type:float

ratio_of_frameedge_glass_conductance_to_centerofglass_conductance

field Ratio of Frame-Edge Glass Conductance to Center-Of-Glass Conductance

Excludes air films; applies only to multipane windows

Obtained from WINDOW 5 or other 2-D calculation

Default value: 1.0

value <= 4.0

Parameters:value (float) – value for IDD Field Ratio of Frame-Edge Glass Conductance to Center-Of-Glass Conductance Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_frameedge_glass_conductance_to_centerofglass_conductance or None if not set Return type:float

class pyidf.thermal_zones_and_surfaces.WindowPropertyShadingControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowProperty:ShadingControl Specifies the type, location, and controls for window shades, window blinds, and switchable glazing. Referenced by the surface objects for exterior windows and glass doors (ref: FenestrationSurface:Detailed, Window, and GlazedDoor).

construction_with_shading_name

field Construction with Shading Name

Required if Shading Type = SwitchableGlazing

Required if Shading Type = interior or exterior shade or blind, or exterior screen, and

“Shading Device Material Name” is not specified.

If both “Construction with Shading Name” and “Shading Device Material Name” are entered,

the former takes precedence.

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

glare_control_is_active

field Glare Control Is Active

If Yes and window is in a daylit zone, shading is on if zone’s discomfort glare index exceeds

the maximum discomfort glare index specified in the Daylighting object referenced by the zone.

The glare test is OR’ed with the test specified by Shading Control Type.

Glare Control Is Active = Yes is required if Shading Control Type = OnIfHighGlare.

Default value: No

Parameters:value (str) – value for IDD Field Glare Control Is Active Raises:ValueError – if value is not a valid value Returns:the value of glare_control_is_active or None if not set Return type:str

name

field Name

Referenced by surfaces that are exterior windows

Not used by interzone windows

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

schedule_name

field Schedule Name

Required if Shading Control Is Scheduled = Yes.

If schedule value = 1, shading control is active, i.e., shading can take place only

if the control test passes. If schedule value = 0, shading is off whether or not

the control test passes. Schedule Name is required if Shading Control Is Scheduled = Yes.

If Schedule Name is not specified, shading control is assumed to be active at all times.

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

setpoint

field Setpoint

W/m2 for solar-based controls, W for cooling- or heating-based controls,

deg C for temperature-based controls.

Unused for Shading Control Type = AlwaysOn, AlwaysOff, OnIfScheduleAllows,

OnIfHighGlare, Glare, and DaylightIlluminance

Units: W/m2, W or deg C

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

setpoint_2

field Setpoint 2

W/m2 for solar-based controls, deg C for temperature-based controls.

Used only as the second setpoint for the following two-setpoint control types:

OnIfHighOutdoorAirTempAndHighSolarOnWindow, OnIfHighOutdoorAirTempAndHighHorizontalSolar,

OnIfHighZoneAirTempAndHighSolarOnWindow, and OnIfHighZoneAirTempAndHighHorizontalSolar

Units: W/m2 or deg C

IP-Units: unknown

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

shading_control_is_scheduled

field Shading Control Is Scheduled

If Yes, Schedule Name is required; if No, Schedule Name is not used.

Shading Control Is Scheduled = Yes is required if Shading Control Type = OnIfScheduleAllows.

Default value: No

Parameters:value (str) – value for IDD Field Shading Control Is Scheduled Raises:ValueError – if value is not a valid value Returns:the value of shading_control_is_scheduled or None if not set Return type:str

shading_control_type

field Shading Control Type

OnIfScheduleAllows requires that Schedule Name be specified and

Shading Control Is Scheduled = Yes.

AlwaysOn, AlwaysOff and OnIfScheduleAllows are the only valid control types for ExteriorScreen.

The following six control types are used primarily to reduce

zone cooling load due to window solar gain

Following entry should be used only if Shading Type = SwitchableGlazing

and window is in a daylit zone

The following three control types are used to reduce zone Heating load. They can be

used with any Shading Type but are most appropriate for opaque interior or exterior

shades with high insulating value (“opaque movable insulation”)

The following two control types are used to reduce zone heating and cooling load.

They can be used with any Shading Type but are most appropriate for translucent interior

or exterior shades with high insulating value (“translucent movable insulation”)

The following two control types are used to reduce zone Cooling load.

They can be used with any Shading Type but are most appropriate for interior

or exterior blinds,interior or exterior shades with low insulating value, or

switchable glazing

The following four control types require that both Setpoint and Setpoint2 be specified

Setpoint will correspond to outdoor air temp or zone air temp (deg C)

Setpoint2 will correspond to solar on window or horizontal solar (W/m2)

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

shading_device_material_name

field Shading Device Material Name

Enter the name of a WindowMaterial:Shade, WindowMaterial:Screen or WindowMaterial:Blind object.

Required if “Construction with Shading Name” is not specified.

Not used if Shading Control Type = SwitchableGlazing, BetweenGlassShade, or BetweenGlassBlind.

If both “Construction with Shading Name” and “Shading Device Material Name” are entered,

the former takes precedence.

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

shading_type

field Shading Type

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

slat_angle_schedule_name

field Slat Angle Schedule Name

Used only if Shading Type = InteriorBlind, ExteriorBlind or BetweenGlassBlind.

Required if Type of Slat Angle Control for Blinds = ScheduledSlatAngle

Schedule values should be degrees (0 minimum, 180 maximum)

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

type_of_slat_angle_control_for_blinds

field Type of Slat Angle Control for Blinds

Used only if Shading Type = InteriorBlind, ExteriorBlind or BetweenGlassBlind.

If choice is ScheduledSlatAngle then Slat Angle Schedule Name is required.

Default value: FixedSlatAngle

Parameters:value (str) – value for IDD Field Type of Slat Angle Control for Blinds Raises:ValueError – if value is not a valid value Returns:the value of type_of_slat_angle_control_for_blinds or None if not set Return type:str

class pyidf.thermal_zones_and_surfaces.WindowPropertyStormWindow

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowProperty:StormWindow This is a movable exterior glass layer that is usually applied in the winter and removed in the summer.

day_of_month_that_storm_glass_layer_is_put_on

field Day of Month that Storm Glass Layer is Put On

value >= 1

value <= 31

Parameters:value (int) – value for IDD Field Day of Month that Storm Glass Layer is Put On Raises:ValueError – if value is not a valid value Returns:the value of day_of_month_that_storm_glass_layer_is_put_on or None if not set Return type:int

day_of_month_that_storm_glass_layer_is_taken_off

field Day of Month that Storm Glass Layer is Taken Off

value >= 1

value <= 31

Parameters:value (int) – value for IDD Field Day of Month that Storm Glass Layer is Taken Off Raises:ValueError – if value is not a valid value Returns:the value of day_of_month_that_storm_glass_layer_is_taken_off or None if not set Return type:int

distance_between_storm_glass_layer_and_adjacent_glass

field Distance Between Storm Glass Layer and Adjacent Glass

Units: m

Default value: 0.05

value <= 0.5

Parameters:value (float) – value for IDD Field Distance Between Storm Glass Layer and Adjacent Glass Raises:ValueError – if value is not a valid value Returns:the value of distance_between_storm_glass_layer_and_adjacent_glass or None if not set Return type:float

month_that_storm_glass_layer_is_put_on

field Month that Storm Glass Layer is Put On

value >= 1

value <= 12

Parameters:value (int) – value for IDD Field Month that Storm Glass Layer is Put On Raises:ValueError – if value is not a valid value Returns:the value of month_that_storm_glass_layer_is_put_on or None if not set Return type:int

month_that_storm_glass_layer_is_taken_off

field Month that Storm Glass Layer is Taken Off

value >= 1

value <= 12

Parameters:value (int) – value for IDD Field Month that Storm Glass Layer is Taken Off Raises:ValueError – if value is not a valid value Returns:the value of month_that_storm_glass_layer_is_taken_off or None if not set Return type:int

storm_glass_layer_name

field Storm Glass Layer Name

Must be a WindowMaterial:Glazing or WindowMaterial:Glazing:RefractionExtinctionMethod

Gap between storm glass layer and adjacent glass layer is assumed to be filled

with Air

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

window_name

field Window Name

Must be the name of a FenestrationSurface:Detailed object with Surface Type = WINDOW.

The WindowProperty:StormWindow object can only be used with exterior windows.

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.thermal_zones_and_surfaces.Zone

Bases: pyidf.helper.DataObject

Corresponds to IDD object Zone Defines a thermal zone of the building.

ceiling_height

field Ceiling Height

If this field is 0.0, negative or autocalculate, then the average height

of the zone is automatically calculated and used in subsequent calculations.

If this field is positive, then the number entered here will be used.

Note that the Zone Ceiling Height is the distance from the Floor to

the Ceiling in the Zone, not an absolute height from the ground.

Units: m

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Ceiling Height Raises:ValueError – if value is not a valid value Returns:the value of ceiling_height or None if not set Return type:float or “Autocalculate”

direction_of_relative_north

field Direction of Relative North

Units: deg

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

floor_area

field Floor Area

If this field is 0.0, negative or autocalculate, then the floor area of the zone

is automatically calculated and used in subsequent calculations.

If this field is positive, then the number entered here will be used.

Units: m2

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Floor Area Raises:ValueError – if value is not a valid value Returns:the value of floor_area or None if not set Return type:float or “Autocalculate”

multiplier

field Multiplier

Default value: 1

value >= 1

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

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

part_of_total_floor_area

field Part of Total Floor Area

Default value: Yes

Parameters:value (str) – value for IDD Field Part of Total Floor Area Raises:ValueError – if value is not a valid value Returns:the value of part_of_total_floor_area or None if not set Return type:str

type

field Type

Default value: 1

value >= 1

value <= 1

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

volume

field Volume

If this field is 0.0, negative or autocalculate, then the volume of the zone

is automatically calculated and used in subsequent calculations.

If this field is positive, then the number entered here will be used.

Units: m3

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Volume Raises:ValueError – if value is not a valid value Returns:the value of volume or None if not set Return type:float or “Autocalculate”

x_origin

field X Origin

Units: m

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

y_origin

field Y Origin

Units: m

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

z_origin

field Z Origin

Units: m

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

zone_inside_convection_algorithm

field Zone Inside Convection Algorithm

Will default to same value as SurfaceConvectionAlgorithm:Inside object

setting this field overrides the default SurfaceConvectionAlgorithm:Inside for this zone

Simple = constant natural convection (ASHRAE)

TARP = variable natural convection based on temperature difference (ASHRAE)

CeilingDiffuser = ACH based forced and mixed convection correlations

for ceiling diffuser configuration with simple natural convection limit

AdaptiveConvectionAlgorithm = dynamic selection of convection models based on conditions

TrombeWall = variable natural convection in an enclosed rectangular cavity

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

zone_outside_convection_algorithm

field Zone Outside Convection Algorithm

Will default to same value as SurfaceConvectionAlgorithm:Outside object

setting this field overrides the default SurfaceConvectionAlgorithm:Outside for this zone

SimpleCombined = Combined radiation and convection coefficient using simple ASHRAE model

TARP = correlation from models developed by ASHRAE, Walton, and Sparrow et. al.

MoWiTT = correlation from measurements by Klems and Yazdanian for smooth surfaces

DOE-2 = correlation from measurements by Klems and Yazdanian for rough surfaces

AdaptiveConvectionAlgorithm = dynamic selection of correlations based on conditions

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

class pyidf.thermal_zones_and_surfaces.ZoneGroup

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneGroup Adds a multiplier to a ZoneList. This can be used to reduce the amount of input necessary for simulating repetitive structures, such as the identical floors of a multi-story building.

name

field Name

Name of the Zone Group

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

zone_list_multiplier

field Zone List Multiplier

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Zone List Multiplier Raises:ValueError – if value is not a valid value Returns:the value of zone_list_multiplier or None if not set Return type:int

zone_list_name

field Zone List Name

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

class pyidf.thermal_zones_and_surfaces.ZoneList

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneList Defines a list of thermal zones which can be referenced as a group. The ZoneList name may be used elsewhere in the input to apply a parameter to all zones in the list. ZoneLists can be used effectively with the following objects: People, Lights, ElectricEquipment, GasEquipment, HotWaterEquipment, ZoneInfiltration:DesignFlowRate, ZoneVentilation:DesignFlowRate, Sizing:Zone, ZoneControl:Thermostat, and others.

add_extensible(zone_1_name=None)

Add values for extensible fields

Parameters:zone_1_name (str) – value for IDD Field Zone 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

Name of the Zone List

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