Thermal Zones and Surfaces¶

43 object types from idfpy.models.thermal_zones · EnergyPlus 26.2

Object	Summary
BuildingSurface:Detailed	Allows for detailed entry of building heat transfer surfaces.
Ceiling:Adiabatic	Allows for simplified entry of interior ceilings.
Ceiling:Interzone	Allows for simplified entry of ceilings using adjacent zone (interzone) heat transfer - adjacent surface …
Door	Allows for simplified entry of opaque Doors.
Door:Interzone	Allows for simplified entry of interzone (opaque interior) doors (adjacent to other zones).
FenestrationSurface:Detailed	Allows for detailed entry of subsurfaces (windows, doors, glass doors, tubular daylighting devices).
Floor:Adiabatic	Allows for simplified entry of exterior floors ignoring ground contact or interior floors.
Floor:Detailed	Allows for detailed entry of floor heat transfer surfaces.
Floor:GroundContact	Allows for simplified entry of exterior floors with ground contact.
Floor:Interzone	Allows for simplified entry of floors using adjacent zone (interzone) heat transfer - adjacent surface should …
GeometryTransform	Provides a simple method of altering the footprint geometry of a model.
GlazedDoor	Allows for simplified entry of glass Doors.
GlazedDoor:Interzone	Allows for simplified entry of interzone (glass interior) doors (adjacent to other zones).
GlobalGeometryRules	Specifies the geometric rules used to describe the input of surface vertices and daylighting reference points.
InternalMass	Used to describe internal zone surface area that does not need to be part of geometric representation.
Roof	Allows for simplified entry of roofs (exterior).
RoofCeiling:Detailed	Allows for detailed entry of roof/ceiling heat transfer surfaces.
Shading:Building	used for shading elements such as trees, other buildings, parts of this building not being modeled these …
Shading:Building:Detailed	used for shading elements such as trees, other buildings, parts of this building not being modeled these …
Shading:Fin	Fins are usually shading surfaces that are perpendicular to a window or door.
Shading:Fin:Projection	Fins are usually shading surfaces that are perpendicular to a window or door.
Shading:Overhang	Overhangs are usually flat shading surfaces that reference a window or door.
Shading:Overhang:Projection	Overhangs are typically flat shading surfaces that reference a window or door.
Shading:Site	used for shading elements such as trees these items are fixed in space and would not move with relative …
Shading:Site:Detailed	used for shading elements such as trees these items are fixed in space and would not move with relative …
Shading:Zone:Detailed	used For fins, overhangs, elements that shade the building, are attached to the building but are not part of …
ShadingProperty:Reflectance	If this object is not defined for a shading surface the default values listed in following fields will be …
Space	Defines a space (room) in the building.
SpaceList	Defines a list of Spaces which can be referenced as a group.
Wall:Adiabatic	Allows for simplified entry of interior walls.
Wall:Detailed	Allows for detailed entry of wall heat transfer surfaces.
Wall:Exterior	Allows for simplified entry of exterior walls.
Wall:Interzone	Allows for simplified entry of interzone walls (walls between zones).
Wall:Underground	Allows for simplified entry of underground walls.
Window	Allows for simplified entry of Windows.
Window:Interzone	Allows for simplified entry of interzone windows (adjacent to other zones).
WindowProperty:AirflowControl	Used to control forced airflow through a gap between glass layers
WindowProperty:FrameAndDivider	Specifies the dimensions of a window frame, dividers, and inside reveal surfaces.
WindowProperty:StormWindow	This is a movable exterior glass layer that is usually applied in the winter and removed in the summer.
WindowShadingControl	Specifies the type, location, and controls for window shades, window blinds, and switchable glazing.
Zone	Defines a thermal zone of the building.
ZoneGroup	Adds a multiplier to a ZoneList.
ZoneList	Defines a list of thermal zones which can be referenced as a group.

BuildingSurface:Detailed¶

from idfpy.models import BuildingSurfaceDetailed extensible

Allows for detailed entry of building heat transfer surfaces. Does not include subsurfaces such as windows or doors.

Field	Type	Default	Details
`name` Name required	string
`surface_type` Surface Type required	choice		One of `Ceiling`, `Floor`, `Roof`, `Wall`
`construction_name` Construction Name	reference		To be matched with a construction in this input file. If blank, a ConstructionAssignmentSet assigned to the surface's Space or Building is required. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition` Outside Boundary Condition required	choice		One of `Adiabatic`, `Foundation`, `Ground`, `GroundBasementPreprocessorAverageFloor`, `GroundBasementPreprocessorAverageWall`, `GroundBasementPreprocessorLowerWall`, `GroundBasementPreprocessorUpperWall`, `GroundFCfactorMethod`, `GroundSlabPreprocessorAverage`, `GroundSlabPreprocessorCore`, `GroundSlabPreprocessorPerimeter`, `OtherSideCoefficients`, `OtherSideConditionsModel`, `Outdoors`, `Space`, `Surface`, `Zone`
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		Non-blank only if the field Outside Boundary Condition is Surface, Zone, Space, 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 Foundation, specify the name of the corresponding Foundation object and the program will calculate the heat transfer appropriately If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`sun_exposure` Sun Exposure	choice	`SunExposed`	One of `NoSun`, `SunExposed`
`wind_exposure` Wind Exposure	choice	`WindExposed`	One of `NoWind`, `WindExposed`
`view_factor_to_ground` View Factor to Ground	number or `Autocalculate`	`Autocalculate`	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
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 57 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExposedFoundationPerimeter, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, SwimmingPool:Indoor, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Ceiling:Adiabatic¶

from idfpy.models import CeilingAdiabatic

Allows for simplified entry of interior ceilings.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of Ceiling Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`0.0`	Ceilings are usually tilted 0 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		If not Flat, Starting coordinate is the Lower Left Corner of the Ceiling
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 48 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Ceiling:Interzone¶

from idfpy.models import CeilingInterzone

Allows for simplified entry of ceilings using adjacent zone (interzone) heat transfer - adjacent surface should be a floor

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition_object` Outside Boundary Condition Object required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of wall (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`0.0`	Ceilings are usually tilted 0 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		If not Flat, should be Lower Left Corner (from outside)
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 55 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Door¶

from idfpy.models import Door

Allows for simplified entry of opaque Doors.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Door starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 50 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Door:Interzone¶

from idfpy.models import DoorInterzone

Allows for simplified entry of interzone (opaque interior) doors (adjacent to other zones).

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		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) Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Door starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 50 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

FenestrationSurface:Detailed¶

from idfpy.models import FenestrationSurfaceDetailed

Allows for detailed entry of subsurfaces (windows, doors, glass doors, tubular daylighting devices).

Field	Type	Default	Details
`name` Name required	string
`surface_type` Surface Type required	choice		Window is kept for backward compatibility and is treated as FixedWindow. Prefer FixedWindow, OperableWindow, or Skylight for new models. One of `Door`, `FixedWindow`, `GlassDoor`, `OperableWindow`, `OverheadDoor`, `Skylight`, `TubularDaylightDiffuser`, `TubularDaylightDome`, `Window`
`construction_name` Construction Name	reference		To be matched with a construction in this input file. If blank, a ConstructionAssignmentSet assigned to the surface's Space or Building is required. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:ComplexFenestrationState, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		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 Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`view_factor_to_ground` View Factor to Ground	number or `Autocalculate`	`Autocalculate`	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
`frame_and_divider_name` Frame and Divider Name	reference		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. Names a WindowProperty:FrameAndDivider
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertex_1_x_coordinate` Vertex 1 X-coordinate required	number m
`vertex_1_y_coordinate` Vertex 1 Y-coordinate required	number m
`vertex_1_z_coordinate` Vertex 1 Z-coordinate required	number m
`vertex_2_x_coordinate` Vertex 2 X-coordinate required	number m
`vertex_2_y_coordinate` Vertex 2 Y-coordinate required	number m
`vertex_2_z_coordinate` Vertex 2 Z-coordinate required	number m
`vertex_3_x_coordinate` Vertex 3 X-coordinate required	number m
`vertex_3_y_coordinate` Vertex 3 Y-coordinate required	number m
`vertex_3_z_coordinate` Vertex 3 Z-coordinate required	number m
`vertex_4_x_coordinate` Vertex 4 X-coordinate	number m		Not used for triangles
`vertex_4_y_coordinate` Vertex 4 Y-coordinate	number m		Not used for triangles
`vertex_4_z_coordinate` Vertex 4 Z-coordinate	number m		Not used for triangles

Referenced by 51 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, WindowShadingControl, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Floor:Adiabatic¶

from idfpy.models import FloorAdiabatic

Allows for simplified entry of exterior floors ignoring ground contact or interior floors. View Factor to Ground is automatically calculated.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`180.0`	Floors are usually tilted 180 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		if not flat, should be lower left corner (from outside)
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 50 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExposedFoundationPerimeter, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, SwimmingPool:Indoor, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Floor:Detailed¶

from idfpy.models import FloorDetailed extensible

Allows for detailed entry of floor heat transfer surfaces.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition` Outside Boundary Condition required	choice		One of `Adiabatic`, `Foundation`, `Ground`, `GroundBasementPreprocessorAverageFloor`, `GroundBasementPreprocessorAverageWall`, `GroundBasementPreprocessorLowerWall`, `GroundBasementPreprocessorUpperWall`, `GroundFCfactorMethod`, `GroundSlabPreprocessorAverage`, `GroundSlabPreprocessorCore`, `GroundSlabPreprocessorPerimeter`, `OtherSideCoefficients`, `OtherSideConditionsModel`, `Outdoors`, `Space`, `Surface`, `Zone`
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		Non-blank only if the field Outside Boundary Condition is Surface, Zone, Space, 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 Foundation, specify the name of the corresponding Foundation object and If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`sun_exposure` Sun Exposure	choice	`SunExposed`	One of `NoSun`, `SunExposed`
`wind_exposure` Wind Exposure	choice	`WindExposed`	One of `NoWind`, `WindExposed`
`view_factor_to_ground` View Factor to Ground	number or `Autocalculate`	`Autocalculate`	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
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 57 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExposedFoundationPerimeter, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, SwimmingPool:Indoor, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Floor:GroundContact¶

from idfpy.models import FloorGroundContact

Allows for simplified entry of exterior floors with ground contact. View Factors to Ground is automatically calculated.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file If the construction is type "Construction:FfactorGroundFloor", then the GroundFCfactorMethod will be used. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`180.0`	Floors are usually tilted 180 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		if not flat, should be lower left corner (from outside)
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 50 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExposedFoundationPerimeter, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, SwimmingPool:Indoor, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Floor:Interzone¶

from idfpy.models import FloorInterzone

Allows for simplified entry of floors using adjacent zone (interzone) heat transfer - adjacent surface should be a ceiling.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone for the inside face of the surface. Names a Zone
`space_name` Space Name	reference		Space for the inside face of the surface (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition_object` Outside Boundary Condition Object required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`azimuth_angle` Azimuth Angle	number deg		Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`180.0`	Floors are usually tilted 180 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		If not Flat, should be Lower Left Corner (from outside)
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 57 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExposedFoundationPerimeter, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, SwimmingPool:Indoor, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

GeometryTransform¶

from idfpy.models import GeometryTransform unique

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.

Field	Type	Default	Details
`plane_of_transform` Plane of Transform	choice	`XY`	only current allowed value is "XY" One of `XY`
`current_aspect_ratio` Current Aspect Ratio required	number		Aspect ratio of building as described in idf Range: > 0
`new_aspect_ratio` New Aspect Ratio required	number		Aspect ratio to transform to during run Range: > 0

GlazedDoor¶

from idfpy.models import GlazedDoor

Allows for simplified entry of glass Doors.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`frame_and_divider_name` Frame and Divider Name	reference		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. Names a WindowProperty:FrameAndDivider
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Door starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 45 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, WindowShadingControl, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneProperty:UserViewFactors:BySurfaceName

GlazedDoor:Interzone¶

from idfpy.models import GlazedDoorInterzone

Allows for simplified entry of interzone (glass interior) doors (adjacent to other zones).

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		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) Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Door starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Door starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 44 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneProperty:UserViewFactors:BySurfaceName

GlobalGeometryRules¶

from idfpy.models import GlobalGeometryRules unique

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

Field	Type	Default	Details
`starting_vertex_position` Starting Vertex Position required	choice		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) One of `LowerLeftCorner`, `LowerRightCorner`, `UpperLeftCorner`, `UpperRightCorner`
`vertex_entry_direction` Vertex Entry Direction required	choice		One of `Clockwise`, `Counterclockwise`
`coordinate_system` Coordinate System required	choice		Relative -- coordinates are entered relative to zone origin World -- all coordinates entered are "absolute" for this facility One of `Relative`, `World`
`daylighting_reference_point_coordinate_system` Daylighting Reference Point Coordinate System	choice	`Relative`	Relative -- coordinates are entered relative to zone origin World -- all coordinates entered are "absolute" for this facility One of `Relative`, `World`
`rectangular_surface_coordinate_system` Rectangular Surface Coordinate System	choice	`Relative`	Relative -- Starting corner is entered relative to zone origin World -- Starting corner is entered in "absolute" One of `Relative`, `World`

InternalMass¶

from idfpy.models import 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. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList. Likewise for SpaceList.

Field	Type	Details
`name` Name required	string
`construction_name` Construction Name	reference	To be matched with a construction in this input file. If blank, a ConstructionAssignmentSet assigned to the surface's Space or Building is required. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_or_zonelist_name` Zone or ZoneList Name	reference	Zone(s) the surface is a part of. This field is ignored when a Space or SpaceList Name is specified. Names a Zone, ZoneList
`space_or_spacelist_name` Space or SpaceList Name	reference	Space(s) the surface is a part of. This field is ignored when a ZoneList Name is specified for Zone or ZoneList Name. An internal mass surface will be added to every Space in every Zone in the ZoneList. Names a Space, SpaceList
`surface_area` Surface Area required	number m2	Range: > 0

Referenced by 17 object types

AirflowNetwork:Distribution:DuctViewFactors, ComfortViewFactorAngles, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:LocalEnvironment, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Roof¶

from idfpy.models import Roof

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

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of Roof Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`0.0`	Flat Roofs are tilted 0 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		If not Flat, Starting coordinate is the Lower Left Corner of the Roof
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m		Along X Axis
`width` Width	number m		Along Y Axis

Referenced by 48 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

RoofCeiling:Detailed¶

from idfpy.models import RoofCeilingDetailed extensible

Allows for detailed entry of roof/ceiling heat transfer surfaces.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition` Outside Boundary Condition required	choice		One of `Adiabatic`, `Ground`, `GroundBasementPreprocessorAverageFloor`, `GroundBasementPreprocessorAverageWall`, `GroundBasementPreprocessorLowerWall`, `GroundBasementPreprocessorUpperWall`, `GroundSlabPreprocessorAverage`, `GroundSlabPreprocessorCore`, `GroundSlabPreprocessorPerimeter`, `OtherSideCoefficients`, `OtherSideConditionsModel`, `Outdoors`, `Space`, `Surface`, `Zone`
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		Non-blank only if the field Outside Boundary Condition is Surface, Zone, Space, 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 Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`sun_exposure` Sun Exposure	choice	`SunExposed`	One of `NoSun`, `SunExposed`
`wind_exposure` Wind Exposure	choice	`WindExposed`	One of `NoWind`, `WindExposed`
`view_factor_to_ground` View Factor to Ground	number or `Autocalculate`	`Autocalculate`	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
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 55 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Shading:Building¶

from idfpy.models import ShadingBuilding

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

Field	Type	Default	Details
`name` Name required	string
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of shading device (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting coordinate is the Lower Left Corner of the Shade
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 9 object types

Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Building:Detailed¶

from idfpy.models import ShadingBuildingDetailed extensible

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

Field	Type	Default	Details
`name` Name required	string
`transmittance_schedule_name` Transmittance Schedule Name	reference		Transmittance schedule for the shading device, defaults to zero (always opaque) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 9 object types

Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Fin¶

from idfpy.models import ShadingFin

Fins are usually shading surfaces that are perpendicular to a window or door.

Field	Type	Default	Details
`name` Name required	string
`window_or_door_name` Window or Door Name required	reference		Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`left_extension_from_window_door` Left Extension from Window/Door	number m
`left_distance_above_top_of_window` Left Distance Above Top of Window	number m
`left_distance_below_bottom_of_window` Left Distance Below Bottom of Window	number m		N2 + N3 + height of Window/Door is height of Fin
`left_tilt_angle_from_window_door` Left Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`left_depth` Left Depth	number m		Range: ≥ 0
`right_extension_from_window_door` Right Extension from Window/Door	number m
`right_distance_above_top_of_window` Right Distance Above Top of Window	number m
`right_distance_below_bottom_of_window` Right Distance Below Bottom of Window	number m		N7 + N8 + height of Window/Door is height of Fin
`right_tilt_angle_from_window_door` Right Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`right_depth` Right Depth	number m		Range: ≥ 0

Referenced by 10 object types

DaylightingDevice:Shelf, Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Fin:Projection¶

from idfpy.models import ShadingFinProjection

Fins are usually shading surfaces that are perpendicular to a window or door.

Field	Type	Default	Details
`name` Name required	string
`window_or_door_name` Window or Door Name required	reference		Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`left_extension_from_window_door` Left Extension from Window/Door	number m
`left_distance_above_top_of_window` Left Distance Above Top of Window	number m
`left_distance_below_bottom_of_window` Left Distance Below Bottom of Window	number m		N2 + N3 + height of Window/Door is height of Fin
`left_tilt_angle_from_window_door` Left Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`left_depth_as_fraction_of_window_door_width` Left Depth as Fraction of Window/Door Width	number dimensionless		Range: ≥ 0
`right_extension_from_window_door` Right Extension from Window/Door	number m
`right_distance_above_top_of_window` Right Distance Above Top of Window	number m
`right_distance_below_bottom_of_window` Right Distance Below Bottom of Window	number m		N7 + N8 + height of Window/Door is height of Fin
`right_tilt_angle_from_window_door` Right Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`right_depth_as_fraction_of_window_door_width` Right Depth as Fraction of Window/Door Width	number dimensionless		Range: ≥ 0

Referenced by 10 object types

DaylightingDevice:Shelf, Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Overhang¶

from idfpy.models import ShadingOverhang

Overhangs are usually flat shading surfaces that reference a window or door.

Field	Type	Default	Details
`name` Name required	string
`window_or_door_name` Window or Door Name required	reference		Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`height_above_window_or_door` Height above Window or Door	number m
`tilt_angle_from_window_door` Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`left_extension_from_window_door_width` Left extension from Window/Door Width	number m
`right_extension_from_window_door_width` Right extension from Window/Door Width	number m		N3 + N4 + Window/Door Width is Overhang Length
`depth` Depth	number m		Range: ≥ 0

Referenced by 10 object types

DaylightingDevice:Shelf, Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Overhang:Projection¶

from idfpy.models import ShadingOverhangProjection

Overhangs are typically flat shading surfaces that reference a window or door.

Field	Type	Default	Details
`name` Name required	string
`window_or_door_name` Window or Door Name required	reference		Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`height_above_window_or_door` Height above Window or Door	number m
`tilt_angle_from_window_door` Tilt Angle from Window/Door	number deg	`90.0`	Range: ≥ 0, ≤ 180
`left_extension_from_window_door_width` Left extension from Window/Door Width	number m
`right_extension_from_window_door_width` Right extension from Window/Door Width	number m		N3 + N4 + Window/Door Width is Overhang Length
`depth_as_fraction_of_window_door_height` Depth as Fraction of Window/Door Height	number dimensionless		Range: ≥ 0

Referenced by 10 object types

DaylightingDevice:Shelf, Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Site¶

from idfpy.models import ShadingSite

used for shading elements such as trees these items are fixed in space and would not move with relative geometry

Field	Type	Default	Details
`name` Name required	string
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of shading device (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting coordinate is the Lower Left Corner of the Shade
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 9 object types

Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Site:Detailed¶

from idfpy.models import ShadingSiteDetailed extensible

used for shading elements such as trees these items are fixed in space and would not move with relative geometry

Field	Type	Default	Details
`name` Name required	string
`transmittance_schedule_name` Transmittance Schedule Name	reference		Transmittance schedule for the shading device, defaults to zero (always opaque) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 9 object types

Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

Shading:Zone:Detailed¶

from idfpy.models import ShadingZoneDetailed extensible

used For fins, overhangs, elements that shade the building, are attached to the building but are not part of the heat transfer calculations

Field	Type	Default	Details
`name` Name required	string
`base_surface_name` Base Surface Name required	reference		Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`transmittance_schedule_name` Transmittance Schedule Name	reference		Transmittance schedule for the shading device, defaults to zero (always opaque) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 10 object types

DaylightingDevice:Shelf, Generator:PVWatts, Generator:Photovoltaic, ShadingProperty:Reflectance, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceProperty:ExteriorNaturalVentedCavity, WaterUse:RainCollector

ShadingProperty:Reflectance¶

from idfpy.models import ShadingPropertyReflectance

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.

Field	Type	Default	Details
`shading_surface_name` Shading Surface Name required	reference		Names a Shading:Building, Shading:Building:Detailed, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, Shading:Site, Shading:Site:Detailed, Shading:Zone:Detailed
`diffuse_solar_reflectance_of_unglazed_part_of_shading_surface` Diffuse Solar Reflectance of Unglazed Part of Shading Surface	number	`0.2`	Range: ≥ 0, ≤ 1
`diffuse_visible_reflectance_of_unglazed_part_of_shading_surface` Diffuse Visible Reflectance of Unglazed Part of Shading Surface	number	`0.2`	Range: ≥ 0, ≤ 1
`fraction_of_shading_surface_that_is_glazed` Fraction of Shading Surface That Is Glazed	number	`0.0`	Range: ≥ 0, ≤ 1
`glazing_construction_name` Glazing Construction Name	string		Required if Fraction of Shading Surface That Is Glazed > 0.0

Space¶

from idfpy.models import Space extensible

Defines a space (room) in the building. All Spaces are part of a Zone. Every Zone contains one or more spaces. Space is an optional input. If a Zone has no Space(s) specified in input then a default Space named <Zone Name> will be created. If some surfaces in a Zone are assigned to a space and some are not, then a default Space named <Zone Name>-Remainder will be created. Input references to Space Names must have a matching Space object (default space names may not be referenced except in output variable keys).

Field	Type	Default	Details
`name` Name required	string		Name of the Space. This name must be unique across Zone, Space, ZoneList, and SpaceList names.
`zone_name` Zone Name required	reference		Names a Zone
`ceiling_height` Ceiling Height	number or `Autocalculate` m	`Autocalculate`	If this field is 0.0, negative or autocalculate, then the average height of the space is automatically calculated and used in subsequent calculations. If this field is positive, then the number entered here will be used. Note that the Space Ceiling Height is the distance from the Floor to the Ceiling in the Space, not an absolute height from the ground.
`volume` Volume	number or `Autocalculate` m3	`Autocalculate`	If this field is 0.0, negative or autocalculate, then the volume of the space is automatically calculated and used in subsequent calculations. If this field is positive, then the number entered here will be used.
`floor_area` Floor Area	number or `Autocalculate` m2	`Autocalculate`	If this field is 0.0, negative or autocalculate, then the floor area of the space is automatically calculated and used in subsequent calculations. If this field is positive, then the number entered here will be used.
`space_type` Space Type	string	`General`	Space type is used to tag spaces by activity type, such as office, classroom, storage, etc.
`construction_assignment_set_name` Construction Assignment Set Name	reference		Optional. Overrides the Building-level Construction Assignment Set for surfaces in this Space. Names a ConstructionAssignmentSet
`tags`	list		Each item: `tag`

Referenced by 56 object types

BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Daylighting:Controls, Daylighting:ReferencePoint, DesignSpecification:OutdoorAir:SpaceList, Door:Interzone, ElectricEquipment, ElectricEquipment:ITE:AirCooled, ElectricEquipment:ITE:AirCooled:Instance, ElectricEquipment:Instance, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GasEquipment, GasEquipment:Instance, GlazedDoor:Interzone, HotWaterEquipment, HotWaterEquipment:Instance, InternalMass, Lights, Lights:Instance, OtherEquipment, OtherEquipment:Instance, Output:IlluminanceMap, People, People:Instance, Roof, RoofCeiling:Detailed, SpaceHVAC:EquipmentConnections, SpaceHVAC:ZoneEquipmentMixer, SpaceHVAC:ZoneEquipmentSplitter, SpaceHVAC:ZoneReturnMixer, SpaceList, SteamEquipment, SteamEquipment:Instance, Wall:Adiabatic, Wall:Detailed, Wall:Exterior, Wall:Interzone, Wall:Underground, Window:Interzone, ZoneBaseboard:OutdoorTemperatureControlled, ZoneCoolTower:Shower, ZoneCrossMixing, ZoneInfiltration:DesignFlowRate, ZoneInfiltration:EffectiveLeakageArea, ZoneInfiltration:FlowCoefficient, ZoneMixing, ZoneProperty:UserViewFactors:BySurfaceName, ZoneRefrigerationDoorMixing, ZoneThermalChimney, ZoneVentilation:DesignFlowRate, ZoneVentilation:WindandStackOpenArea

SpaceList¶

from idfpy.models import SpaceList extensible

Defines a list of Spaces which can be referenced as a group. The SpaceList name may be used elsewhere in the input to apply a parameter to all Spaces in the list. SpaceLists can be used effectively with the following objects: InternalMass, People, Lights, ElectricEquipment, GasEquipment, HotWaterEquipment, and others.

Field	Type	Default	Details
`name` Name required	string		Name of the SpaceList. This name must be unique across Zone, Space, ZoneList, and SpaceList names.
`spaces`	list		Each item: `space_name`

Referenced by 19 object types

ElectricEquipment, ElectricEquipment:Instance, GasEquipment, GasEquipment:Instance, HotWaterEquipment, HotWaterEquipment:Instance, InternalMass, Lights, Lights:Instance, OtherEquipment, OtherEquipment:Instance, People, People:Instance, SteamEquipment, SteamEquipment:Instance, ZoneBaseboard:OutdoorTemperatureControlled, ZoneInfiltration:DesignFlowRate, ZoneProperty:UserViewFactors:BySurfaceName, ZoneVentilation:DesignFlowRate

Wall:Adiabatic¶

from idfpy.models import WallAdiabatic

Allows for simplified entry of interior walls.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of wall (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Walls are usually tilted 90 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting (x,y,z) coordinate is the Lower Left Corner of the Wall
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 48 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Wall:Detailed¶

from idfpy.models import WallDetailed extensible

Allows for detailed entry of wall heat transfer surfaces.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition` Outside Boundary Condition required	choice		One of `Adiabatic`, `Foundation`, `Ground`, `GroundBasementPreprocessorAverageFloor`, `GroundBasementPreprocessorAverageWall`, `GroundBasementPreprocessorLowerWall`, `GroundBasementPreprocessorUpperWall`, `GroundFCfactorMethod`, `GroundSlabPreprocessorAverage`, `GroundSlabPreprocessorCore`, `GroundSlabPreprocessorPerimeter`, `OtherSideCoefficients`, `OtherSideConditionsModel`, `Outdoors`, `Space`, `Surface`, `Zone`
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		Non-blank only if the field Outside Boundary Condition is Surface, Zone, Space, 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 Foundation, specify the name of the corresponding Foundation object and If OtherSideCoefficients, specify name of SurfaceProperty:OtherSideCoefficients If OtherSideConditionsModel, specify name of SurfaceProperty:OtherSideConditionsModel Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`sun_exposure` Sun Exposure	choice	`SunExposed`	One of `NoSun`, `SunExposed`
`wind_exposure` Wind Exposure	choice	`WindExposed`	One of `NoWind`, `WindExposed`
`view_factor_to_ground` View Factor to Ground	number or `Autocalculate`	`Autocalculate`	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
`number_of_vertices` Number of Vertices	number or `Autocalculate`	`Autocalculate`	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.
`vertices`	list		Each item: `vertex_x_coordinate` (m), `vertex_y_coordinate` (m), `vertex_z_coordinate` (m)

Referenced by 55 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Wall:Exterior¶

from idfpy.models import WallExterior

Allows for simplified entry of exterior walls. View Factor to Ground is automatically calculated.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of wall (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Walls are usually tilted 90 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting (x,y,z) coordinate is the Lower Left Corner of the Wall
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 48 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Wall:Interzone¶

from idfpy.models import WallInterzone

Allows for simplified entry of interzone walls (walls between zones).

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone for the inside face of the surface. Names a Zone
`space_name` Space Name	reference		Space for the inside face of the surface (optional, see description of Space object for more details). Names a Space
`outside_boundary_condition_object` Outside Boundary Condition Object required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of wall (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Walls are usually tilted 90 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting (x,y,z) coordinate is the Lower Left Corner of the Wall
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 55 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Wall:Underground¶

from idfpy.models import WallUnderground

Allows for simplified entry of underground walls.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file. If the construction is type "Construction:CfactorUndergroundWall", then the GroundFCfactorMethod will be used. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`zone_name` Zone Name required	reference		Zone the surface is a part of. Names a Zone
`space_name` Space Name	reference		Space the surface is a part of (optional, see description of Space object for more details). Names a Space
`azimuth_angle` Azimuth Angle	number deg		Facing direction of outside of wall (S=180,N=0,E=90,W=270) Range: ≥ 0, ≤ 360
`tilt_angle` Tilt Angle	number deg	`90.0`	Walls are usually tilted 90 degrees Range: ≥ 0, ≤ 180
`starting_x_coordinate` Starting X Coordinate	number m		Starting (x,y,z) coordinate is the Lower Left Corner of the Wall
`starting_y_coordinate` Starting Y Coordinate	number m
`starting_z_coordinate` Starting Z Coordinate	number m
`length` Length	number m
`height` Height	number m

Referenced by 48 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, ComfortViewFactorAngles, Daylighting:DELight:ComplexFenestration, DaylightingDevice:Shelf, Door, Door:Interzone, FenestrationSurface:Detailed, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor, GlazedDoor:Interzone, IndoorLivingWall, People, People:Instance, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Zone:Detailed, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion, SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceControl:MovableInsulation, SurfaceProperties:VaporCoefficients, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:HeatBalanceSourceTerm, SurfaceProperty:HeatTransferAlgorithm, SurfaceProperty:HeatTransferAlgorithm:SurfaceList, SurfaceProperty:IncidentSolarMultiplier, SurfaceProperty:LocalEnvironment, SurfaceProperty:SolarIncidentInside, WaterUse:RainCollector, Window, Window:Interzone, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneHVAC:LowTemperatureRadiant:ConstantFlow, ZoneHVAC:LowTemperatureRadiant:Electric, ZoneHVAC:LowTemperatureRadiant:SurfaceGroup, ZoneHVAC:LowTemperatureRadiant:VariableFlow, ZoneHVAC:VentilatedSlab, ZoneHVAC:VentilatedSlab:SlabGroup, ZoneProperty:UserViewFactors:BySurfaceName

Window¶

from idfpy.models import Window

Allows for simplified entry of Windows.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`frame_and_divider_name` Frame and Divider Name	reference		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. Names a WindowProperty:FrameAndDivider
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Window starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Window starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 45 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, WindowShadingControl, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneProperty:UserViewFactors:BySurfaceName

Window:Interzone¶

from idfpy.models import WindowInterzone

Allows for simplified entry of interzone windows (adjacent to other zones).

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		To be matched with a construction in this input file Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`building_surface_name` Building Surface Name required	reference		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. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`outside_boundary_condition_object` Outside Boundary Condition Object	reference		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) Names a BuildingSurface:Detailed, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Foundation:Kiva, GlazedDoor, GlazedDoor:Interzone, RoofCeiling:Detailed, Space and 7 more
`multiplier` Multiplier	number	`1.0`	Used only for Surface Type = WINDOW, GLASSDOOR or DOOR Non-integer values will be truncated to integer Range: ≥ 1
`starting_x_coordinate` Starting X Coordinate	number m		Window starting coordinate is specified relative to the Base Surface origin.
`starting_z_coordinate` Starting Z Coordinate	number m		How far up the wall the Window starts. (in 2-d, this would be a Y Coordinate)
`length` Length	number m
`height` Height	number m

Referenced by 44 object types

AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:MultiZone:Surface, BuildingSurface:Detailed, Ceiling:Interzone, ComfortViewFactorAngles, ComplexFenestrationProperty:SolarAbsorbedLayers, Daylighting:DELight:ComplexFenestration, DaylightingDevice:LightWell, DaylightingDevice:Shelf, DaylightingDevice:Tubular, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, Generator:PVWatts, Generator:Photovoltaic, GlazedDoor:Interzone, People, People:Instance, RoofCeiling:Detailed, RoomAir:Node, RoomAir:Node:AirflowNetwork:AdjacentSurfaceList, RoomAir:TemperaturePattern:SurfaceMapping, Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, SolarCollector:FlatPlate:PhotovoltaicThermal, SolarCollector:FlatPlate:Water, SolarCollector:IntegralCollectorStorage, SolarCollector:UnglazedTranspired, SurfaceContaminantSourceAndSink:Generic:PressureDriven, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ExteriorNaturalVentedCavity, SurfaceProperty:LocalEnvironment, Wall:Detailed, Wall:Interzone, WaterUse:RainCollector, Window:Interzone, WindowProperty:AirflowControl, WindowProperty:StormWindow, ZoneHVAC:Baseboard:RadiantConvective:Electric, ZoneProperty:UserViewFactors:BySurfaceName

WindowProperty:AirflowControl¶

from idfpy.models import WindowPropertyAirflowControl

Used to control forced airflow through a gap between glass layers

Field	Type	Default	Details
`name` Name required	reference		Name must be that of an exterior window with two or three glass layers. Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`airflow_source` Airflow Source	choice	`IndoorAir`	One of `IndoorAir`, `OutdoorAir`
`airflow_destination` Airflow Destination	choice	`OutdoorAir`	If ReturnAir is selected, the name of the Return Air Node may be specified below. One of `IndoorAir`, `OutdoorAir`, `ReturnAir`
`maximum_flow_rate` Maximum Flow Rate	number m3/s-m	`0.0`	Above is m3/s per m of glazing width Range: ≥ 0
`airflow_control_type` Airflow Control Type	choice	`AlwaysOnAtMaximumFlow`	ScheduledOnly requires that Airflow Has Multiplier Schedule Name = Yes and that Airflow Multiplier Schedule Name is specified. One of `AlwaysOff`, `AlwaysOnAtMaximumFlow`, `ScheduledOnly`
`airflow_is_scheduled` Airflow Is Scheduled	choice	`No`	If Yes, then Airflow Multiplier Schedule Name must be specified One of `No`, `Yes`
`airflow_multiplier_schedule_name` Airflow Multiplier Schedule Name	reference		Required if Airflow Is Scheduled = Yes. Schedule values are 0.0 or 1.0 and multiply Maximum Air Flow. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`airflow_return_air_node_name` Airflow Return Air Node Name	string		Name of the return air node for this airflow window if the Airflow Destination is ReturnAir. If left blank, defaults to the first return air node for the zone of the window surface.

WindowProperty:FrameAndDivider¶

from idfpy.models import WindowPropertyFrameAndDivider

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).

Field	Type	Default	Details
`name` Name required	string		Referenced by surfaces that are exterior windows Not used by interzone windows
`frame_width` Frame Width	number m	`0.0`	Width of frame in plane of window Frame width assumed the same on all sides of window Range: ≥ 0, ≤ 1
`frame_outside_projection` Frame Outside Projection	number m	`0.0`	Amount that frame projects outward from the outside face of the glazing Range: ≥ 0, ≤ 0.5
`frame_inside_projection` Frame Inside Projection	number m	`0.0`	Amount that frame projects inward from the inside face of the glazing Range: ≥ 0, ≤ 0.5
`frame_conductance` Frame Conductance	number W/m2-K	`0.0`	Effective conductance of frame Excludes air films Obtained from WINDOW 5 or other 2-D calculation Range: ≥ 0
`ratio_of_frame_edge_glass_conductance_to_center_of_glass_conductance` Ratio of Frame-Edge Glass Conductance to Center-Of-Glass Conductance	number	`1.0`	Excludes air films; applies only to multipane windows Obtained from WINDOW 5 or other 2-D calculation Range: > 0, ≤ 4
`frame_solar_absorptance` Frame Solar Absorptance	number	`0.7`	Assumed same on outside and inside of frame Range: ≥ 0, ≤ 1
`frame_visible_absorptance` Frame Visible Absorptance	number	`0.7`	Assumed same on outside and inside of frame Range: ≥ 0, ≤ 1
`frame_thermal_hemispherical_emissivity` Frame Thermal Hemispherical Emissivity	number	`0.9`	Assumed same on outside and inside of frame Range: > 0
`divider_type` Divider Type	choice	`DividedLite`	One of `DividedLite`, `Suspended`
`divider_width` Divider Width	number m	`0.0`	Width of dividers in plane of window Width assumed the same for all dividers Range: ≥ 0, ≤ 0.5
`number_of_horizontal_dividers` Number of Horizontal Dividers	integer	`0`	"Horizontal" means parallel to local window X-axis Range: ≥ 0
`number_of_vertical_dividers` Number of Vertical Dividers	integer	`0`	"Vertical" means parallel to local window Y-axis Range: ≥ 0
`divider_outside_projection` Divider Outside Projection	number m	`0.0`	Amount that divider projects outward from the outside face of the glazing Outside projection assumed the same for all divider elements Range: ≥ 0, ≤ 0.5
`divider_inside_projection` Divider Inside Projection	number m	`0.0`	Amount that divider projects inward from the inside face of the glazing Inside projection assumed the same for all divider elements Range: ≥ 0, ≤ 0.5
`divider_conductance` Divider Conductance	number W/m2-K	`0.0`	Effective conductance of divider Excludes air films Obtained from WINDOW 5 or other 2-D calculation Range: ≥ 0
`ratio_of_divider_edge_glass_conductance_to_center_of_glass_conductance` Ratio of Divider-Edge Glass Conductance to Center-Of-Glass Conductance	number	`1.0`	Excludes air films Obtained from WINDOW 5 or other 2-D calculation Range: > 0, ≤ 4
`divider_solar_absorptance` Divider Solar Absorptance	number	`0.0`	Assumed same on outside and inside of divider Range: ≥ 0, ≤ 1
`divider_visible_absorptance` Divider Visible Absorptance	number	`0.0`	Assumed same on outside and inside of divider Range: ≥ 0, ≤ 1
`divider_thermal_hemispherical_emissivity` Divider Thermal Hemispherical Emissivity	number	`0.9`	Assumed same on outside and inside of divider Range: > 0, < 1
`outside_reveal_solar_absorptance` Outside Reveal Solar Absorptance	number	`0.0`	Range: ≥ 0, ≤ 1
`inside_sill_depth` Inside Sill Depth	number m	`0.0`	Range: ≥ 0, ≤ 2
`inside_sill_solar_absorptance` Inside Sill Solar Absorptance	number	`0.0`	Range: ≥ 0, ≤ 1
`inside_reveal_depth` Inside Reveal Depth	number m	`0.0`	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. Range: ≥ 0, ≤ 2
`inside_reveal_solar_absorptance` Inside Reveal Solar Absorptance	number	`0.0`	Range: ≥ 0, ≤ 1
`nfrc_product_type_for_assembly_calculations` NFRC Product Type for Assembly Calculations	choice	`CurtainWall`	Used when computing the assembly u-factor, SHGC and visible transmittance for reporting only One of `CasementDouble`, `CasementSingle`, `CurtainWall`, `DoorSidelite`, `DoorTransom`, `DualAction`, `Fixed`, `Garage`, `Greenhouse`, `HingedEscape`, `HorizontalSlider`, `Jal`, `Pivoted`, `ProjectingDual`, `ProjectingSingle`, `SideHingedDoor`, `Skylight`, `SlidingPatioDoor`, `SpandrelPanel`, `TropicalAwning`, `TubularDaylightingDevice`, `VerticalSlider`

Referenced by 3 object types

FenestrationSurface:Detailed, GlazedDoor, Window

WindowProperty:StormWindow¶

from idfpy.models import WindowPropertyStormWindow

This is a movable exterior glass layer that is usually applied in the winter and removed in the summer.

Field	Type	Default	Details
`window_name` Window Name required	reference		Must be the name of a FenestrationSurface:Detailed object with Surface Type = WINDOW. The WindowProperty:StormWindow object can only be used with exterior windows. Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
`storm_glass_layer_name` Storm Glass Layer Name required	reference		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 Names a WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:SimpleGlazingSystem
`distance_between_storm_glass_layer_and_adjacent_glass` Distance Between Storm Glass Layer and Adjacent Glass	number m	`0.05`	Range: > 0, ≤ 0.5
`month_that_storm_glass_layer_is_put_on` Month that Storm Glass Layer is Put On required	integer		Range: ≥ 1, ≤ 12
`day_of_month_that_storm_glass_layer_is_put_on` Day of Month that Storm Glass Layer is Put On required	integer		Range: ≥ 1, ≤ 31
`month_that_storm_glass_layer_is_taken_off` Month that Storm Glass Layer is Taken Off required	integer		Range: ≥ 1, ≤ 12
`day_of_month_that_storm_glass_layer_is_taken_off` Day of Month that Storm Glass Layer is Taken Off required	integer		Range: ≥ 1, ≤ 31

WindowShadingControl¶

from idfpy.models import WindowShadingControl extensible

Specifies the type, location, and controls for window shades, window blinds, and switchable glazing. Referencing the surface objects for exterior windows and glass doors (ref: FenestrationSurface:Detailed, Window, and GlazedDoor).

Field	Type	Default	Details
`name` Name required	string		Referenced by surfaces that are exterior windows Not used by interzone windows
`zone_name` Zone Name required	reference		Names a Zone
`shading_control_sequence_number` Shading Control Sequence Number	integer	`1`	If multiple WindowShadingControl objects are used than the order that they deploy the window shades can be set with this field. The first WindowShadingControl should be 1 and subsequent WindowShadingControl should 2 or 3 or higher. This is usually used when the Multiple Surface Control Type field is set to Group and groups of windows are being controlled in a certain order. Range: ≥ 1
`shading_type` Shading Type required	choice		One of `BetweenGlassBlind`, `BetweenGlassShade`, `ExteriorBlind`, `ExteriorScreen`, `ExteriorShade`, `InteriorBlind`, `InteriorShade`, `SwitchableGlazing`
`construction_with_shading_name` Construction with Shading Name	reference		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. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`shading_control_type` Shading Control Type required	choice		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) The following three control types require that both Setpoint and Setpoint2 be specified Setpoint corresponds to solar radiation incident (W/m2) Setpoint2 corresponds to luminance (cd/m2) They can only be used in zones with daylighting controls. They are applicable to any Shading Type except ExteriorScreen. One of `AlwaysOff`, `AlwaysOn`, `MeetDaylightIlluminanceSetpoint`, `OffNightAndOnDayIfCoolingAndHighSolarOnWindow`, `OnIfHighGlare`, `OnIfHighHorizontalSolar`, `OnIfHighOutdoorAirTempAndHighHorizontalSolar`, `OnIfHighOutdoorAirTempAndHighSolarOnWindow`, `OnIfHighOutdoorAirTemperature`, `OnIfHighSolarOnWindow`, `OnIfHighSolarOrHighLuminanceTillMidnight`, `OnIfHighSolarOrHighLuminanceTillNextMorning`, `OnIfHighSolarOrHighLuminanceTillSunset`, `OnIfHighZoneAirTempAndHighHorizontalSolar`, `OnIfHighZoneAirTempAndHighSolarOnWindow`, `OnIfHighZoneAirTemperature`, `OnIfHighZoneCooling`, `OnIfScheduleAllows`, `OnNightAndOnDayIfCoolingAndHighSolarOnWindow`, `OnNightIfHeatingAndOffDay`, `OnNightIfHeatingAndOnDayIfCooling`, `OnNightIfLowInsideTempAndOffDay`, `OnNightIfLowOutdoorTempAndOffDay`, `OnNightIfLowOutdoorTempAndOnDayIfCooling`
`schedule_name` Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`setpoint` Setpoint	number W/m2, W or deg C		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
`shading_control_is_scheduled` Shading Control Is Scheduled	choice	`No`	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. One of `No`, `Yes`
`glare_control_is_active` Glare Control Is Active	choice	`No`	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. One of `No`, `Yes`
`shading_device_material_name` Shading Device Material Name	reference		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. Names a WindowMaterial:Blind, WindowMaterial:Screen, WindowMaterial:Shade
`type_of_slat_angle_control_for_blinds` Type of Slat Angle Control for Blinds	choice	`FixedSlatAngle`	Used only if Shading Type = InteriorBlind, ExteriorBlind or BetweenGlassBlind. If choice is ScheduledSlatAngle then Slat Angle Schedule Name is required. One of `BlockBeamSolar`, `FixedSlatAngle`, `ScheduledSlatAngle`
`slat_angle_schedule_name` Slat Angle Schedule Name	reference		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) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`setpoint_2` Setpoint 2	number W/m2, deg C or cd/m2		W/m2 for solar-based controls, deg C for temperature-based controls, cd/m2 for luminance based controls. Used only as the second setpoint for the following two-setpoint control types: OnIfHighOutdoorAirTempAndHighSolarOnWindow, OnIfHighOutdoorAirTempAndHighHorizontalSolar, OnIfHighZoneAirTempAndHighSolarOnWindow, OnIfHighZoneAirTempAndHighHorizontalSolar, OnIfHighSolarOrHighLuminanceTillMidnight, OnIfHighSolarOrHighLuminanceTillSunset, and OnIfHighSolarOrHighLuminanceTillNextMorning.
`daylighting_control_object_name` Daylighting Control Object Name	reference		Reference to the Daylighting:Controls object that provides the glare and illuminance control to the zone. Names a Daylighting:Controls
`multiple_surface_control_type` Multiple Surface Control Type	choice	`Sequential`	When Sequential is used the list of fenestration surfaces are controlled individually in the order specified When Group is used the entire list is controlled simultaneously and if glare control is needed the entire group of window shades are deployed together a the same time One of `Group`, `Sequential`
`fenestration_surfaces`	list		Each item: `fenestration_surface_name`

Zone¶

from idfpy.models import Zone

Defines a thermal zone of the building. Every zone contains one or more Spaces. Space is an optional input. If a Zone has no Space(s) specified in input then a default Space named <Zone Name> will be created. If some surfaces in a Zone are assigned to a space and some are not, then a default Space named <Zone Name>-Remainder will be created. Input references to Space Names must have a matching Space object (default space names may not be referenced except in output variable keys).

Field	Type	Default	Details
`name` Name required	string		Name of the Zone. This name must be unique across Zone, Space, ZoneList, and SpaceList names.
`direction_of_relative_north` Direction of Relative North	number deg	`0.0`
`x_origin` X Origin	number m	`0.0`
`y_origin` Y Origin	number m	`0.0`
`z_origin` Z Origin	number m	`0.0`
`type` Type	integer	`1`	Range: ≥ 1, ≤ 1
`multiplier` Multiplier	integer	`1`	Range: ≥ 1
`ceiling_height` Ceiling Height	number or `Autocalculate` m	`Autocalculate`	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.
`volume` Volume	number or `Autocalculate` m3	`Autocalculate`	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.
`floor_area` Floor Area	number or `Autocalculate` m2	`Autocalculate`	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.
`zone_inside_convection_algorithm` Zone Inside Convection Algorithm	choice		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 ASTMC1340 = mixed convection correlations specified for attic zone One of `ASTMC1340`, `AdaptiveConvectionAlgorithm`, `CeilingDiffuser`, `Simple`, `TARP`, `TrombeWall`
`zone_outside_convection_algorithm` Zone Outside Convection Algorithm	choice		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 One of `AdaptiveConvectionAlgorithm`, `DOE-2`, `MoWiTT`, `SimpleCombined`, `TARP`
`part_of_total_floor_area` Part of Total Floor Area	choice	`Yes`	One of `No`, `Yes`

Referenced by 187 object types

ZoneGroup¶

from idfpy.models import 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.

Field	Type	Default	Details
`name` Name required	string		Name of the Zone Group
`zone_list_name` Zone List Name required	reference		Names a ZoneList
`zone_list_multiplier` Zone List Multiplier	integer	`1`	Range: ≥ 1

ZoneList¶

from idfpy.models import ZoneList extensible

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.

Field	Type	Default	Details
`name` Name required	string		Name of the ZoneList. This name must be unique across Zone, Space, ZoneList, and SpaceList names.
`zones`	list		Each item: `zone_name`

Referenced by 30 object types

AvailabilityManager:NightCycle, AvailabilityManager:OptimumStart, Controller:MechanicalVentilation, ElectricEquipment, ElectricEquipment:Instance, GasEquipment, GasEquipment:Instance, HotWaterEquipment, HotWaterEquipment:Instance, InternalMass, Lights, Lights:Instance, OtherEquipment, OtherEquipment:Instance, People, People:Instance, PlantEquipmentOperation:ChillerHeaterChangeover, ShadowCalculation, Sizing:Zone, SteamEquipment, SteamEquipment:Instance, ZoneBaseboard:OutdoorTemperatureControlled, ZoneCapacitanceMultiplier:ResearchSpecial, ZoneControl:Thermostat, ZoneControl:Thermostat:StagedDualSetpoint, ZoneControl:Thermostat:ThermalComfort, ZoneGroup, ZoneInfiltration:DesignFlowRate, ZoneProperty:UserViewFactors:BySurfaceName, ZoneVentilation:DesignFlowRate