pyidf.zone_hvac_forced_air_units module

Data objects in group “Zone HVAC Forced Air Units”

class pyidf.zone_hvac_forced_air_units.ZoneHvacDehumidifierDx

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Dehumidifier:DX 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.

air_inlet_node_name

field Air Inlet Node Name

Air inlet node for the dehumidifier must be a zone air exhaust node.

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

air_outlet_node_name

field Air Outlet Node Name

Air outlet node for the dehumidifier must be a zone air inlet node.

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

availability_schedule_name

field Availability Schedule Name

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.

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

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

Name of storage tank used to collect water removed by the dehumidifier.

Parameters:value (str) – value for IDD Field Condensate Collection Water Storage Tank Name Raises:ValueError – if value is not a valid value Returns:the value of condensate_collection_water_storage_tank_name or None if not set Return type:str

energy_factor_curve_name

field Energy Factor Curve Name

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 + b*T + c*T**2 + d*RH +

e*RH**2 + f*T*RH

T = inlet air dry-bulb temperature (C)

RH = inlet air RH (%)

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

maximum_drybulb_temperature_for_dehumidifier_operation

field Maximum Dry-Bulb Temperature for Dehumidifier Operation

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.

Units: C

Default value: 35.0

Parameters:value (float) – value for IDD Field Maximum Dry-Bulb Temperature for Dehumidifier Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_drybulb_temperature_for_dehumidifier_operation or None if not set Return type:float

minimum_drybulb_temperature_for_dehumidifier_operation

field Minimum Dry-Bulb Temperature for Dehumidifier Operation

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.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Minimum Dry-Bulb Temperature for Dehumidifier Operation Raises:ValueError – if value is not a valid value Returns:the value of minimum_drybulb_temperature_for_dehumidifier_operation or None if not set Return type:float

name

field Name

Unique name for this direct expansion (DX) zone dehumidifier object.

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

offcycle_parasitic_electric_load

field Off-Cycle Parasitic Electric Load

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.

Units: W

Parameters:value (float) – value for IDD Field Off-Cycle Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of offcycle_parasitic_electric_load or None if not set Return type:float

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

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 + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (dehumidification load/steady state water removal capacity)

Parameters:value (str) – value for IDD Field Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of part_load_fraction_correlation_curve_name or None if not set Return type:str

rated_air_flow_rate

field Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_air_flow_rate or None if not set Return type:float

rated_energy_factor

field Rated Energy Factor

Rating point: air entering dehumidifier at 26.7 C (80 F) dry-bulb and 60% relative humidity.

Units: L/kWh

Parameters:value (float) – value for IDD Field Rated Energy Factor Raises:ValueError – if value is not a valid value Returns:the value of rated_energy_factor or None if not set Return type:float

rated_water_removal

field Rated Water Removal

Rating point: air entering dehumidifier at 26.7 C (80 F) dry-bulb and 60% relative humidity.

Units: L/day

Parameters:value (float) – value for IDD Field Rated Water Removal Raises:ValueError – if value is not a valid value Returns:the value of rated_water_removal or None if not set Return type:float

water_removal_curve_name

field Water Removal Curve Name

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 + b*T + c*T**2 + d*RH +

e*RH**2 + f*T*RH

T = inlet air dry-bulb temperature (C)

RH = inlet air RH (%)

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

class pyidf.zone_hvac_forced_air_units.ZoneHvacEnergyRecoveryVentilator

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:EnergyRecoveryVentilator 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).

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

controller_name

field Controller Name

Enter the name of a ZoneHVAC:EnergyRecoveryVentilator:Controller object.

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

exhaust_air_fan_name

field Exhaust Air Fan Name

Fan type must be Fan:OnOff

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

exhaust_air_flow_rate

field Exhaust Air Flow Rate

This flow rate must match the supply fan air flow rate.

Units: m3/s

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

heat_exchanger_name

field Heat Exchanger Name

Heat exchanger type must be HeatExchanger:AirToAir:SensibleAndLatent

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

name

field Name

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

supply_air_fan_name

field Supply Air Fan Name

Fan type must be Fan:OnOff

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

supply_air_flow_rate

field Supply Air Flow Rate

This flow rate must match the supply fan’s air flow rate.

Units: m3/s

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

ventilation_rate_per_occupant

field Ventilation Rate per Occupant

0.00236 m3/s-person corresponds to 5 ft3/min-person

Used only when supply and exhaust air flow rates are autosized.

Units: m3/s-person

Parameters:value (float) – value for IDD Field Ventilation Rate per Occupant Raises:ValueError – if value is not a valid value Returns:the value of ventilation_rate_per_occupant or None if not set Return type:float

ventilation_rate_per_unit_floor_area

field Ventilation Rate per Unit Floor Area

0.000508 m3/s-m2 corresponds to 0.1 ft3/min-ft2

Used only when supply and exhaust air flow rates are autosized.

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Ventilation Rate per Unit Floor Area Raises:ValueError – if value is not a valid value Returns:the value of ventilation_rate_per_unit_floor_area or None if not set Return type:float

class pyidf.zone_hvac_forced_air_units.ZoneHvacEnergyRecoveryVentilatorController

Bases: pyidf.helper.DataObject

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

control_high_indoor_humidity_based_on_outdoor_humidity_ratio

field Control High Indoor Humidity Based on Outdoor Humidity Ratio

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.

Default value: Yes

Parameters:value (str) – value for IDD Field Control High Indoor Humidity Based on Outdoor Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of control_high_indoor_humidity_based_on_outdoor_humidity_ratio or None if not set Return type:str

dewpoint_temperature_limit

field Dewpoint Temperature Limit

Enter the maximum outdoor dew point temperature limit for economizer operation.

No input or blank input means this limit is not operative

Units: C

Parameters:value (float) – value for IDD Field Dewpoint Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of dewpoint_temperature_limit or None if not set Return type:float

electronic_enthalpy_limit_curve_name

field Electronic Enthalpy Limit Curve Name

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

Parameters:value (str) – value for IDD Field Electronic Enthalpy Limit Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electronic_enthalpy_limit_curve_name or None if not set Return type:str

enthalpy_high_limit

field Enthalpy High Limit

Enter the maximum outdoor enthalpy limit for economizer operation.

No input or blank input means this limit is not operative

Units: J/kg

Parameters:value (float) – value for IDD Field Enthalpy High Limit Raises:ValueError – if value is not a valid value Returns:the value of enthalpy_high_limit or None if not set Return type:float

exhaust_air_enthalpy_limit

field Exhaust Air Enthalpy Limit

Default value: NoExhaustAirEnthalpyLimit

Parameters:value (str) – value for IDD Field Exhaust Air Enthalpy Limit Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_enthalpy_limit or None if not set Return type:str

exhaust_air_temperature_limit

field Exhaust Air Temperature Limit

Default value: NoExhaustAirTemperatureLimit

Parameters:value (str) – value for IDD Field Exhaust Air Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_temperature_limit or None if not set Return type:str

high_humidity_control_flag

field High Humidity Control Flag

Select Yes to modify air flow rates based on a zone humidistat.

Select No to disable this feature.

Default value: No

Parameters:value (str) – value for IDD Field High Humidity Control Flag Raises:ValueError – if value is not a valid value Returns:the value of high_humidity_control_flag or None if not set Return type:str

high_humidity_outdoor_air_flow_ratio

field High Humidity Outdoor Air Flow Ratio

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.

Default value: 1.0

Parameters:value (float) – value for IDD Field High Humidity Outdoor Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of high_humidity_outdoor_air_flow_ratio or None if not set Return type:float

humidistat_control_zone_name

field Humidistat Control Zone Name

Enter the name of the zone where the humidistat is located.

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

name

field Name

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

temperature_high_limit

field Temperature High Limit

Enter the maximum outdoor dry-bulb temperature limit for economizer operation.

No input or blank input means this limit is not operative

Units: C

Parameters:value (float) – value for IDD Field Temperature High Limit Raises:ValueError – if value is not a valid value Returns:the value of temperature_high_limit or None if not set Return type:float

temperature_low_limit

field Temperature Low Limit

Enter the minimum outdoor dry-bulb temperature limit for economizer operation.

No input or blank input means this limit is not operative

Units: C

Parameters:value (float) – value for IDD Field Temperature Low Limit Raises:ValueError – if value is not a valid value Returns:the value of temperature_low_limit or None if not set Return type:float

time_of_day_economizer_flow_control_schedule_name

field Time of Day Economizer Flow Control Schedule Name

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.

Parameters:value (str) – value for IDD Field Time of Day Economizer Flow Control Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of time_of_day_economizer_flow_control_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacEvaporativeCoolerUnit

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:EvaporativeCoolerUnit Zone evaporative cooler. Forced-convection cooling-only unit with supply fan, 100% outdoor air supply. Optional relief exhaust node

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

cooler_outlet_node_name

field Cooler Outlet Node Name

this is a zone inlet node

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

cooler_unit_control_method

field Cooler Unit Control Method

Parameters:value (str) – value for IDD Field Cooler Unit Control Method Raises:ValueError – if value is not a valid value Returns:the value of cooler_unit_control_method or None if not set Return type:str

cooling_load_control_threshold_heat_transfer_rate

field Cooling Load Control Threshold Heat Transfer Rate

Sign convention is that positive values indicate a cooling load

Units: W

Default value: 100.0

Parameters:value (float) – value for IDD Field Cooling Load Control Threshold Heat Transfer Rate Raises:ValueError – if value is not a valid value Returns:the value of cooling_load_control_threshold_heat_transfer_rate or None if not set Return type:float

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

design_supply_air_flow_rate

field Design Supply Air Flow Rate

Units: m3/s

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

fan_placement

field Fan Placement

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

first_evaporative_cooler_object_name

field First Evaporative Cooler Object Name

Parameters:value (str) – value for IDD Field First Evaporative Cooler Object Name Raises:ValueError – if value is not a valid value Returns:the value of first_evaporative_cooler_object_name or None if not set Return type:str

first_evaporative_cooler_object_type

field First Evaporative Cooler Object Type

Parameters:value (str) – value for IDD Field First Evaporative Cooler Object Type Raises:ValueError – if value is not a valid value Returns:the value of first_evaporative_cooler_object_type or None if not set Return type:str

name

field Name

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

this is an outdoor air node

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

second_evaporative_cooler_name

field Second Evaporative Cooler Name

optional, used for direct/indirect configurations

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

second_evaporative_cooler_object_type

field Second Evaporative Cooler Object Type

optional, used for direct/indirect configurations

second cooler must be immediately downstream of first cooler, if present

Parameters:value (str) – value for IDD Field Second Evaporative Cooler Object Type Raises:ValueError – if value is not a valid value Returns:the value of second_evaporative_cooler_object_type or None if not set Return type:str

supply_air_fan_name

field Supply Air Fan Name

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

supply_air_fan_object_type

field Supply Air Fan Object Type

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

throttling_range_temperature_difference

field Throttling Range Temperature Difference

used for ZoneTemperatureDeadbandOnOffCycling hystersis range for thermostatic control

Units: deltaC

Default value: 1.0

Parameters:value (float) – value for IDD Field Throttling Range Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of throttling_range_temperature_difference or None if not set Return type:float

zone_relief_air_node_name

field Zone Relief Air Node Name

this is a zone exhaust node, optional if flow is being balanced elsewhere

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

class pyidf.zone_hvac_forced_air_units.ZoneHvacFourPipeFanCoil

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:FourPipeFanCoil 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.

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

capacity_control_method

field Capacity Control Method

Parameters:value (str) – value for IDD Field Capacity Control Method Raises:ValueError – if value is not a valid value Returns:the value of capacity_control_method or None if not set Return type:str

cooling_coil_name

field Cooling Coil Name

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

cooling_coil_object_type

field Cooling Coil Object Type

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_convergence_tolerance

field Cooling Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Cooling Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of cooling_convergence_tolerance or None if not set Return type:float

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

heating_coil_name

field Heating Coil Name

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

heating_coil_object_type

field Heating Coil Object Type

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_convergence_tolerance

field Heating Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Heating Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of heating_convergence_tolerance or None if not set Return type:float

low_speed_supply_air_flow_ratio

field Low Speed Supply Air Flow Ratio

Default value: 0.33

Parameters:value (float) – value for IDD Field Low Speed Supply Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of low_speed_supply_air_flow_ratio or None if not set Return type:float

maximum_cold_water_flow_rate

field Maximum Cold Water Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Cold Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_cold_water_flow_rate or None if not set Return type:float or “Autosize”

maximum_hot_water_flow_rate

field Maximum Hot Water Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Hot Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_hot_water_flow_rate or None if not set Return type:float or “Autosize”

maximum_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

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

maximum_supply_air_flow_rate

field Maximum Supply Air Flow Rate

Units: m3/s

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

medium_speed_supply_air_flow_ratio

field Medium Speed Supply Air Flow Ratio

Medium Speed Supply Air Flow Ratio should be greater

than Low Speed Supply Air Flow Ratio

Default value: 0.66

Parameters:value (float) – value for IDD Field Medium Speed Supply Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of medium_speed_supply_air_flow_ratio or None if not set Return type:float

minimum_cold_water_flow_rate

field Minimum Cold Water Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Cold Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_cold_water_flow_rate or None if not set Return type:float

minimum_hot_water_flow_rate

field Minimum Hot Water Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_flow_rate or None if not set Return type:float

name

field Name

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

outdoor_air_mixer_name

field Outdoor Air Mixer Name

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

outdoor_air_mixer_object_type

field Outdoor Air Mixer Object Type

currently only one type OutdoorAir:Mixer object is available.

Parameters:value (str) – value for IDD Field Outdoor Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_mixer_object_type or None if not set Return type:str

outdoor_air_schedule_name

field Outdoor Air Schedule Name

Value of schedule multiplies maximum outdoor air flow rate

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

supply_air_fan_name

field Supply Air Fan Name

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

supply_air_fan_object_type

field Supply Air Fan Object Type

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.

The fan’s inlet node should be the same as the outdoor air mixer’s mixed air node.

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacIdealLoadsAirSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:IdealLoadsAirSystem 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 DistrictHeating and DistrictCooling.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

cooling_availability_schedule_name

field Cooling Availability Schedule Name

If blank, cooling is always available.

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

cooling_limit

field Cooling Limit

Default value: NoLimit

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

cooling_sensible_heat_ratio

field Cooling Sensible Heat Ratio

This field is applicable only when Dehumidification Control Type is ConstantSensibleHeatRatio

Units: dimensionless

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Cooling Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_sensible_heat_ratio or None if not set Return type:float

dehumidification_control_type

field Dehumidification Control Type

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.

Default value: ConstantSensibleHeatRatio

Parameters:value (str) – value for IDD Field Dehumidification Control Type Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_control_type or None if not set Return type:str

demand_controlled_ventilation_type

field Demand Controlled Ventilation Type

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.

Default value: None

Parameters:value (str) – value for IDD Field Demand Controlled Ventilation Type Raises:ValueError – if value is not a valid value Returns:the value of demand_controlled_ventilation_type or None if not set Return type:str

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

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.

Parameters:value (str) – value for IDD Field Design Specification Outdoor Air Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_outdoor_air_object_name or None if not set Return type:str

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

heat_recovery_type

field Heat Recovery Type

Default value: None

Parameters:value (str) – value for IDD Field Heat Recovery Type Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_type or None if not set Return type:str

heating_availability_schedule_name

field Heating Availability Schedule Name

If blank, heating is always available.

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

heating_limit

field Heating Limit

Default value: NoLimit

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

humidification_control_type

field Humidification Control Type

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.

Default value: None

Parameters:value (str) – value for IDD Field Humidification Control Type Raises:ValueError – if value is not a valid value Returns:the value of humidification_control_type or None if not set Return type:str

latent_heat_recovery_effectiveness

field Latent Heat Recovery Effectiveness

Applicable only if Heat Recovery Type is Enthalpy.

Units: dimensionless

Default value: 0.65

value <= 1.0

Parameters:value (float) – value for IDD Field Latent Heat Recovery Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of latent_heat_recovery_effectiveness or None if not set Return type:float

maximum_cooling_air_flow_rate

field Maximum Cooling Air Flow Rate

This field is ignored if Cooling Limit = NoLimit

This field is required if Outdoor Air Economizer Type is anything other than NoEconomizer.

Units: m3/s

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

maximum_heating_air_flow_rate

field Maximum Heating Air Flow Rate

This field is ignored if Heating Limit = NoLimit

If this field is blank, there is no limit.

Units: m3/s

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

maximum_heating_supply_air_humidity_ratio

field Maximum Heating Supply Air Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.0156

Parameters:value (float) – value for IDD Field Maximum Heating Supply Air Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_heating_supply_air_humidity_ratio or None if not set Return type:float

maximum_heating_supply_air_temperature

field Maximum Heating Supply Air Temperature

Units: C

Default value: 50.0

value < 100.0

Parameters:value (float) – value for IDD Field Maximum Heating Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_heating_supply_air_temperature or None if not set Return type:float

maximum_sensible_heating_capacity

field Maximum Sensible Heating Capacity

This field is ignored if Heating Limit = NoLimit

If this field is blank, there is no limit.

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Sensible Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of maximum_sensible_heating_capacity or None if not set Return type:float or “Autosize”

maximum_total_cooling_capacity

field Maximum Total Cooling Capacity

This field is ignored if Cooling Limit = NoLimit

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of maximum_total_cooling_capacity or None if not set Return type:float or “Autosize”

minimum_cooling_supply_air_humidity_ratio

field Minimum Cooling Supply Air Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.0077

Parameters:value (float) – value for IDD Field Minimum Cooling Supply Air Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_cooling_supply_air_humidity_ratio or None if not set Return type:float

minimum_cooling_supply_air_temperature

field Minimum Cooling Supply Air Temperature

Units: C

Default value: 13.0

value > -100.0

value < 50.0

Parameters:value (float) – value for IDD Field Minimum Cooling Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_cooling_supply_air_temperature or None if not set Return type:float

name

field Name

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

outdoor_air_economizer_type

field Outdoor Air Economizer Type

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.

Default value: NoEconomizer

Parameters:value (str) – value for IDD Field Outdoor Air Economizer Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_economizer_type or None if not set Return type:str

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

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.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

Units: dimensionless

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Sensible Heat Recovery Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_recovery_effectiveness or None if not set Return type:float

zone_exhaust_air_node_name

field Zone Exhaust Air Node Name

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.

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

zone_supply_air_node_name

field Zone Supply Air Node Name

Must match a zone air inlet node name.

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

class pyidf.zone_hvac_forced_air_units.ZoneHvacOutdoorAirUnit

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:OutdoorAirUnit 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.

airinlet_node_name

field AirInlet Node Name

air leaves zone

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

airoutlet_node_name

field AirOutlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

exhaust_air_flow_rate

field Exhaust Air Flow Rate

Units: m3/s

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

exhaust_air_schedule_name

field Exhaust Air Schedule Name

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

exhaust_fan_name

field Exhaust Fan Name

Allowable fan types are Fan:ConstantVolume and

Fan:VariableVolume

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

high_air_control_temperature_schedule_name

field High Air Control Temperature Schedule Name

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.

Parameters:value (str) – value for IDD Field High Air Control Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of high_air_control_temperature_schedule_name or None if not set Return type:str

low_air_control_temperature_schedule_name

field Low Air Control Temperature Schedule Name

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.

Parameters:value (str) – value for IDD Field Low Air Control Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of low_air_control_temperature_schedule_name or None if not set Return type:str

name

field Name

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

outdoor_air_flow_rate

field Outdoor Air Flow Rate

Units: m3/s

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

outdoor_air_node_name

field Outdoor Air Node Name

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

outdoor_air_schedule_name

field Outdoor Air Schedule Name

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

outdoor_air_unit_list_name

field Outdoor Air Unit List Name

Enter the name of an ZoneHVAC:OutdoorAirUnit:EquipmentList object.

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

supply_fan_name

field Supply Fan Name

Allowable fan types are Fan:ConstantVolume and

Fan:VariableVolume

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

supply_fan_placement

field Supply Fan Placement

Default value: DrawThrough

Parameters:value (str) – value for IDD Field Supply Fan Placement Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_placement or None if not set Return type:str

supply_fanoutlet_node_name

field Supply FanOutlet Node Name

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

unit_control_type

field Unit Control Type

Default value: NeutralControl

Parameters:value (str) – value for IDD Field Unit Control Type Raises:ValueError – if value is not a valid value Returns:the value of unit_control_type or None if not set Return type:str

zone_name

field Zone Name

(name of zone system is serving)

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

class pyidf.zone_hvac_forced_air_units.ZoneHvacOutdoorAirUnitEquipmentList

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:OutdoorAirUnit:EquipmentList Equipment list for components in a ZoneHVAC:OutdoorAirUnit. Components are simulated sequentially in the order given in the equipment list.

component_1_name

field Component 1 Name

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

component_1_object_type

field Component 1 Object Type

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

component_2_name

field Component 2 Name

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

component_2_object_type

field Component 2 Object Type

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

component_3_name

field Component 3 Name

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

component_3_object_type

field Component 3 Object Type

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

component_4_name

field Component 4 Name

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

component_4_object_type

field Component 4 Object Type

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

component_5_name

field Component 5 Name

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

component_5_object_type

field Component 5 Object Type

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

component_6_name

field Component 6 Name

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

component_6_object_type

field Component 6 Object Type

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

component_7_name

field Component 7 Name

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

component_7_object_type

field Component 7 Object Type

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

component_8_name

field Component 8 Name

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

component_8_object_type

field Component 8 Object Type

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

name

field Name

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

class pyidf.zone_hvac_forced_air_units.ZoneHvacPackagedTerminalAirConditioner

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:PackagedTerminalAirConditioner 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.

air_inlet_node_name

field Air Inlet Node Name

Air inlet node for the PTAC must be a zone air exhaust Node.

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

air_outlet_node_name

field Air Outlet Node Name

Air outlet node for the PTAC must be a zone air inlet node.

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

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.

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

cooling_coil_name

field Cooling Coil Name

Needs to match a DX cooling coil object.

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

cooling_coil_object_type

field Cooling Coil Object Type

Select the type of Cooling Coil.

Only works with Coil:Cooling:DX:SingleSpeed or

CoilSystem:Cooling:DX:HeatExchangerAssisted or

Coil:Cooling:DX:VariableSpeed.

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_outdoor_air_flow_rate

field Cooling Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during cooling operation.

Units: m3/s

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

fan_placement

field Fan Placement

Select fan placement as either blow through or draw through.

Default value: DrawThrough

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

heating_coil_name

field Heating Coil Name

Needs to match in the heating coil object.

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

heating_coil_object_type

field Heating Coil Object Type

Select the type of heating coil.

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_outdoor_air_flow_rate

field Heating Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during heating operation.

Units: m3/s

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

name

field Name

Unique name for this packaged terminal air conditioner object.

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

no_load_outdoor_air_flow_rate

field No Load Outdoor Air Flow Rate

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.

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field No Load Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of no_load_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

no_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

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.

Units: m3/s

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

outdoor_air_mixer_name

field Outdoor Air Mixer Name

Needs to match the name of the PTAC outdoor air mixer object.

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

outdoor_air_mixer_object_type

field Outdoor Air Mixer Object Type

currently only one OutdoorAir:Mixer object type is available.

Parameters:value (str) – value for IDD Field Outdoor Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_mixer_object_type or None if not set Return type:str

supply_air_fan_name

field Supply Air Fan Name

Needs to match in the fan object.

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

supply_air_fan_object_type

field Supply Air Fan Object Type

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:OnOff object must be used.

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacPackagedTerminalHeatPump

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:PackagedTerminalHeatPump 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.

air_inlet_node_name

field Air Inlet Node Name

Air inlet node for the PTHP must be a zone air exhaust node.

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

air_outlet_node_name

field Air Outlet Node Name

Air outlet node for the PTHP must be a zone air inlet node.

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

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.

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

cooling_coil_name

field Cooling Coil Name

Needs to match in the DX Cooling Coil object.

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

cooling_coil_object_type

field Cooling Coil Object Type

Only works with Coil:Cooling:DX:SingleSpeed or

CoilSystem:Cooling:DX:HeatExchangerAssisted or

Coil:Cooling:DX:VariableSpeed.

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_convergence_tolerance

field Cooling Convergence Tolerance

Defines Cooling convergence tolerance as a fraction of the Cooling load to be met.

Units: dimensionless

Default value: 0.001

Parameters:value (float) – value for IDD Field Cooling Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of cooling_convergence_tolerance or None if not set Return type:float

cooling_outdoor_air_flow_rate

field Cooling Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during cooling operation.

Units: m3/s

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

fan_placement

field Fan Placement

Select fan placement as either blow through or draw through.

Default value: DrawThrough

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

heating_coil_name

field Heating Coil Name

Needs to match in the DX Heating Coil object.

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

heating_coil_object_type

field Heating Coil Object Type

Only works with Coil:Heating:DX:SingleSpeed or

Coil:Heating:DX:VariableSpeed.

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_convergence_tolerance

field Heating Convergence Tolerance

Defines Heating convergence tolerance as a fraction of Heating load to be met.

Units: dimensionless

Default value: 0.001

Parameters:value (float) – value for IDD Field Heating Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of heating_convergence_tolerance or None if not set Return type:float

heating_outdoor_air_flow_rate

field Heating Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during heating operation.

Units: m3/s

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Supplemental heater will not operate when outdoor temperature exceeds this value.

Units: C

Default value: 21.0

value <= 21.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set Return type:float

maximum_supply_air_temperature_from_supplemental_heater

field Maximum Supply Air Temperature from Supplemental Heater

Supply air temperature from the supplemental heater will not exceed this value.

Units: C

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature from Supplemental Heater Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_air_temperature_from_supplemental_heater or None if not set Return type:float or “Autosize”

minimum_outdoor_drybulb_temperature_for_compressor_operation

field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation

Needs to match the corresponding minimum outdoor temperature defined

in the DX Heating Coil object.

Units: C

Default value: -8.0

value >= -20.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_drybulb_temperature_for_compressor_operation or None if not set Return type:float

name

field Name

Unique name for this packaged terminal heat pump object.

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

no_load_outdoor_air_flow_rate

field No Load Outdoor Air Flow Rate

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.

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field No Load Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of no_load_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

no_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

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.

Units: m3/s

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

outdoor_air_mixer_name

field Outdoor Air Mixer Name

Needs to match name of outdoor air mixer object.

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

outdoor_air_mixer_object_type

field Outdoor Air Mixer Object Type

currently only one OutdoorAir:Mixer object type is available.

Parameters:value (str) – value for IDD Field Outdoor Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_mixer_object_type or None if not set Return type:str

supplemental_heating_coil_name

field Supplemental Heating Coil Name

Needs to match in the supplemental heating coil object.

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

supplemental_heating_coil_object_type

field Supplemental Heating Coil Object Type

works with gas, electric, hot water and steam heating coil.

Parameters:value (str) – value for IDD Field Supplemental Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of supplemental_heating_coil_object_type or None if not set Return type:str

supply_air_fan_name

field Supply Air Fan Name

Needs to match a fan object.

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

supply_air_fan_object_type

field Supply Air Fan Object Type

Fan:ConstantVolume only works with fan operating mode is continuous.

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacTerminalUnitVariableRefrigerantFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:TerminalUnit:VariableRefrigerantFlow Zone 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 system.

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

cooling_coil_object_name

field Cooling Coil Object Name

Cooling Coil Type must be Coil:Cooling:DX:VariableRefrigerantFlow

This field may be left blank if heating-only mode is used

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

cooling_coil_object_type

field Cooling Coil Object Type

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

is used to model VRF outdoor unit

This field may be left blank if heating-only mode is used

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_outdoor_air_flow_rate

field Cooling Outdoor Air Flow Rate

Units: m3/s

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Units: m3/s

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

heating_coil_object_name

field Heating Coil Object Name

Heating Coil Type must be Coil:Heating:DX:VariableRefrigerantFlow

This field may be left blank if cooling-only mode is used

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

heating_coil_object_type

field Heating Coil Object Type

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

is used to model VRF outdoor unit

This field may be left blank if cooling-only mode is used

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_outdoor_air_flow_rate

field Heating Outdoor Air Flow Rate

Units: m3/s

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Units: m3/s

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

no_cooling_supply_air_flow_rate

field No Cooling Supply Air Flow Rate

Units: m3/s

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

no_heating_supply_air_flow_rate

field No Heating Supply Air Flow Rate

Units: m3/s

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

no_load_outdoor_air_flow_rate

field No Load Outdoor Air Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field No Load Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of no_load_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

outside_air_mixer_object_name

field Outside Air Mixer Object Name

If this field is blank, and outside air mixer is not used.

Parameters:value (str) – value for IDD Field Outside Air Mixer Object Name Raises:ValueError – if value is not a valid value Returns:the value of outside_air_mixer_object_name or None if not set Return type:str

outside_air_mixer_object_type

field Outside Air Mixer Object Type

If this field is blank, and outside air mixer is not used.

Parameters:value (str) – value for IDD Field Outside Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outside_air_mixer_object_type or None if not set Return type:str

rated_heating_capacity_sizing_ratio

field Rated Heating Capacity Sizing Ratio

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.

Units: W/W

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Rated Heating Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of rated_heating_capacity_sizing_ratio or None if not set Return type:float

supply_air_fan_object_name

field Supply Air Fan Object Name

Parameters:value (str) – value for IDD Field Supply Air Fan Object Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_name or None if not set Return type:str

supply_air_fan_object_type

field Supply Air Fan Object Type

Supply Air Fan Object Type must be

Fan:OnOff or Fan:ConstantVolume

if AirConditioner:VariableRefrigerantFlow

is used to model VRF outdoor unit

Supply Air Fan Object Type must be Fan:VariableVolume if

AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl

is used to model VRF outdoor unit

Default value: Fan:ConstantVolume

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

supply_air_fan_placement

field Supply Air Fan Placement

Select fan placement as either blow through or draw through.

Default value: BlowThrough

Parameters:value (str) – value for IDD Field Supply Air Fan Placement Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_placement or None if not set Return type:str

terminal_unit_air_inlet_node_name

field Terminal Unit Air Inlet Node Name

the inlet node to the terminal unit

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

terminal_unit_air_outlet_node_name

field Terminal Unit Air Outlet Node Name

the outlet node of the terminal unit

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

terminal_unit_availability_schedule

field Terminal Unit Availability Schedule

The unit is available the entire simulation if this field is left blank

Schedule values of 0 denote the unit is off.

Parameters:value (str) – value for IDD Field Terminal Unit Availability Schedule Raises:ValueError – if value is not a valid value Returns:the value of terminal_unit_availability_schedule or None if not set Return type:str

zone_terminal_unit_name

field Zone Terminal Unit Name

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

zone_terminal_unit_off_parasitic_electric_energy_use

field Zone Terminal Unit Off Parasitic Electric Energy Use

Units: W

Parameters:value (float) – value for IDD Field Zone Terminal Unit Off Parasitic Electric Energy Use Raises:ValueError – if value is not a valid value Returns:the value of zone_terminal_unit_off_parasitic_electric_energy_use or None if not set Return type:float

zone_terminal_unit_on_parasitic_electric_energy_use

field Zone Terminal Unit On Parasitic Electric Energy Use

Units: W

Parameters:value (float) – value for IDD Field Zone Terminal Unit On Parasitic Electric Energy Use Raises:ValueError – if value is not a valid value Returns:the value of zone_terminal_unit_on_parasitic_electric_energy_use or None if not set Return type:float

class pyidf.zone_hvac_forced_air_units.ZoneHvacUnitHeater

Bases: pyidf.helper.DataObject

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

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

heating_coil_name

field Heating Coil Name

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

heating_coil_object_type

field Heating Coil Object Type

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_convergence_tolerance

field Heating Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Heating Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of heating_convergence_tolerance or None if not set Return type:float

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when heating coil is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_hot_water_or_steam_flow_rate or None if not set Return type:float or “Autosize”

maximum_supply_air_flow_rate

field Maximum Supply Air Flow Rate

Units: m3/s

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when heating coil is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_or_steam_flow_rate or None if not set Return type:float

name

field Name

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

supply_air_fan_name

field Supply Air Fan Name

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

supply_air_fan_object_type

field Supply Air Fan Object Type

Allowable fan types are Fan:ConstantVolume, Fan:OnOff and

Fan:VariableVolume

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

supply_air_fan_operation_during_no_heating

field Supply Air Fan Operation During No Heating

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operation During No Heating Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operation_during_no_heating or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacUnitVentilator

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:UnitVentilator 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.

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

coil_option

field Coil Option

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

cooling_coil_name

field Cooling Coil Name

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

cooling_coil_object_type

field Cooling Coil Object Type

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_convergence_tolerance

field Cooling Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Cooling Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of cooling_convergence_tolerance or None if not set Return type:float

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

exhaust_air_node_name

field Exhaust Air Node Name

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

heating_coil_name

field Heating Coil Name

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

heating_coil_object_type

field Heating Coil Object Type

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_convergence_tolerance

field Heating Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Heating Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of heating_convergence_tolerance or None if not set Return type:float

maximum_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

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

maximum_outdoor_air_fraction_or_temperature_schedule_name

field Maximum Outdoor Air Fraction or Temperature Schedule Name

that this depends on the control type as to whether it is a fraction or temperature

Parameters:value (str) – value for IDD Field Maximum Outdoor Air Fraction or Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_air_fraction_or_temperature_schedule_name or None if not set Return type:str

maximum_supply_air_flow_rate

field Maximum Supply Air Flow Rate

Units: m3/s

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

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

minimum_outdoor_air_schedule_name

field Minimum Outdoor Air Schedule Name

schedule values multiply the minimum outdoor air flow rate

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

mixed_air_node_name

field Mixed Air Node Name

inlet to coils

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

name

field Name

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

outdoor_air_control_type

field Outdoor Air Control Type

Parameters:value (str) – value for IDD Field Outdoor Air Control Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_control_type or None if not set Return type:str

outdoor_air_node_name

field Outdoor Air Node Name

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

supply_air_fan_name

field Supply Air Fan Name

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

supply_air_fan_object_type

field Supply Air Fan Object Type

Allowable fan types are Fan:ConstantVolume, Fan:OnOff and

Fan:VariableVolume

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacWaterToAirHeatPump

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:WaterToAirHeatPump 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.

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

cooling_coil_name

field Cooling Coil Name

Needs to match in the water-to-air heat pump cooling coil object

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

cooling_coil_object_type

field Cooling Coil Object Type

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_outdoor_air_flow_rate

field Cooling Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during cooling operation.

Units: m3/s

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

fan_placement

field Fan Placement

Default value: BlowThrough

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

fraction_of_oncycle_power_use

field Fraction of On-Cycle Power Use

The fraction of on-cycle power use to adjust the part load fraction based on

the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.

Suggested value is 0.01 for a typical heat pump

Default value: 0.01

value <= 0.05

Parameters:value (float) – value for IDD Field Fraction of On-Cycle Power Use Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_oncycle_power_use or None if not set Return type:float

heat_pump_coil_water_flow_mode

field Heat Pump Coil Water Flow Mode

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

Default value: Cycling

Parameters:value (str) – value for IDD Field Heat Pump Coil Water Flow Mode Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_coil_water_flow_mode or None if not set Return type:str

heat_pump_fan_delay_time

field Heat Pump Fan Delay Time

Programmed time delay for heat pump fan to shut off after compressor cycle off.

Only required when fan operating mode is cycling

Enter 0 when fan operating mode is continuous

Units: s

Default value: 60.0

Parameters:value (float) – value for IDD Field Heat Pump Fan Delay Time Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_fan_delay_time or None if not set Return type:float

heat_pump_time_constant

field Heat Pump Time Constant

Time constant for the cooling coil’s capacity to reach steady state after startup

Suggested value is 60 for a typical heat pump

Units: s

Default value: 60.0

value <= 500.0

Parameters:value (float) – value for IDD Field Heat Pump Time Constant Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_time_constant or None if not set Return type:float

heating_coil_name

field Heating Coil Name

Needs to match in the water-to-air heat pump heating coil object

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

heating_coil_object_type

field Heating Coil Object Type

Parameters:value (str) – value for IDD Field Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_object_type or None if not set Return type:str

heating_outdoor_air_flow_rate

field Heating Outdoor Air Flow Rate

Must be less than or equal to supply air flow rate during heating operation.

Units: m3/s

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Must be less than or equal to fan size.

Units: m3/s

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

maximum_cycling_rate

field Maximum Cycling Rate

The maximum on-off cycling rate for the compressor

Suggested value is 2.5 for a typical heat pump

Units: cycles/hr

Default value: 2.5

value <= 5.0

Parameters:value (float) – value for IDD Field Maximum Cycling Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_cycling_rate or None if not set Return type:float

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Units: C

Default value: 21.0

value <= 21.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set Return type:float

maximum_supply_air_temperature_from_supplemental_heater

field Maximum Supply Air Temperature from Supplemental Heater

Units: C

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature from Supplemental Heater Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_air_temperature_from_supplemental_heater or None if not set Return type:float or “Autosize”

name

field Name

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

no_load_outdoor_air_flow_rate

field No Load Outdoor Air Flow Rate

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.

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field No Load Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of no_load_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

no_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

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.

Units: m3/s

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

outdoor_air_mixer_name

field Outdoor Air Mixer Name

This optional field specifies the name of the outdoor air mixer object.

When used, this name needs to match name of outdoor air mixer object.

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

outdoor_air_mixer_object_type

field Outdoor Air Mixer Object Type

currently only one OutdoorAir:Mixer object type is available.

Parameters:value (str) – value for IDD Field Outdoor Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_mixer_object_type or None if not set Return type:str

outdoor_drybulb_temperature_sensor_node_name

field Outdoor Dry-Bulb Temperature Sensor Node Name

Parameters:value (str) – value for IDD Field Outdoor Dry-Bulb Temperature Sensor Node Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_drybulb_temperature_sensor_node_name or None if not set Return type:str

supplemental_heating_coil_name

field Supplemental Heating Coil Name

Needs to match in the supplemental heating coil object

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

supplemental_heating_coil_object_type

field Supplemental Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

Parameters:value (str) – value for IDD Field Supplemental Heating Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of supplemental_heating_coil_object_type or None if not set Return type:str

supply_air_fan_name

field Supply Air Fan Name

Needs to match Fan:OnOff object

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

supply_air_fan_object_type

field Supply Air Fan Object Type

Only works with On/Off Fan

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str

class pyidf.zone_hvac_forced_air_units.ZoneHvacWindowAirConditioner

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:WindowAirConditioner Window air conditioner. Forced-convection cooling-only unit with supply fan, direct expansion (DX) cooling coil, and fixed-position outdoor air mixer.

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

cooling_coil_object_type

field Cooling Coil Object Type

Parameters:value (str) – value for IDD Field Cooling Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_object_type or None if not set Return type:str

cooling_convergence_tolerance

field Cooling Convergence Tolerance

Default value: 0.001

Parameters:value (float) – value for IDD Field Cooling Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of cooling_convergence_tolerance or None if not set Return type:float

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

Parameters:value (str) – value for IDD Field Design Specification ZoneHVAC Sizing Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zonehvac_sizing_object_name or None if not set Return type:str

dx_cooling_coil_name

field DX Cooling Coil Name

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

fan_placement

field Fan Placement

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

maximum_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

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

maximum_supply_air_flow_rate

field Maximum Supply Air Flow Rate

Units: m3/s

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

name

field Name

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

outdoor_air_mixer_name

field Outdoor Air Mixer Name

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

outdoor_air_mixer_object_type

field Outdoor Air Mixer Object Type

currently only one OutdoorAir:Mixer object type is available.

Parameters:value (str) – value for IDD Field Outdoor Air Mixer Object Type Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_mixer_object_type or None if not set Return type:str

supply_air_fan_name

field Supply Air Fan Name

Fan type Fan:ConstantVolume is used with continuous fan

and fan type Fan:OnOff is used with cycling Fan.

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

supply_air_fan_object_type

field Supply Air Fan Object Type

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:OnOff object must be used.

Parameters:value (str) – value for IDD Field Supply Air Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_object_type or None if not set Return type:str

supply_air_fan_operating_mode_schedule_name

field Supply Air Fan Operating Mode Schedule Name

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.

Parameters:value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_air_fan_operating_mode_schedule_name or None if not set Return type:str