Zone HVAC Air Loop Terminal Units¶

18 object types from idfpy.models.zone_terminals · EnergyPlus 26.2

Object	Summary
AirTerminal:DualDuct:ConstantVolume	Central air system terminal unit, dual duct, constant volume.
AirTerminal:DualDuct:VAV	Central air system terminal unit, dual duct, variable volume.
AirTerminal:DualDuct:VAV:OutdoorAir	Central air system terminal unit, dual duct, variable volume with special controls.
AirTerminal:SingleDuct:ConstantVolume:CooledBeam	Central air system terminal unit, single duct, constant volume, with cooled beam (active or passive).
AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam	Central air system terminal unit, single duct, constant volume, with heating and/or cooling.
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction	Central air system terminal unit, single duct, variable volume, induction unit with hot water reheat coil and …
AirTerminal:SingleDuct:ConstantVolume:NoReheat	Central air system terminal unit, single duct, constant volume, without reheat coil
AirTerminal:SingleDuct:ConstantVolume:Reheat	Central air system terminal unit, single duct, constant volume, with reheat coil (hot water, electric, gas, …
AirTerminal:SingleDuct:Mixer	The mixer air terminal unit provides a means of supplying central system air to the air inlet or outlet side …
AirTerminal:SingleDuct:ParallelPIU:Reheat	Central air system terminal unit, single duct, variable volume, parallel powered induction unit (PIU), with …
AirTerminal:SingleDuct:SeriesPIU:Reheat	Central air system terminal unit, single duct, variable volume, series powered induction unit (PIU), with …
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat	Central air system terminal unit, single duct, variable volume for both cooling and heating, with no reheat …
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat	Central air system terminal unit, single duct, variable volume for both cooling and heating, with reheat coil …
AirTerminal:SingleDuct:VAV:NoReheat	Central air system terminal unit, single duct, variable volume, with no reheat coil.
AirTerminal:SingleDuct:VAV:Reheat	Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, …
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan	Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, …
ZoneHVAC:AirDistributionUnit	Central air system air distribution unit, serves as a wrapper for a specific type of air terminal unit.
ZoneHVAC:ExhaustControl	Defines a controlled exhaust flow from a zone which finally feeds into one of AirLoopHVAC:ZoneMixer's inlets, …

AirTerminal:DualDuct:ConstantVolume¶

from idfpy.models import AirTerminalDualDuctConstantVolume

Central air system terminal unit, dual duct, constant volume.

Field	Type	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string	The outlet node of the terminal unit. This is also the zone inlet node.
`hot_air_inlet_node_name` Hot Air Inlet Node Name required	string
`cold_air_inlet_node_name` Cold Air Inlet Node Name required	string
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:DualDuct:VAV¶

from idfpy.models import AirTerminalDualDuctVAV

Central air system terminal unit, dual duct, variable volume.

Field	Type	Default	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string		The outlet node of the terminal unit. This is also the zone inlet node.
`hot_air_inlet_node_name` Hot Air Inlet Node Name required	string
`cold_air_inlet_node_name` Cold Air Inlet Node Name required	string
`maximum_damper_air_flow_rate` Maximum Damper Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_fraction` Zone Minimum Air Flow Fraction	number	`0.2`	fraction of maximum air flow Range: ≥ 0, ≤ 1
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference		This field adjusts the design minimum flow rate by multiplying it using this schedule of fraction values. This field is used with "Zone Minimum Air Flow Fraction". Schedule values are fractions 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1 and the VAV air terminal uses fixed fraction specified in the field "Zone Minimum Air Flow Fraction". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:DualDuct:VAV:OutdoorAir¶

from idfpy.models import AirTerminalDualDuctVAVOutdoorAir

Central air system terminal unit, dual duct, variable volume with special controls. One VAV duct is controlled to supply ventilation air and the other VAV duct is controlled to meet the zone cooling load.

Field	Type	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string	The outlet node of the terminal unit. This is also the zone inlet node.
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name required	string
`recirculated_air_inlet_node_name` Recirculated Air Inlet Node Name	string
`maximum_terminal_air_flow_rate` Maximum Terminal Air Flow Rate required	number or `Autosize` m3/s	If autosized this is the sum of flow needed for cooling and maximum required outdoor air
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name required	reference	When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based mode selected in the next field. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`per_person_ventilation_rate_mode` Per Person Ventilation Rate Mode	choice	CurrentOccupancy models demand controlled ventilation using the current number of people DesignOccupancy uses the total Number of People in the zone and is constant One of `CurrentOccupancy`, `DesignOccupancy`

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ConstantVolume:CooledBeam¶

from idfpy.models import AirTerminalSingleDuctConstantVolumeCooledBeam

Central air system terminal unit, single duct, constant volume, with cooled beam (active or passive).

Field	Type	Default	Details
`name` Name required	string
`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
`cooled_beam_type` Cooled Beam Type required	choice		One of `Active`, `Passive`
`supply_air_inlet_node_name` Supply Air Inlet Node Name required	string
`supply_air_outlet_node_name` Supply Air Outlet Node Name required	string
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`supply_air_volumetric_flow_rate` Supply Air Volumetric Flow Rate	number or `Autosize` m3/s	`Autosize`
`maximum_total_chilled_water_volumetric_flow_rate` Maximum Total Chilled Water Volumetric Flow Rate	number or `Autosize` m3/s	`Autosize`
`number_of_beams` Number of Beams	integer or `Autosize`	`Autosize`	Number of individual beam units in the zone
`beam_length` Beam Length	number or `Autosize` m	`Autosize`	Length of an individual beam unit
`design_inlet_water_temperature` Design Inlet Water Temperature	number C	`15.0`	Range: ≥ 0
`design_outlet_water_temperature` Design Outlet Water Temperature	number C	`17.0`	Range: ≥ 0
`coil_surface_area_per_coil_length` Coil Surface Area per Coil Length	number m2/m	`5.422`	Range: ≥ 0
`model_parameter_a` Model Parameter a	number	`15.3`	Range: ≥ 0
`model_parameter_n1` Model Parameter n1	number	`0.0`	Range: ≥ 0
`model_parameter_n2` Model Parameter n2	number	`0.84`	Range: ≥ 0
`model_parameter_n3` Model Parameter n3	number	`0.12`	Range: ≥ 0
`model_parameter_a0` Model Parameter a0	number m2/m	`0.171`	Free area of the coil in plan view per unit beam length Range: ≥ 0
`model_parameter_k1` Model Parameter K1	number	`0.0057`	Range: ≥ 0
`model_parameter_n` Model Parameter n	number	`0.4`	Range: ≥ 0
`coefficient_of_induction_kin` Coefficient of Induction Kin	number or `Autocalculate`	`Autocalculate`
`leaving_pipe_inside_diameter` Leaving Pipe Inside Diameter	number m	`0.0145`	Range: > 0

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam¶

from idfpy.models import AirTerminalSingleDuctConstantVolumeFourPipeBeam

Central air system terminal unit, single duct, constant volume, with heating and/or cooling. Operates as two-pipe unit if heating or cooling water is omitted. Heating and/or cooling can be scheduled off for dedicated ventilation.

Field	Type	Default	Details
`name` Name required	string
`primary_air_availability_schedule_name` Primary Air Availability Schedule Name	reference		Primary air is supplied by central air handling unit and must be on for heating or cooling. Schedule value > 0 means the primary air supply is available. If this field is blank, the primary air supply 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
`cooling_availability_schedule_name` Cooling Availability Schedule Name	reference		Cooling operation can be controlled separately using this availability schedule. Schedule value > 0 means beam cooling is available. If this field is blank, the beam cooling is always available (as long as primary air is also available). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_availability_schedule_name` Heating Availability Schedule Name	reference		Heating operation can be controlled separately using this availability schedule. Schedule value > 0 means beam heating is available. If this field is blank, the beam heating is always available (as long as primary air is also available). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`primary_air_inlet_node_name` Primary Air Inlet Node Name required	string		Name of the air system node for primary supply air entering the air distribution unit.
`primary_air_outlet_node_name` Primary Air Outlet Node Name required	string		Name of the air system node for primary supply air leaving the air distribution unit and entering the zone.
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name	string		Name of the plant system node for chilled water entering the beam. The two chilled water nodes can (only) be omitted to model a two-pipe heating only beam.
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name	string		Name of the plant system node for chilled water leaving the beam.
`hot_water_inlet_node_name` Hot Water Inlet Node Name	string		Name of the plant system node for hot water entering the beam. The two hot water nodes can (only) be omitted to model a two-pipe cooling-only beam.
`hot_water_outlet_node_name` Hot Water Outlet Node Name	string		Name of the plant system node for hot water leaving the beam.
`design_primary_air_volume_flow_rate` Design Primary Air Volume Flow Rate	number or `Autosize` m3/s	`Autosize`
`design_chilled_water_volume_flow_rate` Design Chilled Water Volume Flow Rate	number or `Autosize` m3/s	`Autosize`
`design_hot_water_volume_flow_rate` Design Hot Water Volume Flow Rate	number or `Autosize` m3/s	`Autosize`
`zone_total_beam_length` Zone Total Beam Length	number or `Autosize` m	`Autosize`	Sum of the length of all the beam units in the zone represented by this terminal unit.
`rated_primary_air_flow_rate_per_beam_length` Rated Primary Air Flow Rate per Beam Length	number m3/s-m	`0.035`	Primary air supply flow rate normalized by beam length. Range: > 0
`beam_rated_cooling_capacity_per_beam_length` Beam Rated Cooling Capacity per Beam Length	number W/m	`600.0`	Sensible cooling capacity per meter of beam length at the rating point. Range: > 0
`beam_rated_cooling_room_air_chilled_water_temperature_difference` Beam Rated Cooling Room Air Chilled Water Temperature Difference	number deltaC	`10.0`	Difference in temperature between the zone air and the entering chilled water at the rating point. Range: > 0
`beam_rated_chilled_water_volume_flow_rate_per_beam_length` Beam Rated Chilled Water Volume Flow Rate per Beam Length	number m3/s-m	`5e-05`	The volume flow rate of chilled water per meter of beam length at the rating point. Range: > 0
`beam_cooling_capacity_temperature_difference_modification_factor_curve_name` Beam Cooling Capacity Temperature Difference Modification Factor Curve Name	reference		Adjusts beam cooling capacity when the temperature difference between entering water and zone air is different than at the rating point. Single independent variable is the ratio of the current temperature difference divided by the rating point temperature difference. This field is required when beam is connected to a chilled water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`beam_cooling_capacity_air_flow_modification_factor_curve_name` Beam Cooling Capacity Air Flow Modification Factor Curve Name	reference		Adjusts beam cooling capacity when the primary air supply flow rate is different than at the rating point. The single independent variable is the current normalized air flow rate divided by the normalized air flow rate at the rating point. This field is required when beam is connected to a chilled water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`beam_cooling_capacity_chilled_water_flow_modification_factor_curve_name` Beam Cooling Capacity Chilled Water Flow Modification Factor Curve Name	reference		Adjusts beam cooling capacity when the normalized chilled water flow rate is different than at the rating point. The single independent variable is the current normalized chilled water flow rate divided by the normalized chilled water flow rate at the rating point. This field is required when beam is connected to a chilled water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`beam_rated_heating_capacity_per_beam_length` Beam Rated Heating Capacity per Beam Length	number W/m	`1500.0`	Sensible heating capacity per meter of beam length at the rating point. Range: > 0
`beam_rated_heating_room_air_hot_water_temperature_difference` Beam Rated Heating Room Air Hot Water Temperature Difference	number deltaC	`27.8`	Difference in temperature between the zone air and the entering hot water at the rating point. Range: > 0
`beam_rated_hot_water_volume_flow_rate_per_beam_length` Beam Rated Hot Water Volume Flow Rate per Beam Length	number m3/s-m	`5e-05`	The volume flow rate of hot water per meter of beam length at the rating point. Range: > 0
`beam_heating_capacity_temperature_difference_modification_factor_curve_name` Beam Heating Capacity Temperature Difference Modification Factor Curve Name	reference		Adjusts beam heating capacity when the temperature difference between entering water and zone air is different than at the rating point. Single independent variable is the ratio of the current temperature difference divided by the rating point temperature difference. This field is required when beam is connected to a hot water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`beam_heating_capacity_air_flow_modification_factor_curve_name` Beam Heating Capacity Air Flow Modification Factor Curve Name	reference		Adjusts beam heating capacity when the primary air supply flow rate is different than at the rating point. The single independent variable is the current normalized air flow rate divided by the normalized air flow rate at the rating point. This field is required when beam is connected to a hot water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`beam_heating_capacity_hot_water_flow_modification_factor_curve_name` Beam Heating Capacity Hot Water Flow Modification Factor Curve Name	reference		Adjusts beam heating capacity when the normalized hot water flow rate is different than at the rating point. The single independent variable is the current normalized hot water flow rate divided by the normalized hot water flow rate at the rating point. This field is required when beam is connected to a hot water plant. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction¶

from idfpy.models import AirTerminalSingleDuctConstantVolumeFourPipeInduction

Central air system terminal unit, single duct, variable volume, induction unit with hot water reheat coil and chilled water recool coil.

Field	Type	Default	Details
`name` Name required	string
`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
`maximum_total_air_flow_rate` Maximum Total Air Flow Rate required	number or `Autosize` m3/s
`induction_ratio` Induction Ratio	number	`2.5`	ratio of induced air flow rate to primary air flow rate Range: ≥ 0
`supply_air_inlet_node_name` Supply Air Inlet Node Name required	string
`induced_air_inlet_node_name` Induced Air Inlet Node Name required	string		should be a zone exhaust node, also the heating coil inlet node
`air_outlet_node_name` Air Outlet Node Name required	string		should be a zone inlet node
`heating_coil_object_type` Heating Coil Object Type required	choice		One of `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_flow_rate` Maximum Hot Water Flow Rate	number or `Autosize` m3/s		Not used when heating coil type is gas or electric
`minimum_hot_water_flow_rate` Minimum Hot Water Flow Rate	number m3/s	`0.0`	Not used when heating coil type is gas or electric Range: ≥ 0
`heating_convergence_tolerance` Heating Convergence Tolerance	number	`0.001`	Range: > 0
`cooling_coil_object_type` Cooling Coil Object Type	choice		One of `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`
`cooling_coil_name` Cooling Coil Name	reference		Names a Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry
`maximum_cold_water_flow_rate` Maximum Cold Water Flow Rate	number or `Autosize` m3/s
`minimum_cold_water_flow_rate` Minimum Cold Water Flow Rate	number m3/s	`0.0`	Range: ≥ 0
`cooling_convergence_tolerance` Cooling Convergence Tolerance	number	`0.001`	Range: > 0
`zone_mixer_name` Zone Mixer Name required	reference		Names a AirLoopHVAC:ZoneMixer

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ConstantVolume:NoReheat¶

from idfpy.models import AirTerminalSingleDuctConstantVolumeNoReheat

Central air system terminal unit, single duct, constant volume, without reheat coil

Field	Type	Default	Details
`name` Name required	string
`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
`air_inlet_node_name` Air Inlet Node Name required	string		The air-inlet node name that connects the air splitter to the individual zone air distribution unit. This node should also be one of the outlet air node of an AirLoopHVAC:ZoneSplitter or AirLoopHVAC:SupplyPlenum component.
`air_outlet_node_name` Air Outlet Node Name required	string		This is an air outlet node from the air distribution unit. This node name should be one of the supply air inlet node names of a zone served by this component.
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used to modulate the terminal unit flow rate based on the specified outdoor air requirement. When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will adjust flow to meet this outdoor air requirement and no more. There is no control for zone load. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on either the current or design occupancy as specified in the Per Person Ventilation Rate Mode field. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. The requested flow rate may not be fully met if the system is operating with cycling fan. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. This field is optional. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`per_person_ventilation_rate_mode` Per Person Ventilation Rate Mode	choice	`CurrentOccupancy`	CurrentOccupancy uses current number of people in the zone which may vary DesignOccupancy uses the total number of people in the zone and is constant One of `CurrentOccupancy`, `DesignOccupancy`

Referenced by 3 object types

AirflowNetwork:Distribution:Component:TerminalUnit, AirflowNetwork:Distribution:Linkage, ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ConstantVolume:Reheat¶

from idfpy.models import AirTerminalSingleDuctConstantVolumeReheat

Central air system terminal unit, single duct, constant volume, with reheat coil (hot water, electric, gas, or steam).

Field	Type	Default	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string
`air_inlet_node_name` Air Inlet Node Name required	string
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`reheat_coil_object_type` Reheat Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when reheat coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when reheat coil type is gas or electric Range: ≥ 0
`convergence_tolerance` Convergence Tolerance	number	`0.001`	Range: > 0
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0

Referenced by 3 object types

AirflowNetwork:Distribution:Component:TerminalUnit, AirflowNetwork:Distribution:Linkage, ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:Mixer¶

from idfpy.models import AirTerminalSingleDuctMixer

The mixer air terminal unit provides a means of supplying central system air to the air inlet or outlet side of a zoneHVAC equipment such as a four pipe fan coil unit. Normally the central air would be ventilation air from a dedicated outdoor air system (DOAS).

Field	Type	Default	Details
`name` Name required	string
`zonehvac_unit_object_type` ZoneHVAC Unit Object Type required	choice		The type of ZoneHVAC equipment to which this terminal mixer will be connected. One of `AirLoopHVAC:UnitarySystem`, `ZoneHVAC:FourPipeFanCoil`, `ZoneHVAC:PackagedTerminalAirConditioner`, `ZoneHVAC:PackagedTerminalHeatPump`, `ZoneHVAC:TerminalUnit:VariableRefrigerantFlow`, `ZoneHVAC:UnitVentilator`, `ZoneHVAC:WaterToAirHeatPump`
`zonehvac_unit_object_name` ZoneHVAC Unit Object Name required	reference		The name of ZoneHVAC equipment to which this terminal mixer will be connected. Names a AirLoopHVAC:UnitarySystem, ZoneHVAC:FourPipeFanCoil, ZoneHVAC:PackagedTerminalAirConditioner, ZoneHVAC:PackagedTerminalHeatPump, ZoneHVAC:TerminalUnit:VariableRefrigerantFlow, ZoneHVAC:UnitVentilator, ZoneHVAC:WaterToAirHeatPump
`mixer_outlet_node_name` Mixer Outlet Node Name required	string		This is the outlet air node name of the mixer. This will be the inlet air node name of the ZoneHVAC equipment if the connection type in the input field Mixer Connection Type below is InletSide, else this will be an inlet air node name of the conditioned zone if the connection type in the input field Mixer Connection Type below is SupplySide.
`mixer_primary_air_inlet_node_name` Mixer Primary Air Inlet Node Name required	string		The primary air (treated outdoor air) inlet node name of the mixer. This will be an outlet air node name of an AirLoopHVAC:ZoneSplitter or AirLoopHVAC:SupplyPlenum providing the connection to the DOA system.
`mixer_secondary_air_inlet_node_name` Mixer Secondary Air Inlet Node Name required	string		The secondary air (recirculating air) inlet node name of the mixer. This will be the outlet air node name of the ZoneHVAC equipment if the connection type in the input field mixer Connection Type below is SupplySide, or else this will be an exhaust air node name of the conditioned zone if the connection type in the input field Mixer Connection Type below is InletSide.
`mixer_connection_type` Mixer Connection Type required	choice		This input field allows user to specify the mixer connection type. Valid choices are InletSide or SupplySide. This is a required input field. If the mixer connection type selected is InletSide, then the mixer is connected on the inlet side of the ZoneHVAC equipment, or else if the mixer connection type selected is SupplySide, then the mixer is connected at the outlet side of the ZoneHVAC equipment. One of `InletSide`, `SupplySide`
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will adjust flow to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone, as for demand controlled ventilation. If this field is blank, then the terminal unit will be controlled using the DesignSpecification:OutdoorAir object referenced in the Sizing:Zone object. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`per_person_ventilation_rate_mode` Per Person Ventilation Rate Mode	choice	`CurrentOccupancy`	CurrentOccupancy models demand controlled ventilation using the current number of people DesignOccupancy uses the total Number of People in the zone and is constant One of `CurrentOccupancy`, `DesignOccupancy`

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:ParallelPIU:Reheat¶

from idfpy.models import AirTerminalSingleDuctParallelPIUReheat

Central air system terminal unit, single duct, variable volume, parallel powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

Field	Type	Default	Details
`name` Name required	string
`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
`maximum_primary_air_flow_rate` Maximum Primary Air Flow Rate required	number or `Autosize` m3/s
`maximum_secondary_air_flow_rate` Maximum Secondary Air Flow Rate required	number or `Autosize` m3/s
`minimum_primary_air_flow_fraction` Minimum Primary Air Flow Fraction required	number or `Autosize`		When set to autosize, the calculated air flow is determined based on the System Outdoor Air Method used in the air loop's Sizing:System object.
`fan_on_flow_fraction` Fan On Flow Fraction required	number or `Autosize`		the fraction of the primary air flow at which fan turns on
`supply_air_inlet_node_name` Supply Air Inlet Node Name	string
`secondary_air_inlet_node_name` Secondary Air Inlet Node Name	string
`outlet_node_name` Outlet Node Name	string
`zone_mixer_name` Zone Mixer Name	reference		Names a AirLoopHVAC:ZoneMixer
`fan_name` Fan Name	reference		Fan type must be Fan:SystemModel or Fan:ConstantVolume Names a Fan:ConstantVolume, Fan:SystemModel
`reheat_coil_object_type` Reheat Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when reheat coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when reheat coil type is gas or electric Range: ≥ 0
`convergence_tolerance` Convergence Tolerance	number	`0.001`	Range: > 0
`fan_control_type` Fan Control Type	choice	`ConstantSpeed`	If VariableSpeed, then the fan object type must be Fan:SystemModel One of `ConstantSpeed`, `VariableSpeed`
`minimum_fan_turn_down_ratio` Minimum Fan Turn Down Ratio	number dimensionless	`0.3`	flow through terminal at minimum fan speed is this ratio multiplied by Maximum Air Flow Rate Range: ≥ 0, ≤ 1
`heating_control_type` Heating Control Type	choice		Only used if Fan Control Type is VariableSpeed One of `Modulated`, `Staged`
`design_heating_discharge_air_temperature` Design Heating Discharge Air Temperature	number C	`32.1`	Only used if Heating Control Type is Modulated Used to control second stage heating, typically zone heat setpoint plus 20F
`high_limit_heating_discharge_air_temperature` High Limit Heating Discharge Air Temperature	number C	`37.7`	Only used if Heating Control Type is Modulated Used to determine end of third stage heating
`backdraft_damper_leakage_fraction_curve_name` Backdraft Damper Leakage Fraction Curve Name	reference		Backdraft damper leakage fraction is the ratio of mass leakage flow rate to primary air flow rate at a constant static pressure setpoint. This curve should describe the ratio as a function primary air flow fraction (ratio of primary flow fraction to maximum nominal primary air flow rate). Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`backdraft_damper_leakage_zone_name` Backdraft Damper Leakage Zone Name	reference		Name of a zone that will be impacted by the backdraft damper leakage. Names a Zone

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:SeriesPIU:Reheat¶

from idfpy.models import AirTerminalSingleDuctSeriesPIUReheat

Central air system terminal unit, single duct, variable volume, series powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

Field	Type	Default	Details
`name` Name required	string
`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
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`maximum_primary_air_flow_rate` Maximum Primary Air Flow Rate required	number or `Autosize` m3/s
`minimum_primary_air_flow_fraction` Minimum Primary Air Flow Fraction required	number or `Autosize`		When set to autosize, the calculated air flow is determined based on the System Outdoor Air Method used in the air loop's Sizing:System object.
`supply_air_inlet_node_name` Supply Air Inlet Node Name	string
`secondary_air_inlet_node_name` Secondary Air Inlet Node Name	string
`outlet_node_name` Outlet Node Name	string
`zone_mixer_name` Zone Mixer Name	reference		Names a AirLoopHVAC:ZoneMixer
`fan_name` Fan Name	reference		Fan type must be Fan:SystemModel or Fan:ConstantVolume Names a Fan:ConstantVolume, Fan:SystemModel
`reheat_coil_object_type` Reheat Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when reheat coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when reheat coil type is gas or electric Range: ≥ 0
`convergence_tolerance` Convergence Tolerance	number	`0.001`	Range: > 0
`fan_control_type` Fan Control Type	choice	`ConstantSpeed`	If VariableSpeed, then the fan object type must be Fan:SystemModel One of `ConstantSpeed`, `VariableSpeed`
`minimum_fan_turn_down_ratio` Minimum Fan Turn Down Ratio	number dimensionless	`0.3`	flow through terminal at minimum fan speed is this ratio multiplied by Maximum Air Flow Rate Range: ≥ 0, ≤ 1
`heating_control_type` Heating Control Type	choice		Only used if Fan Control Type is VariableSpeed One of `Modulated`, `Staged`
`design_heating_discharge_air_temperature` Design Heating Discharge Air Temperature	number C	`32.1`	Only used if Heating Control Type is Modulated Used to control second stage heating, typically zone heat setpoint plus 20F
`high_limit_heating_discharge_air_temperature` High Limit Heating Discharge Air Temperature	number C	`37.7`	Only used if Heating Control Type is Modulated Used to determine end of third stage heating

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat¶

from idfpy.models import AirTerminalSingleDuctVAVHeatAndCoolNoReheat

Central air system terminal unit, single duct, variable volume for both cooling and heating, with no reheat coil.

Field	Type	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string	The outlet node of the terminal unit. This is also the zone inlet node.
`air_inlet_node_name` Air Inlet Node Name required	string
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_fraction` Zone Minimum Air Flow Fraction required	number	fraction of maximum air flow Range: ≥ 0, ≤ 1
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference	This field adjusts the design minimum flow rate by multiplying it using this schedule of fraction values. This field is used with "Zone Minimum Air Flow Fraction". Schedule values are fractions 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1 and the model uses the fixed fraction specified in in the field "Zone Minimum Air Flow Fraction". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat¶

from idfpy.models import AirTerminalSingleDuctVAVHeatAndCoolReheat

Central air system terminal unit, single duct, variable volume for both cooling and heating, with reheat coil (hot water, electric, gas, or steam).

Field	Type	Default	Details
`name` Name required	string
`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
`damper_air_outlet_node_name` Damper Air Outlet Node Name required	string		the outlet node of the damper and the inlet node of the reheat coil this is an internal node to the terminal unit and connects the damper and reheat coil
`air_inlet_node_name` Air Inlet Node Name required	string		the inlet node to the terminal unit and the damper
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_fraction` Zone Minimum Air Flow Fraction required	number		fraction of maximum air flow Range: ≥ 0, ≤ 1
`reheat_coil_object_type` Reheat Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when reheat coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when reheat coil type is gas or electric Range: ≥ 0
`air_outlet_node_name` Air Outlet Node Name required	string		The outlet node of the terminal unit and the reheat coil. This is also the zone inlet node.
`convergence_tolerance` Convergence Tolerance	number	`0.001`	Range: > 0
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference		This field adjusts the design minimum flow rate by multiplying it using this schedule of fraction values. This field is used with "Zone Minimum Air Flow Fraction". Schedule values are fractions 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1 and the model uses the fixed fraction specified in in the field "Zone Minimum Air Flow Fraction". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:VAV:NoReheat¶

from idfpy.models import AirTerminalSingleDuctVAVNoReheat

Central air system terminal unit, single duct, variable volume, with no reheat coil.

Field	Type	Default	Details
`name` Name required	string
`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
`air_outlet_node_name` Air Outlet Node Name required	string
`air_inlet_node_name` Air Inlet Node Name required	string
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_input_method` Zone Minimum Air Flow Input Method	choice	`Constant`	Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate) FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate) Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow One of `Constant`, `FixedFlowRate`, `Scheduled`
`constant_minimum_air_flow_fraction` Constant Minimum Air Flow Fraction	number or `Autosize`	`Autosize`	This field is used if the field Zone Minimum Air Flow Input Method is Constant If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional; if a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the following field are entered, the larger result is used. The values for autosizing are picked up from the Sizing:Zone input fields "Cooling Minimum Air Flow per Zone Floor Area", "Cooling Minimum Air Flow", and "Cooling Minimum Air Flow Fraction". If there is no sizing calculation a default of 0.000762 m3/s-m2 (0.15 cfm/ft2) is used.
`fixed_minimum_air_flow_rate` Fixed Minimum Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate. If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional; if a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the previous field are entered, the larger result is used. The values for autosizing are picked up from the Sizing:Zone input fields "Cooling Minimum Air Flow per Zone Floor Area", "Cooling Minimum Air Flow", and "Cooling Minimum Air Flow Fraction". If there is no sizing calculation a default of 0.000762 m3/s-m2 (0.15 cfm/ft2) is used.
`minimum_air_flow_fraction_schedule_name` Minimum Air Flow Fraction Schedule Name	reference		This field is used if the field Zone Minimum Air Flow Input Method is Scheduled Schedule values are fractions, 0.0 to 1.0. If the field Constant Minimum Air Flow Fraction is blank, then the average of the minimum and maximum schedule values is used for sizing normal-action reheat coils. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference		This field adjusts the design minimum flow rate by multiplying it using this schedule of fraction values. This field can be used with any of the three "Zone Minimum Air Flow Input Method". Schedule values are fractions, 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:VAV:Reheat¶

from idfpy.models import AirTerminalSingleDuctVAVReheat

Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam).

Field	Type	Default	Details
`name` Name required	string
`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
`damper_air_outlet_node_name` Damper Air Outlet Node Name required	string		the outlet node of the damper and the inlet node of the reheat coil this is an internal node to the terminal unit and connects the damper and reheat coil
`air_inlet_node_name` Air Inlet Node Name required	string		the inlet node to the terminal unit and the damper
`maximum_air_flow_rate` Maximum Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_input_method` Zone Minimum Air Flow Input Method	choice	`Constant`	Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate) FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate) Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow One of `Constant`, `FixedFlowRate`, `Scheduled`
`constant_minimum_air_flow_fraction` Constant Minimum Air Flow Fraction	number or `Autosize`	`Autosize`	This field is used if the field Zone Minimum Air Flow Input Method is Constant If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional; if a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the following field are entered, the larger result is used. The values for autosizing are picked up from the Sizing:Zone input fields "Cooling Minimum Air Flow per Zone Floor Area", "Cooling Minimum Air Flow", and "Cooling Minimum Air Flow Fraction". If there is no sizing calculation a default of 0.000762 m3/s-m2 (0.15 cfm/ft2) is used.
`fixed_minimum_air_flow_rate` Fixed Minimum Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate. If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional; if a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the previous field are entered, the larger result is used. The values for autosizing are picked up from the Sizing:Zone input fields "Cooling Minimum Air Flow per Zone Floor Area", "Cooling Minimum Air Flow", and "Cooling Minimum Air Flow Fraction". If there is no sizing calculation a default of 0.000762 m3/s-m2 (0.15 cfm/ft2) is used.
`minimum_air_flow_fraction_schedule_name` Minimum Air Flow Fraction Schedule Name	reference		This field is used if the field Zone Minimum Air Flow Input Method is Scheduled Schedule values are fractions, 0.0 to 1.0. If the field Constant Minimum Air Flow Fraction is blank, then the average of the minimum and maximum schedule values is used for sizing normal-action reheat coils. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`reheat_coil_object_type` Reheat Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when reheat coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when reheat coil type is gas or electric Range: ≥ 0
`air_outlet_node_name` Air Outlet Node Name required	string		The outlet node of the terminal unit and the reheat coil. This is also the zone inlet node.
`convergence_tolerance` Convergence Tolerance	number	`0.001`	Range: > 0
`damper_heating_action` Damper Heating Action	choice	`ReverseWithLimits`	Normal means the damper is fixed at the minimum position in heating mode Reverse means the damper can open fully during reheat ReverseWithLimits means the damper will open partially during reheat as specified in the following 2 fields One of `Normal`, `Reverse`, `ReverseWithLimits`
`maximum_flow_per_zone_floor_area_during_reheat` Maximum Flow per Zone Floor Area During Reheat	number or `Autosize` m3/s-m2	`Autosize`	Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = ReverseWithLimits When autocalculating, the maximum flow per zone is set to 0.002032 m3/s-m2 (0.4 cfm/sqft) This optional field limits the maximum flow allowed in reheat mode. At no time will the maximum flow rate calculated here exceed the value of Maximum Air Flow Rate.
`maximum_flow_fraction_during_reheat` Maximum Flow Fraction During Reheat	number or `Autosize`	`Autosize`	Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = ReverseWithLimits When autocalculating, the maximum flow fraction is set to the ratio of 0.002032 m3/s-m2 (0.4 cfm/sqft) multiplied by the zone floor area and the Maximum Air Flow Rate. This optional field limits the maximum flow allowed in reheat mode. At no time will the maximum flow rate calculated here exceed the value of Maximum Air Flow Rate.
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference		This field adjusts the design minimum flow rate by multiplying it using this schedule of fraction values. This field can be used with any of the three "Zone Minimum Air Flow Input Method". Schedule values are fractions, 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 3 object types

AirflowNetwork:Distribution:Component:TerminalUnit, AirflowNetwork:Distribution:Linkage, ZoneHVAC:AirDistributionUnit

AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan¶

from idfpy.models import AirTerminalSingleDuctVAVReheatVariableSpeedFan

Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam) and variable-speed fan. These units are usually employed in underfloor air distribution (UFAD) systems where the air is supplied at low static pressure through an underfloor plenum. The fan is used to control the flow of conditioned air that enters the space.

Field	Type	Default	Details
`name` Name required	string
`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
`maximum_cooling_air_flow_rate` Maximum Cooling Air Flow Rate required	number or `Autosize` m3/s
`maximum_heating_air_flow_rate` Maximum Heating Air Flow Rate required	number or `Autosize` m3/s
`zone_minimum_air_flow_fraction` Zone Minimum Air Flow Fraction required	number		fraction of cooling air flow rate Range: ≥ 0, ≤ 1
`air_inlet_node_name` Air Inlet Node Name	string		The name of the HVAC system node that is the air inlet node for the terminal unit. This is also the air inlet node for the unit's fan.
`air_outlet_node_name` Air Outlet Node Name	string		The name of the HVAC system node that is the air outlet node for the terminal unit. This is also the air outlet node for the unit's heating coil's air outlet node. This node is also a zone inlet node.
`fan_object_type` Fan Object Type required	choice		One of `Fan:SystemModel`, `Fan:VariableVolume`
`fan_name` Fan Name required	reference		Names a Fan:SystemModel, Fan:VariableVolume
`heating_coil_object_type` Heating Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when heating coil type is gas or electric
`minimum_hot_water_or_steam_flow_rate` Minimum Hot Water or Steam Flow Rate	number m3/s	`0.0`	Not used when heating coil type is gas or electric Range: ≥ 0
`heating_convergence_tolerance` Heating Convergence Tolerance	number	`0.001`	Range: > 0
`minimum_air_flow_turndown_schedule_name` Minimum Air Flow Turndown Schedule Name	reference		This field adjusts the fan-off minimum flow rate by multiplying it using this scheduled fraction values. This field is used with "Zone Minimum Air Flow Fraction". Schedule values are fractions 0.0 to 1.0. This field adjusts the minimum airflow turndown below the design minimum air flow and is intended for use with ASHRAE Standard 170. If this field is left blank, then the turndown minimum air flow fraction value is set to 1 and the model uses the fixed fraction specified in in the field "Zone Minimum Air Flow Fraction". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

ZoneHVAC:AirDistributionUnit

ZoneHVAC:AirDistributionUnit¶

from idfpy.models import ZoneHVACAirDistributionUnit

Central air system air distribution unit, serves as a wrapper for a specific type of air terminal unit. This object is referenced in a ZoneHVAC:EquipmentList.

Field	Type	Default	Details
`name` Name required	string
`air_distribution_unit_outlet_node_name` Air Distribution Unit Outlet Node Name required	string
`air_terminal_object_type` Air Terminal Object Type required	choice		One of `AirTerminal:DualDuct:ConstantVolume`, `AirTerminal:DualDuct:VAV`, `AirTerminal:DualDuct:VAV:OutdoorAir`, `AirTerminal:SingleDuct:ConstantVolume:CooledBeam`, `AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam`, `AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction`, `AirTerminal:SingleDuct:ConstantVolume:NoReheat`, `AirTerminal:SingleDuct:ConstantVolume:Reheat`, `AirTerminal:SingleDuct:Mixer`, `AirTerminal:SingleDuct:ParallelPIU:Reheat`, `AirTerminal:SingleDuct:SeriesPIU:Reheat`, `AirTerminal:SingleDuct:UserDefined`, `AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat`, `AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat`, `AirTerminal:SingleDuct:VAV:NoReheat`, `AirTerminal:SingleDuct:VAV:Reheat`, `AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan`
`air_terminal_name` Air Terminal Name required	reference		Names a AirTerminal:DualDuct:ConstantVolume, AirTerminal:DualDuct:VAV, AirTerminal:DualDuct:VAV:OutdoorAir, AirTerminal:SingleDuct:ConstantVolume:CooledBeam, AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam, AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction, AirTerminal:SingleDuct:ConstantVolume:NoReheat, AirTerminal:SingleDuct:ConstantVolume:Reheat, AirTerminal:SingleDuct:Mixer, AirTerminal:SingleDuct:ParallelPIU:Reheat, AirTerminal:SingleDuct:SeriesPIU:Reheat, AirTerminal:SingleDuct:UserDefined and 5 more
`nominal_upstream_leakage_fraction` Nominal Upstream Leakage Fraction	number	`0.0`	fraction at system design Flow; leakage Flow constant, leakage fraction varies with variable system Flow Rate. Range: ≥ 0, ≤ 0.3
`constant_downstream_leakage_fraction` Constant Downstream Leakage Fraction	number	`0.0`	Range: ≥ 0, ≤ 0.3
`design_specification_air_terminal_sizing_object_name` Design Specification Air Terminal Sizing Object Name	reference		This optional field is the name of a DesignSpecification:AirTerminal:Sizing object which specifies sizing adjustments to be made for this terminal unit. Names a DesignSpecification:AirTerminal:Sizing

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:ExhaustControl¶

from idfpy.models import ZoneHVACExhaustControl

Defines a controlled exhaust flow from a zone which finally feeds into one of AirLoopHVAC:ZoneMixer's inlets, which are part of an AirLoopHVAC:ExhaustSystem.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this exhaust system. Schedule value > 0 means it is available. If this field is blank, the exhaust system is always available. If the attached AirLoopHVAC:ExhaustSystem is off, then the flow will be zero. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`zone_name` Zone Name required	reference		Zone the exhaust inlet node is part of Names a Zone
`inlet_node_name` Inlet Node Name required	string		Inlet node name for the exhaust. Must be a zone exhaust node.
`outlet_node_name` Outlet Node Name required	string		Outlet node name for the exhaust
`design_exhaust_flow_rate` Design Exhaust Flow Rate	number or `Autosize` m3/s	`Autosize`
`flow_control_type` Flow Control Type	choice	`Scheduled`	Control type of the zone exhaust flow One of `FollowSupply`, `Scheduled`
`exhaust_flow_fraction_schedule_name` Exhaust Flow Fraction Schedule Name	reference		Schedule name of the exhaust flow fraction. Used only with Scheduled control type. If this field is blank, the flow fraction is always 1.0. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_node_or_nodelist_name` Supply Node or NodeList Name	string		Used only with FollowSupply control type.
`minimum_zone_temperature_limit_schedule_name` Minimum Zone Temperature Limit Schedule Name	reference		Schedule name of the Minimum Zone Temperature Limit in degree Celsius If this field is blank, there is no limit. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`minimum_exhaust_flow_fraction_schedule_name` Minimum Exhaust Flow Fraction Schedule Name	reference		Schedule name of the minimum exhaust flow fraction. Applied when the zone temperature falls below the Minimum Zone Temperature Limit. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`balanced_exhaust_fraction_schedule_name` Balanced Exhaust Fraction Schedule Name	reference		Schedule name of the Balanced Exhaust Fraction. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules