Zone HVAC Forced Air Units¶

16 object types from idfpy.models.zone_forced_air · EnergyPlus 26.2

Object	Summary
ZoneHVAC:Dehumidifier:DX	This object calculates the performance of zone (room) air dehumidifiers.
ZoneHVAC:EnergyRecoveryVentilator	This compound component models a stand-alone energy recovery ventilator (ERV) that conditions outdoor …
ZoneHVAC:EnergyRecoveryVentilator:Controller	This controller is used exclusively by the ZoneHVAC:EnergyRecoveryVentilator object to allow economizer (free …
ZoneHVAC:EvaporativeCoolerUnit	Zone evaporative cooler.
ZoneHVAC:FourPipeFanCoil	Four pipe fan coil system.
ZoneHVAC:HybridUnitaryHVAC	Hybrid Unitary HVAC.
ZoneHVAC:IdealLoadsAirSystem	Ideal system used to calculate loads without modeling a full HVAC system.
ZoneHVAC:OutdoorAirUnit	The zone outdoor air unit models a single-zone dedicated outdoor air system (DOAS).
ZoneHVAC:OutdoorAirUnit:EquipmentList	Equipment list for components in a ZoneHVAC:OutdoorAirUnit.
ZoneHVAC:PackagedTerminalAirConditioner	Packaged terminal air conditioner (PTAC).
ZoneHVAC:PackagedTerminalHeatPump	Packaged terminal heat pump (PTHP).
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow	A terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air heat pump).
ZoneHVAC:UnitHeater	Unit heater.
ZoneHVAC:UnitVentilator	Unit ventilator.
ZoneHVAC:WaterToAirHeatPump	Water-to-air heat pump.
ZoneHVAC:WindowAirConditioner	Window air conditioner.

ZoneHVAC:Dehumidifier:DX¶

from idfpy.models import ZoneHVACDehumidifierDX

This object calculates the performance of zone (room) air dehumidifiers. Meant to model conventional direct expansion (DX) cooling-based room air dehumidifiers (reject 100% of condenser heat to the zone air), but this object might be able to be used to model other room air dehumidifier types.

Field	Type	Default	Details
`name` Name required	string		Unique name for this direct expansion (DX) zone dehumidifier object.
`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. Schedule values of 0 denote the unit is off. Schedule values >0.0 (usually 1.0) indicate that the dehumidifier is available to operate. 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		Air inlet node for the dehumidifier must be a zone air exhaust node.
`air_outlet_node_name` Air Outlet Node Name required	string		Air outlet node for the dehumidifier must be a zone air inlet node.
`rated_water_removal` Rated Water Removal required	number L/day		Rating point: air entering dehumidifier at 26.7 C (80 F) dry-bulb and 60% relative humidity. Range: > 0
`rated_energy_factor` Rated Energy Factor required	number L/kWh		Rating point: air entering dehumidifier at 26.7 C (80 F) dry-bulb and 60% relative humidity. Range: > 0
`rated_air_flow_rate` Rated Air Flow Rate required	number m3/s		Range: > 0
`water_removal_curve_name` Water Removal Curve Name required	reference		Name of a curve that describes the water removal rate (normalized to rated conditions) as a function of the dry-bulb temperature and relative humidity of the air entering the dehumidifier. Curve output = (actual water removal/rated water removal) = a + bT + cT*2 + dRH + eRH2 + fT*RH T = inlet air dry-bulb temperature (C) RH = inlet air RH (%) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`energy_factor_curve_name` Energy Factor Curve Name required	reference		Name of a curve that describes the energy factor (normalized to rated conditions) as a function of the dry-bulb temperature and relative humidity of the air entering the dehumidifier. Curve output = (actual energy factor/rated energy factor) = a + bT + cT*2 + dRH + eRH2 + fT*RH T = inlet air dry-bulb temperature (C) RH = inlet air RH (%) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`part_load_fraction_correlation_curve_name` Part Load Fraction Correlation Curve Name required	reference		Name of a curve that describes the part load fraction (PLF) of the system as a function of the part load ratio. Used to calculate dehumidifier run time fraction and electric power. quadratic curve = a + bPLR + cPLR*2 cubic curve = a + bPLR + cPLR2 + dPLR**3 PLR = part load ratio (dehumidification load/steady state water removal capacity) 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
`minimum_dry_bulb_temperature_for_dehumidifier_operation` Minimum Dry-Bulb Temperature for Dehumidifier Operation	number C	`10.0`	Dehumidifier shut off if inlet air (zone) temperature is below this value. This value must be less than the Maximum Dry-Bulb Temperature for Dehumidifier Operation.
`maximum_dry_bulb_temperature_for_dehumidifier_operation` Maximum Dry-Bulb Temperature for Dehumidifier Operation	number C	`35.0`	Dehumidifier shut off if inlet air (zone) temperature is above this value. This value must be greater than the Minimum Dry-Bulb Temperature for Dehumidifier Operation.
`off_cycle_parasitic_electric_load` Off-Cycle Parasitic Electric Load	number W	`0.0`	Parasitic electric power consumed when the dehumidifier is available to operate, but does not operate (i.e., no high humidity load to be met). Off cycle parasitic power is 0 when the availability schedule is 0. This electric load is considered as a heat gain to the zone air. Range: ≥ 0
`condensate_collection_water_storage_tank_name` Condensate Collection Water Storage Tank Name	reference		Name of storage tank used to collect water removed by the dehumidifier. Names a WaterUse:Storage

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:EnergyRecoveryVentilator¶

from idfpy.models import ZoneHVACEnergyRecoveryVentilator

This compound component models a stand-alone energy recovery ventilator (ERV) that conditions outdoor ventilation air and supplies that air directly to a zone. The ERV unit is modeled as a collection of components: air-to-air heat exchanger, supply air fan, exhaust air fan and an optional controller to avoid overheating of the supply air (economizer or free cooling operation).

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
`heat_exchanger_name` Heat Exchanger Name required	reference	Heat exchanger type must be HeatExchanger:AirToAir:SensibleAndLatent Names a HeatExchanger:AirToAir:SensibleAndLatent
`supply_air_flow_rate` Supply Air Flow Rate required	number or `Autosize` m3/s	This flow rate must match the supply fan's air flow rate.
`exhaust_air_flow_rate` Exhaust Air Flow Rate required	number or `Autosize` m3/s	This flow rate must match the supply fan air flow rate.
`supply_air_fan_name` Supply Air Fan Name required	reference	Fan type must be Fan:OnOff or Fan:SystemModel Names a Fan:OnOff, Fan:SystemModel
`exhaust_air_fan_name` Exhaust Air Fan Name required	reference	Fan type must be Fan:OnOff or Fan:SystemModel Names a Fan:OnOff, Fan:SystemModel
`controller_name` Controller Name	reference	Enter the name of a ZoneHVAC:EnergyRecoveryVentilator:Controller object. Names a ZoneHVAC:EnergyRecoveryVentilator:Controller
`ventilation_rate_per_unit_floor_area` Ventilation Rate per Unit Floor Area	number m3/s-m2	0.000508 m3/s-m2 corresponds to 0.1 ft3/min-ft2 Used only when supply and exhaust air flow rates are autosized. Range: ≥ 0
`ventilation_rate_per_occupant` Ventilation Rate per Occupant	number m3/s-person	0.00236 m3/s-person corresponds to 5 ft3/min-person Used only when supply and exhaust air flow rates are autosized. Range: ≥ 0
`availability_manager_list_name` Availability Manager List Name	reference	Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:EnergyRecoveryVentilator:Controller¶

from idfpy.models import ZoneHVACEnergyRecoveryVentilatorController

This controller is used exclusively by the ZoneHVAC:EnergyRecoveryVentilator object to allow economizer (free cooling) operation when possible.

Field	Type	Default	Details
`name` Name required	string
`temperature_high_limit` Temperature High Limit	number C		Enter the maximum outdoor dry-bulb temperature limit for economizer operation. No input or blank input means this limit is not operative
`temperature_low_limit` Temperature Low Limit	number C		Enter the minimum outdoor dry-bulb temperature limit for economizer operation. No input or blank input means this limit is not operative
`enthalpy_high_limit` Enthalpy High Limit	number J/kg		Enter the maximum outdoor enthalpy limit for economizer operation. No input or blank input means this limit is not operative
`dewpoint_temperature_limit` Dewpoint Temperature Limit	number C		Enter the maximum outdoor dew point temperature limit for economizer operation. No input or blank input means this limit is not operative
`electronic_enthalpy_limit_curve_name` Electronic Enthalpy Limit Curve Name	reference		Enter the name of a quadratic or cubic curve which defines the maximum outdoor humidity ratio (function of outdoor dry-bulb temperature) for economizer operation. No input or blank input means this limit is not operative 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
`exhaust_air_temperature_limit` Exhaust Air Temperature Limit	choice	`NoExhaustAirTemperatureLimit`	One of `ExhaustAirTemperatureLimit`, `NoExhaustAirTemperatureLimit`
`exhaust_air_enthalpy_limit` Exhaust Air Enthalpy Limit	choice	`NoExhaustAirEnthalpyLimit`	One of `ExhaustAirEnthalpyLimit`, `NoExhaustAirEnthalpyLimit`
`time_of_day_economizer_flow_control_schedule_name` Time of Day Economizer Flow Control Schedule Name	reference		Schedule values greater than 0 indicate economizer operation is active. This schedule may be used with or without the High Humidity Control option. When used together, high humidity control has priority over economizer control. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`high_humidity_control_flag` High Humidity Control Flag	choice	`No`	Select Yes to modify air flow rates based on a zone humidistat. Select No to disable this feature. One of `No`, `Yes`
`humidistat_control_zone_name` Humidistat Control Zone Name	reference		Enter the name of the zone where the humidistat is located. Names a Zone
`high_humidity_outdoor_air_flow_ratio` High Humidity Outdoor Air Flow Ratio	number	`1.0`	Enter the ratio of supply (outdoor) air to the maximum supply air flow rate when modified air flow rates are active based on high indoor humidity. Range: > 0
`control_high_indoor_humidity_based_on_outdoor_humidity_ratio` Control High Indoor Humidity Based on Outdoor Humidity Ratio	choice	`Yes`	If NO is selected, the air flow rate is modified any time indoor relative humidity is above humidistat setpoint. If YES is selected, outdoor air flow rate is modified any time indoor relative humidity is above the humidistat setpoint AND the outdoor humidity ratio is less than the indoor humidity ratio. One of `No`, `Yes`

Referenced by 1 object types

ZoneHVAC:EnergyRecoveryVentilator

ZoneHVAC:EvaporativeCoolerUnit¶

from idfpy.models import ZoneHVACEvaporativeCoolerUnit

Zone evaporative cooler. Forced-convection cooling-only unit with supply fan, 100% outdoor air supply. Optional relief exhaust node

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
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name required	string		this is an outdoor air node
`cooler_outlet_node_name` Cooler Outlet Node Name required	string		this is a zone inlet node
`zone_relief_air_node_name` Zone Relief Air Node Name	string		this is a zone exhaust node, optional if flow is being balanced elsewhere
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		One of `Fan:ComponentModel`, `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`, `Fan:VariableVolume`
`supply_air_fan_name` Supply Air Fan Name required	reference		Names a Fan:ComponentModel, Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`design_supply_air_flow_rate` Design Supply Air Flow Rate required	number or `Autosize` m3/s
`fan_placement` Fan Placement required	choice		One of `BlowThrough`, `DrawThrough`
`cooler_unit_control_method` Cooler Unit Control Method required	choice		One of `ZoneCoolingLoadOnOffCycling`, `ZoneCoolingLoadVariableSpeedFan`, `ZoneTemperatureDeadbandOnOffCycling`
`throttling_range_temperature_difference` Throttling Range Temperature Difference	number deltaC	`1.0`	used for ZoneTemperatureDeadbandOnOffCycling hysteresis range for thermostatic control Range: > 0
`cooling_load_control_threshold_heat_transfer_rate` Cooling Load Control Threshold Heat Transfer Rate	number W	`100.0`	Sign convention is that positive values indicate a cooling load Range: > 0
`first_evaporative_cooler_object_type` First Evaporative Cooler Object Type required	choice		One of `EvaporativeCooler:Direct:CelDekPad`, `EvaporativeCooler:Direct:ResearchSpecial`, `EvaporativeCooler:Indirect:CelDekPad`, `EvaporativeCooler:Indirect:ResearchSpecial`, `EvaporativeCooler:Indirect:WetCoil`
`first_evaporative_cooler_object_name` First Evaporative Cooler Object Name required	reference		Names a EvaporativeCooler:Direct:CelDekPad, EvaporativeCooler:Direct:ResearchSpecial, EvaporativeCooler:Indirect:CelDekPad, EvaporativeCooler:Indirect:ResearchSpecial, EvaporativeCooler:Indirect:WetCoil
`second_evaporative_cooler_object_type` Second Evaporative Cooler Object Type	choice		optional, used for direct/indirect configurations second cooler must be immediately downstream of first cooler, if present One of `EvaporativeCooler:Direct:CelDekPad`, `EvaporativeCooler:Direct:ResearchSpecial`, `EvaporativeCooler:Indirect:CelDekPad`, `EvaporativeCooler:Indirect:ResearchSpecial`, `EvaporativeCooler:Indirect:WetCoil`
`second_evaporative_cooler_name` Second Evaporative Cooler Name	reference		optional, used for direct/indirect configurations Names a EvaporativeCooler:Direct:CelDekPad, EvaporativeCooler:Direct:ResearchSpecial, EvaporativeCooler:Indirect:CelDekPad, EvaporativeCooler:Indirect:ResearchSpecial, EvaporativeCooler:Indirect:WetCoil
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`shut_off_relative_humidity` Shut Off Relative Humidity	number percent		Zone relative humidity above which the evap cooler is shut off. Range: ≥ 0, ≤ 100

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:FourPipeFanCoil¶

from idfpy.models import ZoneHVACFourPipeFanCoil

Four pipe fan coil system. Forced-convection hydronic heating-cooling unit with supply fan, hot water heating coil, chilled water cooling coil, and fixed-position outdoor air mixer.

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
`capacity_control_method` Capacity Control Method required	choice		One of `ASHRAE90VariableFan`, `ConstantFanVariableFlow`, `CyclingFan`, `MultiSpeedFan`, `VariableFanConstantFlow`, `VariableFanVariableFlow`
`maximum_supply_air_flow_rate` Maximum Supply Air Flow Rate required	number or `Autosize` m3/s
`low_speed_supply_air_flow_ratio` Low Speed Supply Air Flow Ratio	number	`0.33`	Range: > 0
`medium_speed_supply_air_flow_ratio` Medium Speed Supply Air Flow Ratio	number	`0.66`	Medium Speed Supply Air Flow Ratio should be greater than Low Speed Supply Air Flow Ratio Range: > 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate required	number or `Autosize` m3/s
`outdoor_air_schedule_name` Outdoor Air Schedule Name	reference		Value of schedule multiplies maximum outdoor air flow rate 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
`air_outlet_node_name` Air Outlet Node Name required	string
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type	choice		Currently only one type OutdoorAir:Mixer object is available. This field should be left blank if the FanCoil is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name	reference		If this field is blank, the OutdoorAir:Mixer is not used. This optional field specifies the name of the OutdoorAir:Mixer object. When used, this name needs to match name of the OutdoorAir:Mixer object. This field should be left blank if the FanCoil is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. Names a OutdoorAir:Mixer
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Fan type must be according to capacity control method (see I/O) For ConstantFanVariableFlow a Fan:OnOff or Fan:ConstantVolume is valid. For CyclingFan a Fan:OnOff is valid. For VariableFanVariableFlow or VariableFanConstantFlow a Fan:VariableVolume is valid. For ASHRAE90.1 a Fan:OnOff or Fan:VariableVolume is valid. Fan:SystemModel is valid for all capacity control methods. The fan's inlet node should be the same as the outdoor air mixer's mixed air node. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`, `Fan:VariableVolume`
`supply_air_fan_name` Supply Air Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`cooling_coil_object_type` Cooling Coil Object Type required	choice		One of `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `CoilSystem:Cooling:Water:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Names a Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, CoilSystem:Cooling:Water:HeatExchangerAssisted
`maximum_cold_water_flow_rate` Maximum Cold Water Flow Rate required	number or `Autosize` m3/s
`minimum_cold_water_flow_rate` Minimum Cold Water Flow Rate	number m3/s	`0.0`
`cooling_convergence_tolerance` Cooling Convergence Tolerance	number	`0.001`	Range: > 0
`heating_coil_object_type` Heating Coil Object Type required	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Water
`maximum_hot_water_flow_rate` Maximum Hot Water Flow Rate required	number or `Autosize` m3/s
`minimum_hot_water_flow_rate` Minimum Hot Water Flow Rate	number m3/s	`0.0`
`heating_convergence_tolerance` Heating Convergence Tolerance	number	`0.001`	Range: > 0
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule Name values of 0 denote cycling fan operation (fan cycles with cooling coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this field is left blank. This input field is currently used with MultiStageFan capacity control method Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`minimum_supply_air_temperature_in_cooling_mode` Minimum Supply Air Temperature in Cooling Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = ASHRAE90VariableFan, enter the minimum air temperature in cooling mode. Leave this field blank or enter 0 to control to the zone load per ASHRAE 90.1. In this case, a zone sizing simulation is required.
`maximum_supply_air_temperature_in_heating_mode` Maximum Supply Air Temperature in Heating Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = ASHRAE90VariableFan, enter the maximum air temperature in heating mode. Leave this field blank or enter 0 to control to the zone load per ASHRAE 90.1. In this case, a zone sizing simulation is required.

Referenced by 4 object types

AirTerminal:SingleDuct:Mixer, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:HybridUnitaryHVAC¶

from idfpy.models import ZoneHVACHybridUnitaryHVAC extensible

Hybrid Unitary HVAC. A black box model for multi-mode packaged forced air equipment. Independent variables include outdoor air conditions and indoor air conditions. Controlled inputs include operating mode, supply air flow rate, and outdoor air faction. Empirical lookup tables are required to map supply air temperature supply air humidity, electricity use, fuel uses, water use, fan electricity use, and external static pressure as a function of each independent variable and each controlled input. In each timestep the model will choose one or more combinations of settings for mode, supply air flow rate, outdoor air faction, and part runtime fraction so as to satisfy zone requests for sensible cooling, heating, ventilation, and/or dehumidification with the least resource consumption. Equipment in this class may consume electricity, water, and up to two additional fuel types.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Enter the 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
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`minimum_supply_air_temperature_schedule_name` Minimum Supply Air Temperature Schedule Name	reference		Values in this schedule are used as a constraint in choosing the feasible settings for supply air flow rate and outside air fraction in each operating mode. If this field is blank, no minimum is imposed. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_temperature_schedule_name` Maximum Supply Air Temperature Schedule Name	reference		Values in this schedule are used as a constraint in choosing the feasible settings for supply air flow rate and outdoor air fraction in each operating mode. If this field is blank, no maximum is imposed. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`minimum_supply_air_humidity_ratio_schedule_name` Minimum Supply Air Humidity Ratio Schedule Name	reference		Values in this schedule are used as a constraint in choosing the feasible settings for supply air flow rate and outdoor air fraction in each operating mode. If this field is blank, no minimum is imposed. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_humidity_ratio_schedule_name` Maximum Supply Air Humidity Ratio Schedule Name	reference		Values in this schedule are used as a constraint in choosing the feasible settings for supply air flow rate and outdoor air fraction in each operating mode. If this field is blank, no maximum is imposed. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`method_to_choose_controlled_inputs_and_part_runtime_fraction` Method to Choose Controlled Inputs and Part Runtime Fraction	choice	`Automatic`	Select the method that will be used to choose operating mode(s), supply air flow rate(s), outdoor air fraction(s) and part runtime fraction(s) in each time step. "Automatic" = chooses controlled inputs and part runtime fraction(s) to minimize resource use within each time step while best satisfying requested sensible cooling, dehumidification and ventilation, and subject to constraints. "User Defined" = EMS will be used to choose controlled inputs and part runtime fraction(s) in each time step. If this field is blank, default to "Automatic". One of `Automatic`, `User Defined`
`return_air_node_name` Return Air Node Name required	string		Return air node for the hybrid unit must be a zone exhaust node.
`outdoor_air_node_name` Outdoor Air Node Name required	string		Outdoor air node for the hybrid unit must be an outdoor air node.
`supply_air_node_name` Supply Air Node Name required	string		Supply air node for the hybrid unit must be a zone air inlet node.
`relief_node_name` Relief Node Name	string		Relief node for the hybrid unit must be a zone exhaust node, unless flow is being balanced elsewhere.
`system_maximum_supply_air_flow_rate` System Maximum Supply Air Flow Rate	number m3/s		The value in this field represents the maximum supply air volume flow rate among all operating modes. Values of extensive variables in lookup tables are normalized by the system maximum supply air mass flow rate that was used to build performance curves. The value in this field is used to rescale the output from extensive variables to a desired system size. Range: > 0
`external_static_pressure_at_system_maximum_supply_air_flow_rate` External Static Pressure at System Maximum Supply Air Flow Rate	number Pa		Input the external static pressure when the system operates at maximum supply air flow rate. Fan affinity laws are used to scale supply fan power from the values tabulated in lookup tables, to values that match the external static pressure input to this field. If this field is blank, the supply fan power is not scaled from the values tabulated in lookup tables. Range: > 0
`fan_heat_included_in_lookup_tables` Fan Heat Included in Lookup Tables	choice	`No`	This field specifies if the fan heat is accounted for in the lookup tables. One of `No`, `Yes`
`fan_heat_gain_location` Fan Heat Gain Location	choice	`SupplyAirStream`	This field specifies where to add the fan heat in the air stream. One of `MixedAirStream`, `SupplyAirStream`
`fan_heat_in_air_stream_fraction` Fan Heat In Air Stream Fraction	number	`1.0`	0.0 means no fan heat is added to the air stream, 1.0 means all fan heat is added to the air stream. Range: ≥ 0, ≤ 1
`scaling_factor` Scaling Factor	number	`1.0`	The value in this field scales all extensive performance variables including: supply air mass flow rate, fuel uses, and water use. If this field is blank, the default scaling factor is 1. Range: > 0
`minimum_time_between_mode_change` Minimum Time Between Mode Change	number minutes	`10.0`	Any mode selected will not operate for less time than the value input in this field. If the value in this field is larger than each timestep, the mode selected in one time step will persist in later time steps until the minimum time between mode change is satisfied. Supply air mass flow rate and outdoor air fraction within a mode are not subject to minimum runtime and may change in every time step. Mode 0 does not have a minimum time. If this field is blank, the default minimum time between mode change is 10 minutes. Range: ≥ 1
`first_fuel_type` First Fuel Type	choice	`Electricity`	Select the fuel type associated with field: "System Electric Power Lookup Table" in each mode. If this field is blank, default first fuel type = Electricity. One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `None`, `OtherFuel1`, `OtherFuel2`, `Propane`
`second_fuel_type` Second Fuel Type	choice	`None`	Select the fuel type associated with field: "System Second Fuel Consumption Lookup Table" in each mode. If this field is blank, default second fuel type = None. One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `None`, `OtherFuel1`, `OtherFuel2`, `Propane`
`third_fuel_type` Third Fuel Type	choice	`None`	Select the fuel type associated with field: "System Third Fuel Consumption Lookup Table" in each mode. If this field is blank, default third fuel type = None. One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `None`, `OtherFuel1`, `OtherFuel2`, `Propane`
`objective_function_to_minimize` Objective Function to Minimize	choice	`Electricity Use`	In each time step, controlled variables will be chosen to minimize the selection in this field, subject to constraints. If this field is blank, the objective function will minimize electricity use. One of `Electricity Use`, `Second Fuel Use`, `Third Fuel Use`, `Water Use`
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		Enter the name of a DesignSpecification:OutdoorAir object. Information in that object will be used to compute the minimum outdoor air flow rate in each time step. If this field is blank, the system may still supply outdoor air, if it is capable as described by lookup tables, when doing so is the most efficient way to satisfy other constraints. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`mode_0_name` Mode 0 Name	string		Enter a name for Mode 0. Mode 0 describes equipment performance in standby. Mode 0 is usually characterized by electricity use for controls and crankcase heaters, or other standby resource consumption. Mode 0 will be chosen for any timestep, or portion of timestep, when no ventilation, cooling, humidification, or dehumidification is required. Mode 0 is available at any environmental condition.
`mode_0_supply_air_temperature_lookup_table_name` Mode 0 Supply Air Temperature Lookup Table Name	reference		Enter the name of the Supply Air Temperature Lookup Table for Mode 0. Units for lookup table values should be in C. If this field is blank, Mode 0 will not be considered for any period that requires ventilation, heating, cooling, humidification, or dehumidification. If this field is blank, when Mode 0 is chosen (during standby periods) the supply air temperature will equal the return air temperature. Names a Table:Lookup
`mode_0_supply_air_humidity_ratio_lookup_table_name` Mode 0 Supply Air Humidity Ratio Lookup Table Name	reference		Enter the name of the Supply Air Humidity Ratio Lookup Table for Mode 0. Units for lookup table values should be in kgWater/kgDryAir. If this field is blank, Mode 0 will not be considered for any period that requires ventilation, heating, cooling, humidification, or dehumidification. If this field is blank, when Mode 0 is chosen (during standby periods) the supply air humidity ratio will equal the return air humidity ratio. Names a Table:Lookup
`mode_0_system_electric_power_lookup_table_name` Mode 0 System Electric Power Lookup Table Name	reference		Enter the name of the Electric Power Lookup Table for Mode 0. Units for lookup table values should be in W. If this field is blank, Mode 0 does not consume electricity. Names a Table:Lookup
`mode_0_supply_fan_electric_power_lookup_table_name` Mode 0 Supply Fan Electric Power Lookup Table Name	reference		Enter the name of the Supply Fan Electric Power Lookup Table for Mode 0. Units for lookup table values should be in W. If this field is blank, Mode 0 does not consume electricity for supply fan. Names a Table:Lookup
`mode_0_external_static_pressure_lookup_table_name` Mode 0 External Static Pressure Lookup Table Name	reference		Enter the name of the External Static Pressure Lookup Table for Mode 0. Units for lookup table values should be in Pa. If this field is blank, external static pressure will not be reported. Names a Table:Lookup
`mode_0_system_second_fuel_consumption_lookup_table_name` Mode 0 System Second Fuel Consumption Lookup Table Name	reference		Enter the name of the System Second Fuel Consumption Lookup Table for Mode 0. Units for lookup table values should be in W. If this field is blank, Mode 0 does not consume a second fuel. Names a Table:Lookup
`mode_0_system_third_fuel_consumption_lookup_table_name` Mode 0 System Third Fuel Consumption Lookup Table Name	reference		Enter the name of the System Third Fuel Consumption Lookup Table for Mode 0. Units for lookup table values should be in W. If this field is blank, Mode 0 does not consume a third fuel. Names a Table:Lookup
`mode_0_system_water_use_lookup_table_name` Mode 0 System Water Use Lookup Table Name	reference		Enter the name of the System Water Use Lookup Table for Mode 0. Units for lookup table values should be in kg/s. If this field is blank, Mode 0 does not consume water. Names a Table:Lookup
`mode_0_outdoor_air_fraction` Mode 0 Outdoor Air Fraction	number	`0.0`	Enter the outdoor air fraction for Mode 0. If this field is blank, the outdoor air fraction for Mode 0 will be 0.00. Range: ≥ 0, ≤ 1
`mode_0_supply_air_mass_flow_rate_ratio` Mode 0 Supply Air Mass Flow Rate Ratio	number	`0.0`	Enter the supply air mass flow rate ratio for Mode 0. The value in this field will be used to determine the supply air mass flow rate in Mode 0. Supply air mass flow rate ratio describes supply air mass flow rate as a fraction of mass flow rate associated with the value in field: "System Maximum Supply Air Flow Rate". If this field is blank, the supply air mass flow rate ratio for Mode 0 will be 0. Range: ≥ 0, ≤ 1
`modes`	list		Each item: `mode_name`, `mode_supply_air_temperature_lookup_table_name`, `mode_supply_air_humidity_ratio_lookup_table_name`, `mode_system_electric_power_lookup_table_name`, `mode_supply_fan_electric_power_lookup_table_name`, `mode_external_static_pressure_lookup_table_name`, `mode_system_second_fuel_consumption_lookup_table_name`, `mode_system_third_fuel_consumption_lookup_table_name`, `mode_system_water_use_lookup_table_name`, `mode_minimum_outdoor_air_temperature` (C), `mode_maximum_outdoor_air_temperature` (C), `mode_minimum_outdoor_air_humidity_ratio` (kgWater/kgDryAir), `mode_maximum_outdoor_air_humidity_ratio` (kgWater/kgDryAir), `mode_minimum_outdoor_air_relative_humidity` (percent), `mode_maximum_outdoor_air_relative_humidity` (percent), `mode_minimum_return_air_temperature` (C), `mode_maximum_return_air_temperature` (C), `mode_minimum_return_air_humidity_ratio` (kgWater/kgDryAir), `mode_maximum_return_air_humidity_ratio` (kgWater/kgDryAir), `mode_minimum_return_air_relative_humidity` (percent), `mode_maximum_return_air_relative_humidity` (percent), `mode_minimum_outdoor_air_fraction`, `mode_maximum_outdoor_air_fraction`, `mode_minimum_supply_air_mass_flow_rate_ratio`, `mode_maximum_supply_air_mass_flow_rate_ratio`

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:IdealLoadsAirSystem¶

from idfpy.models import ZoneHVACIdealLoadsAirSystem

Ideal system used to calculate loads without modeling a full HVAC system. All that is required for the ideal system are zone controls, zone equipment configurations, and the ideal loads system component. This component can be thought of as an ideal unit that mixes zone air with the specified amount of outdoor air and then adds or removes heat and moisture at 100% efficiency in order to meet the specified controls. Energy use is reported as DistrictHeatingWater and DistrictCooling.

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
`zone_supply_air_node_name` Zone Supply Air Node Name required	string		Must match a zone air inlet node name.
`zone_exhaust_air_node_name` Zone Exhaust Air Node Name	string		Should match a zone air exhaust node name. This field is optional, but is required if this this object is used with other forced air equipment.
`system_inlet_air_node_name` System Inlet Air Node Name	string		This field is only required when the Ideal Loads Air System is connected to an AirloopHVAC:ZoneReturnPlenum, otherwise leave this field blank. When connected to a plenum the return plenum Outlet Node Name (or Induced Air Outlet Node Name when connecting multiple ideal loads air systems) is entered here. The two ideal loads air system node name fields described above, the Zone Supply Air Node Name and the Zone Exhaust Air Node Name must also be entered. The Zone Supply Air Node Name must match a zone inlet air node name for the zone where this Ideal Loads Air System is connected. The Zone Exhaust Air Node Name must match an inlet air node name of an AirloopHVAC:ReturnAirPlenum object.
`maximum_heating_supply_air_temperature` Maximum Heating Supply Air Temperature	number C	`50.0`	Range: > 0, < 100
`minimum_cooling_supply_air_temperature` Minimum Cooling Supply Air Temperature	number C	`13.0`	Range: > -100, < 50
`maximum_heating_supply_air_humidity_ratio` Maximum Heating Supply Air Humidity Ratio	number kgWater/kgDryAir	`0.0156`	Range: > 0
`minimum_cooling_supply_air_humidity_ratio` Minimum Cooling Supply Air Humidity Ratio	number kgWater/kgDryAir	`0.0077`	Range: > 0
`heating_limit` Heating Limit	choice	`NoLimit`	One of `LimitCapacity`, `LimitFlowRate`, `LimitFlowRateAndCapacity`, `NoLimit`
`maximum_heating_air_flow_rate` Maximum Heating Air Flow Rate	number or `Autosize` m3/s		This field is ignored if Heating Limit = NoLimit If this field is blank, there is no limit.
`maximum_sensible_heating_capacity` Maximum Sensible Heating Capacity	number or `Autosize` W		This field is ignored if Heating Limit = NoLimit If this field is blank, there is no limit.
`cooling_limit` Cooling Limit	choice	`NoLimit`	One of `LimitCapacity`, `LimitFlowRate`, `LimitFlowRateAndCapacity`, `NoLimit`
`maximum_cooling_air_flow_rate` Maximum Cooling Air Flow Rate	number or `Autosize` m3/s		This field is ignored if Cooling Limit = NoLimit This field is required if Outdoor Air Economizer Type is anything other than NoEconomizer.
`maximum_total_cooling_capacity` Maximum Total Cooling Capacity	number or `Autosize` W		This field is ignored if Cooling Limit = NoLimit
`heating_availability_schedule_name` Heating Availability Schedule Name	reference		If blank, heating 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		If blank, cooling 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
`dehumidification_control_type` Dehumidification Control Type	choice	`ConstantSensibleHeatRatio`	ConstantSensibleHeatRatio means that the ideal loads system will be controlled to meet the sensible cooling load, and the latent cooling rate will be computed using a constant sensible heat ratio (SHR) Humidistat means that there is a ZoneControl:Humidistat for this zone and the ideal loads system will attempt to satisfy the humidistat. None means that there is no dehumidification. ConstantSupplyHumidityRatio means that during cooling the supply air will always be at the Minimum Cooling Supply Humidity Ratio. One of `ConstantSensibleHeatRatio`, `ConstantSupplyHumidityRatio`, `Humidistat`, `None`
`cooling_sensible_heat_ratio` Cooling Sensible Heat Ratio	number dimensionless	`0.7`	This field is applicable only when Dehumidification Control Type is ConstantSensibleHeatRatio Range: > 0, ≤ 1
`humidification_control_type` Humidification Control Type	choice	`None`	None means that there is no humidification. Humidistat means that there is a ZoneControl:Humidistat for this zone and the ideal loads system will attempt to satisfy the humidistat. ConstantSupplyHumidityRatio means that during heating the supply air will always be at the Maximum Heating Supply Humidity Ratio. One of `ConstantSupplyHumidityRatio`, `Humidistat`, `None`
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the minimum outdoor air flow rate will be computed using these specifications. The outdoor air flow rate will also be affected by the next two fields. If this field is blank, there will be no outdoor air and the remaining fields will be ignored. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		This field is required if the system provides outdoor air Enter the name of an outdoor air node. This node name is also specified in an OutdoorAir:Node or OutdoorAir:NodeList object.
`demand_controlled_ventilation_type` Demand Controlled Ventilation Type	choice	`None`	This field controls how the minimum outdoor air flow rate is calculated. None means that design occupancy will be used to compute the minimum outdoor air flow rate OccupancySchedule means that current occupancy level will be used. CO2Setpoint means that the design occupancy will be used to compute the minimum outdoor air flow rate and the outdoor air flow rate may be increased if necessary to maintain the indoor air carbon dioxide setpoint defined in a ZoneControl:ContaminantController object. One of `CO2Setpoint`, `None`, `OccupancySchedule`
`outdoor_air_economizer_type` Outdoor Air Economizer Type	choice	`NoEconomizer`	DifferentialDryBulb and DifferentialEnthalpy will increase the outdoor air flow rate when there is a cooling load and the outdoor air temperature or enthalpy is below the zone exhaust air temperature or enthalpy. One of `DifferentialDryBulb`, `DifferentialEnthalpy`, `NoEconomizer`
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number dimensionless	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number dimensionless	`0.65`	Applicable only if Heat Recovery Type is Enthalpy. Range: ≥ 0, ≤ 1
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`heating_fuel_efficiency_schedule_name` Heating Fuel Efficiency Schedule Name	reference		Reference heating fuel efficiency value for converting heating ideal loads into fuel energy consumption. The minimum schedule value must be greater than 0.0. The maximum value depends on the technology, and can exceed 1.0. If blank, heating fuel efficiency value 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
`heating_fuel_type` Heating Fuel Type	choice	`DistrictHeatingWater`	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`cooling_fuel_efficiency_schedule_name` Cooling Fuel Efficiency Schedule Name	reference		Reference cooling fuel efficiency value for converting cooling ideal loads into fuel energy consumption. The minimum schedule value must be greater than 0.0. The maximum value depends on the technology, and can exceed 1.0. If blank, cooling fuel efficiency value 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
`cooling_fuel_type` Cooling Fuel Type	choice	`DistrictCooling`	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:OutdoorAirUnit¶

from idfpy.models import ZoneHVACOutdoorAirUnit

The zone outdoor air unit models a single-zone dedicated outdoor air system (DOAS). Forced-convection 100% outdoor air unit with supply fan and optional equipment including exhaust fan, heating coil, cooling coil, and heat recovery.

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
`zone_name` Zone Name required	reference		(name of zone system is serving) Names a Zone
`outdoor_air_flow_rate` Outdoor Air Flow Rate required	number or `Autosize` m3/s
`outdoor_air_schedule_name` Outdoor Air Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_name` Supply Fan Name required	reference		Allowable fan types are Fan:SystemModel and Fan:ConstantVolume and Fan:VariableVolume Names a Fan:ConstantVolume, Fan:SystemModel, Fan:VariableVolume
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`exhaust_fan_name` Exhaust Fan Name	reference		Allowable fan types are Fan:SystemModel and Fan:ConstantVolume and Fan:VariableVolume Fan:VariableVolume Names a Fan:ConstantVolume, Fan:SystemModel, Fan:VariableVolume
`exhaust_air_flow_rate` Exhaust Air Flow Rate	number or `Autosize` m3/s
`exhaust_air_schedule_name` Exhaust Air Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`unit_control_type` Unit Control Type	choice	`NeutralControl`	One of `NeutralControl`, `TemperatureControl`
`high_air_control_temperature_schedule_name` High Air Control Temperature Schedule Name	reference		Air and control temperatures for cooling. If outdoor air temperature is above the high air control temperature, then the zone inlet air temperature is set to the high air control temperature. If the outdoor air is between high and low air control temperature, then there is no cooling/heating requirements. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`low_air_control_temperature_schedule_name` Low Air Control Temperature Schedule Name	reference		Air and control temperatures for Heating. If outdoor air temperature is below the low air control temperature, then the zone inlet air temperature is set to the low air control temperature. If the outdoor air is between high and low air control temperature, then there is no cooling/heating requirements. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`outdoor_air_node_name` Outdoor Air Node Name required	string
`airoutlet_node_name` AirOutlet Node Name required	string
`airinlet_node_name` AirInlet Node Name	string		air leaves zone
`supply_fanoutlet_node_name` Supply FanOutlet Node Name required	string
`outdoor_air_unit_list_name` Outdoor Air Unit List Name required	reference		Enter the name of an ZoneHVAC:OutdoorAirUnit:EquipmentList object. Names a ZoneHVAC:OutdoorAirUnit:EquipmentList
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:OutdoorAirUnit:EquipmentList¶

from idfpy.models import ZoneHVACOutdoorAirUnitEquipmentList

Equipment list for components in a ZoneHVAC:OutdoorAirUnit. Components are simulated sequentially in the order given in the equipment list.

Field	Type	Details
`name` Name required	string
`component_1_object_type` Component 1 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_1_name` Component 1 Name	string
`component_2_object_type` Component 2 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_2_name` Component 2 Name	string
`component_3_object_type` Component 3 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_3_name` Component 3 Name	string
`component_4_object_type` Component 4 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_4_name` Component 4 Name	string
`component_5_object_type` Component 5 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_5_name` Component 5 Name	string
`component_6_object_type` Component 6 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_6_name` Component 6 Name	string
`component_7_object_type` Component 7 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_7_name` Component 7 Name	string
`component_8_object_type` Component 8 Object Type	choice	One of `AirLoopHVAC:UnitarySystem`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `CoilSystem:Cooling:DX`, `CoilSystem:Cooling:Water:HeatexchangerAssisted`, `CoilSystem:Heating:DX`, `Dehumidifier:Desiccant:NoFans`, `HeatExchanger:AirToAir:FlatPlate`, `HeatExchanger:AirToAir:SensibleAndLatent`
`component_8_name` Component 8 Name	string

Referenced by 1 object types

ZoneHVAC:OutdoorAirUnit

ZoneHVAC:PackagedTerminalAirConditioner¶

from idfpy.models import ZoneHVACPackagedTerminalAirConditioner

Packaged terminal air conditioner (PTAC). Forced-convection heating-cooling unit with supply fan, direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam) and fixed-position outdoor air mixer.

Field	Type	Default	Details
`name` Name required	string		Unique name for this packaged terminal air conditioner object.
`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. Schedule values of 0 denote the unit is off. 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		Air inlet node for the PTAC must be a zone air exhaust Node.
`air_outlet_node_name` Air Outlet Node Name required	string		Air outlet node for the PTAC must be a zone air inlet node.
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type	choice		Currently only one OutdoorAir:Mixer object type is available. This field should be left blank if the PTAC is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name	reference		If this field is blank, the OutdoorAir:Mixer is not used. This optional field specifies the name of the OutdoorAir:Mixer object. When used, this name needs to match name of the OutdoorAir:Mixer object. This field should be left blank if the PTAC is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. Names a OutdoorAir:Mixer
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to fan size. Only used when supply air fan operating mode schedule values specify continuous fan (schedule values greater than 0 specify continuous fan operation). This air flow rate is used when no heating or cooling is required and the cooling or heating coil is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`no_load_supply_air_flow_rate_control_set_to_low_speed` No Load Supply Air Flow Rate Control Set To Low Speed	choice	`Yes`	When Yes is selected the minimum air flow rate is used. When No is selected the maximum air flow rate is used. One of `No`, `Yes`
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during cooling operation. This field is set to zero flow when the PTAC is connected to central dedicated outdoor air through air terminal single duct mixer object.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during heating operation. This field is set to zero flow when the PTAC is connected to central dedicated outdoor air through air terminal single duct mixer object.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s		Only used when supply air fan operating mode schedule values specify continuous fan (schedule values greater than 0 specify continuous fan operation). This air flow rate is used when no heating or cooling is required and the cooling or heating coil is off. If this field is left blank or zero, the outdoor air flow rate from the previous on cycle (either cooling or heating) is used. This field is set to zero flow when the PTAC is connected to central dedicated outdoor air through air terminal single duct mixer object.
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Fan:ConstantVolume only works when continuous fan operation is used the entire simulation (all supply air fan operating mode schedule values are greater than 0). If any fan operating mode schedule values are 0 a Fan:SystemModel or Fan:OnOff object must be used. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_name` Supply Air Fan Name required	reference		Needs to match in the fan object. Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel
`heating_coil_object_type` Heating Coil Object Type required	choice		Select the type of heating coil. One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Needs to match in the heating coil object. Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Select the type of Cooling Coil. Only works with Coil:Cooling:DX or Coil:Cooling:DX:SingleSpeed or CoilSystem:Cooling:DX:HeatExchangerAssisted or Coil:Cooling:DX:VariableSpeed. One of `Coil:Cooling:DX`, `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match a DX cooling coil object. Names a Coil:Cooling:DX, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`fan_placement` Fan Placement	choice	`DrawThrough`	Select fan placement as either blow through or draw through. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule Name values of 0 denote cycling fan operation (fan cycles with cooling or heating coil). Schedule Name values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`capacity_control_method` Capacity Control Method	choice	`None`	One of `None`, `SingleZoneVAV`
`minimum_supply_air_temperature_in_cooling_mode` Minimum Supply Air Temperature in Cooling Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = SingleZoneVAV, enter the minimum air temperature limit for reduced fan speed.
`maximum_supply_air_temperature_in_heating_mode` Maximum Supply Air Temperature in Heating Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = SingleZoneVAV, enter the maximum air temperature limit for reduced fan speed.

Referenced by 4 object types

AirTerminal:SingleDuct:Mixer, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:PackagedTerminalHeatPump¶

from idfpy.models import ZoneHVACPackagedTerminalHeatPump

Packaged terminal heat pump (PTHP). Forced-convection heating-cooling unit with supply fan, direct expansion (DX) cooling coil, DX heating coil (air-to-air heat pump), supplemental heating coil (gas, electric, hot water, or steam), and fixed-position outdoor air mixer.

Field	Type	Default	Details
`name` Name required	string		Unique name for this packaged terminal heat pump object.
`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. Schedule values of 0 denote the unit is off. 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		Air inlet node for the PTHP must be a zone air exhaust node.
`air_outlet_node_name` Air Outlet Node Name required	string		Air outlet node for the PTHP must be a zone air inlet node.
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type	choice		Currently only one OutdoorAir:Mixer object type is available. This field should be left blank if the PTHP is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name	reference		If this field is blank, the OutdoorAir:Mixer is not used. This optional field specifies the name of the OutdoorAir:Mixer object. When used, this name needs to match name of the OutdoorAir:Mixer object. This field should be left blank if the PTHP is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. Names a OutdoorAir:Mixer
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to fan size. Only used when heat pump fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`no_load_supply_air_flow_rate_control_set_to_low_speed` No Load Supply Air Flow Rate Control Set To Low Speed	choice	`Yes`	When Yes is selected the minimum air flow rate is used. When No is selected the maximum air flow rate is used. One of `No`, `Yes`
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during cooling operation. This field is set to zero flow when the PTHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during heating operation. This field is set to zero flow when the PTHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s		Only used when heat pump Fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the outdoor air flow rate from the previous on cycle (either cooling or heating) is used. This field is set to zero flow when the PTHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Fan:ConstantVolume only works with fan operating mode is continuous. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_name` Supply Air Fan Name required	reference		Needs to match a fan object. Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel
`heating_coil_object_type` Heating Coil Object Type required	choice		Only works with Coil:Heating:DX:SingleSpeed or Coil:Heating:DX:VariableSpeed. One of `Coil:Heating:DX:SingleSpeed`, `Coil:Heating:DX:VariableSpeed`
`heating_coil_name` Heating Coil Name required	reference		Needs to match in the DX Heating Coil object. Names a Coil:Heating:DX:SingleSpeed, Coil:Heating:DX:VariableRefrigerantFlow, Coil:Heating:DX:VariableSpeed
`heating_convergence_tolerance` Heating Convergence Tolerance	number dimensionless	`0.001`	Defines Heating convergence tolerance as a fraction of Heating load to be met. Range: > 0
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Only works with Coil:Cooling:DX or Coil:Cooling:DX:SingleSpeed or CoilSystem:Cooling:DX:HeatExchangerAssisted or Coil:Cooling:DX:VariableSpeed. One of `Coil:Cooling:DX`, `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match in the DX Cooling Coil object. Names a Coil:Cooling:DX, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`cooling_convergence_tolerance` Cooling Convergence Tolerance	number dimensionless	`0.001`	Defines Cooling convergence tolerance as a fraction of the Cooling load to be met. Range: > 0
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coil. One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name required	reference		Needs to match in the supplemental heating coil object. Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater required	number or `Autosize` C		Supply air temperature from the supplemental heater will not exceed this value.
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Supplemental heater will not operate when outdoor temperature exceeds this value. Range: ≤ 21
`fan_placement` Fan Placement	choice	`DrawThrough`	Select fan placement as either blow through or draw through. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule values of 0 denote cycling fan operation (fan cycles with cooling or heating coil). Schedule Name values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`capacity_control_method` Capacity Control Method	choice	`None`	One of `None`, `SingleZoneVAV`
`minimum_supply_air_temperature_in_cooling_mode` Minimum Supply Air Temperature in Cooling Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = SingleZoneVAV, enter the minimum air temperature limit for reduced fan speed.
`maximum_supply_air_temperature_in_heating_mode` Maximum Supply Air Temperature in Heating Mode	number or `Autosize` C	`Autosize`	For Capacity Control Method = SingleZoneVAV, enter the maximum air temperature limit for reduced fan speed.
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0

Referenced by 4 object types

AirTerminal:SingleDuct:Mixer, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:TerminalUnit:VariableRefrigerantFlow¶

from idfpy.models import ZoneHVACTerminalUnitVariableRefrigerantFlow

A terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air heat pump). The VRF terminal units are served by an AirConditioner:VariableRefrigerantFlow or AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:* system. Terminal units can be configured as zone, air loop or outside air system equipment.

Field	Type	Default	Details
`name` Zone Terminal Unit Name	string
`terminal_unit_availability_schedule` Terminal Unit Availability Schedule	reference		The unit is available the entire simulation if this field is left blank Schedule values of 0 denote the unit is off. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`terminal_unit_air_inlet_node_name` Terminal Unit Air Inlet Node Name required	string		the inlet node to the terminal unit
`terminal_unit_air_outlet_node_name` Terminal Unit Air Outlet Node Name required	string		the outlet node of the terminal unit
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s
`no_cooling_supply_air_flow_rate` No Cooling Supply Air Flow Rate	number or `Autosize` m3/s
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s
`no_heating_supply_air_flow_rate` No Heating Supply Air Flow Rate	number or `Autosize` m3/s
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate	number or `Autosize` m3/s		This field is used only when an outdoor air mixer is included. This field is set to zero flow when the VRF terminal unit is connected to central dedicated outdoor air through air terminal single duct mixer object. When this VRF terminal is used as air loop equipment the autosized flow rate will be set to 0 when an outdoor air system is connected to this air loop, otherwise the outdoor air flow rate will equal the maximum outdoor air flow rate.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate	number or `Autosize` m3/s		This field is used only when an outdoor air mixer is included. This field is set to zero flow when the VRF terminal unit is connected to central dedicated outdoor air through air terminal single duct mixer object. When this VRF terminal is used as air loop equipment the autosized flow rate will be set to 0 when an outdoor air system is connected to this air loop, otherwise the outdoor air flow rate will equal the maximum outdoor air flow rate.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s		This field is used only when an outdoor air mixer is included. This field is set to zero flow when the VRF terminal unit is connected to central dedicated outdoor air through air terminal single duct mixer object. When this VRF terminal is used as air loop equipment the autosized flow rate will be set to 0 when an outdoor air system is connected to this air loop, otherwise the outdoor air flow rate will equal the maximum outdoor air flow rate.
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Required for zone equipment. Leave blank if terminal unit is used in AirLoopHVAC:OutdoorAirSystem:EquipmentList. Also leave blank if terminal unit is used on main AirloopHVAC branch and terminal unit has no fan. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_air_fan_placement` Supply Air Fan Placement	choice	`BlowThrough`	Select fan placement as either blow through or draw through. Required for zone equipment. This field is ignored if the VRF terminal unit is used in AirLoopHVAC:OutdoorAirSystem:EquipmentList. This field is also ignored if VRF terminal unit is used on main AirloopHVAC branch and terminal unit has no fan. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_object_type` Supply Air Fan Object Type	choice	`Fan:ConstantVolume`	Supply Air Fan Object Type must be Fan:SystemModel, Fan:OnOff, or Fan:ConstantVolume if AirConditioner:VariableRefrigerantFlow is used to model VRF outdoor unit Supply Air Fan Object Type must be Fan:SystemModel if AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR is used to model VRF outdoor unit Required for zone equipment. Leave blank if terminal unit is used in AirLoopHVAC:OutdoorAirSystem:EquipmentList. Also leave blank if terminal unit is used on main AirloopHVAC branch and terminal unit has no fan. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_object_name` Supply Air Fan Object Name	reference		Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`outside_air_mixer_object_type` Outside Air Mixer Object Type	choice		Currently only one type OutdoorAir:Mixer object is available. If this field is blank, and outside air mixer is not used. This field should be left blank if the VRF terminal unit is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. This field may also be left blank when the VRF terminal is used in the air loop or outdoor air system. One of `OutdoorAir:Mixer`
`outside_air_mixer_object_name` Outside Air Mixer Object Name	reference		If this field is blank, the OutdoorAir:Mixer is not used. This optional field specifies the name of the OutdoorAir:Mixer object. When used, this name needs to match name of the OutdoorAir:Mixer object. This field should be left blank if the VRF terminal unit is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. This field may also be left blank when the VRF terminal is used in the air loop or outdoor air system. Names a OutdoorAir:Mixer
`cooling_coil_object_type` Cooling Coil Object Type	choice		Cooling Coil Type must be Coil:Cooling:DX:VariableRefrigerantFlow if AirConditioner:VariableRefrigerantFlow is used to model VRF outdoor unit Cooling Coil Type must be Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl if AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or if AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR is used to model VRF outdoor unit This field may be left blank if heating-only mode is used One of `Coil:Cooling:DX:VariableRefrigerantFlow`, `Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl`
`cooling_coil_object_name` Cooling Coil Object Name	reference		Cooling Coil Type must be Coil:Cooling:DX:VariableRefrigerantFlow This field may be left blank if heating-only mode is used Names a Coil:Cooling:DX:VariableRefrigerantFlow, Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl
`heating_coil_object_type` Heating Coil Object Type	choice		Heating Coil Type must be Coil:Heating:DX:VariableRefrigerantFlow if AirConditioner:VariableRefrigerantFlow is used to model VRF outdoor unit Heating Coil Type must be Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl if AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or if AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR is used to model VRF outdoor unit This field may be left blank if cooling-only mode is used One of `Coil:Heating:DX:VariableRefrigerantFlow`, `Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl`
`heating_coil_object_name` Heating Coil Object Name	reference		Heating Coil Type must be Coil:Heating:DX:VariableRefrigerantFlow This field may be left blank if cooling-only mode is used Names a Coil:Heating:DX:VariableRefrigerantFlow, Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl
`zone_terminal_unit_on_parasitic_electric_energy_use` Zone Terminal Unit On Parasitic Electric Energy Use	number W	`0.0`	Range: ≥ 0
`zone_terminal_unit_off_parasitic_electric_energy_use` Zone Terminal Unit Off Parasitic Electric Energy Use	number W	`0.0`	Range: ≥ 0
`rated_heating_capacity_sizing_ratio` Rated Heating Capacity Sizing Ratio	number W/W	`1.0`	If this terminal unit's heating coil is autosized, the heating capacity is sized to be equal to the cooling capacity multiplied by this sizing ratio. This input applies to the terminal unit heating coil and overrides the sizing ratio entered in the AirConditioner:VariableRefrigerantFlow object. Range: ≥ 1
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type	choice		works with gas, electric, hot water and steam heating coil. One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name	reference		Needs to match in the supplemental heating coil object. Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater	number or `Autosize` C	`Autosize`	Supply air temperature from the supplemental heater will not exceed this value.
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Supplemental heater will not operate when outdoor temperature exceeds this value. Range: ≤ 21
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location	reference		Used only for AirloopHVAC equipment on a main branch and defines zone name where thermostat is located. Not required for zone equipment. Leave blank if terminal unit is used in AirLoopHVAC:OutdoorAirSystem:EquipmentList. Required when terminal unit is used on main AirloopHVAC branch and coils are not set point controlled. When terminal unit is used in air loop and is load controlled, this zone's thermostat will control operation. Names a Zone
`design_specification_multispeed_object_type` Design Specification Multispeed Object Type	choice		Enter the type of performance specification object used to describe the multispeed coil or fan. One of `UnitarySystemPerformance:Multispeed`
`design_specification_multispeed_object_name` Design Specification Multispeed Object Name	reference		The name of the performance specification object used to describe the multispeed coil or fan. Names a UnitarySystemPerformance:Multispeed

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirTerminal:SingleDuct:Mixer, Branch, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList, ZoneTerminalUnitList

ZoneHVAC:UnitHeater¶

from idfpy.models import ZoneHVACUnitHeater

Unit heater. Forced-convection heating-only unit with supply fan, heating coil (gas, electric, hot water, or steam) and fixed-position outdoor air mixer.

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	string
`air_outlet_node_name` Air Outlet Node Name	string
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Allowable fan types are Fan:ConstantVolume, Fan:OnOff, Fan:VariableVolume and Fan:SystemModel One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`, `Fan:VariableVolume`
`supply_air_fan_name` Supply Air Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`maximum_supply_air_flow_rate` Maximum Supply Air Flow Rate required	number or `Autosize` m3/s
`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
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule name values of 0 denote cycling fan operation (fan cycles with the heating coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this input field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_air_fan_operation_during_no_heating` Supply Air Fan Operation During No Heating required	choice		This choice field allows the user to define how the unit heater will operate under "no heating load" or cooling conditions. If the "No" is selected, then the fan will not run unless there is a heating load. If the fan does not run, this effectively shuts the unit heater system off when there is no heating load. If the "Yes" is selected, the unit heater is available and has a ConstantVolume fan, or has an OnOff fan with "Supply Air Fan Operating Mode Schedule" value greater than zero, then the fan will always run regardless of the zone load. One of `No`, `Yes`
`maximum_hot_water_or_steam_flow_rate` Maximum Hot Water or Steam Flow Rate	number or `Autosize` m3/s		Not used when heating coil 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 is gas or electric Range: ≥ 0
`heating_convergence_tolerance` Heating Convergence Tolerance	number	`0.001`	Range: > 0
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:UnitVentilator¶

from idfpy.models import ZoneHVACUnitVentilator

Unit ventilator. Forced-convection ventilation unit with supply fan (constant-volume or variable-volume), optional chilled water cooling coil, optional heating coil (gas, electric, hot water, or steam) and controllable outdoor air mixer.

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_supply_air_flow_rate` Maximum Supply Air Flow Rate required	number or `Autosize` m3/s
`outdoor_air_control_type` Outdoor Air Control Type required	choice		One of `FixedAmount`, `FixedTemperature`, `VariablePercent`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate required	number or `Autosize` m3/s
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name required	reference		schedule values multiply the minimum outdoor air flow rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate required	number or `Autosize` m3/s
`maximum_outdoor_air_fraction_or_temperature_schedule_name` Maximum Outdoor Air Fraction or Temperature Schedule Name required	reference		that this depends on the control type as to whether it is a fraction or temperature 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		Inlet node name must be zone exhaust node name if there is no DOA Mixer, or if the unit ventilator is connected DOA, then the air inlet node name must be the mixer outlet air node name for InletSide mixer connection.
`air_outlet_node_name` Air Outlet Node Name required	string		Outlet node name must be zone inlet node name if there is no DOA Mixer, or if the unit ventilator is connected DOA, then the air outlet node name must be the mixer secondary air inlet node name for SupplySide mixer connection.
`outdoor_air_node_name` Outdoor Air Node Name	string		this field is left blank only if the Unit Ventilator is connected to a central dedicated outdoor air (DOA) via AirTerminal:SingleDuct:Mixer object
`exhaust_air_node_name` Exhaust Air Node Name	string		this field is left blank only if the Unit Ventilator is connected to a central dedicated outdoor air (DOA) via AirTerminal:SingleDuct:Mixer object
`mixed_air_node_name` Mixed Air Node Name	string		inlet to coils this field is left blank only if the Unit Ventilator is connected to a central dedicated outdoor air (DOA) via AirTerminal:SingleDuct:Mixer object
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Allowable fan types are Fan:ConstantVolume, Fan:OnOff, Fan:VariableVolume, and Fan:SystemModel One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`, `Fan:VariableVolume`
`supply_air_fan_name` Supply Air Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`coil_option` Coil Option required	choice		One of `Cooling`, `Heating`, `HeatingAndCooling`, `None`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule name values of 0 denote cycling fan operation (fan cycles with cooling/heating coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this input field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_object_type` Heating Coil Object Type	choice		One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`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`, `CoilSystem:Cooling:Water:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name	reference		Names a Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, CoilSystem:Cooling:Water:HeatExchangerAssisted
`cooling_convergence_tolerance` Cooling Convergence Tolerance	number	`0.001`	Range: > 0
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing

Referenced by 4 object types

AirTerminal:SingleDuct:Mixer, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:WaterToAirHeatPump¶

from idfpy.models import ZoneHVACWaterToAirHeatPump

Water-to-air heat pump. Forced-convection heating-cooling unit with supply fan, water-to-air cooling and heating coils, supplemental heating coil (gas, electric, hot water, or steam), and fixed-position outdoor air mixer.

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
`air_outlet_node_name` Air Outlet Node Name required	string
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type	choice		Currently only one OutdoorAir:Mixer object type is available. This field should be left blank if the WSHP is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name	reference		If this field is blank, the OutdoorAir:Mixer is not used. This optional field specifies the name of the OutdoorAir:Mixer object. When used, this name needs to match name of the OutdoorAir:Mixer object. This field should be left blank if the WSHP is connected to central dedicated outdoor air through an AirTerminal:SingleDuct:Mixer object. Names a OutdoorAir:Mixer
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to fan size.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to fan size. Only used when heat pump fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`no_load_supply_air_flow_rate_control_set_to_low_speed` No Load Supply Air Flow Rate Control Set To Low Speed	choice	`Yes`	When Yes is selected the minimum air flow rate is used. When No is selected the maximum air flow rate is used. One of `No`, `Yes`
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during cooling operation. This field is set to zero flow when the WSHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to supply air flow rate during heating operation. This field is set to zero flow when the WSHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s		Only used when heat pump Fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the outdoor air flow rate from the previous on cycle (either cooling or heating) is used. This field is set to zero flow when the PTHP is connected to central dedicated outdoor air through air terminal single duct mixer object.
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		One of `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_name` Supply Air Fan Name required	reference		Needs to match Fan:SystemModel or Fan:OnOff object Names a Fan:OnOff, Fan:SystemModel
`heating_coil_object_type` Heating Coil Object Type required	choice		One of `Coil:Heating:WaterToAirHeatPump:EquationFit`, `Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit`
`heating_coil_name` Heating Coil Name required	reference		Needs to match in the water-to-air heat pump heating coil object Names a Coil:Heating:WaterToAirHeatPump:EquationFit, Coil:Heating:WaterToAirHeatPump:ParameterEstimation, Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit
`cooling_coil_object_type` Cooling Coil Object Type required	choice		One of `Coil:Cooling:WaterToAirHeatPump:EquationFit`, `Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match in the water-to-air heat pump cooling coil object Names a Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name required	reference		Needs to match in the supplemental heating coil object Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater	number or `Autosize` C	`Autosize`	Supply air temperature from the supplemental heater will not exceed this value.
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Range: ≤ 21
`outdoor_dry_bulb_temperature_sensor_node_name` Outdoor Dry-Bulb Temperature Sensor Node Name	string
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule values of 0 denote cycling fan operation (fan cycles with cooling or heating coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`heat_pump_coil_water_flow_mode` Heat Pump Coil Water Flow Mode	choice	`Cycling`	used only when the heat pump coils are of the type WaterToAirHeatPump:EquationFit Constant results in 100% water flow regardless of compressor PLR Cycling results in water flow that matches compressor PLR ConstantOnDemand results in 100% water flow whenever the coil is on, but is 0% whenever the coil has no load One of `Constant`, `ConstantOnDemand`, `Cycling`
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing
`design_specification_multispeed_object_type` Design Specification Multispeed Object Type	choice		Enter the type of performance specification object used to describe the multispeed coil or fan. One of `UnitarySystemPerformance:Multispeed`
`design_specification_multispeed_object_name` Design Specification Multispeed Object Name	reference		The name of the performance specification object used to describe the multispeed coil or fan. Names a UnitarySystemPerformance:Multispeed
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0

Referenced by 4 object types

AirTerminal:SingleDuct:Mixer, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

ZoneHVAC:WindowAirConditioner¶

from idfpy.models import ZoneHVACWindowAirConditioner

Window air conditioner. Forced-convection cooling-only unit with supply fan, direct expansion (DX) cooling coil, and fixed-position outdoor air mixer.

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_supply_air_flow_rate` Maximum Supply Air Flow Rate required	number or `Autosize` m3/s
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate required	number or `Autosize` m3/s
`air_inlet_node_name` Air Inlet Node Name required	string
`air_outlet_node_name` Air Outlet Node Name required	string
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type required	choice		currently only one OutdoorAir:Mixer object type is available. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name required	reference		Names a OutdoorAir:Mixer
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Fan:ConstantVolume only works when continuous fan operation is used the entire simulation (all supply air fan operating mode schedule values are greater than 0). If any fan operating mode schedule values are 0 a Fan:SystemModel or Fan:OnOff object must be used. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_name` Supply Air Fan Name required	reference		Fan type Fan:ConstantVolume is used with continuous fan and fan type Fan:OnOff is used with cycling Fan. Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel
`cooling_coil_object_type` Cooling Coil Object Type required	choice		One of `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`dx_cooling_coil_name` DX Cooling Coil Name required	reference		Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule Name values of 0 denote cycling fan operation (fan cycles with cooling coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fan_placement` Fan Placement required	choice		One of `BlowThrough`, `DrawThrough`
`cooling_convergence_tolerance` Cooling Convergence Tolerance	number	`0.001`	Range: > 0
`availability_manager_list_name` Availability Manager List Name	reference		Enter the name of an AvailabilityManagerAssignmentList object. Names a AvailabilityManagerAssignmentList
`design_specification_zonehvac_sizing_object_name` Design Specification ZoneHVAC Sizing Object Name	reference		Enter the name of a DesignSpecificationZoneHVACSizing object. Names a DesignSpecification:ZoneHVAC:Sizing

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList