Air Distribution¶

14 object types from idfpy.models.air_distribution · EnergyPlus 26.2

Object	Summary
AirLoopHVAC	Defines a central forced air system.
AirLoopHVAC:DedicatedOutdoorAirSystem	Defines a central forced air system to provide dedicated outdoor air to multiple AirLoopHVACs.
AirLoopHVAC:ExhaustSystem	Defines a general exhaust system with a central exhaust fan drawing from one or more ZoneHVAC:ExhaustControl …
AirLoopHVAC:Mixer	Mix N inlet air streams from Relief Air Stream Node in OutdoorAir:Mixer objects served by AirLoopHVAC objects …
AirLoopHVAC:OutdoorAirSystem	Outdoor air subsystem for an AirLoopHVAC.
AirLoopHVAC:OutdoorAirSystem:EquipmentList	List equipment in simulation order
AirLoopHVAC:ReturnPath	A return air path can only contain one AirLoopHVAC:ZoneMixer and one or more AirLoopHVAC:ReturnPlenum objects.
AirLoopHVAC:ReturnPlenum	Connects N zone inlet air streams, through zone return plenum, to outlet (currently 500 per air loop) Node …
AirLoopHVAC:Splitter	Split one air stream from AirLoopHVAC:DedicatedOutdoorAirSystem outlet node into N outlet streams (currently …
AirLoopHVAC:SupplyPath	A supply path can only contain AirLoopHVAC:ZoneSplitter and AirLoopHVAC:SupplyPlenum objects which may be in …
AirLoopHVAC:SupplyPlenum	Connects 1 zone inlet air stream, through zone supply plenum, to one or more outlets.
AirLoopHVAC:ZoneMixer	Mix N inlet air streams into one (currently 500 per air loop, but extensible).
AirLoopHVAC:ZoneSplitter	Split one air stream into N outlet streams (currently 500 per air loop, but extensible).
OutdoorAir:Mixer	Outdoor air mixer.

AirLoopHVAC¶

from idfpy.models import AirLoopHVAC

Defines a central forced air system.

Field	Type	Default	Details
`name` Name required	string
`controller_list_name` Controller List Name	reference		Enter the name of an AirLoopHVAC:ControllerList object. Names a AirLoopHVAC:ControllerList
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_supply_air_flow_rate` Design Supply Air Flow Rate	number or `Autosize` m3/s	`0.0`
`branch_list_name` Branch List Name required	reference		Name of a BranchList containing all the branches in this air loop Names a BranchList
`connector_list_name` Connector List Name	reference		Name of a ConnectorList containing all the splitters and mixers in the loop Names a ConnectorList
`supply_side_inlet_node_name` Supply Side Inlet Node Name required	string		Name of inlet node where air enters the supply side of the air loop. If this air loop has a return path, then this node is where return air enters the supply side. If this air loop has no return path, then this node is where outdoor air or other air enters the supply side.
`demand_side_outlet_node_name` Demand Side Outlet Node Name	string		Name of outlet node where return air leaves the demand side and enters the supply side. Required if this air loop has a return path. Leave this field blank if there is no return.
`demand_side_inlet_node_names` Demand Side Inlet Node Names required	string		Name of a Node or NodeList containing the inlet node(s) supplying air to zone equipment.
`supply_side_outlet_node_names` Supply Side Outlet Node Names required	string		Name of a Node or NodeList containing the outlet node(s) supplying air to the demand side.
`design_return_air_flow_fraction_of_supply_air_flow` Design Return Air Flow Fraction of Supply Air Flow	number	`1.0`	The design return air flow rate as a fraction of supply air flow rate with no exhaust. This can be used to model a pressurized system or set to zero to model a DOAS with no return flow. Use ZoneAirMassFlowConservation to balance zone infiltration and mixing flows. Range: ≥ 0

Referenced by 16 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, AvailabilityManager:HybridVentilation, Duct:Loss:Conduction, Duct:Loss:Leakage, Duct:Loss:MakeupAir, SetpointManager:Coldest, SetpointManager:MultiZone:Cooling:Average, SetpointManager:MultiZone:Heating:Average, SetpointManager:MultiZone:Humidity:Maximum, SetpointManager:MultiZone:Humidity:Minimum, SetpointManager:MultiZone:MaximumHumidity:Average, SetpointManager:MultiZone:MinimumHumidity:Average, SetpointManager:ReturnAirBypassFlow, SetpointManager:Warmest, SetpointManager:WarmestTemperatureFlow, Sizing:System

AirLoopHVAC:DedicatedOutdoorAirSystem¶

from idfpy.models import AirLoopHVACDedicatedOutdoorAirSystem extensible

Defines a central forced air system to provide dedicated outdoor air to multiple AirLoopHVACs.

Field	Type	Details
`name` Name required	string
`airloophvac_outdoorairsystem_name` AirLoopHVAC:OutdoorAirSystem Name	reference	Enter the name of an AirLoopHVAC:OutdoorAirSystem object. Names a AirConditioner:VariableRefrigerantFlow, AirLoopHVAC:OutdoorAirSystem, AirLoopHVAC:Unitary:Furnace:HeatCool, AirLoopHVAC:Unitary:Furnace:HeatOnly, AirLoopHVAC:UnitaryHeatCool, AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass, AirLoopHVAC:UnitaryHeatOnly, AirLoopHVAC:UnitaryHeatPump:AirToAir, AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed, AirLoopHVAC:UnitaryHeatPump:WaterToAir, AirLoopHVAC:UnitarySystem, AirTerminal:SingleDuct:ConstantVolume:CooledBeam and 125 more
`availability_schedule_name` Availability Schedule Name	reference	Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`airloophvac_mixer_name` AirLoopHVAC:Mixer Name required	reference	Name of AirLoopHVAC:Mixer. Names a AirLoopHVAC:Mixer
`airloophvac_splitter_name` AirLoopHVAC:Splitter Name required	reference	Name of AirLoopHVAC:Splitter. Names a AirLoopHVAC:Splitter
`preheat_design_temperature` Preheat Design Temperature required	number C
`preheat_design_humidity_ratio` Preheat Design Humidity Ratio required	number kgWater/kgDryAir
`precool_design_temperature` Precool Design Temperature required	number C
`precool_design_humidity_ratio` Precool Design Humidity Ratio required	number kgWater/kgDryAir
`number_of_airloophvac` Number of AirLoopHVAC required	integer	Enter the number of the AirLoopHVAC served by AirLoopHVAC:DedicatedOutdoorAirSystem
`airloophvacs`	list	Each item: `airloophvac_name`

AirLoopHVAC:ExhaustSystem¶

from idfpy.models import AirLoopHVACExhaustSystem

Defines a general exhaust system with a central exhaust fan drawing from one or more ZoneHVAC:ExhaustControl outlet nodes via an AirLoopHVAC:ZoneMixer.

Field	Type	Details
`name` Name required	string	Name of the exhaust system
`zone_mixer_name` Zone Mixer Name required	reference	The name of the exhaust system AirLoopHVAC:ZoneMixer Names a AirLoopHVAC:ZoneMixer
`fan_object_type` Fan Object Type required	choice	One of `Fan:ComponentModel`, `Fan:SystemModel`
`fan_name` Fan Name required	reference	Names a Fan:ComponentModel, Fan:SystemModel

AirLoopHVAC:Mixer¶

from idfpy.models import AirLoopHVACMixer extensible

Mix N inlet air streams from Relief Air Stream Node in OutdoorAir:Mixer objects served by AirLoopHVAC objects listed in AirLoopHVAC:DedicatedOutdoorAirSystem into one (currently 10 as default, but extensible). Node names cannot be duplicated within a single mixer list.

Field	Type	Details
`name` Name required	string
`outlet_node_name` Outlet Node Name required	string
`nodes`	list	Each item: `inlet_node_name`

Referenced by 1 object types

AirLoopHVAC:DedicatedOutdoorAirSystem

AirLoopHVAC:OutdoorAirSystem¶

from idfpy.models import AirLoopHVACOutdoorAirSystem

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.

Field	Type	Details
`name` Name required	string
`controller_list_name` Controller List Name	reference	Enter the name of an AirLoopHVAC:ControllerList object or blank if this object is used in AirLoopHVAC:DedicatedOutdoorAirSystem. Names a AirLoopHVAC:ControllerList
`outdoor_air_equipment_list_name` Outdoor Air Equipment List Name required	reference	Enter the name of an AirLoopHVAC:OutdoorAirSystem:EquipmentList object. Names a AirLoopHVAC:OutdoorAirSystem:EquipmentList

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:OutdoorAirSystem:EquipmentList¶

from idfpy.models import AirLoopHVACOutdoorAirSystemEquipmentList

List equipment in simulation order

Field	Type	Details
`name` Name required	string
`component_1_object_type` Component 1 Object Type required	reference	Names a
`component_1_name` Component 1 Name required	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_2_object_type` Component 2 Object Type	reference	Names a
`component_2_name` Component 2 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_3_object_type` Component 3 Object Type	reference	Names a
`component_3_name` Component 3 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_4_object_type` Component 4 Object Type	reference	Names a
`component_4_name` Component 4 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_5_object_type` Component 5 Object Type	reference	Names a
`component_5_name` Component 5 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_6_object_type` Component 6 Object Type	reference	Names a
`component_6_name` Component 6 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_7_object_type` Component 7 Object Type	reference	Names a
`component_7_name` Component 7 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_8_object_type` Component 8 Object Type	reference	Names a
`component_8_name` Component 8 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more
`component_9_object_type` Component 9 Object Type	reference	Names a
`component_9_name` Component 9 Name	reference	Names a AirLoopHVAC:UnitarySystem, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined, CoilSystem:Cooling:DX, CoilSystem:Cooling:Water, CoilSystem:Cooling:Water:HeatExchangerAssisted, CoilSystem:Heating:DX and 20 more

Referenced by 1 object types

AirLoopHVAC:OutdoorAirSystem

AirLoopHVAC:ReturnPath¶

from idfpy.models import AirLoopHVACReturnPath extensible

A return air path can only contain one AirLoopHVAC:ZoneMixer and one or more AirLoopHVAC:ReturnPlenum objects.

Field	Type	Details
`name` Name required	string
`return_air_path_outlet_node_name` Return Air Path Outlet Node Name required	string
`components`	list	Each item: `component_object_type`, `component_name`

AirLoopHVAC:ReturnPlenum¶

from idfpy.models import AirLoopHVACReturnPlenum extensible

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.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`zone_node_name` Zone Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`induced_air_outlet_node_or_nodelist_name` Induced Air Outlet Node or NodeList Name	string
`nodes`	list	Each item: `inlet_node_name`

Referenced by 1 object types

AirLoopHVAC:ReturnPath

AirLoopHVAC:Splitter¶

from idfpy.models import AirLoopHVACSplitter extensible

Split one air stream from AirLoopHVAC:DedicatedOutdoorAirSystem outlet node into N outlet streams (currently 10 as default, but extensible). Node names should be Outdoor Air Stream Node Name in OutdoorAir:Mixer objects served by AirLoopHVAC objects listed in AirLoopHVAC:DedicatedOutdoorAirSystem.

Field	Type	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`nodes`	list	Each item: `outlet_node_name`

Referenced by 1 object types

AirLoopHVAC:DedicatedOutdoorAirSystem

AirLoopHVAC:SupplyPath¶

from idfpy.models import AirLoopHVACSupplyPath extensible

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

Field	Type	Details
`name` Name required	string
`supply_air_path_inlet_node_name` Supply Air Path Inlet Node Name required	string
`components`	list	Each item: `component_object_type`, `component_name`

AirLoopHVAC:SupplyPlenum¶

from idfpy.models import AirLoopHVACSupplyPlenum extensible

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.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`zone_node_name` Zone Node Name required	string
`inlet_node_name` Inlet Node Name required	string
`nodes`	list	Each item: `outlet_node_name`

Referenced by 1 object types

AirLoopHVAC:SupplyPath

AirLoopHVAC:ZoneMixer¶

from idfpy.models import AirLoopHVACZoneMixer extensible

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.

Field	Type	Details
`name` Name required	string
`outlet_node_name` Outlet Node Name required	string
`nodes`	list	Each item: `inlet_node_name`

Referenced by 5 object types

AirLoopHVAC:ExhaustSystem, AirLoopHVAC:ReturnPath, AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction, AirTerminal:SingleDuct:ParallelPIU:Reheat, AirTerminal:SingleDuct:SeriesPIU:Reheat

AirLoopHVAC:ZoneSplitter¶

from idfpy.models import AirLoopHVACZoneSplitter extensible

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.

Field	Type	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`nodes`	list	Each item: `outlet_node_name`

Referenced by 1 object types

AirLoopHVAC:SupplyPath

OutdoorAir:Mixer¶

from idfpy.models import OutdoorAirMixer

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

Field	Type	Details
`name` Name required	string
`mixed_air_node_name` Mixed Air Node Name required	string	Name of Mixed Air Node
`outdoor_air_stream_node_name` Outdoor Air Stream Node Name required	string	Name of Outdoor Air Stream Node
`relief_air_stream_node_name` Relief Air Stream Node Name required	string	Name of Relief Air Stream Node
`return_air_stream_node_name` Return Air Stream Node Name required	string	Name of Return Air Stream Node

Referenced by 10 object types

AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass, AirflowNetwork:Distribution:Component:OutdoorAirFlow, AirflowNetwork:Distribution:Component:ReliefAirFlow, ZoneHVAC:FourPipeFanCoil, ZoneHVAC:PackagedTerminalAirConditioner, ZoneHVAC:PackagedTerminalHeatPump, ZoneHVAC:TerminalUnit:VariableRefrigerantFlow, ZoneHVAC:WaterToAirHeatPump, ZoneHVAC:WindowAirConditioner