pyidf.hvac_templates module

Data objects in group “HVAC Templates”

class pyidf.hvac_templates.HvactemplatePlantBoiler

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Boiler This object adds a boiler to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop.

boiler_type

field Boiler Type

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

capacity

field Capacity

Units: W

Default value: “autosize”

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

efficiency

field Efficiency

Not applicable if Boiler Type is DistrictHotWater

Default value: 0.8

value <= 1.0

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

fuel_type

field Fuel Type

Not applicable if Boiler Type is DistrictHotWater

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

maximum_part_load_ratio

field Maximum Part Load Ratio

Default value: 1.1

Parameters:value (float) – value for IDD Field Maximum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_part_load_ratio or None if not set Return type:float

minimum_part_load_ratio

field Minimum Part Load Ratio

Parameters:value (float) – value for IDD Field Minimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_part_load_ratio 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

optimum_part_load_ratio

field Optimum Part Load Ratio

Default value: 1.0

Parameters:value (float) – value for IDD Field Optimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of optimum_part_load_ratio or None if not set Return type:float

priority

field Priority

If Hot Water Plant Operation Scheme Type=Default

in HVACTemplate:Plant:HotWaterLoop, then equipment

operates in priority order, 1, 2, 3, etc.

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

template_plant_loop_type

field Template Plant Loop Type

Specifies if this boiler serves a template hot water loop or mixed water loop

If left blank, will serve a hot water loop if present, or a mixed water loop (if

no hot water loop is present).

Parameters:value (str) – value for IDD Field Template Plant Loop Type Raises:ValueError – if value is not a valid value Returns:the value of template_plant_loop_type or None if not set Return type:str

water_outlet_upper_temperature_limit

field Water Outlet Upper Temperature Limit

Units: C

Default value: 100.0

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

class pyidf.hvac_templates.HvactemplatePlantBoilerObjectReference

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Boiler:ObjectReference This object references a detailed boiler object and adds it to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop. The user must create a complete detailed boiler object with all required curve or performance objects.

boiler_name

field Boiler Name

The name of the detailed boiler object.

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

boiler_object_type

field Boiler Object Type

Default value: Boiler:HotWater

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

name

field Name

The name of this 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

priority

field Priority

If Hot Water Plant Operation Scheme Type=Default

in HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop, then equipment

operates in Priority order, 1, 2, 3, etc.

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

template_plant_loop_type

field Template Plant Loop Type

Specifies if this boiler serves a template hot water loop or mixed water loop

If left blank, will serve a hot water loop if present, or a mixed water loop (if

no hot water loop is present).

Parameters:value (str) – value for IDD Field Template Plant Loop Type Raises:ValueError – if value is not a valid value Returns:the value of template_plant_loop_type or None if not set Return type:str

class pyidf.hvac_templates.HvactemplatePlantChilledWaterLoop

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:ChilledWaterLoop Plant and condenser loops to serve all HVACTemplate chilled water coils, chillers, and towers.

chilled_water_demand_side_bypass_pipe

field Chilled Water Demand Side Bypass Pipe

Determines if a demand side bypass pipe is present in the chilled water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Chilled Water Demand Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_demand_side_bypass_pipe or None if not set Return type:str

chilled_water_design_setpoint

field Chilled Water Design Setpoint

Used for sizing and as constant setpoint if no Chilled Water Setpoint Schedule Name is specified.

Units: C

Default value: 7.22

Parameters:value (float) – value for IDD Field Chilled Water Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_design_setpoint or None if not set Return type:float

chilled_water_load_distribution_scheme

field Chilled Water Load Distribution Scheme

Default value: SequentialLoad

Parameters:value (str) – value for IDD Field Chilled Water Load Distribution Scheme Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_load_distribution_scheme or None if not set Return type:str

chilled_water_primary_pump_type

field Chilled Water Primary Pump Type

Describes the type of pump configuration used for the primary portion of the chilled water loop.

Default value: SinglePump

Parameters:value (str) – value for IDD Field Chilled Water Primary Pump Type Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_primary_pump_type or None if not set Return type:str

chilled_water_pump_configuration

field Chilled Water Pump Configuration

VariablePrimaryNoSecondary - variable flow to chillers and coils

ConstantPrimaryNoSecondary - constant flow to chillers and coils, excess bypassed

ConstantPrimaryVariableSecondary - constant flow to chillers, variable flow to coils

VariablePrimaryConstantSecondary - currently unsupported - variable flow to chillers, constant flow to coils

Default value: ConstantPrimaryNoSecondary

Parameters:value (str) – value for IDD Field Chilled Water Pump Configuration Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_pump_configuration or None if not set Return type:str

chilled_water_reset_outdoor_drybulb_high

field Chilled Water Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 26.7

Parameters:value (float) – value for IDD Field Chilled Water Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_reset_outdoor_drybulb_high or None if not set Return type:float

chilled_water_reset_outdoor_drybulb_low

field Chilled Water Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Chilled Water Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_reset_outdoor_drybulb_low or None if not set Return type:float

chilled_water_secondary_pump_type

field Chilled Water Secondary Pump Type

Describes the type of pump configuration used for the secondary portion of the chilled water loop.

Default value: SinglePump

Parameters:value (str) – value for IDD Field Chilled Water Secondary Pump Type Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_secondary_pump_type or None if not set Return type:str

chilled_water_setpoint_at_outdoor_drybulb_high

field Chilled Water Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 6.7

Parameters:value (float) – value for IDD Field Chilled Water Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

chilled_water_setpoint_at_outdoor_drybulb_low

field Chilled Water Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Chilled Water Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

chilled_water_setpoint_reset_type

field Chilled Water Setpoint Reset Type

Overrides Chilled Water Setpoint Schedule Name

Default value: None

Parameters:value (str) – value for IDD Field Chilled Water Setpoint Reset Type Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_setpoint_reset_type or None if not set Return type:str

chilled_water_setpoint_schedule_name

field Chilled Water Setpoint Schedule Name

Leave blank if constant setpoint

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

chilled_water_supply_side_bypass_pipe

field Chilled Water Supply Side Bypass Pipe

Determines if a supply side bypass pipe is present in the chilled water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Chilled Water Supply Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of chilled_water_supply_side_bypass_pipe or None if not set Return type:str

chiller_plant_equipment_operation_schemes_name

field Chiller Plant Equipment Operation Schemes Name

Name of a PlantEquipmentOperationSchemes object

Ignored if Chiller Plant Operation Scheme Type = Default

Parameters:value (str) – value for IDD Field Chiller Plant Equipment Operation Schemes Name Raises:ValueError – if value is not a valid value Returns:the value of chiller_plant_equipment_operation_schemes_name or None if not set Return type:str

chiller_plant_operation_scheme_type

field Chiller Plant Operation Scheme Type

Default operation type makes all equipment available

at all times operating in order of Priority specified

in HVACTemplate:Plant:Chiller objects.

Default value: Default

Parameters:value (str) – value for IDD Field Chiller Plant Operation Scheme Type Raises:ValueError – if value is not a valid value Returns:the value of chiller_plant_operation_scheme_type or None if not set Return type:str

condenser_equipment_operation_schemes_name

field Condenser Equipment Operation Schemes Name

Name of a CondenserEquipmentOperationSchemes object

Ignored if Condenser Plant Operation Scheme Type = Default

May be left blank if not serving any water cooled chillers

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

condenser_plant_operation_scheme_type

field Condenser Plant Operation Scheme Type

Default operation type makes all equipment available

at all times operating in order of Priority specified

in HVACTemplate:Plant:Tower objects.

May be left blank if not serving any water cooled chillers

Default value: Default

Parameters:value (str) – value for IDD Field Condenser Plant Operation Scheme Type Raises:ValueError – if value is not a valid value Returns:the value of condenser_plant_operation_scheme_type or None if not set Return type:str

condenser_water_demand_side_bypass_pipe

field Condenser Water Demand Side Bypass Pipe

Determines if a demand side bypass pipe is present in the condenser water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Condenser Water Demand Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_demand_side_bypass_pipe or None if not set Return type:str

condenser_water_design_setpoint

field Condenser Water Design Setpoint

Used for sizing and as constant setpoint if no Condenser Water Setpoint Schedule Name is specified.

May be left blank if not serving any water cooled chillers

Units: C

Default value: 29.4

Parameters:value (float) – value for IDD Field Condenser Water Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_design_setpoint or None if not set Return type:float

condenser_water_load_distribution_scheme

field Condenser Water Load Distribution Scheme

Default value: SequentialLoad

Parameters:value (str) – value for IDD Field Condenser Water Load Distribution Scheme Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_load_distribution_scheme or None if not set Return type:str

condenser_water_pump_rated_head

field Condenser Water Pump Rated Head

May be left blank if not serving any water cooled chillers

default head is 60 feet H2O

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

condenser_water_pump_type

field Condenser Water Pump Type

Describes the type of pump configuration used for the condenser water loop.

Default value: SinglePump

Parameters:value (str) – value for IDD Field Condenser Water Pump Type Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_pump_type or None if not set Return type:str

condenser_water_setpoint_schedule_name

field Condenser Water Setpoint Schedule Name

Leave blank if constant setpoint

May be left blank if not serving any water cooled chillers

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

condenser_water_supply_side_bypass_pipe

field Condenser Water Supply Side Bypass Pipe

Determines if a supply side bypass pipe is present in the condenser water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Condenser Water Supply Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_supply_side_bypass_pipe or None if not set Return type:str

condenser_water_temperature_control_type

field Condenser Water Temperature Control Type

May be left blank if not serving any water cooled chillers

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

fluid_type

field Fluid Type

Default value: Water

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

loop_design_delta_temperature

field Loop Design Delta Temperature

The temperature difference used in sizing the loop flow rate.

Units: deltaC

Default value: 6.67

Parameters:value (float) – value for IDD Field Loop Design Delta Temperature Raises:ValueError – if value is not a valid value Returns:the value of loop_design_delta_temperature or None if not set Return type:float

minimum_outdoor_dry_bulb_temperature

field Minimum Outdoor Dry Bulb Temperature

The minimum outdoor dry-bulb temperature that the chilled water loops operate.

Leave blank for no limit.

Units: C

Parameters:value (float) – value for IDD Field Minimum Outdoor Dry Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_dry_bulb_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

primary_chilled_water_pump_rated_head

field Primary Chilled Water Pump Rated Head

default head is 60 feet H2O

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

Parameters:value (float) – value for IDD Field Primary Chilled Water Pump Rated Head Raises:ValueError – if value is not a valid value Returns:the value of primary_chilled_water_pump_rated_head or None if not set Return type:float

pump_control_type

field Pump Control Type

Applies to both chilled water and condenser loop pumps

Default value: Intermittent

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

pump_schedule_name

field Pump Schedule Name

If blank, always available

Applies to both chilled water and condenser loop pumps

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

secondary_chilled_water_pump_rated_head

field Secondary Chilled Water Pump Rated Head

default head is 60 feet H2O

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

Parameters:value (float) – value for IDD Field Secondary Chilled Water Pump Rated Head Raises:ValueError – if value is not a valid value Returns:the value of secondary_chilled_water_pump_rated_head or None if not set Return type:float

class pyidf.hvac_templates.HvactemplatePlantChiller

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Chiller This object adds a chiller to an HVACTemplate:Plant:ChilledWaterLoop.

capacity

field Capacity

Units: W

Default value: “autosize”

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

chiller_type

field Chiller Type

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

condenser_type

field Condenser Type

Not applicable if Chiller Type is DistrictChilledWater

Default value: WaterCooled

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

leaving_chilled_water_lower_temperature_limit

field Leaving Chilled Water Lower Temperature Limit

Units: C

Default value: 5.0

Parameters:value (float) – value for IDD Field Leaving Chilled Water Lower Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of leaving_chilled_water_lower_temperature_limit or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

Maximum allowable part load ratio. Must be greater than or equal to Minimum Part Load Ratio.

Default value: 1.0

Parameters:value (float) – value for IDD Field Maximum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_part_load_ratio or None if not set Return type:float

minimum_part_load_ratio

field Minimum Part Load Ratio

Part load ratio below which the chiller starts cycling on/off to meet the load.

Must be less than or equal to Maximum Part Load Ratio.

Parameters:value (float) – value for IDD Field Minimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_part_load_ratio or None if not set Return type:float

minimum_unloading_ratio

field Minimum Unloading Ratio

Part load ratio where the chiller can no longer unload and false loading begins.

Minimum unloading ratio must be greater than or equal to the Minimum Part Load Ratio

and less than or equal to the Maximum Part Load Ratio.

Default value: 0.25

Parameters:value (float) – value for IDD Field Minimum Unloading Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_unloading_ratio 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

nominal_cop

field Nominal COP

Not applicable if Chiller Type is DistrictChilledWater

Electric Reciprocating Chiller

Units: W/W

Parameters:value (float) – value for IDD Field Nominal COP Raises:ValueError – if value is not a valid value Returns:the value of nominal_cop or None if not set Return type:float

optimum_part_load_ratio

field Optimum Part Load Ratio

Optimum part load ratio where the chiller is most efficient.

Must be greater than or equal to the Minimum Part Load Ratio

and less than or equal to the Maximum Part Load Ratio.

Default value: 1.0

Parameters:value (float) – value for IDD Field Optimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of optimum_part_load_ratio or None if not set Return type:float

priority

field Priority

If Chiller Plant Operation Scheme Type=Default

in HVACTemplate:Plant:ChilledWaterLoop, then equipment

operates in Priority order, 1, 2, 3, etc.

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

class pyidf.hvac_templates.HvactemplatePlantChillerObjectReference

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Chiller:ObjectReference This object references a detailed chiller object and adds it to an HVACTemplate:Plant:ChilledWaterLoop. The user must create a complete detailed chiller object with all required curve or performance objects.

chiller_name

field Chiller Name

The name of the detailed chiller object.

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

chiller_object_type

field Chiller Object Type

Default value: Chiller:Electric:EIR

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

name

field Name

The name of this 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

priority

field Priority

If Chiller Plant Operation Scheme Type=Default

in HVACTemplate:Plant:ChilledWaterLoop, then equipment

operates in Priority order, 1, 2, 3, etc.

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

class pyidf.hvac_templates.HvactemplatePlantHotWaterLoop

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:HotWaterLoop Plant loop to serve all HVACTemplate hot water coils and boilers.

demand_side_bypass_pipe

field Demand Side Bypass Pipe

Determines if a demand side bypass pipe is present in the hot water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Demand Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of demand_side_bypass_pipe or None if not set Return type:str

fluid_type

field Fluid Type

Default value: Water

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

hot_water_design_setpoint

field Hot Water Design Setpoint

Used for sizing and as constant setpoint if no Setpoint Schedule Name is specified.

Units: C

Default value: 82.0

Parameters:value (float) – value for IDD Field Hot Water Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of hot_water_design_setpoint or None if not set Return type:float

hot_water_plant_equipment_operation_schemes_name

field Hot Water Plant Equipment Operation Schemes Name

Name of a PlantEquipmentOperationSchemes object

Ignored if Plant Operation Scheme Type = Default

Parameters:value (str) – value for IDD Field Hot Water Plant Equipment Operation Schemes Name Raises:ValueError – if value is not a valid value Returns:the value of hot_water_plant_equipment_operation_schemes_name or None if not set Return type:str

hot_water_plant_operation_scheme_type

field Hot Water Plant Operation Scheme Type

Default operation type makes all equipment available

at all times operating in order of Priority specified

in HVACTemplate:Plant:Boiler objects.

Default value: Default

Parameters:value (str) – value for IDD Field Hot Water Plant Operation Scheme Type Raises:ValueError – if value is not a valid value Returns:the value of hot_water_plant_operation_scheme_type or None if not set Return type:str

hot_water_pump_configuration

field Hot Water Pump Configuration

VariableFlow - variable flow to boilers and coils, excess bypassed

ConstantFlow - constant flow to boilers and coils, excess bypassed

Default value: ConstantFlow

Parameters:value (str) – value for IDD Field Hot Water Pump Configuration Raises:ValueError – if value is not a valid value Returns:the value of hot_water_pump_configuration or None if not set Return type:str

hot_water_pump_rated_head

field Hot Water Pump Rated Head

Default head is 60 feet H2O

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

hot_water_pump_type

field Hot Water Pump Type

Describes the type of pump configuration used for the hot water loop.

Default value: SinglePump

Parameters:value (str) – value for IDD Field Hot Water Pump Type Raises:ValueError – if value is not a valid value Returns:the value of hot_water_pump_type or None if not set Return type:str

hot_water_reset_outdoor_drybulb_high

field Hot Water Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Hot Water Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of hot_water_reset_outdoor_drybulb_high or None if not set Return type:float

hot_water_reset_outdoor_drybulb_low

field Hot Water Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: -6.7

Parameters:value (float) – value for IDD Field Hot Water Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of hot_water_reset_outdoor_drybulb_low or None if not set Return type:float

hot_water_setpoint_at_outdoor_drybulb_high

field Hot Water Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 65.6

Parameters:value (float) – value for IDD Field Hot Water Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of hot_water_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

hot_water_setpoint_at_outdoor_drybulb_low

field Hot Water Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 82.2

Parameters:value (float) – value for IDD Field Hot Water Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of hot_water_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

hot_water_setpoint_reset_type

field Hot Water Setpoint Reset Type

Overrides Hot Water Setpoint Schedule Name

Default value: None

Parameters:value (str) – value for IDD Field Hot Water Setpoint Reset Type Raises:ValueError – if value is not a valid value Returns:the value of hot_water_setpoint_reset_type or None if not set Return type:str

hot_water_setpoint_schedule_name

field Hot Water Setpoint Schedule Name

Leave blank if constant setpoint

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

load_distribution_scheme

field Load Distribution Scheme

Default value: SequentialLoad

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

loop_design_delta_temperature

field Loop Design Delta Temperature

The temperature difference used in sizing the loop flow rate.

Units: deltaC

Default value: 11.0

Parameters:value (float) – value for IDD Field Loop Design Delta Temperature Raises:ValueError – if value is not a valid value Returns:the value of loop_design_delta_temperature or None if not set Return type:float

maximum_outdoor_dry_bulb_temperature

field Maximum Outdoor Dry Bulb Temperature

The maximum outdoor dry-bulb temperature that the hot water loops operate.

Leave blank for no limit.

Units: C

Parameters:value (float) – value for IDD Field Maximum Outdoor Dry Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_dry_bulb_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

pump_control_type

field Pump Control Type

Default value: Intermittent

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

pump_schedule_name

field Pump Schedule Name

If blank, always available

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

supply_side_bypass_pipe

field Supply Side Bypass Pipe

Determines if a supply side bypass pipe is present in the hot water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Supply Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of supply_side_bypass_pipe or None if not set Return type:str

class pyidf.hvac_templates.HvactemplatePlantMixedWaterLoop

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:MixedWaterLoop Central plant loop portion of a water source heat pump system.

demand_side_bypass_pipe

field Demand Side Bypass Pipe

Determines if a demand side bypass pipe is present in the hot water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Demand Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of demand_side_bypass_pipe or None if not set Return type:str

equipment_operation_schemes_name

field Equipment Operation Schemes Name

Name of a PlantEquipmentOperationSchemes object

Ignored if Plant Operation Scheme Type = Default

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

fluid_type

field Fluid Type

Default value: Water

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

high_temperature_design_setpoint

field High Temperature Design Setpoint

Used for sizing and as constant setpoint if no Setpoint Schedule Name is specified.

Units: C

Default value: 33.0

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

high_temperature_setpoint_schedule_name

field High Temperature Setpoint Schedule Name

Leave blank if constant setpoint

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

load_distribution_scheme

field Load Distribution Scheme

Default value: SequentialLoad

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

loop_design_delta_temperature

field Loop Design Delta Temperature

The temperature difference used in sizing the loop flow rate.

Units: deltaC

Default value: 5.6

Parameters:value (float) – value for IDD Field Loop Design Delta Temperature Raises:ValueError – if value is not a valid value Returns:the value of loop_design_delta_temperature or None if not set Return type:float

low_temperature_design_setpoint

field Low Temperature Design Setpoint

Used for sizing and as constant setpoint if no Condenser Water Setpoint Schedule Name is specified.

May be left blank if not serving any water cooled chillers

Units: C

Default value: 20.0

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

low_temperature_setpoint_schedule_name

field Low Temperature Setpoint Schedule Name

Leave blank if constant setpoint

May be left blank if not serving any water cooled chillers

Parameters:value (str) – value for IDD Field Low Temperature Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of low_temperature_setpoint_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

operation_scheme_type

field Operation Scheme Type

Default operation type makes all equipment available

at all times operating in order of Priority specified

in HVACTemplate:Plant:Boiler and HVACTemplate:Plant:Tower objects.

Default value: Default

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

pump_control_type

field Pump Control Type

Applies to both chilled water and condenser loop pumps

Default value: Intermittent

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

pump_schedule_name

field Pump Schedule Name

If blank, always available

Applies to both chilled water and condenser loop pumps

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

supply_side_bypass_pipe

field Supply Side Bypass Pipe

Determines if a supply side bypass pipe is present in the hot water loop.

Default value: Yes

Parameters:value (str) – value for IDD Field Supply Side Bypass Pipe Raises:ValueError – if value is not a valid value Returns:the value of supply_side_bypass_pipe or None if not set Return type:str

water_pump_configuration

field Water Pump Configuration

VariableFlow - variable flow to boilers and coils, excess bypassed

ConstantFlow - constant flow to boilers and coils, excess bypassed

Default value: ConstantFlow

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

water_pump_rated_head

field Water Pump Rated Head

May be left blank if not serving any water cooled chillers

default head is 60 feet H2O

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

water_pump_type

field Water Pump Type

Describes the type of pump configuration used for the mixed water loop.

Default value: SinglePump

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

class pyidf.hvac_templates.HvactemplatePlantTower

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Tower This object adds a cooling tower to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop.

free_convection_capacity

field Free Convection Capacity

Applicable for Tower Type SingleSpeed and TwoSpeed

Tower capacity in free convection regime with entering water at 35C (95F),

leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature

and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be

5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Tower

free convection capacity times (1.25) gives the actual tower heat rejection at

these operating conditions.

Units: W

Default value: “autosize”

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

high_speed_fan_power

field High Speed Fan Power

Applicable for tower type SingleSpeed and TwoSpeed

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of high_speed_fan_power or None if not set Return type:float or “Autosize”

high_speed_nominal_capacity

field High Speed Nominal Capacity

Applicable for tower type SingleSpeed and TwoSpeed

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature, with the tower fan operating at high speed. Design water

flow rate assumed to be 5.382E-8 m3/s per watt(3 gpm/ton). Nominal tower capacity

times (1.25) gives the actual tower heat rejection at these operating conditions.

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Nominal Capacity Raises:ValueError – if value is not a valid value Returns:the value of high_speed_nominal_capacity or None if not set Return type:float or “Autosize”

low_speed_fan_power

field Low Speed Fan Power

Applicable only for Tower Type TwoSpeed

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of low_speed_fan_power or None if not set Return type:float or “Autosize”

low_speed_nominal_capacity

field Low Speed Nominal Capacity

Applicable only for Tower Type TwoSpeed

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature, with the tower fan operating at low speed. Design water flow

rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity

(3 gpm/ton). Nominal tower capacity times (1.25) gives the actual tower heat

rejection at these operating conditions.

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Nominal Capacity Raises:ValueError – if value is not a valid value Returns:the value of low_speed_nominal_capacity 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

priority

field Priority

Applicable for all Tower Types

If Condenser Plant Operation Scheme Type=Default

in HVACTemplate:Plant:ChilledWaterLoop, then equipment

operates in Priority order, 1, 2, 3, etc.

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

template_plant_loop_type

field Template Plant Loop Type

Specifies if this tower serves a template chilled water loop or mixed water loop

If left blank, will serve a chilled water loop if present, or a mixed water loop (if

no chilled water loop is present).

Parameters:value (str) – value for IDD Field Template Plant Loop Type Raises:ValueError – if value is not a valid value Returns:the value of template_plant_loop_type or None if not set Return type:str

tower_type

field Tower Type

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

class pyidf.hvac_templates.HvactemplatePlantTowerObjectReference

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Plant:Tower:ObjectReference This object references a detailed cooling tower object and adds it to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop. The user must create a complete detailed cooling tower object with all required curve or performance objects.

cooling_tower_name

field Cooling Tower Name

The name of the detailed cooling tower object.

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

cooling_tower_object_type

field Cooling Tower Object Type

Default value: CoolingTower:SingleSpeed

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

name

field Name

The name of this 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

priority

field Priority

If Condenser Plant Operation Scheme Type=Default

in HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop, then equipment

operates in Priority order, 1, 2, 3, etc.

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

template_plant_loop_type

field Template Plant Loop Type

Specifies if this tower serves a template chilled water loop or mixed water loop

If left blank, will serve a chilled water loop if present, or a mixed water loop (if

no chilled water loop is present).

Parameters:value (str) – value for IDD Field Template Plant Loop Type Raises:ValueError – if value is not a valid value Returns:the value of template_plant_loop_type or None if not set Return type:str

class pyidf.hvac_templates.HvactemplateSystemConstantVolume

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:ConstantVolume Constant Air Volume air loop with optional chilled water cooling coil, optional heating coil and optional preheat.

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_control_zone_name

field Cooling Coil Control Zone name

name of the HVACTemplate:ZoneConstantVolume object that

contains the cooling thermostat when Cooling Coil Setpoint Control Type = ControlZone

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

cooling_coil_design_setpoint_temperature

field Cooling Coil Design Setpoint Temperature

Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint_temperature or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_high

field Cooling Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 23.3

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_low

field Cooling Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_high

field Cooling Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_low

field Cooling Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_control_type

field Cooling Coil Setpoint Control Type

Default value: FixedSetpoint

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

cooling_coil_setpoint_schedule_name

field Cooling Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

cooling_coil_type

field Cooling Coil Type

Default value: ChilledWater

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheat = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint.

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

Zone name where humidistat is located

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

dehumidification_relative_humidity_setpoint

field Dehumidification Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint or None if not set Return type:float

dehumidification_relative_humidity_setpoint_schedule_name

field Dehumidification Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Dehumidification Relative Humidity

Setpoint above. Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Dehumidification Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint_schedule_name or None if not set Return type:str

economizer_lower_temperature_limit

field Economizer Lower Temperature Limit

Outdoor temperature below which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

economizer_upper_enthalpy_limit

field Economizer Upper Enthalpy Limit

Outdoor enthalpy above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: J/kg

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

economizer_upper_temperature_limit

field Economizer Upper Temperature Limit

Outdoor temperature above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

gas_preheat_coil_efficiency

field Gas Preheat Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Preheat Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_efficiency or None if not set Return type:float

gas_preheat_coil_parasitic_electric_load

field Gas Preheat Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Preheat Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_parasitic_electric_load or None if not set Return type:float

heat_recovery_frost_control_type

field Heat Recovery Frost Control Type

Default value: None

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

heat_recovery_heat_exchanger_type

field Heat Recovery Heat Exchanger Type

Default value: Plate

Parameters:value (str) – value for IDD Field Heat Recovery Heat Exchanger Type Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_heat_exchanger_type 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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_capacity

field Heating Coil Capacity

Units: W

Default value: “autosize”

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

heating_coil_control_zone_name

field Heating Coil Control Zone name

name of the HVACTemplate:ZoneConstantVolume object that

contains the heating thermostat

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_high

field Heating Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_high or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_low

field Heating Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)

Units: C

Default value: 7.8

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_high

field Heating Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_low

field Heating Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 15.0

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_control_type

field Heating Coil Setpoint Control Type

Default value: FixedSetpoint

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

heating_coil_setpoint_schedule_name

field Heating Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

heating_coil_type

field Heating Coil Type

Default value: HotWater

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_relative_humidity_setpoint

field Humidifier Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100).

Ignored if Humidifier Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint or None if not set Return type:float

humidifier_relative_humidity_setpoint_schedule_name

field Humidifier Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Humidifier Relative Humidity

Setpoint above.Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Humidifier Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint_schedule_name or None if not set Return type:str

humidifier_type

field Humidifier Type

Default value: None

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

latent_heat_recovery_effectiveness

field Latent Heat Recovery Effectiveness

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

preheat_coil_availability_schedule_name

field Preheat Coil Availability Schedule Name

If blank, always on

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

preheat_coil_design_setpoint

field Preheat Coil Design Setpoint

Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.

Units: C

Default value: 7.2

Parameters:value (float) – value for IDD Field Preheat Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of preheat_coil_design_setpoint or None if not set Return type:float

preheat_coil_setpoint_schedule_name

field Preheat Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

preheat_coil_type

field Preheat Coil Type

Default value: None

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

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 300.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 600.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_maximum_flow_rate

field Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

class pyidf.hvac_templates.HvactemplateSystemDedicatedOutdoorAir

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:DedicatedOutdoorAir This object creates a dedicated outdoor air system that must be used with HVACTemplate:Zone:* objects for BaseboardHeat FanCoil PTAC PTHP WaterToAirHeatPump and VRF. Does not support HVACTemplate:Zone:VAV or other central multizone systems

air_outlet_type

field Air Outlet Type

Default value: DirectIntoZone

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_design_setpoint

field Cooling Coil Design Setpoint

Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_high

field Cooling Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 23.3

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_low

field Cooling Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_high

field Cooling Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_low

field Cooling Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_control_type

field Cooling Coil Setpoint Control Type

Default value: FixedSetpoint

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

cooling_coil_setpoint_schedule_name

field Cooling Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

cooling_coil_type

field Cooling Coil Type

Default value: ChilledWater

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheatHeatingCoil = cool beyond the dry-bulb setpoint, reheat with heating coil

Valid for all cooling coil types. If no heating coil specified, cold supply temps may occur.

CoolReheatDesuperheater = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint, reheat with desuperheater coil.

Valid only for Cooling Coil Type = TwoSpeedDX, TwoStageDX, TwoStageHumidityControlDX, or HeatExchangerAssistedDX.

Multimode = activate enhanced dehumidification mode as needed and meet sensible load.

Valid only for Cooling Coil Type = TwoStageHumidityControlDX

Default value: None

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

dehumidification_setpoint

field Dehumidification Setpoint

The supply air humidity ratio for dehumidification control.

Default of 0.00924 kgWater/kgDryAir is equivalent to 12.8C (55F) dewpoint.

Ignored if Dehumidification Setpoint Schedule specified below

Units: kgWater/kgDryAir

Default value: 0.00924

value <= 1.0

Parameters:value (float) – value for IDD Field Dehumidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_setpoint or None if not set Return type:float

dehumidification_setpoint_schedule_name

field Dehumidification Setpoint Schedule Name

Leave blank to use constant setpoint specified in Dehumidification Setpoint above.

Schedule values must be in units of humidity ratio (kgWater/kgDryAir or lbWater/lbDryAir)

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

dx_cooling_coil_gross_rated_cop

field DX Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field DX Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of dx_cooling_coil_gross_rated_cop or None if not set Return type:float

dx_cooling_coil_gross_rated_sensible_heat_ratio

field DX Cooling Coil Gross Rated Sensible Heat Ratio

Gross SHR

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field DX Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of dx_cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

dx_cooling_coil_gross_rated_total_capacity

field DX Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

heat_recovery_frost_control_type

field Heat Recovery Frost Control Type

Default value: None

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

heat_recovery_heat_exchanger_type

field Heat Recovery Heat Exchanger Type

Default value: Plate

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

heat_recovery_latent_effectiveness

field Heat Recovery Latent Effectiveness

Default value: 0.65

value <= 1.0

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

heat_recovery_sensible_effectiveness

field Heat Recovery Sensible Effectiveness

Default value: 0.7

value <= 1.0

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

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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_high

field Heating Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_high or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_low

field Heating Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 7.8

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_high

field Heating Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_low

field Heating Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults 15.0C (59F) at 7.8C (46F) to 12.2C (54F) at 12.2C (54F)

Units: C

Default value: 15.0

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_control_type

field Heating Coil Setpoint Control Type

When selecting OutdoorAirTemperatureReset, the Heating Coil Design Setpoint may need to be changed

Default value: FixedSetpoint

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

heating_coil_setpoint_schedule_name

field Heating Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

heating_coil_type

field Heating Coil Type

Default value: HotWater

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_constant_setpoint

field Humidifier Constant Setpoint

The supply air humidity ratio for humidification control.

Ignored if Humidifier Setpoint Schedule specified below

Units: kgWater/kgDryAir

Default value: 0.003

value <= 1.0

Parameters:value (float) – value for IDD Field Humidifier Constant Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_constant_setpoint or None if not set Return type:float

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_setpoint_schedule_name

field Humidifier Setpoint Schedule Name

Leave blank to use constant setpoint specified in Humidifier Constant Setpoint above.

Schedule values must be in units of humidity ratio (kgWater/kgDryAir or lbWater/lbDryAir)

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

humidifier_type

field Humidifier Type

Default value: None

Parameters:value (str) – value for IDD Field Humidifier Type Raises:ValueError – if value is not a valid value Returns:the value of humidifier_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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_flow_rate

field Supply Fan Flow Rate

Units: m3/s

Default value: “autosize”

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

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; DOAS System always on. Schedule is used in availability manager

and fan scheduling.

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

class pyidf.hvac_templates.HvactemplateSystemDualDuct

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:DualDuct Dual-duct constant volume or variable volume air loop

cold_duct_supply_fan_delta_pressure

field Cold Duct Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Cold Duct Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_delta_pressure or None if not set Return type:float

cold_duct_supply_fan_maximum_flow_rate

field Cold Duct Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

cold_duct_supply_fan_minimum_flow_fraction

field Cold Duct Supply Fan Minimum Flow Fraction

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Cold Duct Supply Fan Minimum Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_minimum_flow_fraction or None if not set Return type:float

cold_duct_supply_fan_motor_efficiency

field Cold Duct Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Cold Duct Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_motor_efficiency or None if not set Return type:float

cold_duct_supply_fan_motor_in_air_stream_fraction

field Cold Duct Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Cold Duct Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

cold_duct_supply_fan_partload_power_coefficients

field Cold Duct Supply Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Cold Duct Supply Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_partload_power_coefficients or None if not set Return type:str

cold_duct_supply_fan_placement

field Cold Duct Supply Fan Placement

Default value: DrawThrough

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

cold_duct_supply_fan_total_efficiency

field Cold Duct Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Cold Duct Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of cold_duct_supply_fan_total_efficiency or None if not set Return type:float

cold_supply_plenum_name

field Cold Supply Plenum Name

Plenum zone name. Supply plenum serves the cold inlets of all zones on this system.

Blank if none.

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_design_setpoint_temperature

field Cooling Coil Design Setpoint Temperature

Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint_temperature or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_high

field Cooling Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 23.3

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_reset_outdoor_drybulb_low

field Cooling Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_reset_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_high

field Cooling Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

cooling_coil_setpoint_at_outdoor_drybulb_low

field Cooling Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 15.6

Parameters:value (float) – value for IDD Field Cooling Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

cooling_coil_setpoint_control_type

field Cooling Coil Setpoint Control Type

Default value: FixedSetpoint

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

cooling_coil_setpoint_schedule_name

field Cooling Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

cooling_coil_type

field Cooling Coil Type

Default value: ChilledWater

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheat = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint.

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

Zone name where humidistat is located

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

dehumidification_relative_humidity_setpoint

field Dehumidification Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint or None if not set Return type:float

dehumidification_relative_humidity_setpoint_schedule_name

field Dehumidification Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Dehumidification Relative Humidity

Setpoint above. Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Dehumidification Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint_schedule_name or None if not set Return type:str

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_lower_temperature_limit

field Economizer Lower Temperature Limit

Outdoor temperature below which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

economizer_upper_enthalpy_limit

field Economizer Upper Enthalpy Limit

Outdoor enthalpy above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: J/kg

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

economizer_upper_temperature_limit

field Economizer Upper Temperature Limit

Outdoor temperature above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

gas_preheat_coil_efficiency

field Gas Preheat Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Preheat Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_efficiency or None if not set Return type:float

gas_preheat_coil_parasitic_electric_load

field Gas Preheat Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Preheat Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_parasitic_electric_load or None if not set Return type:float

heat_recovery_frost_control_type

field Heat Recovery Frost Control Type

Default value: None

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

heat_recovery_heat_exchanger_type

field Heat Recovery Heat Exchanger Type

Default value: Plate

Parameters:value (str) – value for IDD Field Heat Recovery Heat Exchanger Type Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_heat_exchanger_type 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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_capacity

field Heating Coil Capacity

Units: W

Default value: “autosize”

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.

Units: C

Default value: 50.0

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_high

field Heating Coil Reset Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 12.2

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_high or None if not set Return type:float

heating_coil_reset_outdoor_drybulb_low

field Heating Coil Reset Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)

Units: C

Default value: 7.8

Parameters:value (float) – value for IDD Field Heating Coil Reset Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_reset_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_high

field Heating Coil Setpoint at Outdoor Dry-Bulb High

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 20.0

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb High Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_high or None if not set Return type:float

heating_coil_setpoint_at_outdoor_drybulb_low

field Heating Coil Setpoint at Outdoor Dry-Bulb Low

Applicable only for OutdoorAirTemperatureReset control.

Units: C

Default value: 50.0

Parameters:value (float) – value for IDD Field Heating Coil Setpoint at Outdoor Dry-Bulb Low Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_setpoint_at_outdoor_drybulb_low or None if not set Return type:float

heating_coil_setpoint_control_type

field Heating Coil Setpoint Control Type

Default value: FixedSetpoint

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

heating_coil_setpoint_schedule_name

field Heating Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

heating_coil_type

field Heating Coil Type

Default value: HotWater

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

hot_duct_supply_fan_delta_pressure

field Hot Duct Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Hot Duct Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_delta_pressure or None if not set Return type:float

hot_duct_supply_fan_maximum_flow_rate

field Hot Duct Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

hot_duct_supply_fan_minimum_flow_fraction

field Hot Duct Supply Fan Minimum Flow Fraction

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Hot Duct Supply Fan Minimum Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_minimum_flow_fraction or None if not set Return type:float

hot_duct_supply_fan_motor_efficiency

field Hot Duct Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Hot Duct Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_motor_efficiency or None if not set Return type:float

hot_duct_supply_fan_motor_in_air_stream_fraction

field Hot Duct Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Hot Duct Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

hot_duct_supply_fan_partload_power_coefficients

field Hot Duct Supply Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Hot Duct Supply Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_partload_power_coefficients or None if not set Return type:str

hot_duct_supply_fan_placement

field Hot Duct Supply Fan Placement

Default value: DrawThrough

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

hot_duct_supply_fan_total_efficiency

field Hot Duct Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Hot Duct Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of hot_duct_supply_fan_total_efficiency or None if not set Return type:float

hot_supply_plenum_name

field Hot Supply Plenum Name

Plenum zone name. Supply plenum serves the hot inlets of all zones on this system.

Blank if none.

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_relative_humidity_setpoint

field Humidifier Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100).

Ignored if Humidifier Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint or None if not set Return type:float

humidifier_relative_humidity_setpoint_schedule_name

field Humidifier Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Humidifier Relative Humidity

Setpoint above.Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Humidifier Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint_schedule_name or None if not set Return type:str

humidifier_type

field Humidifier Type

Default value: None

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

latent_heat_recovery_effectiveness

field Latent Heat Recovery Effectiveness

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

main_supply_fan_delta_pressure

field Main Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Main Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_delta_pressure or None if not set Return type:float

main_supply_fan_maximum_flow_rate

field Main Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

main_supply_fan_minimum_flow_fraction

field Main Supply Fan Minimum Flow Fraction

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Main Supply Fan Minimum Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_minimum_flow_fraction or None if not set Return type:float

main_supply_fan_motor_efficiency

field Main Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Main Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_motor_efficiency or None if not set Return type:float

main_supply_fan_motor_in_air_stream_fraction

field Main Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Main Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

main_supply_fan_partload_power_coefficients

field Main Supply Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Main Supply Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_partload_power_coefficients or None if not set Return type:str

main_supply_fan_total_efficiency

field Main Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Main Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of main_supply_fan_total_efficiency or None if not set Return type:float

maximum_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_control_type

field Minimum Outdoor Air Control Type

Default value: ProportionalMinimum

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

preheat_coil_availability_schedule_name

field Preheat Coil Availability Schedule Name

If blank, always on

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

preheat_coil_design_setpoint

field Preheat Coil Design Setpoint

Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.

Units: C

Default value: 7.2

Parameters:value (float) – value for IDD Field Preheat Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of preheat_coil_design_setpoint or None if not set Return type:float

preheat_coil_setpoint_schedule_name

field Preheat Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

preheat_coil_type

field Preheat Coil Type

Default value: None

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

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 500.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_partload_power_coefficients

field Return Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Return Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of return_fan_partload_power_coefficients or None if not set Return type:str

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

sizing_option

field Sizing Option

Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident

zone air flow rates.

Default value: NonCoincident

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

system_configuration_type

field System Configuration Type

SingleFan - a single supply fan before the split to dual ducts

DualFan - two supply fans, one each for the cold and hot ducts

ConstantVolume - constant volume

VariableVolume - variable volume

Default value: SingleFanConstantVolume

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

class pyidf.hvac_templates.HvactemplateSystemPackagedVav

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:PackagedVAV Packaged Variable Air Volume (PVAV) air loop with optional heating coil and optional preheat.

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_design_setpoint

field Cooling Coil Design Setpoint

Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint or None if not set Return type:float

cooling_coil_gross_rated_cop

field Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Gross SHR

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

cooling_coil_setpoint_reset_type

field Cooling Coil Setpoint Reset Type

Overrides Cooling Coil Setpoint Schedule Name

None = no reset, control to Cooling Coil Design Setpoint Temperature or Schedule

Warmest = reset as warm as possible yet meet all zone cooling loads at max supply air flow rate

OutdoorAirTemperatureReset = reset based on outdoor air temperature (18.0C at 15.6C ODB,

to the Cooling Design Setpoint at 26.7C)

WarmestTemperatureFirst = reset as warm as possible yet meet all zone cooling loads at

min supply air flow rate

Default value: None

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

cooling_coil_setpoint_schedule_name

field Cooling Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

cooling_coil_type

field Cooling Coil Type

Default value: TwoSpeedDX

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheat = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint.

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

Zone name where humidistat is located

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

dehumidification_setpoint

field Dehumidification Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_setpoint or None if not set Return type:float

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_drybulb_temperature

field Economizer Maximum Limit Dry-Bulb Temperature

Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb

economizer control type. No input or blank input means this limit is

not operative. Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_enthalpy

field Economizer Maximum Limit Enthalpy

Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type.

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: J/kg

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

economizer_minimum_limit_drybulb_temperature

field Economizer Minimum Limit Dry-Bulb Temperature

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

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_capacity

field Heating Coil Capacity

Units: W

Default value: “autosize”

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_setpoint_reset_type

field Heating Coil Setpoint Reset Type

Overrides Heating Coil Setpoint Schedule Name

None = no reset, control to Heating Coil Design Setpoint Temperature or Schedule

OutdoorAirTemperatureReset = reset based on outdoor air temperature

(Heating Design Setpoint at -6.7C ODB to Heating Design Setpoint minus 5.2C at 10C ODB)

min supply air flow rate

Default value: None

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

heating_coil_setpoint_schedule_name

field Heating Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

heating_coil_type

field Heating Coil Type

Default value: None

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_setpoint

field Humidifier Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_setpoint or None if not set Return type:float

humidifier_type

field Humidifier Type

Default value: None

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

latent_heat_recovery_effectiveness

field Latent Heat Recovery Effectiveness

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_control_type

field Minimum Outdoor Air Control Type

Default value: ProportionalMinimum

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 500.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_partload_power_coefficients

field Return Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Return Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of return_fan_partload_power_coefficients or None if not set Return type:str

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

sizing_option

field Sizing Option

Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident

zone air flow rates.

Default value: NonCoincident

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_maximum_flow_rate

field Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

supply_fan_minimum_flow_rate

field Supply Fan Minimum Flow Rate

This field is only used to set a minimum part load on the VAV fan power curve.

Autosize or zero is recommended.

Units: m3/s

Default value: “autosize”

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

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_partload_power_coefficients

field Supply Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Supply Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_partload_power_coefficients 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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; PVAV System always on. Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

class pyidf.hvac_templates.HvactemplateSystemUnitary

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:Unitary Unitary furnace with air conditioner

control_zone_or_thermostat_location_name

field Control Zone or Thermostat Location Name

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_gross_rated_cop

field Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electric power

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Gross SHR

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: SingleSpeedDX

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

cooling_design_supply_air_temperature

field Cooling Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 12.8

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible cooling load only

CoolReheatHeatingCoil = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint, reheat with main heating coil.

CoolReheatDesuperheater = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint, reheat with desuperheater coil.

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

This field is not currently used - the thermostat control zone is also the dehumidification control zone

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

dehumidification_setpoint

field Dehumidification Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_setpoint or None if not set Return type:float

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_lower_temperature_limit

field Economizer Lower Temperature Limit

Outdoor temperature below which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

economizer_upper_enthalpy_limit

field Economizer Upper Enthalpy Limit

Outdoor enthalpy above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: J/kg

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

economizer_upper_temperature_limit

field Economizer Upper Temperature Limit

Outdoor temperature above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_capacity

field Heating Coil Capacity

Units: W

Default value: “autosize”

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

heating_coil_type

field Heating Coil Type

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

heating_design_supply_air_temperature

field Heating Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 50.0

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_setpoint

field Humidifier Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_setpoint or None if not set Return type:float

humidifier_type

field Humidifier Type

Default value: None

Parameters:value (str) – value for IDD Field Humidifier Type Raises:ValueError – if value is not a valid value Returns:the value of humidifier_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.

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 500.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 600.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_maximum_flow_rate

field Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

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

supply_fan_placement

field Supply Fan Placement

Default value: BlowThrough

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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; Unitary System always on. Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

class pyidf.hvac_templates.HvactemplateSystemUnitaryHeatPumpAirToAir

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:UnitaryHeatPump:AirToAir Unitary furnace with electric air-to-air heat pump

control_zone_or_thermostat_location_name

field Control Zone or Thermostat Location Name

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_gross_rated_cop

field Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: SingleSpeedDX

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

cooling_design_supply_air_temperature

field Cooling Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 12.8

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Supply air flow rate during cooling operation

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_drybulb_temperature

field Economizer Maximum Limit Dry-Bulb Temperature

Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb

economizer control type. No input or blank input means this limit is

not operative. Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_enthalpy

field Economizer Maximum Limit Enthalpy

Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type.

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: J/kg

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

economizer_minimum_limit_drybulb_temperature

field Economizer Minimum Limit Dry-Bulb Temperature

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

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

heat_pump_defrost_control

field Heat Pump Defrost Control

Default value: Timed

Parameters:value (str) – value for IDD Field Heat Pump Defrost Control Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_control or None if not set Return type:str

heat_pump_defrost_maximum_outdoor_drybulb_temperature

field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature

Units: C

Default value: 5.0

value <= 7.22

Parameters:value (float) – value for IDD Field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_maximum_outdoor_drybulb_temperature or None if not set Return type:float

heat_pump_defrost_strategy

field Heat Pump Defrost Strategy

Default value: ReverseCycle

Parameters:value (str) – value for IDD Field Heat Pump Defrost Strategy Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_strategy or None if not set Return type:str

heat_pump_defrost_time_period_fraction

field Heat Pump Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if Timed defrost control is specified

Default value: 0.058333

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

heat_pump_heating_coil_availability_schedule_name

field Heat Pump Heating Coil Availability Schedule Name

If blank, always on

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

heat_pump_heating_coil_gross_rated_capacity

field Heat Pump Heating Coil Gross Rated Capacity

Rated heating capacity excluding the effect of supply air fan heat

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Heat Pump Heating Coil Gross Rated Capacity Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_capacity or None if not set Return type:float or “Autosize”

heat_pump_heating_coil_rated_cop

field Heat Pump Heating Coil Rated COP

Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy.

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W/W

Default value: 2.75

Parameters:value (float) – value for IDD Field Heat Pump Heating Coil Rated COP Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_rated_cop or None if not set Return type:float

heat_pump_heating_coil_type

field Heat Pump Heating Coil Type

Default value: SingleSpeedDXHeatPump

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

heat_pump_heating_minimum_outdoor_drybulb_temperature

field Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature

Units: C

Default value: -8.0

value >= -20.0

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

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_design_supply_air_temperature

field Heating Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 50.0

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Supply air flow rate during heating operation

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_setpoint

field Humidifier Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_setpoint or None if not set Return type:float

humidifier_type

field Humidifier Type

Default value: None

Parameters:value (str) – value for IDD Field Humidifier Type Raises:ValueError – if value is not a valid value Returns:the value of humidifier_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.

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

no_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

Supply air flow rate when no cooling or heating is needed

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.

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 500.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

supplemental_gas_heating_coil_efficiency

field Supplemental Gas Heating Coil Efficiency

Applies only if Supplemental Heating Coil Type is Gas

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Supplemental Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_coil_efficiency or None if not set Return type:float

supplemental_gas_heating_coil_parasitic_electric_load

field Supplemental Gas Heating Coil Parasitic Electric Load

Applies only if Supplemental Heating Coil Type is Gas

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Supplemental Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_coil_parasitic_electric_load or None if not set Return type:float

supplemental_heating_coil_availability_schedule_name

field Supplemental Heating Coil Availability Schedule Name

If blank, always on

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

supplemental_heating_coil_capacity

field Supplemental Heating Coil Capacity

Units: W

Default value: “autosize”

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

supplemental_heating_coil_maximum_outdoor_drybulb_temperature

field Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature

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 Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of supplemental_heating_coil_maximum_outdoor_drybulb_temperature or None if not set Return type:float

supplemental_heating_coil_type

field Supplemental Heating Coil Type

Default value: Electric

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 600.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

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

supply_fan_placement

field Supply Fan Placement

Default value: BlowThrough

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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; Unitary System always on. Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

class pyidf.hvac_templates.HvactemplateSystemUnitarySystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:UnitarySystem Unitary HVAC system with optional cooling and heating. Supports DX and chilled water, cooling, gas, electric, and hot water heating, air-to-air and water-to-air heat pumps.

control_type

field Control Type

Load control requires a Controlling Zone name.

SetPoint control requires set points at coil outlet nodes. The user must add appropriate

SetpointManager objects to the idf file.

Default value: Load

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

control_zone_or_thermostat_location_name

field Control Zone or Thermostat Location Name

This field is required if Control Type is Load.

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_type

field Cooling Coil Type

Default value: SingleSpeedDX

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

cooling_design_supply_air_temperature

field Cooling Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 12.8

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Supply air flow rate during cooling operation

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheat = cool beyond the dry-bulb setpoint, reheat with reheat coil

If no reheat coil specified, cold supply temps may occur.

Multimode = activate enhanced dehumidification mode as needed and meet sensible load.

Valid only for Cooling Coil Type = TwoStageHumidityControlDX

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

Zone name where humidistat is located

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

dehumidification_relative_humidity_setpoint

field Dehumidification Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint or None if not set Return type:float

dehumidification_relative_humidity_setpoint_schedule_name

field Dehumidification Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Dehumidification Relative Humidity

Setpoint above. Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Dehumidification Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_relative_humidity_setpoint_schedule_name or None if not set Return type:str

dx_cooling_coil_gross_rated_cop

field DX Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field DX Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of dx_cooling_coil_gross_rated_cop or None if not set Return type:float

dx_cooling_coil_gross_rated_sensible_heat_ratio

field DX Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field DX Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of dx_cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

dx_cooling_coil_gross_rated_total_capacity

field DX Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Default value: “autosize”

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

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_drybulb_temperature

field Economizer Maximum Limit Dry-Bulb Temperature

Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb

economizer control type. No input or blank input means this limit is

not operative. Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_enthalpy

field Economizer Maximum Limit Enthalpy

Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type.

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: J/kg

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

economizer_minimum_limit_drybulb_temperature

field Economizer Minimum Limit Dry-Bulb Temperature

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

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

heat_pump_defrost_control

field Heat Pump Defrost Control

Default value: Timed

Parameters:value (str) – value for IDD Field Heat Pump Defrost Control Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_control or None if not set Return type:str

heat_pump_defrost_maximum_outdoor_drybulb_temperature

field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature

Units: C

Default value: 5.0

value <= 7.22

Parameters:value (float) – value for IDD Field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_maximum_outdoor_drybulb_temperature or None if not set Return type:float

heat_pump_defrost_strategy

field Heat Pump Defrost Strategy

Default value: ReverseCycle

Parameters:value (str) – value for IDD Field Heat Pump Defrost Strategy Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_strategy or None if not set Return type:str

heat_pump_defrost_time_period_fraction

field Heat Pump Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if Timed defrost control is specified

Default value: 0.058333

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

heat_pump_heating_coil_gross_rated_cop

field Heat Pump Heating Coil Gross Rated COP

Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy.

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Applies only to DX coils

Units: W/W

Default value: 2.75

Parameters:value (float) – value for IDD Field Heat Pump Heating Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_cop or None if not set Return type:float

heat_pump_heating_minimum_outdoor_drybulb_temperature

field Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature

Units: C

Default value: -8.0

value >= -20.0

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

heat_recovery_frost_control_type

field Heat Recovery Frost Control Type

Default value: None

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

heat_recovery_heat_exchanger_type

field Heat Recovery Heat Exchanger Type

Default value: Plate

Parameters:value (str) – value for IDD Field Heat Recovery Heat Exchanger Type Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_heat_exchanger_type 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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_gross_rated_capacity

field Heating Coil Gross Rated Capacity

Rated heating capacity excluding the effect of supply air fan heat

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W

Default value: “autosize”

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

heating_coil_type

field Heating Coil Type

Default value: Gas

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

heating_design_supply_air_temperature

field Heating Design Supply Air Temperature

Used for sizing.

Units: C

Default value: 50.0

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Supply air flow rate during heating operation

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_relative_humidity_setpoint

field Humidifier Relative Humidity Setpoint

Zone relative humidity setpoint in percent (0 to 100).

Ignored if Humidifier Relative Humidity Setpoint Schedule specified below

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Relative Humidity Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint or None if not set Return type:float

humidifier_relative_humidity_setpoint_schedule_name

field Humidifier Relative Humidity Setpoint Schedule Name

Leave blank to use constant setpoint specified in Humidifier Relative Humidity

Setpoint above.Schedule values must be in percent relative humidity (0 to 100).

Parameters:value (str) – value for IDD Field Humidifier Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of humidifier_relative_humidity_setpoint_schedule_name or None if not set Return type:str

humidifier_type

field Humidifier Type

Default value: None

Parameters:value (str) – value for IDD Field Humidifier Type Raises:ValueError – if value is not a valid value Returns:the value of humidifier_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.

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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_supply_air_flow_rate

field No Load Supply Air Flow Rate

Supply air flow rate when no cooling or heating is needed

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.

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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”

number_of_speeds_for_cooling

field Number of Speeds for Cooling

Used only for Cooling Coil Type = MultiSpeedDX.

Default value: 1

value <= 4

Parameters:value (int) – value for IDD Field Number of Speeds for Cooling Raises:ValueError – if value is not a valid value Returns:the value of number_of_speeds_for_cooling or None if not set Return type:int

number_of_speeds_or_stages_for_heating

field Number of Speeds or Stages for Heating

Used only for Heating Coil Type = MultiSpeedDXHeatPumpAirSource),

MultiStageElectric, or MultiStageGas.

Default value: 1

value <= 4

Parameters:value (int) – value for IDD Field Number of Speeds or Stages for Heating Raises:ValueError – if value is not a valid value Returns:the value of number_of_speeds_or_stages_for_heating or None if not set Return type:int

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 300.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

sizing_option

field Sizing Option

Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident

zone air flow rates.

Default value: NonCoincident

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

supplemental_gas_heating_or_reheat_coil_efficiency

field Supplemental Gas Heating or Reheat Coil Efficiency

Applies only if Supplemental Heating Coil Type is Gas

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Supplemental Gas Heating or Reheat Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_or_reheat_coil_efficiency or None if not set Return type:float

supplemental_gas_heating_or_reheat_coil_parasitic_electric_load

field Supplemental Gas Heating or Reheat Coil Parasitic Electric Load

Applies only if Supplemental Heating Coil Type is Gas

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Supplemental Gas Heating or Reheat Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_or_reheat_coil_parasitic_electric_load or None if not set Return type:float

supplemental_heating_or_reheat_coil_availability_schedule_name

field Supplemental Heating or Reheat Coil Availability Schedule Name

If blank, always on

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

supplemental_heating_or_reheat_coil_capacity

field Supplemental Heating or Reheat Coil Capacity

Units: W

Default value: “autosize”

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

supplemental_heating_or_reheat_coil_maximum_outdoor_drybulb_temperature

field Supplemental Heating or Reheat Coil Maximum Outdoor Dry-Bulb Temperature

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 Supplemental Heating or Reheat Coil Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of supplemental_heating_or_reheat_coil_maximum_outdoor_drybulb_temperature or None if not set Return type:float

supplemental_heating_or_reheat_coil_type

field Supplemental Heating or Reheat Coil Type

Default value: None

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 600.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

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

supply_fan_placement

field Supply Fan Placement

Default value: BlowThrough

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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always available. Also see Supply Fan Operating Mode Schedule Name field.

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

class pyidf.hvac_templates.HvactemplateSystemVav

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:VAV Variable Air Volume (VAV) air loop with optional heating coil and optional preheat.

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_design_setpoint

field Cooling Coil Design Setpoint

Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.

Units: C

Default value: 12.8

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint or None if not set Return type:float

cooling_coil_setpoint_reset_type

field Cooling Coil Setpoint Reset Type

Overrides Cooling Coil Setpoint Schedule Name

None = no reset, control to Cooling Coil Design Setpoint Temperature or Schedule

Warmest = reset as warm as possible yet meet all zone cooling loads at max supply air flow rate

OutdoorAirTemperatureReset = reset based on outdoor air temperature (18.0C at 15.6C ODB,

to the Cooling Design Setpoint at 26.7C)

WarmestTemperatureFirst = reset as warm as possible yet meet all zone cooling loads at

min supply air flow rate

Default value: None

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

cooling_coil_setpoint_schedule_name

field Cooling Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

cooling_coil_type

field Cooling Coil Type

Default value: ChilledWater

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

CoolReheat = cool beyond the dry-bulb setpoint

as required to meet the humidity setpoint.

Default value: None

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

dehumidification_control_zone_name

field Dehumidification Control Zone Name

Zone name where humidistat is located

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

dehumidification_setpoint

field Dehumidification Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_setpoint or None if not set Return type:float

economizer_lockout

field Economizer Lockout

Default value: NoLockout

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

economizer_lower_temperature_limit

field Economizer Lower Temperature Limit

Outdoor temperature below which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_type

field Economizer Type

Default value: NoEconomizer

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

economizer_upper_enthalpy_limit

field Economizer Upper Enthalpy Limit

Outdoor enthalpy above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: J/kg

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

economizer_upper_temperature_limit

field Economizer Upper Temperature Limit

Outdoor temperature above which economizer is disabled and

heat recovery is enabled (if available).

Blank means no limit.

Units: C

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

gas_preheat_coil_efficiency

field Gas Preheat Coil Efficiency

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Preheat Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_efficiency or None if not set Return type:float

gas_preheat_coil_parasitic_electric_load

field Gas Preheat Coil Parasitic Electric Load

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Preheat Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_preheat_coil_parasitic_electric_load or None if not set Return type:float

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_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_setpoint_reset_type

field Heating Coil Setpoint Reset Type

Overrides Heating Coil Setpoint Schedule Name

None = no reset, control to Heating Coil Design Setpoint Temperature or Schedule

OutdoorAirTemperatureReset = reset based on outdoor air temperature

(Heating Design Setpoint at -6.7C ODB to Heating Design Setpoint minus 5.2C at 10C ODB)

min supply air flow rate

Default value: None

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

heating_coil_setpoint_schedule_name

field Heating Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

heating_coil_type

field Heating Coil Type

Default value: None

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

humidifier_availability_schedule_name

field Humidifier Availability Schedule Name

If blank, always available

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

humidifier_control_zone_name

field Humidifier Control Zone Name

Zone name where humidistat is located

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

humidifier_rated_capacity

field Humidifier Rated Capacity

Moisture output rate at full rated power input.

The humidifier does not currently autosize, so the default is very large

to allow for adequate capacity.

Units: m3/s

IP-Units: gal/min

Default value: 1e-06

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

humidifier_rated_electric_power

field Humidifier Rated Electric Power

Electric power input at rated capacity moisture output.

Power consumption is proportional to moisture output with no part-load penalty.

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Humidifier Rated Electric Power Raises:ValueError – if value is not a valid value Returns:the value of humidifier_rated_electric_power or None if not set Return type:float or “Autosize”

humidifier_setpoint

field Humidifier Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidifier Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidifier_setpoint or None if not set Return type:float

humidifier_type

field Humidifier Type

Default value: None

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

latent_heat_recovery_effectiveness

field Latent Heat Recovery Effectiveness

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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”

minimum_outdoor_air_control_type

field Minimum Outdoor Air Control Type

Default value: ProportionalMinimum

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Default value: “autosize”

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

If blank, multiplier is always one

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

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

night_cycle_control

field Night Cycle Control

Default value: StayOff

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

night_cycle_control_zone_name

field Night Cycle Control Zone Name

Applicable only if Night Cycle Control is Cycle On Control Zone.

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

preheat_coil_availability_schedule_name

field Preheat Coil Availability Schedule Name

If blank, always on

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

preheat_coil_design_setpoint

field Preheat Coil Design Setpoint

Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.

Units: C

Default value: 7.2

Parameters:value (float) – value for IDD Field Preheat Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of preheat_coil_design_setpoint or None if not set Return type:float

preheat_coil_setpoint_schedule_name

field Preheat Coil Setpoint Schedule Name

Leave blank if constant setpoint

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

preheat_coil_type

field Preheat Coil Type

Default value: None

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

return_fan

field Return Fan

Specifies if the system has a return fan.

Default value: No

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

return_fan_delta_pressure

field Return Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 500.0

Parameters:value (float) – value for IDD Field Return Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of return_fan_delta_pressure or None if not set Return type:float

return_fan_motor_efficiency

field Return Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_efficiency or None if not set Return type:float

return_fan_motor_in_air_stream_fraction

field Return Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of return_fan_motor_in_air_stream_fraction or None if not set Return type:float

return_fan_partload_power_coefficients

field Return Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Return Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of return_fan_partload_power_coefficients or None if not set Return type:str

return_fan_total_efficiency

field Return Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Return Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of return_fan_total_efficiency or None if not set Return type:float

return_plenum_name

field Return Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

sensible_heat_recovery_effectiveness

field Sensible Heat Recovery Effectiveness

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

sizing_option

field Sizing Option

Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident

zone air flow rates.

Default value: NonCoincident

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_maximum_flow_rate

field Supply Fan Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will not be

multiplied by any sizing factor or by zone multipliers. If using zone multipliers

a value entered here must be large enough to serve the multiplied zones.

Units: m3/s

Default value: “autosize”

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

supply_fan_minimum_flow_rate

field Supply Fan Minimum Flow Rate

This field is only used to set a minimum part load on the VAV fan power curve.

Autosize or zero is recommended.

Units: m3/s

Default value: “autosize”

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

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_partload_power_coefficients

field Supply Fan Part-Load Power Coefficients

This field selects a predefined set of fan power coefficients.

The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2.

The other sets of coefficients are from the EnergyPlus Input

Output Reference, Fan Coefficient Values table.

Default value: InletVaneDampers

Parameters:value (str) – value for IDD Field Supply Fan Part-Load Power Coefficients Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_partload_power_coefficients 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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum serves all zones on this system.

Blank if none.

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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on; VAV System always on. Schedule is used in availability manager

and fan scheduling.

Also see “Night Cycle Control” field.

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

class pyidf.hvac_templates.HvactemplateSystemVrf

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:System:VRF Variable refrigerant flow (VRF) heat pump condensing unit. Serves one or more VRF zone terminal units (HVACTemplate:Zone:VRF).

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

Parameters:value (float) – value for IDD Field Basin Heater Capacity Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_capacity or None if not set Return type:float

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condenser_type

field Condenser Type

Select either an air cooled or evaporatively cooled condenser.

Default value: AirCooled

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

crankcase_heater_power_per_compressor

field Crankcase Heater Power per Compressor

Enter the value of the resistive heater located in the compressor(s). This heater

is used to warm the refrigerant and oil when the compressor is off.

Units: W

Default value: 33.0

Parameters:value (float) – value for IDD Field Crankcase Heater Power per Compressor Raises:ValueError – if value is not a valid value Returns:the value of crankcase_heater_power_per_compressor or None if not set Return type:float

defrost_control

field Defrost Control

Choose a defrost control type. Either use a fixed Timed defrost period or select

OnDemand to defrost only when necessary.

Default value: Timed

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

defrost_strategy

field Defrost Strategy

Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling

to melt frost formation on the condenser coil. The resistive strategy uses a resistive heater

to melt the frost.

Default value: Resistive

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

defrost_time_period_fraction

field Defrost Time Period Fraction

Fraction of time in defrost mode.

Only applicable if timed defrost control is specified.

Units: dimensionless

Default value: 0.058333

Parameters:value (float) – value for IDD Field Defrost Time Period Fraction Raises:ValueError – if value is not a valid value Returns:the value of defrost_time_period_fraction or None if not set Return type:float

equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode

field Equivalent Piping Length used for Piping Correction Factor in Cooling Mode

Enter the equivalent length of the farthest terminal unit from the condenser

Units: m

Default value: 30.0

Parameters:value (float) – value for IDD Field Equivalent Piping Length used for Piping Correction Factor in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode or None if not set Return type:float

equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode

field Equivalent Piping Length used for Piping Correction Factor in Heating Mode

Enter the equivalent length of the farthest terminal unit from the condenser

Units: m

Default value: 30.0

Parameters:value (float) – value for IDD Field Equivalent Piping Length used for Piping Correction Factor in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode or None if not set Return type:float

evaporative_condenser_air_flow_rate

field Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use.

This field is only used when the Condenser Type = EvaporativelyCooled.

Units: m3/s

Default value: “autosize”

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

evaporative_condenser_effectiveness

field Evaporative Condenser Effectiveness

Enter the effectiveness of the evaporatively cooled condenser.

This field is only used when the Condenser Type = EvaporativelyCooled.

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_effectiveness or None if not set Return type:float

evaporative_condenser_pump_rated_power_consumption

field Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump.

This field is only used when the Condenser Type = EvaporativelyCooled.

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

fuel_type

field Fuel Type

Default value: Electricity

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

gross_rated_cooling_cop

field Gross Rated Cooling COP

Enter the coefficient of performance at rated conditions or leave blank to use default.

COP includes compressor and condenser fan electrical energy input

COP does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.3

Parameters:value (float) – value for IDD Field Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_cooling_cop or None if not set Return type:float

gross_rated_heating_capacity

field Gross Rated Heating Capacity

Enter the heating capacity in watts at rated conditions or set to autosize.

Heating capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

gross_rated_heating_cop

field Gross Rated Heating COP

COP includes compressor and condenser fan electrical energy input

COP does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.4

Parameters:value (float) – value for IDD Field Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_heating_cop or None if not set Return type:float

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Enter the total cooling capacity in watts at rated conditions or set to autosize.

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

heat_pump_waste_heat_recovery

field Heat Pump Waste Heat Recovery

This field is reserved for future use. The only valid choice is No.

Default value: No

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

master_thermostat_priority_control_type

field Master Thermostat Priority Control Type

Choose a thermostat control logic scheme. If these control types fail to control zone

temperature within a reasonable limit, consider using multiple VRF systems

Default value: MasterThermostatPriority

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

maximum_outdoor_drybulb_temperature_for_crankcase_heater

field Maximum Outdoor Dry-bulb Temperature for Crankcase Heater

Enter the maximum outdoor temperature above which the crankcase heaters are disabled.

Units: C

Default value: 5.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-bulb Temperature for Defrost Operation

Enter the maximum outdoor temperature above which defrost operation is disabled.

Units: C

Default value: 5.0

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

maximum_outdoor_temperature_in_cooling_mode

field Maximum Outdoor Temperature in Cooling Mode

Enter the maximum outdoor temperature allowed for cooling operation.

Cooling is disabled above this temperature.

Units: C

Default value: 43.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Temperature in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_temperature_in_cooling_mode or None if not set Return type:float

maximum_outdoor_temperature_in_heat_recovery_mode

field Maximum Outdoor Temperature in Heat Recovery Mode

The maximum outdoor temperature above which heat

recovery mode will not operate.

Units: C

Default value: 45.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Temperature in Heat Recovery Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_temperature_in_heat_recovery_mode or None if not set Return type:float

maximum_outdoor_temperature_in_heating_mode

field Maximum Outdoor Temperature in Heating Mode

Enter the maximum outdoor temperature allowed for heating operation.

Units: C

Default value: 16.0

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

minimum_heat_pump_partload_ratio

field Minimum Heat Pump Part-Load Ratio

Enter the minimum heat pump part-load ratio (PLR). When the cooling or heating PLR is

below this value, the heat pump compressor will cycle to meet the cooling or heating

demand.

Units: dimensionless

Default value: 0.15

Parameters:value (float) – value for IDD Field Minimum Heat Pump Part-Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_heat_pump_partload_ratio or None if not set Return type:float

minimum_outdoor_temperature_in_cooling_mode

field Minimum Outdoor Temperature in Cooling Mode

Enter the minimum outdoor temperature allowed for cooling operation.

Cooling is disabled below this temperature.

Units: C

Default value: -6.0

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

minimum_outdoor_temperature_in_heat_recovery_mode

field Minimum Outdoor Temperature in Heat Recovery Mode

The minimum outdoor temperature below which heat

recovery mode will not operate.

Units: C

Default value: -15.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Temperature in Heat Recovery Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_temperature_in_heat_recovery_mode or None if not set Return type:float

minimum_outdoor_temperature_in_heating_mode

field Minimum Outdoor Temperature in Heating Mode

Enter the minimum outdoor temperature allowed for heating operation.

Units: C

Default value: -20.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Temperature in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_temperature_in_heating_mode 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

number_of_compressors

field Number of Compressors

Enter the total number of compressor. This input is used only for crankcase

heater calculations.

Units: dimensionless

Default value: 2

Parameters:value (int) – value for IDD Field Number of Compressors Raises:ValueError – if value is not a valid value Returns:the value of number_of_compressors or None if not set Return type:int

rated_heating_capacity_sizing_ratio

field Rated Heating Capacity Sizing Ratio

If the Gross Rated Heating Capacity is autosized, the heating capacity is sized

to be equal to the cooling capacity multiplied by this sizing ratio. The zone

terminal unit heating coils are also sized using this ratio unless the sizing

ratio input in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object is entered.

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

ratio_of_compressor_size_to_total_compressor_capacity

field Ratio of Compressor Size to Total Compressor Capacity

Enter the ratio of the first stage compressor to total compressor capacity.

All other compressors are assumed to be equally sized. This inputs is used

only for crankcase heater calculations.

Units: W/W

Default value: 0.5

Parameters:value (float) – value for IDD Field Ratio of Compressor Size to Total Compressor Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_compressor_size_to_total_compressor_capacity or None if not set Return type:float

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

Enter the size of the resistive defrost heating element.

Only applicable if resistive defrost strategy is specified

Units: W

IP-Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Resistive Defrost Heater Capacity Raises:ValueError – if value is not a valid value Returns:the value of resistive_defrost_heater_capacity or None if not set Return type:float or “Autosize”

system_availability_schedule_name

field System 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 System Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of system_availability_schedule_name or None if not set Return type:str

thermostat_priority_schedule_name

field Thermostat Priority Schedule Name

this field is required if Master Thermostat Priority Control Type is Scheduled.

Schedule values of 0 denote cooling, 1 for heating, and all other values disable the system.

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

vertical_height_used_for_piping_correction_factor

field Vertical Height used for Piping Correction Factor

Enter the height difference between the highest and lowest terminal unit

Units: m

Default value: 10.0

Parameters:value (float) – value for IDD Field Vertical Height used for Piping Correction Factor Raises:ValueError – if value is not a valid value Returns:the value of vertical_height_used_for_piping_correction_factor or None if not set Return type:float

water_condenser_volume_flow_rate

field Water Condenser Volume Flow Rate

Only used when Condenser Type = WaterCooled.

Units: m3/s

Default value: “autosize”

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

zone_name_for_master_thermostat_location

field Zone Name for Master Thermostat Location

Enter the name of the zone where the master thermostat is located.

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

class pyidf.hvac_templates.HvactemplateThermostat

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Thermostat Zone thermostat control. Referenced schedules must be defined elsewhere in the idf. Thermostat control type is dual setpoint with deadband. It is not necessary to create a thermostat object for every zone, only for each unique set of setpoint schedules. For example, an office building may have two thermostat objects, one for “Office” and one for “Storage”.

constant_cooling_setpoint

field Constant Cooling Setpoint

Ignored if schedule specified above, must enter schedule or constant setpoint

Units: C

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

constant_heating_setpoint

field Constant Heating Setpoint

Ignored if schedule specified above, must enter schedule or constant setpoint

Units: C

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

cooling_setpoint_schedule_name

field Cooling Setpoint Schedule Name

Leave blank if constant setpoint specified below, must enter schedule or constant setpoint

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

heating_setpoint_schedule_name

field Heating Setpoint Schedule Name

Leave blank if constant setpoint specified below, must enter schedule or constant setpoint

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

name

field Name

This name is referenced by HVACTemplate:Zone:* objects

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.hvac_templates.HvactemplateZoneBaseboardHeat

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:BaseboardHeat Zone baseboard heating system.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: HotWater

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

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneConstantVolume

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:ConstantVolume Zone terminal unit, constant volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

reheat_coil_availability_schedule_name

field Reheat Coil Availability Schedule Name

If blank, always on

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

reheat_coil_type

field Reheat Coil Type

Default value: None

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum runs through only this zone.

Blank if none.

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

supply_air_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum runs through only this zone.

Blank if none.

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

template_constant_volume_system_name

field Template Constant Volume System Name

Name of a HVACTemplate:System:ConstantVolume object serving this zone

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneDualDuct

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:DualDuct Zone terminal unit, dual-duct, constant or variable volume.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

cold_supply_plenum_name

field Cold Supply Plenum Name

Plenum zone name. Cold supply plenum that serves only this zone.

Blank if none.

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

design_specification_outdoor_air_object_name_for_control

field Design Specification Outdoor Air Object Name for Control

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based on the current number of occupants in the zone.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

If this field is blank, then the terminal unit will not be controlled for outdoor air flow.

Note that this field is used only for specifying the design outdoor air flow rate used

for control. The field Design Specification Outdoor Air Object Name for Sizing

(see below) is used to specify the design outdoor air flow rate.

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

design_specification_outdoor_air_object_name_for_sizing

field Design Specification Outdoor Air Object Name for Sizing

This field is used only when Outdoor Air Method=DetailedSpecification.

Note that this field is used only for specifying the design outdoor air flow rate used

for sizing. The field Design Specification Outdoor Air Object Name for Control

(see above) is used to actively control the VAV terminal air flow rate.

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

design_specification_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

hot_supply_plenum_name

field Hot Supply Plenum Name

Plenum zone name. Hot supply plenum that serves only this zone.

Blank if none.

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum that serves only this zone.

Blank if none.

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

supply_air_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

template_dual_duct_system_name

field Template Dual Duct System Name

Name of a HVACTemplate:System:DualDuct object serving this zone

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:DualDuct Cooling Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:DualDuct Heating Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_minimum_air_flow_fraction

field Zone Minimum Air Flow Fraction

This field is the Zone Minimum Air Flow Fraction specified as a fraction of the

maximum air flow rate. This field is ignored if the system serving this zone is

constant volume.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Zone Minimum Air Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of zone_minimum_air_flow_fraction or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneFanCoil

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:FanCoil 4 pipe fan coil unit with optional outdoor air.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

capacity_control_method

field Capacity Control Method

If this field is left blank, it will default to CyclingFan if a Dedicated Outdoor Air

System is specified (see above), otherwise it will default to ConstantFanVariableFlow.

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_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_design_setpoint

field Cooling Coil Design Setpoint

Used for sizing when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 14.0

Parameters:value (float) – value for IDD Field Cooling Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_design_setpoint or None if not set Return type:float

cooling_coil_type

field Cooling Coil Type

Default value: ChilledWater

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

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

heating_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_design_setpoint

field Heating Coil Design Setpoint

Used for sizing when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

Parameters:value (float) – value for IDD Field Heating Coil Design Setpoint Raises:ValueError – if value is not a valid value Returns:the value of heating_coil_design_setpoint or None if not set Return type:float

heating_coil_type

field Heating Coil Type

Default value: HotWater

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

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

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

Parameters:value (str) – value for IDD Field Outdoor Air Method Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_method 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

This schedule is ignored if this zone is served by an HVACTemplate dedicated outdoor

air system.

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_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 75.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_motor_in_air_stream_fraction

field Supply Fan Motor in Air Stream Fraction

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor in Air Stream Fraction Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_in_air_stream_fraction or None if not set Return type:float

supply_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Cooling Coil Design Setpoint (above)

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Heating Coil Design Setpoint (above)

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneIdealLoadsAirSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:IdealLoadsAirSystem Zone with ideal air system that meets heating or cooling loads

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

dehumidification_setpoint

field Dehumidification Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Dehumidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_setpoint or None if not set Return type:float

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

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

humidification_setpoint

field Humidification Setpoint

Zone relative humidity setpoint in percent (0 to 100)

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Humidification Setpoint Raises:ValueError – if value is not a valid value Returns:the value of humidification_setpoint or None if not set Return type:float

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

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_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

None means there is no outdoor air and all related fields will be ignored

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: None

Parameters:value (str) – value for IDD Field Outdoor Air Method Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_method 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

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZonePtac

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:PTAC Packaged Terminal Air Conditioner

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_gross_rated_cooling_cop

field Cooling Coil Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cooling_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: SingleSpeedDX

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Supply air flow rate during cooling operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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”

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

gas_heating_coil_efficiency

field Gas Heating Coil Efficiency

Applies only if Heating Coil Type is Gas

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_efficiency or None if not set Return type:float

gas_heating_coil_parasitic_electric_load

field Gas Heating Coil Parasitic Electric Load

Applies only if Heating Coil Type is Gas

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of gas_heating_coil_parasitic_electric_load or None if not set Return type:float

heating_coil_availability_schedule_name

field Heating Coil Availability Schedule Name

If blank, always on

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

heating_coil_capacity

field Heating Coil Capacity

Units: W

Default value: “autosize”

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

heating_coil_type

field Heating Coil Type

Default value: Electric

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Supply air flow rate during heating operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

Supply air flow rate when no cooling or heating is needed

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.

A value entered in this field will not be multiplied by the sizing factor or

by zone multipliers. It is best to autosize or leave blank when using zone multipliers.

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_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 75.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule Name values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

Parameters:value (str) – value for IDD Field Supply Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_operating_mode_schedule_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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 14.0

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZonePthp

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:PTHP Packaged Terminal Heat Pump

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_gross_rated_cop

field Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: SingleSpeedDX

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Supply air flow rate during cooling operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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”

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

heat_pump_defrost_control

field Heat Pump Defrost Control

Default value: Timed

Parameters:value (str) – value for IDD Field Heat Pump Defrost Control Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_control or None if not set Return type:str

heat_pump_defrost_maximum_outdoor_drybulb_temperature

field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature

Units: C

Default value: 5.0

value <= 7.22

Parameters:value (float) – value for IDD Field Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_maximum_outdoor_drybulb_temperature or None if not set Return type:float

heat_pump_defrost_strategy

field Heat Pump Defrost Strategy

Default value: ReverseCycle

Parameters:value (str) – value for IDD Field Heat Pump Defrost Strategy Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_defrost_strategy or None if not set Return type:str

heat_pump_defrost_time_period_fraction

field Heat Pump Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if Timed defrost control is specified

Default value: 0.058333

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

heat_pump_heating_coil_availability_schedule_name

field Heat Pump Heating Coil Availability Schedule Name

If blank, always on

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

heat_pump_heating_coil_gross_rated_capacity

field Heat Pump Heating Coil Gross Rated Capacity

Capacity excluding supply air fan heat

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Heat Pump Heating Coil Gross Rated Capacity Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_capacity or None if not set Return type:float or “Autosize”

heat_pump_heating_coil_gross_rated_cop

field Heat Pump Heating Coil Gross Rated COP

Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan,

Does not include supply air fan heat or supply air fan electrical energy

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W/W

Default value: 2.75

Parameters:value (float) – value for IDD Field Heat Pump Heating Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_cop or None if not set Return type:float

heat_pump_heating_coil_type

field Heat Pump Heating Coil Type

Default value: SingleSpeedDXHeatPump

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

heat_pump_heating_minimum_outdoor_drybulb_temperature

field Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature

Units: C

Default value: -8.0

value >= -20.0

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

heating_supply_air_flow_rate

field Heating Supply Air Flow Rate

Supply air flow rate during heating operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

Supply air flow rate when no cooling or heating is needed

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.

A value entered in this field will not be multiplied by the sizing factor or

by zone multipliers. It is best to autosize or leave blank when using zone multipliers.

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_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

supplemental_gas_heating_coil_efficiency

field Supplemental Gas Heating Coil Efficiency

Applies only if Supplemental Heating Coil Type is Gas

Default value: 0.8

value <= 1.0

Parameters:value (float) – value for IDD Field Supplemental Gas Heating Coil Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_coil_efficiency or None if not set Return type:float

supplemental_gas_heating_coil_parasitic_electric_load

field Supplemental Gas Heating Coil Parasitic Electric Load

Applies only if Supplemental Heating Coil Type is Gas

Units: W

IP-Units: W

Parameters:value (float) – value for IDD Field Supplemental Gas Heating Coil Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of supplemental_gas_heating_coil_parasitic_electric_load or None if not set Return type:float

supplemental_heating_coil_availability_schedule_name

field Supplemental Heating Coil Availability Schedule Name

If blank, always on

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

supplemental_heating_coil_capacity

field Supplemental Heating Coil Capacity

Units: W

Default value: “autosize”

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

supplemental_heating_coil_maximum_outdoor_drybulb_temperature

field Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature

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 Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of supplemental_heating_coil_maximum_outdoor_drybulb_temperature or None if not set Return type:float

supplemental_heating_coil_type

field Supplemental Heating Coil Type

Default value: Electric

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 75.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

Parameters:value (str) – value for IDD Field Supply Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_operating_mode_schedule_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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 14.0

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneUnitary

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:Unitary Zone terminal unit, constant volume, no controls.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum runs through only this zone.

Blank if none.

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

supply_air_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum runs through only this zone.

Blank if none.

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

template_unitary_system_name

field Template Unitary System Name

Enter the name of an HVACTemplate:System:Unitary, HVACTemplate:System:UnitaryHeatPump:AirTtoAir,

or HVACTemplate:System:UnitarySystem object serving this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:Unitary or HVACTemplate:System:UnitaryHeatPump:AirToAir

Cooling Design Supply Air Temperature

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:Unitary or HVACTemplate:System:UnitaryHeatPump:AirToAir

Heating Design Supply Air Temperature

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneVav

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:VAV Zone terminal unit, variable volume, reheat optional. For heating, this unit activates reheat coil first, then increases airflow (if reverse action specified).

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

constant_minimum_air_flow_fraction

field Constant Minimum Air Flow Fraction

This field is used if the field Zone Minimum Air Flow Input Method is Constant

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional. If a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the following field are entered, the larger result is used.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Constant Minimum Air Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of constant_minimum_air_flow_fraction or None if not set Return type:float

damper_heating_action

field Damper Heating Action

Default value: Reverse

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

design_specification_outdoor_air_object_name_for_control

field Design Specification Outdoor Air Object Name for Control

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based on the current number of occupants in the zone.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

If this field is blank, then the terminal unit will not be controlled for outdoor air flow.

Note that this field is used only for specifying the design outdoor air flow rate used

for control. The field Design Specification Outdoor Air Object Name for Sizing

(see below) is used to specify the design outdoor air flow rate.

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

design_specification_outdoor_air_object_name_for_sizing

field Design Specification Outdoor Air Object Name for Sizing

This field is used only when Outdoor Air Method=DetailedSpecification.

Note that this field is used only for specifying the design outdoor air flow rate used

for sizing. The field Design Specification Outdoor Air Object Name for Control

(see above) is used to actively control the VAV terminal air flow rate.

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

design_specification_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

fixed_minimum_air_flow_rate

field Fixed Minimum Air Flow Rate

This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate.

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional. If a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the previous field are entered, the larger result is used.

Units: m3/s

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

maximum_flow_fraction_during_reheat

field Maximum Flow Fraction During Reheat

Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse

When autocalculating, the maximum flow fraction is set to the ratio of

0.002032 m3/s-m2 (0.4 cfm/sqft) multiplied by the zone floor area and the

Maximum Air Flow Rate.

This optional field limits the maximum flow allowed in reheat mode.

If this field and the previous field are left blank, the maximum flow will not be limited.

At no time will the maximum flow rate calculated here exceed the value of

Maximum Air Flow Rate.

Parameters:value (float or “Autocalculate”) – value for IDD Field Maximum Flow Fraction During Reheat Raises:ValueError – if value is not a valid value Returns:the value of maximum_flow_fraction_during_reheat or None if not set Return type:float or “Autocalculate”

maximum_flow_per_zone_floor_area_during_reheat

field Maximum Flow per Zone Floor Area During Reheat

Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse

When autocalculating, the maximum flow per zone is set to 0.002032 m3/s-m2 (0.4 cfm/sqft)

This optional field limits the maximum flow allowed in reheat mode.

If this field and the following field are left blank, the maximum flow will not be limited.

At no time will the maximum flow rate calculated here exceed the value of

Maximum Air Flow Rate.

Units: m3/s-m2

Parameters:value (float or “Autocalculate”) – value for IDD Field Maximum Flow per Zone Floor Area During Reheat Raises:ValueError – if value is not a valid value Returns:the value of maximum_flow_per_zone_floor_area_during_reheat or None if not set Return type:float or “Autocalculate”

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

minimum_air_flow_fraction_schedule_name

field Minimum Air Flow Fraction Schedule Name

This field is used if the field Zone Minimum Air Flow Input Method is Scheduled

Schedule values are fractions, 0.0 to 1.0.

If the field Constant Minimum Air Flow Fraction is blank, then the average of the

minimum and maximum schedule values is used for sizing normal-action reheat coils.

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

reheat_coil_availability_schedule_name

field Reheat Coil Availability Schedule Name

If blank, always on

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

reheat_coil_type

field Reheat Coil Type

Default value: None

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum runs through only this zone.

Blank if none.

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

supply_air_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum runs through only this zone.

Blank if none.

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

template_vav_system_name

field Template VAV System Name

Name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV

object serving this zone

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_minimum_air_flow_input_method

field Zone Minimum Air Flow Input Method

Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate)

FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate)

Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow

Default value: Constant

Parameters:value (str) – value for IDD Field Zone Minimum Air Flow Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_minimum_air_flow_input_method or None if not set Return type:str

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneVavFanPowered

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:VAV:FanPowered Zone terminal unit, fan powered variable volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

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

fan_delta_pressure

field Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 1000.0

Parameters:value (float) – value for IDD Field Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of fan_delta_pressure or None if not set Return type:float

fan_motor_efficiency

field Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of fan_motor_efficiency or None if not set Return type:float

fan_total_efficiency

field Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of fan_total_efficiency or None if not set Return type:float

flow_type

field Flow Type

Default value: Parallel

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

parallel_fan_on_flow_fraction

field Parallel Fan On Flow Fraction

The fraction of the primary air flow at which fan turns on

Applicable only to Parallel Flow Type

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Parallel Fan On Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of parallel_fan_on_flow_fraction or None if not set Return type:float or “Autosize”

primary_supply_air_maximum_flow_rate

field Primary Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

primary_supply_air_minimum_flow_fraction

field Primary Supply Air Minimum Flow Fraction

Default value: “autosize”

value <= 1.0

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

reheat_coil_availability_schedule_name

field Reheat Coil Availability Schedule Name

If blank, always on

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

reheat_coil_type

field Reheat Coil Type

Default value: Electric

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum runs through only this zone.

Blank if none.

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

secondary_supply_air_maximum_flow_rate

field Secondary Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum runs through only this zone.

Blank if none.

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

template_vav_system_name

field Template VAV System Name

Enter the name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV

object serving this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone Name must match a building zone name

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

zone_piu_fan_schedule_name

field Zone PIU Fan Schedule Name

This is the operating schedule for the zone PIU fan.

For a parallel PIU, the fan operates only when the primary air flow is below the

Parallel Fan On Flow Fraction and the Zone PIU Fan Schedule is on, or it is

activated by an availability manager.

For a series PIU, the zone fan operates whenever the Zone PIU Fan Schedule is on, or it

is activated by an availability manager.

If this field is left blank, the System Availability Schedule for the

HVACTemplate:System serving this zone will be used.

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

class pyidf.hvac_templates.HvactemplateZoneVavHeatAndCool

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:VAV:HeatAndCool VAV system with VAV for both heating and cooling and optional reheat coil. For heating, this unit increases airflow first, then activates reheat coil.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

constant_minimum_air_flow_fraction

field Constant Minimum Air Flow Fraction

This field is used if the field Zone Minimum Air Flow Input Method is Constant

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional. If a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the following field are entered, the larger result is used.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Constant Minimum Air Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of constant_minimum_air_flow_fraction or None if not set Return type:float

design_specification_outdoor_air_object_name_for_sizing

field Design Specification Outdoor Air Object Name for Sizing

This field is used only when Outdoor Air Method=DetailedSpecification.

Note that this field is used only for specifying the design outdoor air flow rate used

for sizing. The field Design Specification Outdoor Air Object Name for Control

(see above) is used to actively control the VAV terminal air flow rate.

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

design_specification_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

reheat_coil_availability_schedule_name

field Reheat Coil Availability Schedule Name

If blank, always on

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

reheat_coil_type

field Reheat Coil Type

Default value: None

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

return_plenum_name

field Return Plenum Name

Plenum zone name. Return plenum runs through only this zone.

Blank if none.

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

supply_air_maximum_flow_rate

field Supply Air Maximum Flow Rate

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

supply_plenum_name

field Supply Plenum Name

Plenum zone name. Supply plenum runs through only this zone.

Blank if none.

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

template_vav_system_name

field Template VAV System Name

Name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV

object serving this zone

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 12.8

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint

Default value: SystemSupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Heating Coil Design Setpoint

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

class pyidf.hvac_templates.HvactemplateZoneVrf

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:VRF Zone terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air or water-to-air heat pump). The VRF terminal units are served by an HVACTemplate:System:VRF system.

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

cooling_coil_availability_schedule_name

field Cooling Coil Availability Schedule Name

If blank, always on

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

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: VariableRefrigerantFlowDX

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

cooling_outdoor_air_flow_rate

field Cooling Outdoor Air Flow Rate

If this field is set to autosize it will be sized based on the outdoor air inputs below,

unless a dedicated outdoor air system is specified for this zone and then it will be

set to zero.

Units: m3/s

Default value: “autosize”

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

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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”

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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

heat_pump_heating_coil_availability_schedule_name

field Heat Pump Heating Coil Availability Schedule Name

If blank, always on

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

heat_pump_heating_coil_gross_rated_capacity

field Heat Pump Heating Coil Gross Rated Capacity

Capacity excluding supply air fan heat

Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Heat Pump Heating Coil Gross Rated Capacity Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_capacity or None if not set Return type:float or “Autosize”

heat_pump_heating_coil_type

field Heat Pump Heating Coil Type

Default value: VariableRefrigerantFlowDX

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

heating_outdoor_air_flow_rate

field Heating Outdoor Air Flow Rate

If this field is set to autosize it will be sized based on the outdoor air inputs below,

unless a dedicated outdoor air system is specified for this zone and then it will be

set to zero.

Units: m3/s

Default value: “autosize”

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

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

This flow rate is used when the terminal is not cooling and the previous mode was cooling.

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

This flow rate is used when the terminal is not heating and the previous mode was heating.

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

If this field is set to autosize it will be sized based on the outdoor air inputs below,

unless a dedicated outdoor air system is specified for this zone and then it will be

set to zero.

Units: m3/s

Default value: “autosize”

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”

outdoor_air_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

rated_total_heating_capacity_sizing_ratio

field Rated Total 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 HVACTemplate:System:VRF object.

Units: W/W

Default value: 1.0

value >= 1.0

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

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 75.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

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

supply_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

template_vrf_system_name

field Template VRF System Name

Name of a HVACTemplate:System:VRF object serving this zone

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 14.0

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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

zone_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.hvac_templates.HvactemplateZoneWaterToAirHeatPump

Bases: pyidf.helper.DataObject

Corresponds to IDD object HVACTemplate:Zone:WaterToAirHeatPump Water to Air Heat Pump to be used with HVACTemplate:Plant:MixedWaterLoop

baseboard_heating_availability_schedule_name

field Baseboard Heating Availability Schedule Name

If blank, always on

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

baseboard_heating_capacity

field Baseboard Heating Capacity

Units: W

Default value: “autosize”

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

baseboard_heating_type

field Baseboard Heating Type

Default value: None

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

cooling_coil_gross_rated_cop

field Cooling Coil Gross Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.5

Parameters:value (float) – value for IDD Field Cooling Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_cop or None if not set Return type:float

cooling_coil_gross_rated_sensible_heat_ratio

field Cooling Coil Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include effect of supply fan heat

Default value: “autosize”

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Coil Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_coil_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

cooling_coil_gross_rated_total_capacity

field Cooling Coil Gross Rated Total Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Default value: “autosize”

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

cooling_coil_type

field Cooling Coil Type

Default value: Coil:Cooling:WaterToAirHeatPump:EquationFit

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

cooling_supply_air_flow_rate

field Cooling Supply Air Flow Rate

Supply air flow rate during cooling operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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”

dedicated_outdoor_air_system_name

field Dedicated Outdoor Air System Name

Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this

zone is served by a separate dedicated outdoor air system (DOAS).

Leave field blank if no DOAS serves this zone.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

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_zone_air_distribution_object_name

field Design Specification Zone Air Distribution Object Name

This field is used only when Outdoor Air Method=DetailedSpecification.

Parameters:value (str) – value for IDD Field Design Specification Zone Air Distribution Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_zone_air_distribution_object_name 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_heating_coil_gross_rated_capacity

field Heat Pump Heating Coil Gross Rated Capacity

Capacity excluding supply air fan heat

Units: W

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Heat Pump Heating Coil Gross Rated Capacity Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_capacity or None if not set Return type:float or “Autosize”

heat_pump_heating_coil_gross_rated_cop

field Heat Pump Heating Coil Gross Rated COP

Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electric power input

Units: W/W

Default value: 4.2

Parameters:value (float) – value for IDD Field Heat Pump Heating Coil Gross Rated COP Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_heating_coil_gross_rated_cop or None if not set Return type:float

heat_pump_heating_coil_type

field Heat Pump Heating Coil Type

Default value: Coil:Heating:WaterToAirHeatPump:EquationFit

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

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_supply_air_flow_rate

field Heating Supply Air Flow Rate

Supply air flow rate during heating operation

This field may be set to “autosize”. If a value is entered, it will be

multiplied by the Supply Air Sizing Factor and by zone multipliers.

Units: m3/s

Default value: “autosize”

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

no_load_supply_air_flow_rate

field No Load Supply Air Flow Rate

Supply air flow rate when no cooling or heating is needed

Only used when heat pump fan operating mode is continuous. This air flow rate

is used when no heating or cooling is required.

If this field is left blank or zero, the supply air flow rate from the previous on cycle

(either cooling or heating) is used.

A value entered in this field will not be multiplied by the sizing factor or

by zone multipliers. It is best to autosize or leave blank when using zone multipliers.

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_flow_rate_per_person

field Outdoor Air Flow Rate per Person

Default 0.00944 is 20 cfm per person

This input is used if the field Outdoor Air Method is

Flow/Person, Sum, or Maximum

Units: m3/s

Default value: 0.00944

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

outdoor_air_flow_rate_per_zone

field Outdoor Air Flow Rate per Zone

This input is used if the field Outdoor Air Method is

Flow/Zone, Sum, or Maximum

Units: m3/s

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

outdoor_air_flow_rate_per_zone_floor_area

field Outdoor Air Flow Rate per Zone Floor Area

This input is used if the field Outdoor Air Method is

Flow/Area, Sum, or Maximum

Units: m3/s-m2

Parameters:value (float) – value for IDD Field Outdoor Air Flow Rate per Zone Floor Area Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_flow_rate_per_zone_floor_area or None if not set Return type:float

outdoor_air_method

field Outdoor Air Method

Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three

fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area,

and Outdoor Air Flow Rate per Zone.

DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead

references design specification objects named in the fields

Design Specification Outdoor Air Object Name and Design Specification Zone Air

Distribution Object Name.

Default value: Flow/Person

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

supplemental_heating_coil_availability_schedule_name

field Supplemental Heating Coil Availability Schedule Name

If blank, always on

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

supplemental_heating_coil_capacity

field Supplemental Heating Coil Capacity

Units: W

Default value: “autosize”

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

supplemental_heating_coil_type

field Supplemental Heating Coil Type

Default value: Electric

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

supply_fan_delta_pressure

field Supply Fan Delta Pressure

Units: Pa

IP-Units: inH2O

Default value: 75.0

Parameters:value (float) – value for IDD Field Supply Fan Delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_delta_pressure or None if not set Return type:float

supply_fan_motor_efficiency

field Supply Fan Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_motor_efficiency or None if not set Return type:float

supply_fan_operating_mode_schedule_name

field Supply Fan Operating Mode Schedule Name

Refers to a schedule to specify unitary supply fan operating mode.

Schedule values of 0 indicate cycling fan (auto)

Schedule values of 1 indicate continuous fan (on)

If this field is left blank, a schedule of always zero (cycling fan) will be used.

Parameters:value (str) – value for IDD Field Supply Fan Operating Mode Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_operating_mode_schedule_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_fan_total_efficiency

field Supply Fan Total Efficiency

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Supply Fan Total Efficiency Raises:ValueError – if value is not a valid value Returns:the value of supply_fan_total_efficiency or None if not set Return type:float

system_availability_schedule_name

field System Availability Schedule Name

If blank, always on

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

template_thermostat_name

field Template Thermostat Name

Enter the name of a HVACTemplate:Thermostat object.

If blank, then it is assumed that standard thermostat objects

have been defined for this zone.

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

zone_cooling_design_supply_air_temperature

field Zone Cooling Design Supply Air Temperature

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 14.0

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

zone_cooling_design_supply_air_temperature_difference

field Zone Cooling Design Supply Air Temperature Difference

Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be subtracted from the zone temperature

at peak load to calculate the Zone Cooling Design Supply Air Temperature.

Units: deltaC

Default value: 11.11

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

zone_cooling_design_supply_air_temperature_input_method

field Zone Cooling Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature

TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Cooling Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_design_supply_air_temperature_input_method or None if not set Return type:str

zone_cooling_sizing_factor

field Zone Cooling Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Cooling Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_cooling_sizing_factor or None if not set Return type:float

zone_heating_design_supply_air_temperature

field Zone Heating Design Supply Air Temperature

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = SupplyAirTemperature

Units: C

Default value: 50.0

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

zone_heating_design_supply_air_temperature_difference

field Zone Heating Design Supply Air Temperature Difference

Zone Heating Design Supply Air Temperature is only used when Zone Heating Design

Supply Air Temperature Input Method = TemperatureDifference

The absolute value of this field will be added to the zone temperature

at peak load to calculate the Zone Heating Design Supply Air Temperature.

Units: deltaC

Default value: 30.0

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

zone_heating_design_supply_air_temperature_input_method

field Zone Heating Design Supply Air Temperature Input Method

SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature

TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference

Default value: SupplyAirTemperature

Parameters:value (str) – value for IDD Field Zone Heating Design Supply Air Temperature Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_design_supply_air_temperature_input_method or None if not set Return type:str

zone_heating_sizing_factor

field Zone Heating Sizing Factor

If blank, value from Sizing:Parameters will be used.

Parameters:value (float) – value for IDD Field Zone Heating Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of zone_heating_sizing_factor or None if not set Return type:float

zone_name

field Zone Name

Zone name must match a building zone name

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