pyidf.air_distribution module¶

Data objects in group “Air Distribution”

class pyidf.air_distribution.AirLoopHvac¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC Defines a central forced air system.

availability_manager_list_name¶

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

branch_list_name¶

field Branch List Name

Name of a BranchList containing all the branches in this air loop

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

connector_list_name¶

field Connector List Name

Name of a ConnectorList containing all the splitters and mixers in the loop

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

controller_list_name¶

field Controller List Name

Enter the name of an AirLoopHVAC:ControllerList object.

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

demand_side_inlet_node_names¶

field Demand Side Inlet Node Names

Name of a Node or NodeList containing the inlet node(s) supplying air to zone equipment.

Parameters:	value (str) – value for IDD Field Demand Side Inlet Node Names
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_inlet_node_names or None if not set
Return type:	str

demand_side_outlet_node_name¶

field Demand Side Outlet Node Name

Name of outlet node where return air leaves the demand side and enters the supply side.

Parameters:	value (str) – value for IDD Field Demand Side Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_outlet_node_name or None if not set
Return type:	str

design_supply_air_flow_rate¶

field Design Supply Air Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Design Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

name¶

field Name

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

supply_side_inlet_node_name¶

field Supply Side Inlet Node Name

Name of inlet node where return air enters the supply side of the air loop

Parameters:	value (str) – value for IDD Field Supply Side Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_side_inlet_node_name or None if not set
Return type:	str

supply_side_outlet_node_names¶

field Supply Side Outlet Node Names

Name of a Node or NodeList containing the outlet node(s) supplying air to the demand side.

Parameters:	value (str) – value for IDD Field Supply Side Outlet Node Names
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_side_outlet_node_names or None if not set
Return type:	str

class pyidf.air_distribution.AirLoopHvacOutdoorAirSystem¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:OutdoorAirSystem Outdoor air subsystem for an AirLoopHVAC. Includes an outdoor air mixing box and optional outdoor air conditioning equipment such as heat recovery, preheat, and precool coils. From the perspective of the primary air loop the outdoor air system is treated as a single component.

availability_manager_list_name¶

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

controller_list_name¶

field Controller List Name

Enter the name of an AirLoopHVAC:ControllerList object.

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

name¶

field Name

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

outdoor_air_equipment_list_name¶

field Outdoor Air Equipment List Name

Enter the name of an AirLoopHVAC:OutdoorAirSystem:EquipmentList object.

Parameters:	value (str) – value for IDD Field Outdoor Air Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_air_equipment_list_name or None if not set
Return type:	str

class pyidf.air_distribution.AirLoopHvacOutdoorAirSystemEquipmentList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:OutdoorAirSystem:EquipmentList List equipment in simulation order

component_1_name¶

field Component 1 Name

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

component_1_object_type¶

field Component 1 Object Type

Parameters:	value (str) – value for IDD Field Component 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_object_type or None if not set
Return type:	str

component_2_name¶

field Component 2 Name

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

component_2_object_type¶

field Component 2 Object Type

Parameters:	value (str) – value for IDD Field Component 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_object_type or None if not set
Return type:	str

component_3_name¶

field Component 3 Name

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

component_3_object_type¶

field Component 3 Object Type

Parameters:	value (str) – value for IDD Field Component 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_object_type or None if not set
Return type:	str

component_4_name¶

field Component 4 Name

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

component_4_object_type¶

field Component 4 Object Type

Parameters:	value (str) – value for IDD Field Component 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_object_type or None if not set
Return type:	str

component_5_name¶

field Component 5 Name

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

component_5_object_type¶

field Component 5 Object Type

Parameters:	value (str) – value for IDD Field Component 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_object_type or None if not set
Return type:	str

component_6_name¶

field Component 6 Name

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

component_6_object_type¶

field Component 6 Object Type

Parameters:	value (str) – value for IDD Field Component 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_object_type or None if not set
Return type:	str

component_7_name¶

field Component 7 Name

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

component_7_object_type¶

field Component 7 Object Type

Parameters:	value (str) – value for IDD Field Component 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_object_type or None if not set
Return type:	str

component_8_name¶

field Component 8 Name

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

component_8_object_type¶

field Component 8 Object Type

Parameters:	value (str) – value for IDD Field Component 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_object_type or None if not set
Return type:	str

component_9_name¶

field Component 9 Name

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

component_9_object_type¶

field Component 9 Object Type

Parameters:	value (str) – value for IDD Field Component 9 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_object_type or None if not set
Return type:	str

name¶

field Name

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

class pyidf.air_distribution.AirLoopHvacReturnPath¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:ReturnPath A return air path can only contain one AirLoopHVAC:ZoneMixer and one or more AirLoopHVAC:ReturnPlenum objects.

add_extensible(component_1_object_type=None, component_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

name¶

field Name

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

return_air_path_outlet_node_name¶

field Return Air Path Outlet Node Name

Parameters:	value (str) – value for IDD Field Return Air Path Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of return_air_path_outlet_node_name or None if not set
Return type:	str

class pyidf.air_distribution.AirLoopHvacReturnPlenum¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:ReturnPlenum Connects N zone inlet air streams, through zone return plenum, to outlet (currently 500 per air loop) Node names cannot be duplicated within a single plenum list.

add_extensible(inlet_1_node_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

induced_air_outlet_node_or_nodelist_name¶

field Induced Air Outlet Node or NodeList Name

Parameters:	value (str) – value for IDD Field Induced Air Outlet Node or NodeList Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of induced_air_outlet_node_or_nodelist_name or None if not set
Return type:	str

name¶

field Name

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

outlet_node_name¶

field Outlet Node Name

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

zone_name¶

field Zone Name

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

zone_node_name¶

field Zone Node Name

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

class pyidf.air_distribution.AirLoopHvacSupplyPath¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:SupplyPath A supply path can only contain AirLoopHVAC:ZoneSplitter and AirLoopHVAC:SupplyPlenum objects which may be in series or parallel.

add_extensible(component_1_object_type=None, component_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

name¶

field Name

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

supply_air_path_inlet_node_name¶

field Supply Air Path Inlet Node Name

Parameters:	value (str) – value for IDD Field Supply Air Path Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_path_inlet_node_name or None if not set
Return type:	str

class pyidf.air_distribution.AirLoopHvacSupplyPlenum¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:SupplyPlenum Connects 1 zone inlet air stream, through zone supply plenum, to one or more outlets. Node names cannot be duplicated within a single supply plenum list.

add_extensible(outlet_1_node_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

inlet_node_name¶

field Inlet Node Name

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

name¶

field Name

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

zone_name¶

field Zone Name

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

zone_node_name¶

field Zone Node Name

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

class pyidf.air_distribution.AirLoopHvacZoneMixer¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:ZoneMixer Mix N inlet air streams into one (currently 500 per air loop, but extensible). Node names cannot be duplicated within a single zone mixer (AirLoopHVAC:ZoneMixer) list.

add_extensible(inlet_1_node_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

name¶

field Name

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

outlet_node_name¶

field Outlet Node Name

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

class pyidf.air_distribution.AirLoopHvacZoneSplitter¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:ZoneSplitter Split one air stream into N outlet streams (currently 500 per air loop, but extensible). Node names cannot be duplicated within a single zone splitter (AirLoopHVAC:ZoneSplitter) list.

add_extensible(outlet_1_node_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

inlet_node_name¶

field Inlet Node Name

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

name¶

field Name

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

class pyidf.air_distribution.OutdoorAirMixer¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutdoorAir:Mixer Outdoor air mixer. Node names cannot be duplicated within a single OutdoorAir:Mixer object or across all outdoor air mixers.

mixed_air_node_name¶

field Mixed Air Node Name

Name of Mixed Air Node

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

name¶

field Name

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

outdoor_air_stream_node_name¶

field Outdoor Air Stream Node Name

Name of Outdoor Air Stream Node

Parameters:	value (str) – value for IDD Field Outdoor Air Stream Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_air_stream_node_name or None if not set
Return type:	str

relief_air_stream_node_name¶

field Relief Air Stream Node Name

Name of Relief Air Stream Node

Parameters:	value (str) – value for IDD Field Relief Air Stream Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relief_air_stream_node_name or None if not set
Return type:	str

return_air_stream_node_name¶

field Return Air Stream Node Name

Name of Return Air Stream Node

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

pyidf.air_distribution module¶

Related Topics

This Page