pyidf.plant_heating_and_cooling_equipment module

Data objects in group “Plant Heating and Cooling Equipment”

class pyidf.plant_heating_and_cooling_equipment.BoilerHotWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Boiler:HotWater This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Boiler performance curves are generated by fitting catalog data to polynomial equations. A constant efficiency boiler may be modeled by leaving the normalized boiler efficiency curve name input blank.

boiler_flow_mode

field Boiler Flow Mode

Select operating mode for fluid flow through the boiler. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by boiler to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by boiler to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

boiler_water_inlet_node_name

field Boiler Water Inlet Node Name

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

boiler_water_outlet_node_name

field Boiler Water Outlet Node Name

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

design_water_flow_rate

field Design Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_water_outlet_temperature

field Design Water Outlet Temperature

Units: C

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

efficiency_curve_temperature_evaluation_variable

field Efficiency Curve Temperature Evaluation Variable

Parameters:value (str) – value for IDD Field Efficiency Curve Temperature Evaluation Variable Raises:ValueError – if value is not a valid value Returns:the value of efficiency_curve_temperature_evaluation_variable or None if not set Return type:str

fuel_type

field Fuel Type

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

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_thermal_efficiency

field Nominal Thermal Efficiency

Based on the higher heating value of fuel.

value <= 1.0

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

normalized_boiler_efficiency_curve_name

field Normalized Boiler Efficiency Curve Name

Linear, Quadratic and Cubic efficiency curves are solely a function of PLR.

All other efficiency curve types are a function of PLR and boiler water temperature.

Linear = C1 + C2*PLR

Quadratic = C1 + C2*PLR + C3*PLR^2

Cubic = C1 + C2*PLR + C3*PLR^2 + C4*PLR^3

Biquadratic = C1 + C2*PLR + C3*PLR^2 + C4*T + C5*T^2 + C6*PLR*T

QuadraticLinear = C1 + C2*PLR + C3*PLR^2 + (C4 + C5*PLR + C6*PLR^2)*T

BiCubic = C1+C2*PLR+C3*PLR^2+C4*T+C5*T^2+C6*PLR*T+C7*PLR^3+C8*T^3+C9*PLR^2*T+C10*PLR*T^2

TriQuadratic curves are not allowed.

PLR = part-load ratio

T = boiler water temperature (either entering or leaving).

Parameters:value (str) – value for IDD Field Normalized Boiler Efficiency Curve Name Raises:ValueError – if value is not a valid value Returns:the value of normalized_boiler_efficiency_curve_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

parasitic_electric_load

field Parasitic Electric Load

Units: W

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

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

water_outlet_upper_temperature_limit

field Water Outlet Upper Temperature Limit

Units: C

Default value: 99.9

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.plant_heating_and_cooling_equipment.BoilerSteam

Bases: pyidf.helper.DataObject

Corresponds to IDD object Boiler:Steam This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Boiler performance curves are generated by fitting catalog data to third order polynomial equations. A constant efficiency boiler is modeled by setting the fuel use coefficients as follows: N9=1, N10=0, N11=0

coefficient_1_of_fuel_use_function_of_part_load_ratio_curve

field Coefficient 1 of Fuel Use Function of Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Fuel Use Function of Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_fuel_use_function_of_part_load_ratio_curve or None if not set Return type:float

coefficient_2_of_fuel_use_function_of_part_load_ratio_curve

field Coefficient 2 of Fuel Use Function of Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Fuel Use Function of Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_fuel_use_function_of_part_load_ratio_curve or None if not set Return type:float

coefficient_3_of_fuel_use_function_of_part_load_ratio_curve

field Coefficient 3 of Fuel Use Function of Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Fuel Use Function of Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_fuel_use_function_of_part_load_ratio_curve or None if not set Return type:float

design_outlet_steam_temperature

field Design Outlet Steam Temperature

Units: C

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

fuel_type

field Fuel Type

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_operating_pressure

field Maximum Operating Pressure

Units: Kpa

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

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

optimum_part_load_ratio

field Optimum Part Load Ratio

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

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

steam_outlet_node_name

field Steam Outlet Node Name

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

theoretical_efficiency

field Theoretical Efficiency

value <= 1.0

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

water_inlet_node_name

field Water Inlet Node Name

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

class pyidf.plant_heating_and_cooling_equipment.CentralHeatPumpSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object CentralHeatPumpSystem This chiller bank can contain multiple chiller heaters and heat pump performance objects. Its function is to encapsulate the extra controls needed to turn individual modules on/off and whether they are to operate in cooling-only, heating-only or simultaneous cooling/heating mode and whether to connect the source water to the evaporator or condenser side.

ancillary_operation_schedule_name

field Ancillary Operation Schedule Name

This value from this schedule is multiplied times the Ancillary Power

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

ancillary_power

field Ancillary Power

Power as demanded from any auxiliary controls

Units: W

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

chiller_heater_models_performance_component_name_5

field Chiller Heater Models Performance Component Name 5

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

chiller_heater_module_control_schedule_name_11

field Chiller Heater Module Control Schedule Name 11

Parameters:value (str) – value for IDD Field Chiller Heater Module Control Schedule Name 11 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_module_control_schedule_name_11 or None if not set Return type:str

chiller_heater_modules_control_control_schedule_name_18

field Chiller Heater Modules Control Control Schedule Name 18

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Control Schedule Name 18 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_control_schedule_name_18 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_1

field Chiller Heater Modules Control Schedule Name 1

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 1 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_1 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_10

field Chiller Heater Modules Control Schedule Name 10

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 10 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_10 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_12

field Chiller Heater Modules Control Schedule Name 12

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 12 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_12 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_13

field Chiller Heater Modules Control Schedule Name 13

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 13 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_13 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_14

field Chiller Heater Modules Control Schedule Name 14

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 14 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_14 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_15

field Chiller Heater Modules Control Schedule Name 15

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 15 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_15 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_16

field Chiller Heater Modules Control Schedule Name 16

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 16 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_16 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_17

field Chiller Heater Modules Control Schedule Name 17

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 17 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_17 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_19

field Chiller Heater Modules Control Schedule Name 19

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 19 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_19 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_2

field Chiller Heater Modules Control Schedule Name 2

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 2 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_2 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_20

field Chiller Heater Modules Control Schedule Name 20

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 20 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_20 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_3

field Chiller Heater Modules Control Schedule Name 3

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 3 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_3 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_4

field Chiller Heater Modules Control Schedule Name 4

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 4 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_4 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_5

field Chiller Heater Modules Control Schedule Name 5

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 5 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_5 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_6

field Chiller Heater Modules Control Schedule Name 6

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 6 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_6 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_7

field Chiller Heater Modules Control Schedule Name 7

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 7 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_7 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_8

field Chiller Heater Modules Control Schedule Name 8

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 8 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_8 or None if not set Return type:str

chiller_heater_modules_control_schedule_name_9

field Chiller Heater Modules Control Schedule Name 9

Parameters:value (str) – value for IDD Field Chiller Heater Modules Control Schedule Name 9 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_control_schedule_name_9 or None if not set Return type:str

chiller_heater_modules_performance_component_name_1

field Chiller Heater Modules Performance Component Name 1

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

chiller_heater_modules_performance_component_name_10

field Chiller Heater Modules Performance Component Name 10

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 10 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_10 or None if not set Return type:str

chiller_heater_modules_performance_component_name_11

field Chiller Heater Modules Performance Component Name 11

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 11 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_11 or None if not set Return type:str

chiller_heater_modules_performance_component_name_12

field Chiller Heater Modules Performance Component Name 12

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 12 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_12 or None if not set Return type:str

chiller_heater_modules_performance_component_name_13

field Chiller Heater Modules Performance Component Name 13

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 13 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_13 or None if not set Return type:str

chiller_heater_modules_performance_component_name_14

field Chiller Heater Modules Performance Component Name 14

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 14 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_14 or None if not set Return type:str

chiller_heater_modules_performance_component_name_15

field Chiller Heater Modules Performance Component Name 15

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 15 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_15 or None if not set Return type:str

chiller_heater_modules_performance_component_name_16

field Chiller Heater Modules Performance Component Name 16

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 16 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_16 or None if not set Return type:str

chiller_heater_modules_performance_component_name_17

field Chiller Heater Modules Performance Component Name 17

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 17 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_17 or None if not set Return type:str

chiller_heater_modules_performance_component_name_18

field Chiller Heater Modules Performance Component Name 18

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 18 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_18 or None if not set Return type:str

chiller_heater_modules_performance_component_name_19

field Chiller Heater Modules Performance Component Name 19

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 19 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_19 or None if not set Return type:str

chiller_heater_modules_performance_component_name_2

field Chiller Heater Modules Performance Component Name 2

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

chiller_heater_modules_performance_component_name_20

field Chiller Heater Modules Performance Component Name 20

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 20 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_20 or None if not set Return type:str

chiller_heater_modules_performance_component_name_4

field Chiller Heater Modules Performance Component Name 4

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

chiller_heater_modules_performance_component_name_6

field Chiller Heater Modules Performance Component Name 6

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

chiller_heater_modules_performance_component_name_7

field Chiller Heater Modules Performance Component Name 7

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

chiller_heater_modules_performance_component_name_8

field Chiller Heater Modules Performance Component Name 8

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

chiller_heater_modules_performance_component_name_9

field Chiller Heater Modules Performance Component Name 9

Parameters:value (str) – value for IDD Field Chiller Heater Modules Performance Component Name 9 Raises:ValueError – if value is not a valid value Returns:the value of chiller_heater_modules_performance_component_name_9 or None if not set Return type:str

chiller_heater_modules_performance_component_object_type_1

field Chiller Heater Modules Performance Component Object Type 1

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

chiller_heater_modules_performance_component_object_type_10

field Chiller Heater Modules Performance Component Object Type 10

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

chiller_heater_modules_performance_component_object_type_11

field Chiller Heater Modules Performance Component Object Type 11

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

chiller_heater_modules_performance_component_object_type_12

field Chiller Heater Modules Performance Component Object Type 12

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

chiller_heater_modules_performance_component_object_type_13

field Chiller Heater Modules Performance Component Object Type 13

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

chiller_heater_modules_performance_component_object_type_14

field Chiller Heater Modules Performance Component Object Type 14

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

chiller_heater_modules_performance_component_object_type_15

field Chiller Heater Modules Performance Component Object Type 15

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

chiller_heater_modules_performance_component_object_type_16

field Chiller Heater Modules Performance Component Object Type 16

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

chiller_heater_modules_performance_component_object_type_17

field Chiller Heater Modules Performance Component Object Type 17

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

chiller_heater_modules_performance_component_object_type_18

field Chiller Heater Modules Performance Component Object Type 18

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

chiller_heater_modules_performance_component_object_type_19

field Chiller Heater Modules Performance Component Object Type 19

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

chiller_heater_modules_performance_component_object_type_2

field Chiller Heater Modules Performance Component Object Type 2

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

chiller_heater_modules_performance_component_object_type_20

field Chiller Heater Modules Performance Component Object Type 20

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

chiller_heater_modules_performance_component_object_type_4

field Chiller Heater Modules Performance Component Object Type 4

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

chiller_heater_modules_performance_component_object_type_5

field Chiller Heater Modules Performance Component Object Type 5

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

chiller_heater_modules_performance_component_object_type_6

field Chiller Heater Modules Performance Component Object Type 6

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

chiller_heater_modules_performance_component_object_type_7

field Chiller Heater Modules Performance Component Object Type 7

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

chiller_heater_modules_performance_component_object_type_8

field Chiller Heater Modules Performance Component Object Type 8

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

chiller_heater_modules_performance_component_object_type_9

field Chiller Heater Modules Performance Component Object Type 9

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

chiller_heater_performance_component_name_3

field Chiller Heater Performance Component Name 3

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

chiller_heater_performance_component_object_type_3

field Chiller Heater Performance Component Object Type 3

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

control_method

field Control Method

Default value: SmartMixing

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

cooling_loop_inlet_node_name

field Cooling Loop Inlet Node Name

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

cooling_loop_outlet_node_name

field Cooling Loop Outlet Node Name

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

heating_loop_inlet_node_name

field Heating Loop Inlet Node Name

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

heating_loop_outlet_node_name

field Heating Loop Outlet Node Name

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

name

field Name

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

number_of_chiller_heater_modules_1

field Number of Chiller Heater Modules 1

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 1 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_1 or None if not set Return type:int

number_of_chiller_heater_modules_10

field Number of Chiller Heater Modules 10

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 10 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_10 or None if not set Return type:int

number_of_chiller_heater_modules_11

field Number of Chiller Heater Modules 11

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 11 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_11 or None if not set Return type:int

number_of_chiller_heater_modules_12

field Number of Chiller Heater Modules 12

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 12 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_12 or None if not set Return type:int

number_of_chiller_heater_modules_13

field Number of Chiller Heater Modules 13

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 13 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_13 or None if not set Return type:int

number_of_chiller_heater_modules_14

field Number of Chiller Heater Modules 14

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 14 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_14 or None if not set Return type:int

number_of_chiller_heater_modules_15

field Number of Chiller Heater Modules 15

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 15 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_15 or None if not set Return type:int

number_of_chiller_heater_modules_16

field Number of Chiller Heater Modules 16

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 16 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_16 or None if not set Return type:int

number_of_chiller_heater_modules_17

field Number of Chiller Heater Modules 17

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 17 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_17 or None if not set Return type:int

number_of_chiller_heater_modules_18

field Number of Chiller Heater Modules 18

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 18 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_18 or None if not set Return type:int

number_of_chiller_heater_modules_19

field Number of Chiller Heater Modules 19

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 19 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_19 or None if not set Return type:int

number_of_chiller_heater_modules_2

field Number of Chiller Heater Modules 2

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 2 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_2 or None if not set Return type:int

number_of_chiller_heater_modules_20

field Number of Chiller Heater Modules 20

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 20 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_20 or None if not set Return type:int

number_of_chiller_heater_modules_3

field Number of Chiller Heater Modules 3

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 3 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_3 or None if not set Return type:int

number_of_chiller_heater_modules_4

field Number of Chiller Heater Modules 4

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 4 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_4 or None if not set Return type:int

number_of_chiller_heater_modules_5

field Number of Chiller Heater Modules 5

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 5 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_5 or None if not set Return type:int

number_of_chiller_heater_modules_6

field Number of Chiller Heater Modules 6

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 6 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_6 or None if not set Return type:int

number_of_chiller_heater_modules_7

field Number of Chiller Heater Modules 7

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 7 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_7 or None if not set Return type:int

number_of_chiller_heater_modules_8

field Number of Chiller Heater Modules 8

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 8 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_8 or None if not set Return type:int

number_of_chiller_heater_modules_9

field Number of Chiller Heater Modules 9

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Chiller Heater Modules 9 Raises:ValueError – if value is not a valid value Returns:the value of number_of_chiller_heater_modules_9 or None if not set Return type:int

source_loop_inlet_node_name

field Source Loop Inlet Node Name

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

source_loop_outlet_node_name

field Source Loop Outlet Node Name

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

class pyidf.plant_heating_and_cooling_equipment.ChillerAbsorption

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:Absorption This indirect absorption chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Two sets of coefficients are required.

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_outlet_temperature_lower_limit

field Chilled Water Outlet Temperature Lower Limit

Units: C

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

coefficient_1_of_the_hot_water_or_steam_use_part_load_ratio_curve

field Coefficient 1 of the Hot Water or Steam Use Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of the Hot Water or Steam Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_the_hot_water_or_steam_use_part_load_ratio_curve or None if not set Return type:float

coefficient_1_of_the_pump_electric_use_part_load_ratio_curve

field Coefficient 1 of the Pump Electric Use Part Load Ratio Curve

The pump electric use coefficients specify the

pumping power as a Fraction of Nominal pumping power

Parameters:value (float) – value for IDD Field Coefficient 1 of the Pump Electric Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_the_pump_electric_use_part_load_ratio_curve or None if not set Return type:float

coefficient_2_of_the_hot_water_or_steam_use_part_load_ratio_curve

field Coefficient 2 of the Hot Water or Steam Use Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of the Hot Water or Steam Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_the_hot_water_or_steam_use_part_load_ratio_curve or None if not set Return type:float

coefficient_2_of_the_pump_electric_use_part_load_ratio_curve

field Coefficient 2 of the Pump Electric Use Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of the Pump Electric Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_the_pump_electric_use_part_load_ratio_curve or None if not set Return type:float

coefficient_3_of_the_hot_water_or_steam_use_part_load_ratio_curve

field Coefficient 3 of the Hot Water or Steam Use Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of the Hot Water or Steam Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_the_hot_water_or_steam_use_part_load_ratio_curve or None if not set Return type:float

coefficient_3_of_the_pump_electric_use_part_load_ratio_curve

field Coefficient 3 of the Pump Electric Use Part Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of the Pump Electric Use Part Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_the_pump_electric_use_part_load_ratio_curve or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

degree_of_subcooling_in_steam_generator

field Degree of Subcooling in Steam Generator

This field is not used when the generator inlet/outlet nodes are not specified or

the generator is connected to a hot water loop.

Units: C

Default value: 1.0

Parameters:value (float) – value for IDD Field Degree of Subcooling in Steam Generator Raises:ValueError – if value is not a valid value Returns:the value of degree_of_subcooling_in_steam_generator or None if not set Return type:float

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the max flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_condenser_inlet_temperature

field Design Condenser Inlet Temperature

Units: C

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

The steam use coefficients below specify the

steam use as a fraction of chiller operating capacity

Units: m3/s

IP-Units: gal/min

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

design_generator_fluid_flow_rate

field Design Generator Fluid Flow Rate

Units: m3/s

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

generator_heat_source_type

field Generator Heat Source Type

The Generator side of the chiller can be connected to a hot water or steam plant where the

generator inlet and outlet nodes are connected to a plant loop. If the generator is not

connected to a plant loop, and the generator inlet/outlet nodes are not used, this field should be

specified as steam or left blank. When a plant is not used, the model assumes steam as the heat source.

Default value: Steam

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

generator_inlet_node_name

field Generator Inlet Node Name

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

generator_outlet_node_name

field Generator Outlet Node Name

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

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_pumping_power

field Nominal Pumping Power

Units: W

IP-Units: W

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

optimum_part_load_ratio

field Optimum Part Load Ratio

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

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.plant_heating_and_cooling_equipment.ChillerAbsorptionIndirect

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:Absorption:Indirect This indirect absorption chiller model is an enhanced model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. The chiller capacity is a function of condenser, chilled water, and generator temperatures. The heat input is a function of part-load ratio, condenser temperature, and chilled water temperature.

capacity_correction_function_of_chilled_water_temperature_curve_name

field Capacity Correction Function of Chilled Water Temperature Curve Name

Curve which shows the change in normalized capacity to changes in leaving chilled water temperature.

Parameters:value (str) – value for IDD Field Capacity Correction Function of Chilled Water Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of capacity_correction_function_of_chilled_water_temperature_curve_name or None if not set Return type:str

capacity_correction_function_of_condenser_temperature_curve_name

field Capacity Correction Function of Condenser Temperature Curve Name

Curve which shows the change in normalized capacity to changes in condenser temperature.

Parameters:value (str) – value for IDD Field Capacity Correction Function of Condenser Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of capacity_correction_function_of_condenser_temperature_curve_name or None if not set Return type:str

capacity_correction_function_of_generator_temperature_curve_name

field Capacity Correction Function of Generator Temperature Curve Name

Used when generator fluid type is hot water

Curve which shows the change in normalized capacity to changes in generator temperature.

Parameters:value (str) – value for IDD Field Capacity Correction Function of Generator Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of capacity_correction_function_of_generator_temperature_curve_name or None if not set Return type:str

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_outlet_temperature_lower_limit

field Chilled Water Outlet Temperature Lower Limit

Capacity is adjusted when leaving chilled water temperature is below minimum.

Units: C

Default value: 5.0

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_inlet_temperature_lower_limit

field Condenser Inlet Temperature Lower Limit

Provides warnings when entering condenser temperature is below minimum.

Capacity is not adjusted when entering condenser temperature is below minimum.

Units: C

Default value: 15.0

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

degree_of_subcooling_in_steam_condensate_loop

field Degree of Subcooling in Steam Condensate Loop

This field is not used when the generator inlet/outlet nodes are not specified or

the generator is connected to a hot water loop.

Units: C

Parameters:value (float) – value for IDD Field Degree of Subcooling in Steam Condensate Loop Raises:ValueError – if value is not a valid value Returns:the value of degree_of_subcooling_in_steam_condensate_loop or None if not set Return type:float

degree_of_subcooling_in_steam_generator

field Degree of Subcooling in Steam Generator

This field is not used when the generator inlet/outlet nodes are not specified or

the generator is connected to a hot water loop.

Units: C

Default value: 1.0

value <= 20.0

Parameters:value (float) – value for IDD Field Degree of Subcooling in Steam Generator Raises:ValueError – if value is not a valid value Returns:the value of degree_of_subcooling_in_steam_generator or None if not set Return type:float

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable flow this is the max flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_condenser_inlet_temperature

field Design Condenser Inlet Temperature

Used only when condenser flow rate is autosized.

Units: C

Default value: 30.0

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_generator_fluid_flow_rate

field Design Generator Fluid Flow Rate

For variable flow this is the max flow and for constant flow this is the flow.

Units: m3/s

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

generator_heat_input_correction_function_of_chilled_water_temperature_curve_name

field Generator Heat Input Correction Function of Chilled Water Temperature Curve Name

Curve which shows the change in normalized heat input to changes in leaving chilled water temperature.

Parameters:value (str) – value for IDD Field Generator Heat Input Correction Function of Chilled Water Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of generator_heat_input_correction_function_of_chilled_water_temperature_curve_name or None if not set Return type:str

generator_heat_input_correction_function_of_condenser_temperature_curve_name

field Generator Heat Input Correction Function of Condenser Temperature Curve Name

Curve which shows the change in normalized heat input to changes in condenser temperature.

Parameters:value (str) – value for IDD Field Generator Heat Input Correction Function of Condenser Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of generator_heat_input_correction_function_of_condenser_temperature_curve_name or None if not set Return type:str

generator_heat_input_function_of_part_load_ratio_curve_name

field Generator Heat Input Function of Part Load Ratio Curve Name

Parameters:value (str) – value for IDD Field Generator Heat Input Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of generator_heat_input_function_of_part_load_ratio_curve_name or None if not set Return type:str

generator_heat_source_type

field Generator Heat Source Type

The Generator side of the chiller can be connected to a hot water or steam plant where the

generator inlet and outlet nodes are connected to a plant loop. If the generator is not

connected to a plant loop, and the generator inlet/outlet nodes are not used, this field should be

specified as steam or left blank. When a plant is not used, the model assumes steam as the heat source.

Default value: Steam

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

generator_inlet_node_name

field Generator Inlet Node Name

Enter the generator inlet node name which connects this chiller to a

steam or hot water plant, otherwise leave this field blank.

Generator nodes are used to model heat input to the chiller.

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

generator_outlet_node_name

field Generator Outlet Node Name

Enter the generator outlet node name which connects this chiller to a

steam or hot water plant, otherwise leave this field blank.

Generator nodes are used to model heat input to the chiller.

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

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_pumping_power

field Nominal Pumping Power

Units: W

IP-Units: W

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

optimum_part_load_ratio

field Optimum Part Load Ratio

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

pump_electric_input_function_of_part_load_ratio_curve_name

field Pump Electric Input Function of Part Load Ratio Curve Name

Parameters:value (str) – value for IDD Field Pump Electric Input Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of pump_electric_input_function_of_part_load_ratio_curve_name 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

temperature_lower_limit_generator_inlet

field Temperature Lower Limit Generator Inlet

Provides warnings when entering generator temperature is below minimum.

Capacity is not adjusted when entering generator temperature is below minimum.

Units: C

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

class pyidf.plant_heating_and_cooling_equipment.ChillerCombustionTurbine

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:CombustionTurbine This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Three sets of coefficients are required.

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 chiller is not operating.

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_outlet_temperature_lower_limit

field Chilled Water Outlet Temperature Lower Limit

Special Gas Turbine Chiller Parameters Below

Units: C

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

coefficient_1_of_capacity_ratio_curve

field Coefficient 1 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_capacity_ratio_curve or None if not set Return type:float

coefficient_1_of_exhaust_flow_curve

field Coefficient 1 of Exhaust Flow Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Exhaust Flow Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_exhaust_flow_curve or None if not set Return type:float

coefficient_1_of_exhaust_gas_temperature_curve

field Coefficient 1 of Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_1_of_fuel_input_curve

field Coefficient 1 of Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_fuel_input_curve or None if not set Return type:float

coefficient_1_of_full_load_ratio_curve

field Coefficient 1 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_full_load_ratio_curve or None if not set Return type:float

coefficient_1_of_power_ratio_curve

field Coefficient 1 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_power_ratio_curve or None if not set Return type:float

coefficient_1_of_recovery_lube_heat_curve

field Coefficient 1 of Recovery Lube Heat Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Recovery Lube Heat Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_recovery_lube_heat_curve or None if not set Return type:float

coefficient_1_of_temperature_based_exhaust_gas_temperature_curve

field Coefficient 1 of Temperature Based Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Temperature Based Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_temperature_based_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_1_of_temperature_based_fuel_input_curve

field Coefficient 1 of Temperature Based Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Temperature Based Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_temperature_based_fuel_input_curve or None if not set Return type:float

coefficient_1_of_ufactor_times_area_curve

field Coefficient 1 of U-Factor Times Area Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_2_of_capacity_ratio_curve

field Coefficient 2 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_capacity_ratio_curve or None if not set Return type:float

coefficient_2_of_exhaust_flow_curve

field Coefficient 2 of Exhaust Flow Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Exhaust Flow Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_exhaust_flow_curve or None if not set Return type:float

coefficient_2_of_exhaust_gas_temperature_curve

field Coefficient 2 of Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_2_of_fuel_input_curve

field Coefficient 2 of Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_fuel_input_curve or None if not set Return type:float

coefficient_2_of_full_load_ratio_curve

field Coefficient 2 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_full_load_ratio_curve or None if not set Return type:float

coefficient_2_of_power_ratio_curve

field Coefficient 2 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_power_ratio_curve or None if not set Return type:float

coefficient_2_of_recovery_lube_heat_curve

field Coefficient 2 of Recovery Lube Heat Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Recovery Lube Heat Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_recovery_lube_heat_curve or None if not set Return type:float

coefficient_2_of_temperature_based_exhaust_gas_temperature_curve

field Coefficient 2 of Temperature Based Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Temperature Based Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_temperature_based_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_2_of_temperature_based_fuel_input_curve

field Coefficient 2 of Temperature Based Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Temperature Based Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_temperature_based_fuel_input_curve or None if not set Return type:float

coefficient_2_of_ufactor_times_area_curve

field Coefficient 2 of U-Factor Times Area Curve

typical value .9

value <= 2.0

Parameters:value (float) – value for IDD Field Coefficient 2 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_3_of_capacity_ratio_curve

field Coefficient 3 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_capacity_ratio_curve or None if not set Return type:float

coefficient_3_of_exhaust_flow_curve

field Coefficient 3 of Exhaust Flow Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Exhaust Flow Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_exhaust_flow_curve or None if not set Return type:float

coefficient_3_of_exhaust_gas_temperature_curve

field Coefficient 3 of Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_3_of_fuel_input_curve

field Coefficient 3 of Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_fuel_input_curve or None if not set Return type:float

coefficient_3_of_full_load_ratio_curve

field Coefficient 3 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_full_load_ratio_curve or None if not set Return type:float

coefficient_3_of_power_ratio_curve

field Coefficient 3 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_power_ratio_curve or None if not set Return type:float

coefficient_3_of_recovery_lube_heat_curve

field Coefficient 3 of Recovery Lube Heat Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Recovery Lube Heat Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_recovery_lube_heat_curve or None if not set Return type:float

coefficient_3_of_temperature_based_exhaust_gas_temperature_curve

field Coefficient 3 of Temperature Based Exhaust Gas Temperature Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Temperature Based Exhaust Gas Temperature Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_temperature_based_exhaust_gas_temperature_curve or None if not set Return type:float

coefficient_3_of_temperature_based_fuel_input_curve

field Coefficient 3 of Temperature Based Fuel Input Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Temperature Based Fuel Input Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_temperature_based_fuel_input_curve or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

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

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the max flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_chilled_water_outlet_temperature

field Design Chilled Water Outlet Temperature

Units: C

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

design_condenser_inlet_temperature

field Design Condenser Inlet Temperature

Units: C

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

This field is not used for Condenser Type = AirCooled or EvaporativelyCooled

Units: m3/s

IP-Units: gal/min

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

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.

Units: m3/s

IP-Units: gal/min

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

design_steam_saturation_temperature

field Design Steam Saturation Temperature

Units: C

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

fuel_higher_heating_value

field Fuel Higher Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_type

field Fuel Type

Default value: NaturalGas

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

gas_turbine_engine_capacity

field Gas Turbine Engine Capacity

Units: W

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

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

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

heat_recovery_maximum_temperature

field Heat Recovery Maximum Temperature

Units: C

Default value: 80.0

value <= 100.0

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

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

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

maximum_exhaust_flow_per_unit_of_power_output

field Maximum Exhaust Flow per Unit of Power Output

Units: (kg/s)/W

Parameters:value (float) – value for IDD Field Maximum Exhaust Flow per Unit of Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_exhaust_flow_per_unit_of_power_output or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

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

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

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

temperature_rise_coefficient

field Temperature Rise Coefficient

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

class pyidf.plant_heating_and_cooling_equipment.ChillerConstantCop

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:ConstantCOP This constant COP chiller model provides a means of quickly specifying a Chiller where performance data is not available.

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 chiller is not operating.

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

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

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the maximum flow and for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

This field is not used for Condenser Type = AirCooled or EvaporativelyCooled

Units: m3/s

IP-Units: gal/min

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

name

field Name

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

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

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.plant_heating_and_cooling_equipment.ChillerElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:Electric This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Three sets of coefficients are required.

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 chiller is not operating.

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_outlet_temperature_lower_limit

field Chilled Water Outlet Temperature Lower Limit

Units: C

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

coefficient_1_of_capacity_ratio_curve

field Coefficient 1 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_capacity_ratio_curve or None if not set Return type:float

coefficient_1_of_full_load_ratio_curve

field Coefficient 1 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_full_load_ratio_curve or None if not set Return type:float

coefficient_1_of_power_ratio_curve

field Coefficient 1 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_power_ratio_curve or None if not set Return type:float

coefficient_2_of_capacity_ratio_curve

field Coefficient 2 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_capacity_ratio_curve or None if not set Return type:float

coefficient_2_of_full_load_ratio_curve

field Coefficient 2 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_full_load_ratio_curve or None if not set Return type:float

coefficient_2_of_power_ratio_curve

field Coefficient 2 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_power_ratio_curve or None if not set Return type:float

coefficient_3_of_capacity_ratio_curve

field Coefficient 3 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_capacity_ratio_curve or None if not set Return type:float

coefficient_3_of_full_load_ratio_curve

field Coefficient 3 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_full_load_ratio_curve or None if not set Return type:float

coefficient_3_of_power_ratio_curve

field Coefficient 3 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_power_ratio_curve or None if not set Return type:float

condenser_heat_recovery_relative_capacity_fraction

field Condenser Heat Recovery Relative Capacity Fraction

This optional field is the fraction of total rejected heat that can be recovered at full load

value <= 1.0

Parameters:value (float) – value for IDD Field Condenser Heat Recovery Relative Capacity Fraction Raises:ValueError – if value is not a valid value Returns:the value of condenser_heat_recovery_relative_capacity_fraction or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

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

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the maximum flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_chilled_water_outlet_temperature

field Design Chilled Water Outlet Temperature

Units: C

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

design_condenser_fluid_flow_rate

field Design Condenser Fluid Flow Rate

This field is only used for Condenser Type = AirCooled or EvaporativelyCooled

when Heat Recovery is specified

Units: m3/s

IP-Units: gal/min

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

design_condenser_inlet_temperature

field Design Condenser Inlet Temperature

Units: C

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

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.

Units: m3/s

IP-Units: gal/min

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

heat_recovery_inlet_high_temperature_limit_schedule_name

field Heat Recovery Inlet High Temperature Limit Schedule Name

This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value

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

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

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

heat_recovery_leaving_temperature_setpoint_node_name

field Heat Recovery Leaving Temperature Setpoint Node Name

This optional field provides control over the heat recovery

Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery

If this field is not used, the bundles are modeled as being in parallel

Parameters:value (str) – value for IDD Field Heat Recovery Leaving Temperature Setpoint Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_leaving_temperature_setpoint_node_name or None if not set Return type:str

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

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

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

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

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

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

temperature_rise_coefficient

field Temperature Rise Coefficient

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

class pyidf.plant_heating_and_cooling_equipment.ChillerElectricEir

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:Electric:EIR This chiller model is the empirical model from the DOE-2 building Energy simulation program. Chiller performance at off-reference conditions is modeled using three polynomial equations. Three curves objects are required.

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 chiller is not operating.

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

condenser_fan_power_ratio

field Condenser Fan Power Ratio

Use for air-cooled or evaporatively-cooled condensers.

Ratio of condenser fan power to reference chiller capacity

Units: W/W

Parameters:value (float) – value for IDD Field Condenser Fan Power Ratio Raises:ValueError – if value is not a valid value Returns:the value of condenser_fan_power_ratio or None if not set Return type:float

condenser_heat_recovery_relative_capacity_fraction

field Condenser Heat Recovery Relative Capacity Fraction

This optional field is the fraction of total rejected heat that can be recovered at full load

value <= 1.0

Parameters:value (float) – value for IDD Field Condenser Heat Recovery Relative Capacity Fraction Raises:ValueError – if value is not a valid value Returns:the value of condenser_heat_recovery_relative_capacity_fraction or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

Not required if air-cooled or evaporatively-cooled

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

condenser_outlet_node_name

field Condenser Outlet Node Name

Not required if air-cooled or evaporatively-cooled

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

condenser_type

field Condenser Type

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

cooling_capacity_function_of_temperature_curve_name

field Cooling Capacity Function of Temperature Curve Name

Cooling capacity as a function of CW supply temp and entering condenser temp

curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT

CWS = supply (leaving) chilled water temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.

Units: m3/s

IP-Units: gal/min

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

electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR)

EIR = 1/COP

quadratic curve = a + b*PLR + c*PLR**2

PLR = part load ratio (cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Electric Input to Cooling Output Ratio Function of Temperature Curve Name

Electric Input Ratio (EIR) as a function of temperature

EIR = 1/COP

curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT

CWS = supply (leaving) chilled water temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

fraction_of_compressor_electric_consumption_rejected_by_condenser

field Fraction of Compressor Electric Consumption Rejected by Condenser

Fraction of compressor electrical energy that must be rejected by the condenser.

Enter a value of 1.0 when modeling hermetic chillers.

For open chillers, enter the compressor motor efficiency.

This value should be greater than 0.6 for practical applications.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Compressor Electric Consumption Rejected by Condenser Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_compressor_electric_consumption_rejected_by_condenser or None if not set Return type:float

heat_recovery_inlet_high_temperature_limit_schedule_name

field Heat Recovery Inlet High Temperature Limit Schedule Name

This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value

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

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

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

heat_recovery_leaving_temperature_setpoint_node_name

field Heat Recovery Leaving Temperature Setpoint Node Name

This optional field provides control over the heat recovery

Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery

If this field is not used, the bundles are modeled as being in parallel

Parameters:value (str) – value for IDD Field Heat Recovery Leaving Temperature Setpoint Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_leaving_temperature_setpoint_node_name or None if not set Return type:str

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_outlet_node_name 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: 2.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.

Default value: 0.1

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

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

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

reference_capacity

field Reference Capacity

Units: W

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

reference_chilled_water_flow_rate

field Reference Chilled Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

reference_condenser_fluid_flow_rate

field Reference Condenser Fluid Flow Rate

This field is only used for Condenser Type = AirCooled or EvaporativelyCooled

when Heat Recovery is specified

Units: m3/s

IP-Units: gal/min

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

reference_cop

field Reference COP

Efficiency of the chiller compressor (cooling output/compressor energy input).

Condenser fan power should not be included here.

Units: W/W

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

reference_entering_condenser_fluid_temperature

field Reference Entering Condenser Fluid Temperature

Units: C

Default value: 29.4

Parameters:value (float) – value for IDD Field Reference Entering Condenser Fluid Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_entering_condenser_fluid_temperature or None if not set Return type:float

reference_leaving_chilled_water_temperature

field Reference Leaving Chilled Water Temperature

Units: C

Default value: 6.67

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

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.plant_heating_and_cooling_equipment.ChillerElectricReformulatedEir

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:Electric:ReformulatedEIR This chiller model is an empirical model, a reformulated version of Chiller:Electric:EIR where the performance is a function of condenser leaving fluid Temperature instead of condenser entering fluid Temperature. Chiller performance at off-reference conditions is modeled using three polynomial equations. Three curve objects are required.

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chiller_flow_mode_type

field Chiller Flow Mode Type

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

condenser_heat_recovery_relative_capacity_fraction

field Condenser Heat Recovery Relative Capacity Fraction

This optional field is the fraction of total rejected heat that can be recovered at full load

value <= 1.0

Parameters:value (float) – value for IDD Field Condenser Heat Recovery Relative Capacity Fraction Raises:ValueError – if value is not a valid value Returns:the value of condenser_heat_recovery_relative_capacity_fraction or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

cooling_capacity_function_of_temperature_curve_name

field Cooling Capacity Function of Temperature Curve Name

Cooling capacity as a function of supply (leaving) chilled water temperature

and leaving condenser fluid temperature

curve = a + b*CWS + c*CWS**2 + d*LCT + e*LCT**2 + f*CWS*LCT

CWS = supply (leaving) chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.

Units: m3/s

IP-Units: gal/min

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

electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR)

EIR = 1/COP

The form of this curve is based on the input for

Electric Input to Cooling Output RatioFunction of Part Load Ratio Curve Type

Type=LeavingCondenserWaterTemperature: Calculated based on LCT and PLR

Curve object type should be Curve:Bicubic or Table:TwoIndependentVariables

Bicubic curve = a + b*LCT + c*LCT**2 + d*PLR + e*PLR**2 + f*LCT*PLR + g*0 + h*PLR**3

+ i*0 + j*0

PLR = part load ratio (cooling load/steady state capacity)

LCT = leaving condenser fluid temperature(C)

Type=Lift: Calculated based on dT*, Tdev* and PLR

Curve object type should be Curve:ChillerPartLoadWithLiftCurves or Table:MultiVariableLookup

ChillerPartLoadWithLiftCurves curve = a + b*(dT*) + c*(dT*)**2 + d*PLR + e*PLR**2 + f*(dT*)*PLR + g*(dT*)**3

+ h*PLR**3 + i*(dT*)**2*PLR + j*(dT*)*PLR**2 + k*(dT*)**2*PLR**2 + l*(Tdev*)*PLR**3

x = dT* = normalized fractional Lift = dT / dTref

y = PLR = part load ratio (cooling load/steady state capacity)

z = Tdev* = normalized Tdev = Tdev / dTref

Where:

dT = Lift = Leaving Condenser Water Temperature - Leaving Chilled Water Temperature

dTref = dT at the reference condition

Tdev = Leaving Chilled Water Temperature - Reference Chilled Water Temperature

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_type

field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Type

Two curve types are available:

Type LeavingCondenserWaterTemperature: based on the leaving condenser water temperature.

Type Lift: based on the normalized lift, which is the temperature difference between the

leaving condenser water temperature and the leaving evaporator water temperature.

Default value: LeavingCondenserWaterTemperature

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Type Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_type or None if not set Return type:str

electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Electric Input to Cooling Output Ratio Function of Temperature Curve Name

Electric Input Ratio (EIR) as a function of supply (leaving) chilled water temperature

and leaving condenser fluid temperature. EIR = 1/COP.

curve = a + b*CWS + c*CWS**2 + d*LCT + e*LCT**2 + f*CWS*LCT

CWS = supply (leaving) chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

fraction_of_compressor_electric_consumption_rejected_by_condenser

field Fraction of Compressor Electric Consumption Rejected by Condenser

Fraction of compressor electrical energy that must be rejected by the condenser.

Enter a value of 1.0 when modeling hermetic chillers.

For open chillers, enter the compressor motor efficiency.

This value should be greater than 0.6 for practical applications.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Compressor Electric Consumption Rejected by Condenser Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_compressor_electric_consumption_rejected_by_condenser or None if not set Return type:float

heat_recovery_inlet_high_temperature_limit_schedule_name

field Heat Recovery Inlet High Temperature Limit Schedule Name

This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value

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

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

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

heat_recovery_leaving_temperature_setpoint_node_name

field Heat Recovery Leaving Temperature Setpoint Node Name

This optional field provides control over the heat recovery

Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery

If this field is not used, the bundles are modeled as being in parallel

Parameters:value (str) – value for IDD Field Heat Recovery Leaving Temperature Setpoint Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_leaving_temperature_setpoint_node_name or None if not set Return type:str

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_outlet_node_name 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: 2.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.

Default value: 0.1

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

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

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

reference_capacity

field Reference Capacity

Units: W

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

reference_chilled_water_flow_rate

field Reference Chilled Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

reference_condenser_water_flow_rate

field Reference Condenser Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

reference_cop

field Reference COP

Efficiency of the chiller compressor (cooling output/compressor energy input).

Condenser fan power should not be included here.

Units: W/W

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

reference_leaving_chilled_water_temperature

field Reference Leaving Chilled Water Temperature

Units: C

Default value: 6.67

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

reference_leaving_condenser_water_temperature

field Reference Leaving Condenser Water Temperature

Units: C

Default value: 35.0

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

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.plant_heating_and_cooling_equipment.ChillerEngineDriven

Bases: pyidf.helper.DataObject

Corresponds to IDD object Chiller:EngineDriven This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Three sets of coefficients are required.

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 chiller is not operating.

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_outlet_temperature_lower_limit

field Chilled Water Outlet Temperature Lower Limit

Special EngineDriven Chiller Parameters Below

Units: C

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

chiller_flow_mode

field Chiller Flow Mode

Select operating mode for fluid flow through the chiller. “NotModulated” is for

either variable or constant pumping with flow controlled by the external plant system.

“ConstantFlow” is for constant pumping with flow controlled by chiller to operate at

full design flow rate. “LeavingSetpointModulated” is for variable pumping with flow

controlled by chiller to vary flow to target a leaving temperature setpoint.

Default value: NotModulated

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

coefficient_1_of_capacity_ratio_curve

field Coefficient 1 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_capacity_ratio_curve or None if not set Return type:float

coefficient_1_of_full_load_ratio_curve

field Coefficient 1 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_full_load_ratio_curve or None if not set Return type:float

coefficient_1_of_power_ratio_curve

field Coefficient 1 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 1 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_power_ratio_curve or None if not set Return type:float

coefficient_1_of_ufactor_times_area_curve

field Coefficient 1 of U-Factor Times Area Curve

curve = C1 * (nominal capacity)**C2

Parameters:value (float) – value for IDD Field Coefficient 1 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_2_of_capacity_ratio_curve

field Coefficient 2 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_capacity_ratio_curve or None if not set Return type:float

coefficient_2_of_full_load_ratio_curve

field Coefficient 2 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_full_load_ratio_curve or None if not set Return type:float

coefficient_2_of_power_ratio_curve

field Coefficient 2 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 2 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_power_ratio_curve or None if not set Return type:float

coefficient_2_of_ufactor_times_area_curve

field Coefficient 2 of U-Factor Times Area Curve

curve = C1 * (nominal capacity)**C2

typical value .9

value <= 2.0

Parameters:value (float) – value for IDD Field Coefficient 2 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_3_of_capacity_ratio_curve

field Coefficient 3 of Capacity Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Capacity Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_capacity_ratio_curve or None if not set Return type:float

coefficient_3_of_full_load_ratio_curve

field Coefficient 3 of Full Load Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Full Load Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_full_load_ratio_curve or None if not set Return type:float

coefficient_3_of_power_ratio_curve

field Coefficient 3 of Power Ratio Curve

Parameters:value (float) – value for IDD Field Coefficient 3 of Power Ratio Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_power_ratio_curve or None if not set Return type:float

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

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

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the maximum flow and for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

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

design_chilled_water_outlet_temperature

field Design Chilled Water Outlet Temperature

Units: C

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

design_condenser_inlet_temperature

field Design Condenser Inlet Temperature

Units: C

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

This field is not used for Condenser Type = AirCooled or EvaporativelyCooled

Units: m3/s

IP-Units: gal/min

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

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.

Units: m3/s

IP-Units: gal/min

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

design_minimum_exhaust_temperature

field Design Minimum Exhaust Temperature

Units: C

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

exhaust_temperature_curve_name

field Exhaust Temperature Curve Name

Curve is a function of Part Load Ratio (PLR)

curve = a + b*PLR + c*PLR**2

PLR = Ratio of evaporator heat transfer rate to nominal capacity

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

fuel_higher_heating_value

field Fuel Higher Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_type

field Fuel Type

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

fuel_use_curve_name

field Fuel Use Curve Name

Curve is a function of Part Load Ratio (PLR)

curve = a + b*PLR + c*PLR**2

PLR = Ratio of evaporator heat transfer rate to nominal capacity

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

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

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

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

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

jacket_heat_recovery_curve_name

field Jacket Heat Recovery Curve Name

Curve is a function of Part Load Ratio (PLR)

curve = a + b*PLR + c*PLR**2

PLR = Ratio of evaporator heat transfer rate to nominal capacity

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

lube_heat_recovery_curve_name

field Lube Heat Recovery Curve Name

Curve is a function of Part Load Ratio (PLR)

curve = a + b*PLR + c*PLR**2

PLR = Ratio of evaporator heat transfer rate to nominal capacity

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

maximum_exhaust_flow_per_unit_of_power_output

field Maximum Exhaust Flow per Unit of Power Output

Units: (kg/s)/W

Parameters:value (float) – value for IDD Field Maximum Exhaust Flow per Unit of Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_exhaust_flow_per_unit_of_power_output or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

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

maximum_temperature_for_heat_recovery_at_heat_recovery_outlet_node

field Maximum Temperature for Heat Recovery at Heat Recovery Outlet Node

Units: C

Default value: 60.0

value <= 100.0

Parameters:value (float) – value for IDD Field Maximum Temperature for Heat Recovery at Heat Recovery Outlet Node Raises:ValueError – if value is not a valid value Returns:the value of maximum_temperature_for_heat_recovery_at_heat_recovery_outlet_node 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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

Nominal Refrigeration Cycle COP

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

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

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

temperature_rise_coefficient

field Temperature Rise Coefficient

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

total_exhaust_energy_curve_name

field Total Exhaust Energy Curve Name

Curve is a function of Part Load Ratio (PLR)

curve = a + b*PLR + c*PLR**2

PLR = Ratio of evaporator heat transfer rate to nominal capacity

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

class pyidf.plant_heating_and_cooling_equipment.ChillerHeaterAbsorptionDirectFired

Bases: pyidf.helper.DataObject

Corresponds to IDD object ChillerHeater:Absorption:DirectFired Direct fired gas absorption chiller-heater using performance curves similar to DOE-2

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_temperature_lower_limit

field Chilled Water Temperature Lower Limit

The chilled water supply temperature below which the chiller

will shut off.

Units: C

Default value: 2.0

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

chiller_flow_mode

field Chiller Flow Mode

This field is not really used and will be deleted from the object.

The required information is gotten internally or

not needed by the program.

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

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

The condenser can either be air cooled or connected to a cooling tower.

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

cooling_capacity_function_of_temperature_curve_name

field Cooling Capacity Function of Temperature Curve Name

The CoolCapFT curve represents the fraction of the cooling capacity of the chiller as it

varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the max flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

The water flow rate at design conditions through the condenser.

This field is not used for Condenser Type = AirCooled

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_entering_condenser_water_temperature

field Design Entering Condenser Water Temperature

The temperature of the water entering the condenser of the chiller when

operating at design conditions. This is usually based on the temperature

delivered by the cooling tower in a water cooled application.

Units: C

Default value: 29.0

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

design_hot_water_flow_rate

field Design Hot Water Flow Rate

The water flow rate at design conditions through the heater side.

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_leaving_chilled_water_temperature

field Design Leaving Chilled Water Temperature

The temperature of the water leaving the evaporator of the chiller when

operating at design conditions also called the chilled water supply temperature

or leaving chilled water temperature.

Units: C

Default value: 7.0

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

electric_input_to_cooling_output_ratio

field Electric Input to Cooling Output Ratio

The positive fraction that represents the ratio of the

instantaneous electricity used divided by the cooling capacity at rated conditions.

If the chiller is both heating and cooling only the cooling electricity is used.

Default value: 0.01

Parameters:value (float) – value for IDD Field Electric Input to Cooling Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio or None if not set Return type:float

electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

The curve represents the fraction of the electricity to the chiller as the load on

the chiller varies but the operating temperatures remain at the design values.

The curve is normalized so that at full load the value of the curve should be 1.0.

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Electric Input to Cooling Output Ratio Function of Temperature Curve Name

The curve represents the fraction of the electricity to the chiller at full load as

it varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

electric_input_to_heating_output_ratio

field Electric Input to Heating Output Ratio

The positive fraction that represents the ratio of the

instantaneous electricity used divided by the nominal heating capacity.

If the chiller is both heating and cooling only the cooling electricity is used.

Parameters:value (float) – value for IDD Field Electric Input to Heating Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_heating_output_ratio or None if not set Return type:float

fuel_higher_heating_value

field Fuel Higher Heating Value

Not currently used.

Units: kJ/kg

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_input_to_cooling_output_ratio

field Fuel Input to Cooling Output Ratio

The positive fraction that represents the ratio of the

instantaneous fuel used divided by the cooling capacity at rated conditions.

Default value: 0.97

Parameters:value (float) – value for IDD Field Fuel Input to Cooling Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_cooling_output_ratio or None if not set Return type:float

fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

The curve represents the fraction of the fuel input to the chiller as the load on

the chiller varies but the operating temperatures remain at the design values.

The curve is normalized so that at full load the value of the curve should be 1.0.

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Fuel Input to Cooling Output Ratio Function of Temperature Curve Name

The curve represents the fraction of the fuel input to the chiller at full load as

it varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Fuel Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name

field Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name

When the chiller is operating as only a heater, this curve is used to represent the

fraction of fuel used as the heating load varies. It is normalized so that a value

of 1.0 is the full heating capacity. The curve is usually linear or quadratic and

will probably be similar to a boiler curve for most chillers.

Parameters:value (str) – value for IDD Field Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name or None if not set Return type:str

fuel_input_to_heating_output_ratio

field Fuel Input to Heating Output Ratio

The positive fraction that represents the ratio of the

instantaneous fuel used divided by the nominal heating capacity.

Default value: 1.25

Parameters:value (float) – value for IDD Field Fuel Input to Heating Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_heating_output_ratio or None if not set Return type:float

fuel_type

field Fuel Type

Default value: NaturalGas

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

heating_capacity_function_of_cooling_capacity_curve_name

field Heating Capacity Function of Cooling Capacity Curve Name

The curve represents how the heating capacity of the chiller varies with cooling

capacity when the chiller is simultaneous heating and cooling. The curve is normalized

so an input of 1.0 represents the nominal cooling capacity and an output of 1.0

represents the full heating capacity (see the Heating to cooling capacity ratio input)

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Cooling Capacity Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_cooling_capacity_curve_name or None if not set Return type:str

heating_to_cooling_capacity_ratio

field Heating to Cooling Capacity Ratio

A positive fraction that represents the ratio of the

heating capacity divided by the cooling capacity at rated conditions.

Default value: 0.8

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

hot_water_inlet_node_name

field Hot Water Inlet Node Name

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

hot_water_outlet_node_name

field Hot Water Outlet Node Name

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

maximum_part_load_ratio

field Maximum Part Load Ratio

The positive fraction that represents the maximum cooling output possible at

rated temperature conditions divided by the nominal cooling capacity at those

same conditions. If greater than 1.0, the chiller is typically thought of as

capable of being overloaded.

Default value: 1.0

value >= 0.5

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

The positive fraction that represents the minimum cooling output possible when

operated continually at rated temperature conditions divided by the nominal

cooling capacity at those same conditions. If the load on the chiller is below

this fraction the chiller will cycle.

Default value: 0.1

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

nominal_cooling_capacity

field Nominal Cooling Capacity

Units: W

Default value: “autosize”

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

optimum_part_load_ratio

field Optimum Part Load Ratio

The positive fraction that represents the optimal cooling output at rated

temperature conditions divided by the nominal cooling capacity at those same

conditions. It represents the most desirable operating point for the chiller.

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

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

temperature_curve_input_variable

field Temperature Curve Input Variable

Sets the second independent variable in the three temperature dependent performance

curves to either the leaving or entering condenser water temperature. Manufacturers

express the performance of their chillers using either the leaving condenser water

temperature (to the tower) or the entering condenser water temperature (from the tower).

Default value: EnteringCondenser

Parameters:value (str) – value for IDD Field Temperature Curve Input Variable Raises:ValueError – if value is not a valid value Returns:the value of temperature_curve_input_variable or None if not set Return type:str

class pyidf.plant_heating_and_cooling_equipment.ChillerHeaterAbsorptionDoubleEffect

Bases: pyidf.helper.DataObject

Corresponds to IDD object ChillerHeater:Absorption:DoubleEffect Exhaust fired absorption chiller-heater using performance curves similar to DOE-2

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

chilled_water_temperature_lower_limit

field Chilled Water Temperature Lower Limit

The chilled water supply temperature below which the chiller

will shut off.

Units: C

Default value: 2.0

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

condenser_inlet_node_name

field Condenser Inlet Node Name

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

condenser_outlet_node_name

field Condenser Outlet Node Name

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

condenser_type

field Condenser Type

The condenser can either be air cooled or connected to a cooling tower.

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

cooling_capacity_function_of_temperature_curve_name

field Cooling Capacity Function of Temperature Curve Name

The CoolCapFT curve represents the fraction of the cooling capacity of the chiller as it

varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

For variable volume this is the max flow & for constant flow this is the flow.

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

The water flow rate at design conditions through the condenser.

This field is not used for Condenser Type = AirCooled

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_entering_condenser_water_temperature

field Design Entering Condenser Water Temperature

The temperature of the water entering the condenser of the chiller when

operating at design conditions. This is usually based on the temperature

delivered by the cooling tower in a water cooled application.

Units: C

Default value: 29.0

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

design_hot_water_flow_rate

field Design Hot Water Flow Rate

The water flow rate at design conditions through the heater side.

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

design_leaving_chilled_water_temperature

field Design Leaving Chilled Water Temperature

The temperature of the water leaving the evaporator of the chiller when

operating at design conditions also called the chilled water supply temperature

or leaving chilled water temperature.

Units: C

Default value: 7.0

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

electric_input_to_cooling_output_ratio

field Electric Input to Cooling Output Ratio

The positive fraction that represents the ratio of the

instantaneous electricity used divided by the cooling capacity at rated conditions.

If the chiller is both heating and cooling only the cooling electricity is used.

Default value: 0.01

Parameters:value (float) – value for IDD Field Electric Input to Cooling Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio or None if not set Return type:float

electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

The curve represents the fraction of the electricity to the chiller as the load on

the chiller varies but the operating temperatures remain at the design values.

The curve is normalized so that at full load the value of the curve should be 1.0.

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Electric Input to Cooling Output Ratio Function of Temperature Curve Name

The curve represents the fraction of the electricity to the chiller at full load as

it varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

electric_input_to_heating_output_ratio

field Electric Input to Heating Output Ratio

The positive fraction that represents the ratio of the

instantaneous electricity used divided by the nominal heating capacity.

If the chiller is both heating and cooling only the cooling electricity is used.

Parameters:value (float) – value for IDD Field Electric Input to Heating Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of electric_input_to_heating_output_ratio or None if not set Return type:float

exhaust_source_object_name

field Exhaust Source Object Name

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

exhaust_source_object_type

field Exhaust Source Object Type

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

fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

The curve represents the fraction of the fuel input to the chiller as the load on

the chiller varies but the operating temperatures remain at the design values.

The curve is normalized so that at full load the value of the curve should be 1.0.

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Fuel Input to Cooling Output Ratio Function of Temperature Curve Name

The curve represents the fraction of the fuel input to the chiller at full load as

it varies by temperature. The curve is normalized so that at design conditions the

value of the curve should be 1.0. This is a biquadratic curve with the

input variables being the leaving chilled water temperature and either

the entering or leaving condenser water temperature.

Parameters:value (str) – value for IDD Field Fuel Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name

field Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name

When the chiller is operating as only a heater, this curve is used to represent the

fraction of fuel used as the heating load varies. It is normalized so that a value

of 1.0 is the full heating capacity. The curve is usually linear or quadratic and

will probably be similar to a boiler curve for most chillers.

Parameters:value (str) – value for IDD Field Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name or None if not set Return type:str

heating_capacity_function_of_cooling_capacity_curve_name

field Heating Capacity Function of Cooling Capacity Curve Name

The curve represents how the heating capacity of the chiller varies with cooling

capacity when the chiller is simultaneous heating and cooling. The curve is normalized

so an input of 1.0 represents the nominal cooling capacity and an output of 1.0

represents the full heating capacity (see the Heating to cooling capacity ratio input)

The curve is usually linear or quadratic.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Cooling Capacity Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_cooling_capacity_curve_name or None if not set Return type:str

heating_to_cooling_capacity_ratio

field Heating to Cooling Capacity Ratio

A positive fraction that represents the ratio of the

heating capacity divided by the cooling capacity at rated conditions.

Default value: 0.8

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

hot_water_inlet_node_name

field Hot Water Inlet Node Name

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

hot_water_outlet_node_name

field Hot Water Outlet Node Name

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

maximum_part_load_ratio

field Maximum Part Load Ratio

The positive fraction that represents the maximum cooling output possible at

rated temperature conditions divided by the nominal cooling capacity at those

same conditions. If greater than 1.0, the chiller is typically thought of as

capable of being overloaded.

Default value: 1.0

value >= 0.5

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

The positive fraction that represents the minimum cooling output possible when

operated continually at rated temperature conditions divided by the nominal

cooling capacity at those same conditions. If the load on the chiller is below

this fraction the chiller will cycle.

Default value: 0.1

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

nominal_cooling_capacity

field Nominal Cooling Capacity

Units: W

Default value: “autosize”

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

optimum_part_load_ratio

field Optimum Part Load Ratio

The positive fraction that represents the optimal cooling output at rated

temperature conditions divided by the nominal cooling capacity at those same

conditions. It represents the most desirable operating point for the chiller.

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

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

temperature_curve_input_variable

field Temperature Curve Input Variable

Sets the second independent variable in the three temperature dependent performance

curves to either the leaving or entering condenser water temperature. Manufacturers

express the performance of their chillers using either the leaving condenser water

temperature (to the tower) or the entering condenser water temperature (from the tower).

Default value: EnteringCondenser

Parameters:value (str) – value for IDD Field Temperature Curve Input Variable Raises:ValueError – if value is not a valid value Returns:the value of temperature_curve_input_variable or None if not set Return type:str

thermal_energy_input_to_cooling_output_ratio

field Thermal Energy Input to Cooling Output Ratio

The positive fraction that represents the ratio of the

instantaneous fuel used divided by the cooling capacity at rated conditions.

Default value: 0.97

Parameters:value (float) – value for IDD Field Thermal Energy Input to Cooling Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of thermal_energy_input_to_cooling_output_ratio or None if not set Return type:float

thermal_energy_input_to_heating_output_ratio

field Thermal Energy Input to Heating Output Ratio

The positive fraction that represents the ratio of the

instantaneous fuel used divided by the nominal heating capacity.

Default value: 1.25

Parameters:value (float) – value for IDD Field Thermal Energy Input to Heating Output Ratio Raises:ValueError – if value is not a valid value Returns:the value of thermal_energy_input_to_heating_output_ratio or None if not set Return type:float

class pyidf.plant_heating_and_cooling_equipment.ChillerHeaterPerformanceElectricEir

Bases: pyidf.helper.DataObject

Corresponds to IDD object ChillerHeaterPerformance:Electric:EIR This chiller model is a generic chiller-heater where the cooling mode performance is a function of condenser entering or leaving fluid temperature and the heating mode performance is typically a function of condenser leaving fluid temperature. Performance at off-reference conditions is modeled using three polynomial equations per mode. Six curve objects are required.

chilled_water_flow_mode_type

field Chilled Water Flow Mode Type

Sets chilled water flow rate to either constant or variable.

Default value: ConstantFlow

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

compressor_motor_efficiency

field Compressor Motor Efficiency

Fraction of compressor electrical energy that must be rejected by the condenser.

Enter 1.0 or leave this field blank for a hermetic compressor.

Default value: 1.0

value <= 1.0

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

condenser_type

field Condenser Type

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

cooling_mode_cooling_capacity_function_of_temperature_curve_name

field Cooling Mode Cooling Capacity Function of Temperature Curve Name

Cooling capacity as a function of leaving chilled water temperature

and either entering or leaving condenser fluid temperature

curve = a + b*CWS + c*CWS**2 + d*TCond + e*TCond**2 + f*CWS*TCond

If ClgModeCondWaterCurveInputVariable = EnteringCondenser, TCond = ECT

If ClgModeCondWaterCurveInputVariable = LeavingCondenser, TCond = LCT

CWS = supply (leaving) chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Cooling Mode Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_mode_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

cooling_mode_cooling_capacity_optimum_part_load_ratio

field Cooling Mode Cooling Capacity 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.

The Min/Max PLR are taken from their associated EIR-FPLR curve references.

Default value: 1.0

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

cooling_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Cooling Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR)

EIR = 1/COP

Bicubic = a + b*TCond + c*TCond**2 + d*PLR + e*PLR**2 + f*TCond*PLR +g*0 + h*PLR**3+i*0+j*0

If ClgModeCondWaterCurveInputVariable = EnteringCondenser, TCond = ECT

If ClgModeCondWaterCurveInputVariable = LeavingCondenser, TCond = LCT

Normally, a bicubic curve here should be in terms of LCT rather than ECT

Also, a bicubic curve is more applicable for variable-speed compressor motor drives

or

Quadratic = a + b*PLR + c*PLR**2

PLR = part load ratio (cooling load/steady-state capacity)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Cooling Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

cooling_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Cooling Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name

Electric Input Ratio (EIR) as a function of supply (leaving) chilled water temperature

and leaving condenser fluid temperature. EIR = 1/COP.

curve = a + b*CWS + c*CWS**2 + d*TCond + e*TCond**2 + f*CWS*TCond

If ClgModeCondWaterCurveInputVariable = EnteringCondenser, TCond = ECT

If ClgModeCondWaterCurveInputVariable = LeavingCondenser, TCond = LCT

CWS = supply (leaving) chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Cooling Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_mode_temperature_curve_condenser_water_independent_variable

field Cooling Mode Temperature Curve Condenser Water Independent Variable

Sets the second independent variable in the three temperature dependent performance

curves to either the leaving or entering condenser water temperature. Manufacturers

express the performance of their chillers using either the leaving condenser water

temperature (to the tower) or the entering condenser water temperature (from the tower).

Cooling mode is generally a stronger function of Entering Condenser Fluid Temperature

Default value: EnteringCondenser

Parameters:value (str) – value for IDD Field Cooling Mode Temperature Curve Condenser Water Independent Variable Raises:ValueError – if value is not a valid value Returns:the value of cooling_mode_temperature_curve_condenser_water_independent_variable or None if not set Return type:str

design_chilled_water_flow_rate

field Design Chilled Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_condenser_water_flow_rate

field Design Condenser Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_hot_water_flow_rate

field Design Hot Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

heating_mode_cooling_capacity_function_of_temperature_curve_name

field Heating Mode Cooling Capacity Function of Temperature Curve Name

Evaporator (cooling) capacity as a function of leaving chilled water temperature

and leaving condenser fluid temperature when in heating or simultaneous cool/heat mode

curve = a + b*CWS + c*CWS**2 + d*TCond + e*TCond**2 + f*CWS*TCond

If independent variable = EnteringCondenser, TCond = ECT

If independent variable = LeavingCondenser, TCond = LCT

CWS = supply (leaving) chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Heating Mode Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_mode_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

heating_mode_cooling_capacity_optimum_part_load_ratio

field Heating Mode Cooling Capacity Optimum Part Load Ratio

Optimum part load ratio where the chiller is most efficient when in heating or simultaneous cool/heat mode.

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

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

The Min/Max PLR are taken from their associated EIR-FPLR curve references.

Default value: 1.0

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

heating_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name

field Heating Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name

Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR) when in heating or simultaneous cool/heat mode

EIR = 1/COP

Bicubic = a + b*LCT + c*LCT**2 + d*PLR + e*PLR**2 + f*LCT*PLR + g*0 + h*PLR**3 + i*0 + j*0

Normally, a bicubic curve here should be in terms of LCT rather than ECT

Also, a bicubic curve is more applicable for variable-speed compressor motor drives

or

Quadratic = a + b*PLR + c*PLR**2

PLR = part load ratio (cooling load/steady-state capacity)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Heating Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name or None if not set Return type:str

heating_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name

field Heating Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name

Electric Input Ratio (EIR) as a function of leaving chilled water temperature when in heating or simultaneous cool/heat mode

and leaving condenser fluid temperature. EIR = 1/COP.

curve = a + b*CWS + c*CWS**2 + d*TCond + e*TCond**2 + f*CWS*TCond

If independent variable = EnteringCondenser, TCond = ECT

If independent variable = LeavingCondenser, TCond = LCT

CWS = leaving chilled water temperature(C)

LCT = leaving condenser fluid temperature(C)

ECT = entering condenser fluid temperature(C)

Parameters:value (str) – value for IDD Field Heating Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name or None if not set Return type:str

heating_mode_entering_chilled_water_temperature_low_limit

field Heating Mode Entering Chilled Water Temperature Low Limit

During simultaneous cooling-heating mode

Units: C

Default value: 12.22

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

heating_mode_temperature_curve_condenser_water_independent_variable

field Heating Mode Temperature Curve Condenser Water Independent Variable

Sets the second independent variable in the three temperature dependent performance

curves to either the leaving or entering condenser water temperature. Manufacturers

express the performance of their chillers using either the leaving condenser water

temperature (to the tower) or the entering condenser water temperature (from the tower).

Heating mode (or Simul Clg/Htg Load) should be a function of Leaving Condenser Fluid Temperature

Only use EnteringCondenser as a last resort in case no performance data exists for LeavingCondenser

Default value: LeavingCondenser

Parameters:value (str) – value for IDD Field Heating Mode Temperature Curve Condenser Water Independent Variable Raises:ValueError – if value is not a valid value Returns:the value of heating_mode_temperature_curve_condenser_water_independent_variable 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

reference_cooling_mode_cop

field Reference Cooling Mode COP

Efficiency of the chiller compressor (cooling output/compressor energy input).

Units: W/W

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

reference_cooling_mode_entering_condenser_fluid_temperature

field Reference Cooling Mode Entering Condenser Fluid Temperature

Units: C

Default value: 29.44

Parameters:value (float) – value for IDD Field Reference Cooling Mode Entering Condenser Fluid Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_cooling_mode_entering_condenser_fluid_temperature or None if not set Return type:float

reference_cooling_mode_evaporator_capacity

field Reference Cooling Mode Evaporator Capacity

Units: W

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

reference_cooling_mode_leaving_chilled_water_temperature

field Reference Cooling Mode Leaving Chilled Water Temperature

Units: C

Default value: 6.67

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

reference_cooling_mode_leaving_condenser_water_temperature

field Reference Cooling Mode Leaving Condenser Water Temperature

Units: C

Default value: 35.0

Parameters:value (float) – value for IDD Field Reference Cooling Mode Leaving Condenser Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_cooling_mode_leaving_condenser_water_temperature or None if not set Return type:float

reference_heating_mode_cooling_capacity_ratio

field Reference Heating Mode Cooling Capacity Ratio

During simultaneous cooling-heating mode, this ratio is relative to the Reference Cooling Mode Cooling Capacity

(Evaporator capacity at simul clg-htg mode ref condition)/ (Evaporator capacity at cooling mode ref condition)

Default value: 0.75

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

reference_heating_mode_cooling_power_input_ratio

field Reference Heating Mode Cooling Power Input Ratio

During simultaneous cooling-heating mode, this ratio is relative to the Reference Cooling Mode COP

(Power at simultaneous clg-htg mode reference condition)/ (Power at cooling mode reference condition)

Default value: 1.38

Parameters:value (float) – value for IDD Field Reference Heating Mode Cooling Power Input Ratio Raises:ValueError – if value is not a valid value Returns:the value of reference_heating_mode_cooling_power_input_ratio or None if not set Return type:float

reference_heating_mode_entering_condenser_fluid_temperature

field Reference Heating Mode Entering Condenser Fluid Temperature

Units: C

Default value: 29.44

Parameters:value (float) – value for IDD Field Reference Heating Mode Entering Condenser Fluid Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_heating_mode_entering_condenser_fluid_temperature or None if not set Return type:float

reference_heating_mode_leaving_chilled_water_temperature

field Reference Heating Mode Leaving Chilled Water Temperature

During simultaneous cooling-heating mode

Units: C

Default value: 6.67

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

reference_heating_mode_leaving_condenser_water_temperature

field Reference Heating Mode Leaving Condenser Water Temperature

During simultaneous cooling-heating mode

Units: C

Default value: 49.0

Parameters:value (float) – value for IDD Field Reference Heating Mode Leaving Condenser Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_heating_mode_leaving_condenser_water_temperature or None if not set Return type:float

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.plant_heating_and_cooling_equipment.DistrictCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object DistrictCooling Centralized source of chilled water, such as a district cooling system.

capacity_fraction_schedule_name

field Capacity Fraction Schedule Name

Schedule values are multiplied by Nominal Capacity for current capacity

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

name

field Name

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

nominal_capacity

field Nominal Capacity

Units: W

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

class pyidf.plant_heating_and_cooling_equipment.DistrictHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object DistrictHeating Centralized source of hot water, such as a district heating system.

capacity_fraction_schedule_name

field Capacity Fraction Schedule Name

Schedule values are multiplied by Nominal Capacity for current capacity

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

hot_water_inlet_node_name

field Hot Water Inlet Node Name

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

hot_water_outlet_node_name

field Hot Water Outlet Node Name

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

name

field Name

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

nominal_capacity

field Nominal Capacity

Units: W

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

class pyidf.plant_heating_and_cooling_equipment.HeatPumpWaterToWaterEquationFitCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeatPump:WaterToWater:EquationFit:Cooling simple water-water heat pump curve-fit model

cooling_capacity_coefficient_1

field Cooling Capacity Coefficient 1

Parameters:value (float) – value for IDD Field Cooling Capacity Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_coefficient_1 or None if not set Return type:float

cooling_capacity_coefficient_2

field Cooling Capacity Coefficient 2

Parameters:value (float) – value for IDD Field Cooling Capacity Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_coefficient_2 or None if not set Return type:float

cooling_capacity_coefficient_3

field Cooling Capacity Coefficient 3

Parameters:value (float) – value for IDD Field Cooling Capacity Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_coefficient_3 or None if not set Return type:float

cooling_capacity_coefficient_4

field Cooling Capacity Coefficient 4

Parameters:value (float) – value for IDD Field Cooling Capacity Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_coefficient_4 or None if not set Return type:float

cooling_capacity_coefficient_5

field Cooling Capacity Coefficient 5

Parameters:value (float) – value for IDD Field Cooling Capacity Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_coefficient_5 or None if not set Return type:float

cooling_compressor_power_coefficient_1

field Cooling Compressor Power Coefficient 1

Parameters:value (float) – value for IDD Field Cooling Compressor Power Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of cooling_compressor_power_coefficient_1 or None if not set Return type:float

cooling_compressor_power_coefficient_2

field Cooling Compressor Power Coefficient 2

Parameters:value (float) – value for IDD Field Cooling Compressor Power Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of cooling_compressor_power_coefficient_2 or None if not set Return type:float

cooling_compressor_power_coefficient_3

field Cooling Compressor Power Coefficient 3

Parameters:value (float) – value for IDD Field Cooling Compressor Power Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of cooling_compressor_power_coefficient_3 or None if not set Return type:float

cooling_compressor_power_coefficient_4

field Cooling Compressor Power Coefficient 4

Parameters:value (float) – value for IDD Field Cooling Compressor Power Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of cooling_compressor_power_coefficient_4 or None if not set Return type:float

cooling_compressor_power_coefficient_5

field Cooling Compressor Power Coefficient 5

Parameters:value (float) – value for IDD Field Cooling Compressor Power Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of cooling_compressor_power_coefficient_5 or None if not set Return type:float

load_side_inlet_node_name

field Load Side Inlet Node Name

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

load_side_outlet_node_name

field Load Side Outlet Node Name

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

name

field Name

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

rated_cooling_capacity

field Rated Cooling Capacity

Units: W

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

rated_cooling_power_consumption

field Rated Cooling Power Consumption

Units: W

Parameters:value (float) – value for IDD Field Rated Cooling Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of rated_cooling_power_consumption or None if not set Return type:float

rated_load_side_flow_rate

field Rated Load Side Flow Rate

Units: m3/s

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

rated_source_side_flow_rate

field Rated Source Side Flow Rate

Units: m3/s

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

source_side_inlet_node_name

field Source Side Inlet Node Name

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

source_side_outlet_node_name

field Source Side Outlet Node Name

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

class pyidf.plant_heating_and_cooling_equipment.HeatPumpWaterToWaterEquationFitHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeatPump:WaterToWater:EquationFit:Heating simple water-water hp curve-fit model

heating_capacity_coefficient_1

field Heating Capacity Coefficient 1

Parameters:value (float) – value for IDD Field Heating Capacity Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_coefficient_1 or None if not set Return type:float

heating_capacity_coefficient_2

field Heating Capacity Coefficient 2

Parameters:value (float) – value for IDD Field Heating Capacity Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_coefficient_2 or None if not set Return type:float

heating_capacity_coefficient_3

field Heating Capacity Coefficient 3

Parameters:value (float) – value for IDD Field Heating Capacity Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_coefficient_3 or None if not set Return type:float

heating_capacity_coefficient_4

field Heating Capacity Coefficient 4

Parameters:value (float) – value for IDD Field Heating Capacity Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_coefficient_4 or None if not set Return type:float

heating_capacity_coefficient_5

field Heating Capacity Coefficient 5

Parameters:value (float) – value for IDD Field Heating Capacity Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_coefficient_5 or None if not set Return type:float

heating_compressor_power_coefficient_1

field Heating Compressor Power Coefficient 1

Parameters:value (float) – value for IDD Field Heating Compressor Power Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of heating_compressor_power_coefficient_1 or None if not set Return type:float

heating_compressor_power_coefficient_2

field Heating Compressor Power Coefficient 2

Parameters:value (float) – value for IDD Field Heating Compressor Power Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of heating_compressor_power_coefficient_2 or None if not set Return type:float

heating_compressor_power_coefficient_3

field Heating Compressor Power Coefficient 3

Parameters:value (float) – value for IDD Field Heating Compressor Power Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of heating_compressor_power_coefficient_3 or None if not set Return type:float

heating_compressor_power_coefficient_4

field Heating Compressor Power Coefficient 4

Parameters:value (float) – value for IDD Field Heating Compressor Power Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of heating_compressor_power_coefficient_4 or None if not set Return type:float

heating_compressor_power_coefficient_5

field Heating Compressor Power Coefficient 5

Parameters:value (float) – value for IDD Field Heating Compressor Power Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of heating_compressor_power_coefficient_5 or None if not set Return type:float

load_side_inlet_node_name

field Load Side Inlet Node Name

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

load_side_outlet_node_name

field Load Side Outlet Node Name

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

name

field Name

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

rated_heating_capacity

field Rated Heating Capacity

Units: W

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

rated_heating_power_consumption

field Rated Heating Power Consumption

Units: W

Parameters:value (float) – value for IDD Field Rated Heating Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of rated_heating_power_consumption or None if not set Return type:float

rated_load_side_flow_rate

field Rated Load Side Flow Rate

Units: m3/s

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

rated_source_side_flow_rate

field Rated Source Side Flow Rate

Units: m3/s

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

source_side_inlet_node_name

field Source Side Inlet Node Name

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

source_side_outlet_node_name

field Source Side Outlet Node Name

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

class pyidf.plant_heating_and_cooling_equipment.HeatPumpWaterToWaterParameterEstimationCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeatPump:WaterToWater:ParameterEstimation:Cooling OSU parameter estimation model

compressor_clearance_factor

field Compressor Clearance Factor

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

compressor_suction_and_discharge_pressure_drop

field Compressor Suction and Discharge Pressure Drop

Units: Pa

Parameters:value (float) – value for IDD Field Compressor Suction and Discharge Pressure Drop Raises:ValueError – if value is not a valid value Returns:the value of compressor_suction_and_discharge_pressure_drop or None if not set Return type:float

constant_part_of_electromechanical_power_losses

field Constant Part of Electromechanical Power Losses

Units: W

Parameters:value (float) – value for IDD Field Constant Part of Electromechanical Power Losses Raises:ValueError – if value is not a valid value Returns:the value of constant_part_of_electromechanical_power_losses or None if not set Return type:float

high_pressure_cut_off

field High Pressure Cut Off

Units: Pa

Default value: 500000000.0

Parameters:value (float) – value for IDD Field High Pressure Cut Off Raises:ValueError – if value is not a valid value Returns:the value of high_pressure_cut_off or None if not set Return type:float

load_side_flow_rate

field Load Side Flow Rate

Units: m3/s

IP-Units: gal/min

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

load_side_heat_transfer_coefficient

field Load Side Heat Transfer Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Load Side Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of load_side_heat_transfer_coefficient or None if not set Return type:float

load_side_inlet_node_name

field Load Side Inlet Node Name

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

load_side_outlet_node_name

field Load Side Outlet Node Name

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

loss_factor

field Loss Factor

Used to define electromechanical loss that is proportional

to the theoretical power %

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

low_pressure_cut_off

field Low Pressure Cut Off

Units: Pa

Parameters:value (float) – value for IDD Field Low Pressure Cut Off Raises:ValueError – if value is not a valid value Returns:the value of low_pressure_cut_off or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

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

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

piston_displacement

field Piston Displacement

Units: m3/s

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

source_side_flow_rate

field Source Side Flow Rate

Units: m3/s

IP-Units: gal/min

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

source_side_heat_transfer_coefficient

field Source Side Heat Transfer Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Source Side Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of source_side_heat_transfer_coefficient or None if not set Return type:float

source_side_inlet_node_name

field Source Side Inlet Node Name

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

source_side_outlet_node_name

field Source Side Outlet Node Name

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

superheating

field Superheating

Units: C

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

class pyidf.plant_heating_and_cooling_equipment.HeatPumpWaterToWaterParameterEstimationHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeatPump:WaterToWater:ParameterEstimation:Heating OSU parameter estimation model

compressor_clearance_factor

field Compressor Clearance Factor

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

compressor_suction_and_discharge_pressure_drop

field Compressor Suction and Discharge Pressure Drop

Units: Pa

Parameters:value (float) – value for IDD Field Compressor Suction and Discharge Pressure Drop Raises:ValueError – if value is not a valid value Returns:the value of compressor_suction_and_discharge_pressure_drop or None if not set Return type:float

constant_part_of_electromechanical_power_losses

field Constant Part of Electromechanical Power Losses

Units: W

Parameters:value (float) – value for IDD Field Constant Part of Electromechanical Power Losses Raises:ValueError – if value is not a valid value Returns:the value of constant_part_of_electromechanical_power_losses or None if not set Return type:float

high_pressure_cut_off

field High Pressure Cut Off

Units: Pa

Default value: 500000000.0

Parameters:value (float) – value for IDD Field High Pressure Cut Off Raises:ValueError – if value is not a valid value Returns:the value of high_pressure_cut_off or None if not set Return type:float

load_side_flow_rate

field Load Side Flow Rate

Units: m3/s

IP-Units: gal/min

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

load_side_heat_transfer_coefficient

field Load Side Heat Transfer Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Load Side Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of load_side_heat_transfer_coefficient or None if not set Return type:float

load_side_inlet_node_name

field Load Side Inlet Node Name

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

load_side_outlet_node_name

field Load Side Outlet Node Name

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

loss_factor

field Loss Factor

Used to define electromechanical loss that is proportional

to the theoretical power %

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

low_pressure_cut_off

field Low Pressure Cut Off

Units: Pa

Parameters:value (float) – value for IDD Field Low Pressure Cut Off Raises:ValueError – if value is not a valid value Returns:the value of low_pressure_cut_off or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

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

nominal_capacity

field Nominal Capacity

Units: W

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

nominal_cop

field Nominal COP

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

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

piston_displacement

field Piston Displacement

Units: m3/s

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

source_side_flow_rate

field Source Side Flow Rate

Units: m3/s

IP-Units: gal/min

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

source_side_heat_transfer_coefficient

field Source Side Heat Transfer Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Source Side Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of source_side_heat_transfer_coefficient or None if not set Return type:float

source_side_inlet_node_name

field Source Side Inlet Node Name

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

source_side_outlet_node_name

field Source Side Outlet Node Name

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

superheating

field Superheating

Units: C

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

class pyidf.plant_heating_and_cooling_equipment.PlantComponentTemperatureSource

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantComponent:TemperatureSource Simulates an object of pre-determined (constant or scheduled) source temperature The object introduces fluid into the plant loop at the specified temperature and at the same flow rate as the fluid enters the component Fluid entering the component vanishes equivalent to the relief air in an air system

design_volume_flow_rate

field Design Volume Flow Rate

The design volumetric flow rate for this source

Units: m3/s

IP-Units: gal/min

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

inlet_node

field Inlet Node

Name of the source inlet node

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

name

field Name

Component 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

outlet_node

field Outlet Node

Name of the source outlet node

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

source_temperature

field Source Temperature

Used if Temperature Specification Type = Constant

Units: C

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

source_temperature_schedule_name

field Source Temperature Schedule Name

Used if Temperature Specification Type = Scheduled

Units: C

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

temperature_specification_type

field Temperature Specification Type

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