Plant Heating and Cooling Equipment¶

28 object types from idfpy.models.plant_equipment · EnergyPlus 26.2

Object	Summary
Boiler:HotWater	This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics …
Boiler:Steam	This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics …
CentralHeatPumpSystem	This chiller bank can contain multiple chiller heaters and heat pump performance objects.
Chiller:Absorption	This indirect absorption chiller model is the empirical model from the Building Loads and System …
Chiller:Absorption:Indirect	This indirect absorption chiller model is an enhanced model from the Building Loads and System Thermodynamics …
Chiller:CombustionTurbine	This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program.
Chiller:ConstantCOP	This constant COP chiller model provides a means of quickly specifying a Chiller where performance data is …
Chiller:Electric	This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program.
Chiller:Electric:ASHRAE205	This chiller model utilizes ASHRAE Standard 205 compliant representations for chillers (Representation …
Chiller:Electric:EIR	This chiller model is the empirical model from the DOE-2 building Energy simulation program.
Chiller:Electric:ReformulatedEIR	This chiller model is an empirical model, a reformulated version of Chiller:Electric:EIR where the …
Chiller:EngineDriven	This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program.
ChillerHeater:Absorption:DirectFired	Direct fired gas absorption chiller-heater using performance curves similar to DOE-2
ChillerHeater:Absorption:DoubleEffect	Exhaust fired absorption chiller-heater using performance curves similar to DOE-2
ChillerHeaterPerformance:Electric:EIR	This chiller model is a generic chiller-heater where the cooling mode performance is a function of condenser …
DistrictCooling	Centralized source of chilled water, such as a district cooling system.
DistrictHeating:Steam	Centralized source of Steam, such as a district heating system.
DistrictHeating:Water	Centralized source of hot water, such as a district heating system.
HeatPump:AirToWater	air-to-water heat pump system which provides either chilled or hot water with single- or variable speed …
HeatPump:AirToWater:FuelFired:Cooling	The object defines a fuel-fired absorption heat pump based on equation-fit models.
HeatPump:AirToWater:FuelFired:Heating	The object defines a fuel-fired absorption heat pump based on equation-fit models.
HeatPump:PlantLoop:EIR:Cooling	An EIR formulated water to water heat pump model, cooling operation.
HeatPump:PlantLoop:EIR:Heating	An EIR formulated water to water heat pump model, heating operation
HeatPump:WaterToWater:EquationFit:Cooling	simple water-water heat pump curve-fit model
HeatPump:WaterToWater:EquationFit:Heating	simple water-water hp curve-fit model
HeatPump:WaterToWater:ParameterEstimation:Cooling	OSU parameter estimation model
HeatPump:WaterToWater:ParameterEstimation:Heating	OSU parameter estimation model
PlantComponent:TemperatureSource	Simulates an object of pre-determined (constant or scheduled) source temperature The object introduces fluid …

Boiler:HotWater¶

from idfpy.models import BoilerHotWater

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.

Field	Type	Default	Details
`name` Name required	string
`fuel_type` Fuel Type required	choice		One of `Coal`, `Diesel`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`nominal_capacity` Nominal Capacity	number or `Autosize` W
`nominal_thermal_efficiency` Nominal Thermal Efficiency required	number		Based on the higher heating value of fuel. Range: > 0
`efficiency_curve_temperature_evaluation_variable` Efficiency Curve Temperature Evaluation Variable	choice		One of `EnteringBoiler`, `LeavingBoiler`
`normalized_boiler_efficiency_curve_name` Normalized Boiler Efficiency Curve Name	reference		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 + C2PLR Quadratic = C1 + C2PLR + C3PLR^2 Cubic = C1 + C2PLR + C3PLR^2 + C4PLR^3 Biquadratic = C1 + C2PLR + C3PLR^2 + C4T + C5T^2 + C6PLRT QuadraticLinear = C1 + C2PLR + C3PLR^2 + (C4 + C5PLR + C6PLR^2)T BiCubic = C1+C2PLR+C3PLR^2+C4T+C5T2+C6PLRT+C7PLR^3+C8T3+C9PLR^{2T+C10PLR*T}2 TriQuadratic curves are not allowed. PLR = part-load ratio T = boiler water temperature (either entering or leaving). Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more
`design_water_flow_rate` Design Water Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	Range: ≥ 0
`boiler_water_inlet_node_name` Boiler Water Inlet Node Name required	string
`boiler_water_outlet_node_name` Boiler Water Outlet Node Name required	string
`water_outlet_upper_temperature_limit` Water Outlet Upper Temperature Limit	number C	`99.9`
`boiler_flow_mode` Boiler Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`on_cycle_parasitic_electric_load` On Cycle Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`off_cycle_parasitic_fuel_load` Off Cycle Parasitic Fuel Load	number W		parasitic fuel load when the boiler is not operating (i.e., standing pilot)

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Boiler, HVACTemplate:Plant:Boiler:ObjectReference, PlantEquipmentList

Boiler:Steam¶

from idfpy.models import BoilerSteam

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

Field	Type	Default	Details
`name` Name required	string
`fuel_type` Fuel Type required	choice		One of `Coal`, `Diesel`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`maximum_operating_pressure` Maximum Operating Pressure	number Pa	`160000.0`
`theoretical_efficiency` Theoretical Efficiency	number	`0.8`	Range: > 0, ≤ 1
`design_outlet_steam_temperature` Design Outlet Steam Temperature	number C	`100.0`
`nominal_capacity` Nominal Capacity	number or `Autosize` W
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`coefficient_1_of_fuel_use_function_of_part_load_ratio_curve` Coefficient 1 of Fuel Use Function of Part Load Ratio Curve	number
`coefficient_2_of_fuel_use_function_of_part_load_ratio_curve` Coefficient 2 of Fuel Use Function of Part Load Ratio Curve	number
`coefficient_3_of_fuel_use_function_of_part_load_ratio_curve` Coefficient 3 of Fuel Use Function of Part Load Ratio Curve	number
`water_inlet_node_name` Water Inlet Node Name	string
`steam_outlet_node_name` Steam Outlet Node Name	string
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

CentralHeatPumpSystem¶

from idfpy.models import 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.

Field	Type	Default	Details
`name` Name required	string
`cooling_loop_inlet_node_name` Cooling Loop Inlet Node Name required	string
`cooling_loop_outlet_node_name` Cooling Loop Outlet Node Name required	string
`source_loop_inlet_node_name` Source Loop Inlet Node Name required	string
`source_loop_outlet_node_name` Source Loop Outlet Node Name required	string
`heating_loop_inlet_node_name` Heating Loop Inlet Node Name required	string
`heating_loop_outlet_node_name` Heating Loop Outlet Node Name required	string
`ancillary_power` Ancillary Power	number W	`0.0`	Power as demanded from any auxiliary controls Range: ≥ 0
`ancillary_operation_schedule_name` Ancillary Operation Schedule Name	reference		This value from this schedule is multiplied times the Ancillary Power Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`chiller_heater_modules_performance_component_object_type_1` Chiller Heater Modules Performance Component Object Type 1 required	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_1` Chiller Heater Modules Performance Component Name 1 required	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_1` Chiller Heater Modules Control Schedule Name 1 required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_1` Number of Chiller Heater Modules 1	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_2` Chiller Heater Modules Performance Component Object Type 2	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_2` Chiller Heater Modules Performance Component Name 2	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_2` Chiller Heater Modules Control Schedule Name 2	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_2` Number of Chiller Heater Modules 2	integer	`1`	Range: ≥ 1
`chiller_heater_performance_component_object_type_3` Chiller Heater Performance Component Object Type 3	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_performance_component_name_3` Chiller Heater Performance Component Name 3	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_3` Chiller Heater Modules Control Schedule Name 3	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_3` Number of Chiller Heater Modules 3	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_4` Chiller Heater Modules Performance Component Object Type 4	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_4` Chiller Heater Modules Performance Component Name 4	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_4` Chiller Heater Modules Control Schedule Name 4	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_4` Number of Chiller Heater Modules 4	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_5` Chiller Heater Modules Performance Component Object Type 5	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_models_performance_component_name_5` Chiller Heater Models Performance Component Name 5	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_5` Chiller Heater Modules Control Schedule Name 5	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_5` Number of Chiller Heater Modules 5	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_6` Chiller Heater Modules Performance Component Object Type 6	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_6` Chiller Heater Modules Performance Component Name 6	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_6` Chiller Heater Modules Control Schedule Name 6	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_6` Number of Chiller Heater Modules 6	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_7` Chiller Heater Modules Performance Component Object Type 7	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_7` Chiller Heater Modules Performance Component Name 7	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_7` Chiller Heater Modules Control Schedule Name 7	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_7` Number of Chiller Heater Modules 7	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_8` Chiller Heater Modules Performance Component Object Type 8	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_8` Chiller Heater Modules Performance Component Name 8	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_8` Chiller Heater Modules Control Schedule Name 8	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_8` Number of Chiller Heater Modules 8	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_9` Chiller Heater Modules Performance Component Object Type 9	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_9` Chiller Heater Modules Performance Component Name 9	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_9` Chiller Heater Modules Control Schedule Name 9	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_9` Number of Chiller Heater Modules 9	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_10` Chiller Heater Modules Performance Component Object Type 10	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_10` Chiller Heater Modules Performance Component Name 10	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_10` Chiller Heater Modules Control Schedule Name 10	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_10` Number of Chiller Heater Modules 10	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_11` Chiller Heater Modules Performance Component Object Type 11	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_11` Chiller Heater Modules Performance Component Name 11	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_module_control_schedule_name_11` Chiller Heater Module Control Schedule Name 11	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_11` Number of Chiller Heater Modules 11	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_12` Chiller Heater Modules Performance Component Object Type 12	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_12` Chiller Heater Modules Performance Component Name 12	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_12` Chiller Heater Modules Control Schedule Name 12	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_12` Number of Chiller Heater Modules 12	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_13` Chiller Heater Modules Performance Component Object Type 13	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_13` Chiller Heater Modules Performance Component Name 13	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_13` Chiller Heater Modules Control Schedule Name 13	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_13` Number of Chiller Heater Modules 13	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_14` Chiller Heater Modules Performance Component Object Type 14	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_14` Chiller Heater Modules Performance Component Name 14	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_14` Chiller Heater Modules Control Schedule Name 14	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_14` Number of Chiller Heater Modules 14	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_15` Chiller Heater Modules Performance Component Object Type 15	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_15` Chiller Heater Modules Performance Component Name 15	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_15` Chiller Heater Modules Control Schedule Name 15	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_15` Number of Chiller Heater Modules 15	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_16` Chiller Heater Modules Performance Component Object Type 16	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_16` Chiller Heater Modules Performance Component Name 16	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_16` Chiller Heater Modules Control Schedule Name 16	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_16` Number of Chiller Heater Modules 16	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_17` Chiller Heater Modules Performance Component Object Type 17	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_17` Chiller Heater Modules Performance Component Name 17	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_17` Chiller Heater Modules Control Schedule Name 17	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_17` Number of Chiller Heater Modules 17	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_18` Chiller Heater Modules Performance Component Object Type 18	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_18` Chiller Heater Modules Performance Component Name 18	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_control_schedule_name_18` Chiller Heater Modules Control Control Schedule Name 18	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_18` Number of Chiller Heater Modules 18	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_19` Chiller Heater Modules Performance Component Object Type 19	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_19` Chiller Heater Modules Performance Component Name 19	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_19` Chiller Heater Modules Control Schedule Name 19	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_19` Number of Chiller Heater Modules 19	integer	`1`	Range: ≥ 1
`chiller_heater_modules_performance_component_object_type_20` Chiller Heater Modules Performance Component Object Type 20	choice		One of `ChillerHeaterPerformance:Electric:EIR`
`chiller_heater_modules_performance_component_name_20` Chiller Heater Modules Performance Component Name 20	reference		Names a ChillerHeaterPerformance:Electric:EIR
`chiller_heater_modules_control_schedule_name_20` Chiller Heater Modules Control Schedule Name 20	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_chiller_heater_modules_20` Number of Chiller Heater Modules 20	integer	`1`	Range: ≥ 1

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

Chiller:Absorption¶

from idfpy.models import ChillerAbsorption

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.

Field	Type	Default	Details
`name` Name required	string
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_pumping_power` Nominal Pumping Power required	number or `Autosize` W
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name required	string
`condenser_outlet_node_name` Condenser Outlet Node Name required	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`design_condenser_inlet_temperature` Design Condenser Inlet Temperature	number C
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s		For variable volume this is the max flow & for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s		The steam use coefficients below specify the steam use as a fraction of chiller operating capacity
`coefficient_1_of_the_hot_water_or_steam_use_part_load_ratio_curve` Coefficient 1 of the Hot Water or Steam Use Part Load Ratio Curve	number
`coefficient_2_of_the_hot_water_or_steam_use_part_load_ratio_curve` Coefficient 2 of the Hot Water or Steam Use Part Load Ratio Curve	number
`coefficient_3_of_the_hot_water_or_steam_use_part_load_ratio_curve` Coefficient 3 of the Hot Water or Steam Use Part Load Ratio Curve	number
`coefficient_1_of_the_pump_electric_use_part_load_ratio_curve` Coefficient 1 of the Pump Electric Use Part Load Ratio Curve	number		The pump electric use coefficients specify the pumping power as a Fraction of Nominal pumping power
`coefficient_2_of_the_pump_electric_use_part_load_ratio_curve` Coefficient 2 of the Pump Electric Use Part Load Ratio Curve	number
`coefficient_3_of_the_pump_electric_use_part_load_ratio_curve` Coefficient 3 of the Pump Electric Use Part Load Ratio Curve	number
`chilled_water_outlet_temperature_lower_limit` Chilled Water Outlet Temperature Lower Limit	number C
`generator_inlet_node_name` Generator Inlet Node Name	string
`generator_outlet_node_name` Generator Outlet Node Name	string
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`generator_heat_source_type` Generator Heat Source Type	choice	`Steam`	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. One of `HotWater`, `Steam`
`design_generator_fluid_flow_rate` Design Generator Fluid Flow Rate	number or `Autosize` m3/s
`degree_of_subcooling_in_steam_generator` Degree of Subcooling in Steam Generator	number C	`1.0`	This field is not used when the generator inlet/outlet nodes are not specified or the generator is connected to a hot water loop.
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:Absorption:Indirect¶

from idfpy.models import ChillerAbsorptionIndirect

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.

Field	Type	Default	Details
`name` Name required	string
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_pumping_power` Nominal Pumping Power required	number or `Autosize` W
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name required	string
`condenser_outlet_node_name` Condenser Outlet Node Name required	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`design_condenser_inlet_temperature` Design Condenser Inlet Temperature	number C	`30.0`	Used only when condenser flow rate is autosized.
`condenser_inlet_temperature_lower_limit` Condenser Inlet Temperature Lower Limit	number C	`15.0`	Provides warnings when entering condenser temperature is below minimum. Capacity is not adjusted when entering condenser temperature is below minimum.
`chilled_water_outlet_temperature_lower_limit` Chilled Water Outlet Temperature Lower Limit	number C	`5.0`	Capacity is adjusted when leaving chilled water temperature is below minimum.
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s	`Autosize`	For variable flow this is the max flow & for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s	`Autosize`
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`generator_heat_input_function_of_part_load_ratio_curve_name` Generator Heat Input Function of Part Load Ratio Curve Name required	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`pump_electric_input_function_of_part_load_ratio_curve_name` Pump Electric Input Function of Part Load Ratio Curve Name	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`generator_inlet_node_name` Generator Inlet Node Name	string		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.
`generator_outlet_node_name` Generator Outlet Node Name	string		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.
`capacity_correction_function_of_condenser_temperature_curve_name` Capacity Correction Function of Condenser Temperature Curve Name	reference		Curve which shows the change in normalized capacity to changes in condenser temperature. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`capacity_correction_function_of_chilled_water_temperature_curve_name` Capacity Correction Function of Chilled Water Temperature Curve Name	reference		Curve which shows the change in normalized capacity to changes in leaving chilled water temperature. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`capacity_correction_function_of_generator_temperature_curve_name` Capacity Correction Function of Generator Temperature Curve Name	reference		Used when generator fluid type is hot water Curve which shows the change in normalized capacity to changes in generator temperature. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`generator_heat_input_correction_function_of_condenser_temperature_curve_name` Generator Heat Input Correction Function of Condenser Temperature Curve Name	reference		Curve which shows the change in normalized heat input to changes in condenser temperature. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`generator_heat_input_correction_function_of_chilled_water_temperature_curve_name` Generator Heat Input Correction Function of Chilled Water Temperature Curve Name	reference		Curve which shows the change in normalized heat input to changes in leaving chilled water temperature. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`generator_heat_source_type` Generator Heat Source Type	choice	`Steam`	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. One of `HotWater`, `Steam`
`design_generator_fluid_flow_rate` Design Generator Fluid Flow Rate	number or `Autosize` m3/s		For variable flow this is the max flow and for constant flow this is the flow.
`temperature_lower_limit_generator_inlet` Temperature Lower Limit Generator Inlet	number C	`0.0`	Provides warnings when entering generator temperature is below minimum. Capacity is not adjusted when entering generator temperature is below minimum.
`degree_of_subcooling_in_steam_generator` Degree of Subcooling in Steam Generator	number C	`1.0`	This field is not used when the generator inlet/outlet nodes are not specified or the generator is connected to a hot water loop. Range: ≥ 0, ≤ 20
`degree_of_subcooling_in_steam_condensate_loop` Degree of Subcooling in Steam Condensate Loop	number C	`0.0`	This field is not used when the generator inlet/outlet nodes are not specified or the generator is connected to a hot water loop. Range: ≥ 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:CombustionTurbine¶

from idfpy.models import ChillerCombustionTurbine

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.

Field	Type	Default	Details
`name` Name required	string
`condenser_type` Condenser Type	choice	`AirCooled`	One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_cop` Nominal COP required	number W/W		Range: > 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`design_condenser_inlet_temperature` Design Condenser Inlet Temperature	number C
`temperature_rise_coefficient` Temperature Rise Coefficient required	number		Range: > 0
`design_chilled_water_outlet_temperature` Design Chilled Water Outlet Temperature	number C
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s		For variable volume this is the max flow & for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s		This field is not used for Condenser Type = AirCooled or EvaporativelyCooled
`coefficient_1_of_capacity_ratio_curve` Coefficient 1 of Capacity Ratio Curve	number
`coefficient_2_of_capacity_ratio_curve` Coefficient 2 of Capacity Ratio Curve	number
`coefficient_3_of_capacity_ratio_curve` Coefficient 3 of Capacity Ratio Curve	number
`coefficient_1_of_power_ratio_curve` Coefficient 1 of Power Ratio Curve	number
`coefficient_2_of_power_ratio_curve` Coefficient 2 of Power Ratio Curve	number
`coefficient_3_of_power_ratio_curve` Coefficient 3 of Power Ratio Curve	number
`coefficient_1_of_full_load_ratio_curve` Coefficient 1 of Full Load Ratio Curve	number
`coefficient_2_of_full_load_ratio_curve` Coefficient 2 of Full Load Ratio Curve	number
`coefficient_3_of_full_load_ratio_curve` Coefficient 3 of Full Load Ratio Curve	number
`chilled_water_outlet_temperature_lower_limit` Chilled Water Outlet Temperature Lower Limit	number C		Special Gas Turbine Chiller Parameters Below
`coefficient_1_of_fuel_input_curve` Coefficient 1 of Fuel Input Curve	number
`coefficient_2_of_fuel_input_curve` Coefficient 2 of Fuel Input Curve	number
`coefficient_3_of_fuel_input_curve` Coefficient 3 of Fuel Input Curve	number
`coefficient_1_of_temperature_based_fuel_input_curve` Coefficient 1 of Temperature Based Fuel Input Curve	number
`coefficient_2_of_temperature_based_fuel_input_curve` Coefficient 2 of Temperature Based Fuel Input Curve	number
`coefficient_3_of_temperature_based_fuel_input_curve` Coefficient 3 of Temperature Based Fuel Input Curve	number
`coefficient_1_of_exhaust_flow_curve` Coefficient 1 of Exhaust Flow Curve	number
`coefficient_2_of_exhaust_flow_curve` Coefficient 2 of Exhaust Flow Curve	number
`coefficient_3_of_exhaust_flow_curve` Coefficient 3 of Exhaust Flow Curve	number
`coefficient_1_of_exhaust_gas_temperature_curve` Coefficient 1 of Exhaust Gas Temperature Curve	number
`coefficient_2_of_exhaust_gas_temperature_curve` Coefficient 2 of Exhaust Gas Temperature Curve	number
`coefficient_3_of_exhaust_gas_temperature_curve` Coefficient 3 of Exhaust Gas Temperature Curve	number
`coefficient_1_of_temperature_based_exhaust_gas_temperature_curve` Coefficient 1 of Temperature Based Exhaust Gas Temperature Curve	number
`coefficient_2_of_temperature_based_exhaust_gas_temperature_curve` Coefficient 2 of Temperature Based Exhaust Gas Temperature Curve	number
`coefficient_3_of_temperature_based_exhaust_gas_temperature_curve` Coefficient 3 of Temperature Based Exhaust Gas Temperature Curve	number
`coefficient_1_of_recovery_lube_heat_curve` Coefficient 1 of Recovery Lube Heat Curve	number
`coefficient_2_of_recovery_lube_heat_curve` Coefficient 2 of Recovery Lube Heat Curve	number
`coefficient_3_of_recovery_lube_heat_curve` Coefficient 3 of Recovery Lube Heat Curve	number
`coefficient_1_of_u_factor_times_area_curve` Coefficient 1 of U-Factor Times Area Curve	number
`coefficient_2_of_u_factor_times_area_curve` Coefficient 2 of U-Factor Times Area Curve	number		typical value .9 Range: ≤ 2
`gas_turbine_engine_capacity` Gas Turbine Engine Capacity	number or `Autosize` W
`maximum_exhaust_flow_per_unit_of_power_output` Maximum Exhaust Flow per Unit of Power Output	number (kg/s)/W
`design_steam_saturation_temperature` Design Steam Saturation Temperature	number C
`fuel_higher_heating_value` Fuel Higher Heating Value	number kJ/kg
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number or `Autosize` m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered.
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`fuel_type` Fuel Type	choice	`NaturalGas`	One of `Diesel`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`heat_recovery_maximum_temperature` Heat Recovery Maximum Temperature	number C	`80.0`	Range: ≥ 0, ≤ 100
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	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. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_heat_recovery_relative_capacity_fraction` Condenser Heat Recovery Relative Capacity Fraction	number		This optional field is the fraction of total rejected heat that can be recovered at full load. Also used to autosize Design Heat Recovery Water Flow Rate as a fraction of Design Condenser Water Flow Rate. Range: ≥ 0, ≤ 1
`turbine_engine_efficiency` Turbine Engine Efficiency	number	`0.35`	This optional field is the nominal turbine engine efficiency and is used when Gas Turbine Engine Capacity is set to Autosize

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:ConstantCOP¶

from idfpy.models import ChillerConstantCOP

This constant COP chiller model provides a means of quickly specifying a Chiller where performance data is not available.

Field	Type	Default	Details
`name` Name required	string
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_cop` Nominal COP required	number W/W		Range: > 0
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s		For variable volume this is the maximum flow and for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s		This field is not used for Condenser Type = AirCooled or EvaporativelyCooled
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string
`condenser_type` Condenser Type	choice	`AirCooled`	One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	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. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`thermosiphon_capacity_fraction_curve_name` Thermosiphon Capacity Fraction Curve Name	reference		quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used Tevap, out = evaporator outlet temperature Tcond, in = condenser inlet temperature If this field is blank the thermosiphon model is disabled. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`thermosiphon_minimum_temperature_difference` Thermosiphon Minimum Temperature Difference	number	`0.0`	Thermosiphon model is disabled below this minimum limit and when the load is greater than calculated using the previous field. Range: ≥ 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:Electric¶

from idfpy.models import ChillerElectric

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.

Field	Type	Default	Details
`name` Name required	string
`condenser_type` Condenser Type	choice	`AirCooled`	One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_cop` Nominal COP required	number W/W		Range: > 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`design_condenser_inlet_temperature` Design Condenser Inlet Temperature	number C
`temperature_rise_coefficient` Temperature Rise Coefficient required	number		Range: > 0
`design_chilled_water_outlet_temperature` Design Chilled Water Outlet Temperature	number C
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s		For variable volume this is the maximum flow & for constant flow this is the flow.
`design_condenser_fluid_flow_rate` Design Condenser Fluid Flow Rate	number or `Autosize` m3/s		For Condenser Type = AirCooled or EvaporativelyCooled, this flow rate is used to calculate the condenser outlet node conditions. If this field is blank or Autosize, the flow rate is estimated using 850 cfm/ton of nominal capacity.
`coefficient_1_of_capacity_ratio_curve` Coefficient 1 of Capacity Ratio Curve	number
`coefficient_2_of_capacity_ratio_curve` Coefficient 2 of Capacity Ratio Curve	number
`coefficient_3_of_capacity_ratio_curve` Coefficient 3 of Capacity Ratio Curve	number
`coefficient_1_of_power_ratio_curve` Coefficient 1 of Power Ratio Curve	number
`coefficient_2_of_power_ratio_curve` Coefficient 2 of Power Ratio Curve	number
`coefficient_3_of_power_ratio_curve` Coefficient 3 of Power Ratio Curve	number
`coefficient_1_of_full_load_ratio_curve` Coefficient 1 of Full Load Ratio Curve	number
`coefficient_2_of_full_load_ratio_curve` Coefficient 2 of Full Load Ratio Curve	number
`coefficient_3_of_full_load_ratio_curve` Coefficient 3 of Full Load Ratio Curve	number
`chilled_water_outlet_temperature_lower_limit` Chilled Water Outlet Temperature Lower Limit	number C
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number or `Autosize` m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered. Heat recovery is only available with Condenser Type = WaterCooled.
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	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. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_heat_recovery_relative_capacity_fraction` Condenser Heat Recovery Relative Capacity Fraction	number		This optional field is the fraction of total rejected heat that can be recovered at full load Range: ≥ 0, ≤ 1
`heat_recovery_inlet_high_temperature_limit_schedule_name` Heat Recovery Inlet High Temperature Limit Schedule Name	reference		This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_recovery_leaving_temperature_setpoint_node_name` Heat Recovery Leaving Temperature Setpoint Node Name	string		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
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`thermosiphon_capacity_fraction_curve_name` Thermosiphon Capacity Fraction Curve Name	reference		quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used Tevap, out = evaporator outlet temperature Tcond, in = condenser inlet temperature If this field is blank the thermosiphon model is disabled. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`thermosiphon_minimum_temperature_difference` Thermosiphon Minimum Temperature Difference	number	`0.0`	Thermosiphon model is disabled below this minimum limit and when the load is greater than calculated using the previous field. Range: ≥ 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:Electric:ASHRAE205¶

from idfpy.models import ChillerElectricASHRAE205

This chiller model utilizes ASHRAE Standard 205 compliant representations for chillers (Representation Specification RS0001).

Field	Type	Default	Details
`name` Name required	string
`representation_file_name` Representation File Name required	string		The name of the ASHRAE205 RS0001 (chiller) representation file
`performance_interpolation_method` Performance Interpolation Method	choice	`Linear`	One of `Cubic`, `Linear`
`rated_capacity` Rated Capacity	number or `Autosize` W	`Autosize`	Not yet implemented / reserved for future use. Full load capacity at AHRI 550/590 test conditions. Used to scale representation data.
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized flow rates. Range: > 0
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		Used to determine standby losses One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Any energy imbalance on the chiller results in heat added to this zone. Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required for Ambient Temperature Indicator=Outdoors
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`chilled_water_maximum_requested_flow_rate` Chilled Water Maximum Requested Flow Rate	number or `Autosize` m3/s	`Autosize`
`condenser_inlet_node_name` Condenser Inlet Node Name	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string
`condenser_maximum_requested_flow_rate` Condenser Maximum Requested Flow Rate	number or `Autosize` m3/s	`Autosize`
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`oil_cooler_inlet_node_name` Oil Cooler Inlet Node Name	string		Use if the oil cooler uses an external cooling loop, otherwise the oil cooler will add heat to the ambient conditions (i.e., it is air cooled).
`oil_cooler_outlet_node_name` Oil Cooler Outlet Node Name	string
`oil_cooler_design_flow_rate` Oil Cooler Design Flow Rate	number m3/s		Range: > 0
`auxiliary_inlet_node_name` Auxiliary Inlet Node Name	string		Use if the auxiliary components of the chiller use an external cooling loop, otherwise the auxiliary components will add heat to the ambient conditions (i.e., they are air cooled).
`auxiliary_outlet_node_name` Auxiliary Outlet Node Name	string
`auxiliary_cooling_design_flow_rate` Auxiliary Cooling Design Flow Rate	number m3/s		Range: > 0
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string		Not yet implemented / reserved for future use. Heat recovery is not yet within scope of ASHRAE Standard 205.
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string		Not yet implemented / reserved for future use. Heat recovery is not yet within scope of ASHRAE Standard 205.
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:Electric:EIR¶

from idfpy.models import ChillerElectricEIR

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.

Field	Type	Default	Details
`name` Name required	string
`reference_capacity` Reference Capacity required	number or `Autosize` W
`reference_cop` Reference COP required	number W/W		Efficiency of the chiller compressor (cooling output/compressor energy input). Condenser fan power should not be included here. Range: > 0
`reference_leaving_chilled_water_temperature` Reference Leaving Chilled Water Temperature	number C	`6.67`
`reference_entering_condenser_fluid_temperature` Reference Entering Condenser Fluid Temperature	number C	`29.4`
`reference_chilled_water_flow_rate` Reference Chilled Water Flow Rate	number or `Autosize` m3/s
`reference_condenser_fluid_flow_rate` Reference Condenser Fluid Flow Rate	number or `Autosize` m3/s		This field is only used for Condenser Type = AirCooled or EvaporativelyCooled when Heat Recovery is specified
`cooling_capacity_function_of_temperature_curve_name` Cooling Capacity Function of Temperature Curve Name required	reference		Cooling capacity as a function of CW supply temp and entering condenser temp curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Electric Input to Cooling Output Ratio Function of Temperature Curve Name required	reference		Electric Input Ratio (EIR) as a function of temperature EIR = 1/COP curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name required	reference		Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR) EIR = 1/COP quadratic curve = a + bPLR + cPLR**2 is typical, other univariate curves may be used PLR = part load ratio (cooling load/steady state capacity) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	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. Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Maximum allowable part load ratio. Must be greater than or equal to Minimum Part Load Ratio. Range: > 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`minimum_unloading_ratio` Minimum Unloading Ratio	number	`0.2`	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. Range: ≥ 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name	string		Not required if air-cooled or evaporatively-cooled
`condenser_outlet_node_name` Condenser Outlet Node Name	string		Not required if air-cooled or evaporatively-cooled
`condenser_type` Condenser Type	choice	`WaterCooled`	One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`condenser_fan_power_ratio` Condenser Fan Power Ratio	number W/W	`0.0`	Use for air-cooled or evaporatively-cooled condensers. Ratio of condenser fan power to reference chiller capacity Range: ≥ 0
`fraction_of_compressor_electric_consumption_rejected_by_condenser` Fraction of Compressor Electric Consumption Rejected by Condenser	number	`1.0`	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. Range: > 0, ≤ 1
`leaving_chilled_water_lower_temperature_limit` Leaving Chilled Water Lower Temperature Limit	number C	`2.0`
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number or `Autosize` m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered. Heat recovery is only available with Condenser Type = WaterCooled.
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	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. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_heat_recovery_relative_capacity_fraction` Condenser Heat Recovery Relative Capacity Fraction	number		This optional field is the fraction of total rejected heat that can be recovered at full load Range: ≥ 0, ≤ 1
`heat_recovery_inlet_high_temperature_limit_schedule_name` Heat Recovery Inlet High Temperature Limit Schedule Name	reference		This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_recovery_leaving_temperature_setpoint_node_name` Heat Recovery Leaving Temperature Setpoint Node Name	string		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
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`condenser_flow_control` Condenser Flow Control	choice	`ConstantFlow`	Select the chiller condenser flow request mode. With "ConstantFlow" a chiller will always request its maximum condenser flow rate. With "ModulatedChillerPLR" the condenser flow request corresponds to the chiller part load ratio multiplied by the chiller maximum condenser flow rate. With "ModulatedLoopPLR" the chiller will request a flow rate that is function of the chilled water loop's part load ratio, see the "Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name" input. With "ModulatedDeltaTemperature" the chiller will request the flow rate required to meet the condenser loop load based on the condenser leaving fluid temperature and a reference temperature, see the "Temperature Difference Across Condenser" and "Temperature Difference Across Condenser Schedule Name" input. Use "ConstantFlow" when modeling a constant flow condenser plant loop, choose one of the other inputs when modeling a variable flow condenser plant loop. One of `ConstantFlow`, `ModulatedChillerPLR`, `ModulatedDeltaTemperature`, `ModulatedLoopPLR`
`condenser_loop_flow_rate_fraction_function_of_loop_part_load_ratio_curve_name` Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name	reference		Condenser loop flow rate fraction as a function of loop part load ratio CWFR = C * PLR + D Where: CWFR is the condenser water flow fraction (actual/design) C and D are coefficients, see "Optimizing Design & Control Of Chilled Water Plants, Part 5", S. Taylor, ASHRAE Journal June 2012 PLR is the chilled water plant loop part load ratio (actual/design) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`temperature_difference_across_condenser_schedule_name` Temperature Difference Across Condenser Schedule Name	reference		A schedule that defines the temperature difference across the condenser. This input is used to calculate the condenser flow. This input is only used when "Condenser Flow Control" is set to "ModulatedDeltaTemperature". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_minimum_flow_fraction` Condenser Minimum Flow Fraction	number	`0.2`	This input corresponds to the minimum flow fraction to be simulated. The minimum condenser flow corresponds to this fraction multiplied by the maximum condenser flow rate. This input is only used when the "Condenser Flow Control" input is set to "ModulatedChillerPLR", "ModulatedLoopPLR" or "ModulatedDeltaTemperature". Range: ≥ 0, ≤ 1
`thermosiphon_capacity_fraction_curve_name` Thermosiphon Capacity Fraction Curve Name	reference		quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used Tevap, out = evaporator outlet temperature Tcond, in = condenser inlet temperature If this field is blank the thermosiphon model is disabled. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`thermosiphon_minimum_temperature_difference` Thermosiphon Minimum Temperature Difference	number	`0.0`	Thermosiphon model is disabled below this minimum limit and when the load is greater than calculated using the previous field. Range: ≥ 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:Electric:ReformulatedEIR¶

from idfpy.models import ChillerElectricReformulatedEIR

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.

Field	Type	Default	Details
`name` Name required	string
`reference_capacity` Reference Capacity required	number or `Autosize` W
`reference_cop` Reference COP required	number W/W		Efficiency of the chiller compressor (cooling output/compressor energy input). Condenser fan power should not be included here. Range: > 0
`reference_leaving_chilled_water_temperature` Reference Leaving Chilled Water Temperature	number C	`6.67`
`reference_leaving_condenser_water_temperature` Reference Leaving Condenser Water Temperature	number C	`35.0`
`reference_chilled_water_flow_rate` Reference Chilled Water Flow Rate	number or `Autosize` m3/s
`reference_condenser_water_flow_rate` Reference Condenser Water Flow Rate	number or `Autosize` m3/s
`cooling_capacity_function_of_temperature_curve_name` Cooling Capacity Function of Temperature Curve Name required	reference		Cooling capacity as a function of supply (leaving) chilled water temperature and leaving condenser fluid temperature curve = a + bCWS + cCWS*2 + dLCT + eLCT2 + fCWS*LCT CWS = supply (leaving) chilled water temperature(C) LCT = leaving condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Electric Input to Cooling Output Ratio Function of Temperature Curve Name required	reference		Electric Input Ratio (EIR) as a function of supply (leaving) chilled water temperature and leaving condenser fluid temperature. EIR = 1/COP. curve = a + bCWS + cCWS*2 + dLCT + eLCT2 + fCWS*LCT CWS = supply (leaving) chilled water temperature(C) LCT = leaving condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_type` Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Type	choice	`LeavingCondenserWaterTemperature`	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. One of `LeavingCondenserWaterTemperature`, `Lift`
`electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name required	reference		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:Lookup Bicubic curve = a + bLCT + cLCT*2 + dPLR + ePLR2 + fLCTPLR + g0 + hPLR3 + i0 + j0 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:Lookup ChillerPartLoadWithLiftCurves curve = a + b(dT) + c(dT)*2 + dPLR + ePLR2 + f(dT)PLR + g(dT)*3 + hPLR*3 + i(dT)2PLR + j(dT)PLR2 + k(dT)2PLR*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 Names a Curve:Bicubic, Curve:Biquadratic, Curve:ChillerPartLoadWithLift, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Curve:Triquadratic, Table:Lookup
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	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. Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Maximum allowable part load ratio. Must be greater than or equal to Minimum Part Load Ratio. Range: > 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`minimum_unloading_ratio` Minimum Unloading Ratio	number	`0.2`	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. Range: ≥ 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name required	string
`condenser_outlet_node_name` Condenser Outlet Node Name required	string
`fraction_of_compressor_electric_consumption_rejected_by_condenser` Fraction of Compressor Electric Consumption Rejected by Condenser	number	`1.0`	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. Range: > 0, ≤ 1
`leaving_chilled_water_lower_temperature_limit` Leaving Chilled Water Lower Temperature Limit	number C	`2.0`
`chiller_flow_mode_type` Chiller Flow Mode Type	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number or `Autosize` m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered.
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`condenser_heat_recovery_relative_capacity_fraction` Condenser Heat Recovery Relative Capacity Fraction	number		This optional field is the fraction of total rejected heat that can be recovered at full load Range: ≥ 0, ≤ 1
`heat_recovery_inlet_high_temperature_limit_schedule_name` Heat Recovery Inlet High Temperature Limit Schedule Name	reference		This optional schedule of temperatures will turn off heat recovery if inlet exceeds the value Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_recovery_leaving_temperature_setpoint_node_name` Heat Recovery Leaving Temperature Setpoint Node Name	string		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
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`condenser_flow_control` Condenser Flow Control	choice	`ConstantFlow`	Select the chiller condenser flow request mode. With "ConstantFlow" a chiller will always request its maximum condenser flow rate. With "ModulatedChillerPLR" the condenser flow request corresponds to the chiller part load ratio multiplied by the chiller maximum condenser flow rate. With "ModulatedLoopPLR" the chiller will request a flow rate that is function of the chilled water loop's part load ratio, see the "Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name" input. With "ModulatedDeltaTemperature" the chiller will request the flow rate required to meet the condenser loop load based on the condenser leaving fluid temperature and a reference temperature, see the "Temperature Difference Across Condenser" and "Temperature Difference Across Condenser Schedule Name" input. Use "ConstantFlow" when modeling a constant flow condenser plant loop, choose one of the other inputs when modeling a variable flow condenser plant loop. One of `ConstantFlow`, `ModulatedChillerPLR`, `ModulatedDeltaTemperature`, `ModulatedLoopPLR`
`condenser_loop_flow_rate_fraction_function_of_loop_part_load_ratio_curve_name` Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name	reference		Condenser loop flow rate fraction as a function of loop part load ratio CWFR = C * PLR + D Where: CWFR is the condenser water flow fraction (actual/design) C and D are coefficients, see "Optimizing Design & Control Of Chilled Water Plants, Part 5", S. Taylor, ASHRAE Journal June 2012 PLR is the chilled water plant loop part load ratio (actual/design) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`temperature_difference_across_condenser_schedule_name` Temperature Difference Across Condenser Schedule Name	reference		A schedule that defines the temperature difference across the condenser. This input is used to calculate the condenser flow. This input is only used when "Condenser Flow Control" is set to "ModulatedDeltaTemperature". Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_minimum_flow_fraction` Condenser Minimum Flow Fraction	number	`0.2`	This input corresponds to the minimum flow fraction to be simulated. The minimum condenser flow corresponds to this fraction multiplied by the maximum condenser flow rate. This input is only used when the "Condenser Flow Control" input is set to "ModulatedChillerPLR", "ModulatedLoopPLR" or "ModulatedDeltaTemperature". Range: ≥ 0, ≤ 1
`thermosiphon_capacity_fraction_curve_name` Thermosiphon Capacity Fraction Curve Name	reference		quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used Tevap, out = evaporator outlet temperature Tcond, in = condenser inlet temperature If this field is blank the thermosiphon model is disabled. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`thermosiphon_minimum_temperature_difference` Thermosiphon Minimum Temperature Difference	number	`0.0`	Thermosiphon model is disabled below this minimum limit and when the load is greater than calculated using the previous field. Range: ≥ 0

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

Chiller:EngineDriven¶

from idfpy.models import ChillerEngineDriven

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.

Field	Type	Default	Details
`name` Name required	string
`condenser_type` Condenser Type	choice	`AirCooled`	One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`nominal_capacity` Nominal Capacity required	number or `Autosize` W
`nominal_cop` Nominal COP required	number W/W		Nominal Refrigeration Cycle COP Range: > 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`design_condenser_inlet_temperature` Design Condenser Inlet Temperature	number C
`temperature_rise_coefficient` Temperature Rise Coefficient required	number		Range: > 0
`design_chilled_water_outlet_temperature` Design Chilled Water Outlet Temperature	number C
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s		For variable volume this is the maximum flow and for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s		This field is not used for Condenser Type = AirCooled or EvaporativelyCooled
`coefficient_1_of_capacity_ratio_curve` Coefficient 1 of Capacity Ratio Curve	number
`coefficient_2_of_capacity_ratio_curve` Coefficient 2 of Capacity Ratio Curve	number
`coefficient_3_of_capacity_ratio_curve` Coefficient 3 of Capacity Ratio Curve	number
`coefficient_1_of_power_ratio_curve` Coefficient 1 of Power Ratio Curve	number
`coefficient_2_of_power_ratio_curve` Coefficient 2 of Power Ratio Curve	number
`coefficient_3_of_power_ratio_curve` Coefficient 3 of Power Ratio Curve	number
`coefficient_1_of_full_load_ratio_curve` Coefficient 1 of Full Load Ratio Curve	number
`coefficient_2_of_full_load_ratio_curve` Coefficient 2 of Full Load Ratio Curve	number
`coefficient_3_of_full_load_ratio_curve` Coefficient 3 of Full Load Ratio Curve	number
`chilled_water_outlet_temperature_lower_limit` Chilled Water Outlet Temperature Lower Limit	number C		Special EngineDriven Chiller Parameters Below
`fuel_use_curve_name` Fuel Use Curve Name	reference		Curve is a function of Part Load Ratio (PLR) curve = a + bPLR + cPLR**2 PLR = Ratio of evaporator heat transfer rate to nominal capacity Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`jacket_heat_recovery_curve_name` Jacket Heat Recovery Curve Name	reference		Curve is a function of Part Load Ratio (PLR) curve = a + bPLR + cPLR**2 PLR = Ratio of evaporator heat transfer rate to nominal capacity Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`lube_heat_recovery_curve_name` Lube Heat Recovery Curve Name	reference		Curve is a function of Part Load Ratio (PLR) curve = a + bPLR + cPLR**2 PLR = Ratio of evaporator heat transfer rate to nominal capacity Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`total_exhaust_energy_curve_name` Total Exhaust Energy Curve Name	reference		Curve is a function of Part Load Ratio (PLR) curve = a + bPLR + cPLR**2 PLR = Ratio of evaporator heat transfer rate to nominal capacity Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`exhaust_temperature_curve_name` Exhaust Temperature Curve Name	reference		Curve is a function of Part Load Ratio (PLR) curve = a + bPLR + cPLR**2 PLR = Ratio of evaporator heat transfer rate to nominal capacity Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`coefficient_1_of_u_factor_times_area_curve` Coefficient 1 of U-Factor Times Area Curve	number		curve = C1 * (nominal capacity)**C2
`coefficient_2_of_u_factor_times_area_curve` Coefficient 2 of U-Factor Times Area Curve	number		curve = C1 * (nominal capacity)**C2 typical value .9 Range: ≤ 2
`maximum_exhaust_flow_per_unit_of_power_output` Maximum Exhaust Flow per Unit of Power Output	number (kg/s)/W		Range: ≥ 0
`design_minimum_exhaust_temperature` Design Minimum Exhaust Temperature	number C
`fuel_type` Fuel Type required	choice		One of `Diesel`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`fuel_higher_heating_value` Fuel Higher Heating Value	number kJ/kg
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number or `Autosize` m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered.
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string
`chiller_flow_mode` Chiller Flow Mode	choice	`NotModulated`	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. One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`maximum_temperature_for_heat_recovery_at_heat_recovery_outlet_node` Maximum Temperature for Heat Recovery at Heat Recovery Outlet Node	number C	`60.0`	Range: ≥ 0, ≤ 100
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	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. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_heat_recovery_relative_capacity_fraction` Condenser Heat Recovery Relative Capacity Fraction	number		This optional field is the fraction of total rejected heat that can be recovered at full load. Also used to autosize Design Heat Recovery Water Flow Rate as a fraction of Design Condenser Water Flow Rate. Range: ≥ 0, ≤ 1

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, FaultModel:Fouling:Chiller, FaultModel:Fouling:EvaporativeCooler, FaultModel:TemperatureSensorOffset:ChillerSupplyWater, HVACTemplate:Plant:Chiller:ObjectReference, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

ChillerHeater:Absorption:DirectFired¶

from idfpy.models import ChillerHeaterAbsorptionDirectFired

Direct fired gas absorption chiller-heater using performance curves similar to DOE-2

Field	Type	Default	Details
`name` Name required	string
`nominal_cooling_capacity` Nominal Cooling Capacity	number or `Autosize` W	`Autosize`
`heating_to_cooling_capacity_ratio` Heating to Cooling Capacity Ratio	number	`0.8`	A positive fraction that represents the ratio of the heating capacity divided by the cooling capacity at rated conditions. Range: ≥ 0
`fuel_input_to_cooling_output_ratio` Fuel Input to Cooling Output Ratio	number	`0.97`	The positive fraction that represents the ratio of the instantaneous fuel used divided by the cooling capacity at rated conditions. Range: > 0
`fuel_input_to_heating_output_ratio` Fuel Input to Heating Output Ratio	number	`1.25`	The positive fraction that represents the ratio of the instantaneous fuel used divided by the nominal heating capacity. Range: ≥ 0
`electric_input_to_cooling_output_ratio` Electric Input to Cooling Output Ratio	number	`0.01`	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. Range: ≥ 0
`electric_input_to_heating_output_ratio` Electric Input to Heating Output Ratio	number	`0.0`	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. Range: ≥ 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name required	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string		Not required if air-cooled
`hot_water_inlet_node_name` Hot Water Inlet Node Name required	string
`hot_water_outlet_node_name` Hot Water Outlet Node Name required	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	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. Range: > 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	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. Range: ≥ 0.5
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`design_entering_condenser_water_temperature` Design Entering Condenser Water Temperature	number C	`29.0`	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.
`design_leaving_chilled_water_temperature` Design Leaving Chilled Water Temperature	number C	`7.0`	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.
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s	`Autosize`	For variable volume this is the max flow & for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s	`Autosize`	The water flow rate at design conditions through the condenser. This field is not used for Condenser Type = AirCooled
`design_hot_water_flow_rate` Design Hot Water Flow Rate	number or `Autosize` m3/s	`Autosize`	The water flow rate at design conditions through the heater side.
`cooling_capacity_function_of_temperature_curve_name` Cooling Capacity Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name` Fuel Input to Cooling Output Ratio Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Electric Input to Cooling Output Ratio Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`heating_capacity_function_of_cooling_capacity_curve_name` Heating Capacity Function of Cooling Capacity Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name` Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`temperature_curve_input_variable` Temperature Curve Input Variable	choice	`EnteringCondenser`	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). One of `EnteringCondenser`, `LeavingCondenser`
`condenser_type` Condenser Type	choice	`WaterCooled`	The condenser can either be air cooled or connected to a cooling tower. One of `AirCooled`, `WaterCooled`
`chilled_water_temperature_lower_limit` Chilled Water Temperature Lower Limit	number C	`2.0`	The chilled water supply temperature below which the chiller will shut off.
`fuel_higher_heating_value` Fuel Higher Heating Value	number kJ/kg	`0.0`	Not currently used.
`fuel_type` Fuel Type	choice	`NaturalGas`	One of `Diesel`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

ChillerHeater:Absorption:DoubleEffect¶

from idfpy.models import ChillerHeaterAbsorptionDoubleEffect

Exhaust fired absorption chiller-heater using performance curves similar to DOE-2

Field	Type	Default	Details
`name` Name required	string
`nominal_cooling_capacity` Nominal Cooling Capacity	number or `Autosize` W	`Autosize`
`heating_to_cooling_capacity_ratio` Heating to Cooling Capacity Ratio	number	`0.8`	A positive fraction that represents the ratio of the heating capacity divided by the cooling capacity at rated conditions. Range: ≥ 0
`thermal_energy_input_to_cooling_output_ratio` Thermal Energy Input to Cooling Output Ratio	number	`0.97`	The positive fraction that represents the ratio of the instantaneous fuel used divided by the cooling capacity at rated conditions. Range: > 0
`thermal_energy_input_to_heating_output_ratio` Thermal Energy Input to Heating Output Ratio	number	`1.25`	The positive fraction that represents the ratio of the instantaneous fuel used divided by the nominal heating capacity. Range: ≥ 0
`electric_input_to_cooling_output_ratio` Electric Input to Cooling Output Ratio	number	`0.01`	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. Range: ≥ 0
`electric_input_to_heating_output_ratio` Electric Input to Heating Output Ratio	number	`0.0`	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. Range: ≥ 0
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`condenser_inlet_node_name` Condenser Inlet Node Name required	string
`condenser_outlet_node_name` Condenser Outlet Node Name	string		Not required if air-cooled
`hot_water_inlet_node_name` Hot Water Inlet Node Name required	string
`hot_water_outlet_node_name` Hot Water Outlet Node Name required	string
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	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. Range: > 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	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. Range: ≥ 0.5
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`design_entering_condenser_water_temperature` Design Entering Condenser Water Temperature	number C	`29.0`	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.
`design_leaving_chilled_water_temperature` Design Leaving Chilled Water Temperature	number C	`7.0`	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.
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s	`Autosize`	For variable volume this is the max flow & for constant flow this is the flow.
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s	`Autosize`	The water flow rate at design conditions through the condenser. This field is not used for Condenser Type = AirCooled
`design_hot_water_flow_rate` Design Hot Water Flow Rate	number or `Autosize` m3/s	`Autosize`	The water flow rate at design conditions through the heater side.
`cooling_capacity_function_of_temperature_curve_name` Cooling Capacity Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name` Fuel Input to Cooling Output Ratio Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Electric Input to Cooling Output Ratio Function of Temperature Curve Name	reference		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. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`heating_capacity_function_of_cooling_capacity_curve_name` Heating Capacity Function of Cooling Capacity Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name` Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name	reference		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. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`temperature_curve_input_variable` Temperature Curve Input Variable	choice	`EnteringCondenser`	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). One of `EnteringCondenser`, `LeavingCondenser`
`condenser_type` Condenser Type	choice	`WaterCooled`	The condenser can either be air cooled or connected to a cooling tower. One of `AirCooled`, `WaterCooled`
`chilled_water_temperature_lower_limit` Chilled Water Temperature Lower Limit	number C	`2.0`	The chilled water supply temperature below which the chiller will shut off.
`exhaust_source_object_type` Exhaust Source Object Type required	choice		One of `Generator:MicroTurbine`
`exhaust_source_object_name` Exhaust Source Object Name	reference		Names a Generator:MicroTurbine
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

ChillerHeaterPerformance:Electric:EIR¶

from idfpy.models import ChillerHeaterPerformanceElectricEIR

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.

Field	Type	Default	Details
`name` Name required	string
`reference_cooling_mode_evaporator_capacity` Reference Cooling Mode Evaporator Capacity required	number or `Autosize` W
`reference_cooling_mode_cop` Reference Cooling Mode COP required	number W/W		Efficiency of the chiller compressor (cooling output/compressor energy input). Range: > 0
`reference_cooling_mode_leaving_chilled_water_temperature` Reference Cooling Mode Leaving Chilled Water Temperature	number C	`6.67`
`reference_cooling_mode_entering_condenser_fluid_temperature` Reference Cooling Mode Entering Condenser Fluid Temperature	number C	`29.44`
`reference_cooling_mode_leaving_condenser_water_temperature` Reference Cooling Mode Leaving Condenser Water Temperature	number C	`35.0`
`reference_heating_mode_cooling_capacity_ratio` Reference Heating Mode Cooling Capacity Ratio	number	`0.75`	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)
`reference_heating_mode_cooling_power_input_ratio` Reference Heating Mode Cooling Power Input Ratio	number	`1.38`	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) Range: > 0
`reference_heating_mode_leaving_chilled_water_temperature` Reference Heating Mode Leaving Chilled Water Temperature	number C	`6.67`	During simultaneous cooling-heating mode
`reference_heating_mode_leaving_condenser_water_temperature` Reference Heating Mode Leaving Condenser Water Temperature	number C	`49.0`	During simultaneous cooling-heating mode
`reference_heating_mode_entering_condenser_fluid_temperature` Reference Heating Mode Entering Condenser Fluid Temperature	number C	`29.44`
`heating_mode_entering_chilled_water_temperature_low_limit` Heating Mode Entering Chilled Water Temperature Low Limit	number C	`12.22`	During simultaneous cooling-heating mode
`chilled_water_flow_mode_type` Chilled Water Flow Mode Type	choice	`ConstantFlow`	Sets chilled water flow rate to either constant or variable. One of `ConstantFlow`, `VariableFlow`
`design_chilled_water_flow_rate` Design Chilled Water Flow Rate	number or `Autosize` m3/s
`design_condenser_water_flow_rate` Design Condenser Water Flow Rate	number or `Autosize` m3/s
`design_hot_water_flow_rate` Design Hot Water Flow Rate	number m3/s	`0.0`	Range: ≥ 0
`compressor_motor_efficiency` Compressor Motor Efficiency	number	`1.0`	Fraction of compressor electrical energy that must be rejected by the condenser. Enter 1.0 or leave this field blank for a hermetic compressor. Range: ≥ 0, ≤ 1
`cooling_mode_temperature_curve_condenser_water_independent_variable` Cooling Mode Temperature Curve Condenser Water Independent Variable	choice	`EnteringCondenser`	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 One of `EnteringCondenser`, `LeavingCondenser`
`cooling_mode_cooling_capacity_function_of_temperature_curve_name` Cooling Mode Cooling Capacity Function of Temperature Curve Name required	reference		Cooling capacity as a function of leaving chilled water temperature and either entering or leaving condenser fluid temperature curve = a + bCWS + cCWS*2 + dTCond + eTCond2 + fCWS*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) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Cooling Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name required	reference		Electric Input Ratio (EIR) as a function of supply (leaving) chilled water temperature and leaving condenser fluid temperature. EIR = 1/COP. curve = a + bCWS + cCWS*2 + dTCond + eTCond2 + fCWS*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) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Cooling Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name required	reference		Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR) EIR = 1/COP Bicubic = a + bTCond + cTCond*2 + dPLR + ePLR2 + fTCondPLR +g0 + hPLR3+i0+j0 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 + bPLR + cPLR*2 PLR = part load ratio (cooling load/steady-state capacity) LCT = leaving condenser fluid temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more
`cooling_mode_cooling_capacity_optimum_part_load_ratio` Cooling Mode Cooling Capacity Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`heating_mode_temperature_curve_condenser_water_independent_variable` Heating Mode Temperature Curve Condenser Water Independent Variable	choice	`LeavingCondenser`	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 One of `EnteringCondenser`, `LeavingCondenser`
`heating_mode_cooling_capacity_function_of_temperature_curve_name` Heating Mode Cooling Capacity Function of Temperature Curve Name required	reference		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 + bCWS + cCWS*2 + dTCond + eTCond2 + fCWS*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) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name` Heating Mode Electric Input to Cooling Output Ratio Function of Temperature Curve Name required	reference		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 + bCWS + cCWS*2 + dTCond + eTCond2 + fCWS*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) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name` Heating Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name required	reference		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 + bLCT + cLCT*2 + dPLR + ePLR2 + fLCTPLR + g0 + hPLR3 + i0 + j0 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 + bPLR + cPLR*2 PLR = part load ratio (cooling load/steady-state capacity) LCT = leaving condenser fluid temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more
`heating_mode_cooling_capacity_optimum_part_load_ratio` Heating Mode Cooling Capacity Optimum Part Load Ratio	number	`1.0`	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. Range: > 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0

Referenced by 1 object types

CentralHeatPumpSystem

DistrictCooling¶

from idfpy.models import DistrictCooling

Centralized source of chilled water, such as a district cooling system.

Field	Type	Details
`name` Name required	string
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name required	string
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name required	string
`nominal_capacity` Nominal Capacity	number or `Autosize` W
`capacity_fraction_schedule_name` Capacity Fraction Schedule Name	reference	Schedule values are multiplied by Nominal Capacity for current capacity Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

DistrictHeating:Steam¶

from idfpy.models import DistrictHeatingSteam

Centralized source of Steam, such as a district heating system.

Field	Type	Details
`name` Name required	string
`steam_inlet_node_name` Steam Inlet Node Name required	string
`steam_outlet_node_name` Steam Outlet Node Name required	string
`nominal_capacity` Nominal Capacity	number or `Autosize` W
`capacity_fraction_schedule_name` Capacity Fraction Schedule Name	reference	Schedule values are multiplied by Nominal Capacity for current capacity Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

DistrictHeating:Water¶

from idfpy.models import DistrictHeatingWater

Centralized source of hot water, such as a district heating system.

Field	Type	Details
`name` Name required	string
`hot_water_inlet_node_name` Hot Water Inlet Node Name required	string
`hot_water_outlet_node_name` Hot Water Outlet Node Name required	string
`nominal_capacity` Nominal Capacity	number or `Autosize` W
`capacity_fraction_schedule_name` Capacity Fraction Schedule Name	reference	Schedule values are multiplied by Nominal Capacity for current capacity Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

HeatPump:AirToWater¶

from idfpy.models import HeatPumpAirToWater

air-to-water heat pump system which provides either chilled or hot water with single- or variable speed compressors.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name_heating` Availability Schedule Name Heating	reference		Enter the name of a schedule that defines the availability of the unit in heating mode Schedule values of 0 denote the unit is off. All other values denote the unit is available If this field is left blank, the unit is available the entire simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`availability_schedule_name_cooling` Availability Schedule Name Cooling	reference		Enter the name of a schedule that defines the availability of the unit in cooling mode Schedule values of 0 denote the unit is off. All other values denote the unit is available If this field is left blank, the unit is available the entire simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`operating_mode_control_method` Operating Mode Control Method	choice	`Load`	One of `EMSControlled`, `Load`, `ScheduledModes`
`operating_mode_control_option_for_multiple_unit` Operating Mode Control Option for Multiple Unit	choice	`SingleMode`	this determines how the operation mode is assigned when the load is too large to be met by multiple heat pump units SingleMode: all units will operate in the same mode (either all cooling or all heating). If the heating load is larger, then all unit operates in heating mode; otherwise, all operate in cooling mode. CoolingPriority: each unit will be staged one by one based on cooling demand first, after all cooling demand is met, if there are remaining heat pumps, they will be used to fulfill the remaining heating demand. HeatingPriority: similar to the previous cooling priority one, but will prioritize to meet the heating demand first Balanced: balance the percent satisfied heating or cooling load One of `Balanced`, `CoolingPriority`, `HeatingPriority`, `SingleMode`
`operating_mode_control_schedule_name` Operating Mode Control Schedule Name	reference		This field is used if the control method is set to ScheduledModes Schedule values control operating mode: 0=off, 1=cooling, 2=heating Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Below this operating limit compressor cycling will occur Range: ≥ 0
`rated_inlet_air_temperature_in_heating_mode` Rated Inlet Air Temperature in Heating Mode	number C	`8.0`	inlet air dry-bulb temperature corresponding to rated heat pump performance (capacity, COP).
`rated_air_flow_rate_in_heating_mode` Rated Air Flow Rate in Heating Mode	number or `Autosize` m3/s	`Autosize`	air flow rate corresponding to rated heat pump performance (capacity, COP).
`rated_leaving_water_temperature_in_heating_mode` Rated Leaving Water Temperature in Heating Mode	number C	`40.0`	outlet water temperature corresponding to rated heat pump performance (heating capacity, COP).
`rated_water_flow_rate_in_heating_mode` Rated Water Flow Rate in Heating Mode	number or `Autosize` m3/s	`Autosize`	Condenser water flow rate corresponding to rated heat pump performance (capacity, COP).
`minimum_outdoor_air_temperature_in_heating_mode` Minimum Outdoor Air Temperature in Heating Mode	number C	`-30.0`	Enter the minimum outdoor temperature allowed for heating operation Heating is disabled below this temperature
`maximum_outdoor_air_temperature_in_heating_mode` Maximum Outdoor Air Temperature in Heating Mode	number C	`100.0`	Enter the maximum outdoor temperature allowed for heating operation Heating is disabled above this temperature
`minimum_leaving_water_temperature_curve_name_in_heating_mode` Minimum Leaving Water Temperature Curve Name in Heating Mode	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_leaving_water_temperature_curve_name_in_heating_mode` Maximum Leaving Water Temperature Curve Name in Heating Mode	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`sizing_factor_for_heating` Sizing Factor for Heating	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`rated_inlet_air_temperature_in_cooling_mode` Rated Inlet Air Temperature in Cooling Mode	number C	`30.0`	inlet air dry-bulb temperature corresponding to rated heat pump performance (capacity, COP).
`rated_air_flow_rate_in_cooling_mode` Rated Air Flow Rate in Cooling Mode	number or `Autosize` m3/s	`Autosize`	air flow rate corresponding to rated heat pump performance (capacity, COP).
`rated_leaving_water_temperature_in_cooling_mode` Rated Leaving Water Temperature in Cooling Mode	number C	`8.0`	outlet water temperature corresponding to rated heat pump performance (cooling capacity, COP).
`rated_water_flow_rate_in_cooling_mode` Rated Water Flow Rate in Cooling Mode	number or `Autosize` m3/s	`Autosize`	Condenser water flow rate corresponding to rated heat pump performance (capacity, COP).
`minimum_outdoor_air_temperature_in_cooling_mode` Minimum Outdoor Air Temperature in Cooling Mode	number C	`-30.0`	Enter the minimum outdoor temperature allowed for cooling operation Cooling is disabled below this temperature
`maximum_outdoor_air_temperature_in_cooling_mode` Maximum Outdoor Air Temperature in Cooling Mode	number C	`100.0`	Enter the maximum outdoor temperature allowed for cooling operation Cooling is disabled above this temperature
`minimum_leaving_water_temperature_curve_name_in_cooling_mode` Minimum Leaving Water Temperature Curve Name in Cooling Mode	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_leaving_water_temperature_curve_name_in_cooling_mode` Maximum Leaving Water Temperature Curve Name in Cooling Mode	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`sizing_factor_for_cooling` Sizing Factor for Cooling	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`air_inlet_node_name` Air Inlet Node Name required	string		The node from which the heat pump draws its inlet air.
`air_outlet_node_name` Air Outlet Node Name required	string		The node to which the heat pump sends its outlet air.
`hot_water_inlet_node_name` Hot Water Inlet Node Name	string		The node connects to the hot water loop
`hot_water_outlet_node_name` Hot Water Outlet Node Name	string		The node connects to the hot water loop
`chilled_water_inlet_node_name` Chilled Water Inlet Node Name	string		The node connects to the chilled water loop
`chilled_water_outlet_node_name` Chilled Water Outlet Node Name	string		The node connects to the chilled water loop
`maximum_outdoor_dry_bulb_temperature_for_defrost_operation` Maximum Outdoor Dry Bulb Temperature For Defrost Operation	number	`10.0`	defrost operation will not be active above this outdoor temperature
`heat_pump_defrost_control` Heat Pump Defrost Control	choice	`None`	One of `None`, `OnDemand`, `Timed`, `TimedEmpirical`
`heat_pump_defrost_time_period_fraction` Heat Pump Defrost Time Period Fraction	number	`0.058333`	Fraction of time in defrost mode only applicable if timed defrost control is specified Range: ≥ 0
`resistive_defrost_heater_capacity` Resistive Defrost Heater Capacity	number W	`0.0`	only applicable if resistive defrost strategy is specified Range: ≥ 0
`defrost_energy_input_ratio_function_of_temperature_curve_name` Defrost Energy Input Ratio Function of Temperature Curve Name	reference		univariate curve = a + bOAT is typical, other univariate curves may be used bivariate curve = a + bWB + cWB2 + dOAT + eOAT2 + fWB*OAT OAT = outdoor air dry-bulb temperature (C) WB = wet-bulb temperature (C) of air entering the indoor coil only required if Timed or OnDemand defrost strategy is specified Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heat_pump_multiplier` Heat Pump Multiplier	integer	`1`	intend to model modular heat pumps
`control_type` Control Type	choice	`VariableSpeed`	One of `FixedSpeed`, `VariableSpeed`
`crankcase_heater_capacity` Crankcase Heater Capacity	number W	`0.0`	The compressor crankcase heater only operates when the dry-bulb temperature of air surrounding the compressor is below the Maximum Ambient Temperature for Crankcase Heater Operation and the heat pump is off. The ambient temperature uses the outdoor air temperature. Range: ≥ 0
`crankcase_heater_capacity_function_of_temperature_curve_name` Crankcase Heater Capacity Function of Temperature Curve Name	reference		A Curve:* or Table:Lookup object encoding the relationship between the crankcase heater capacity and the outdoor air temperature. When this field is missing or empty, constant crankcase heater capacity will be assumed. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_ambient_temperature_for_crankcase_heater_operation` Maximum Ambient Temperature for Crankcase Heater Operation	number C	`10.0`	The compressor crankcase heater only operates when the dry-bulb temperature of air surrounding the compressor is below the Maximum Outdoor Temperature for Crankcase Heater Operation and the unit is off. Range: ≥ 0
`number_of_speeds_for_heating` Number of Speeds for Heating	integer	`1`	the number of speed levels in heating mode if there's only cooling component, set this field to 0 Range: ≥ 0, ≤ 5
`rated_heating_capacity_at_speed_1` Rated Heating Capacity at Speed 1	number or `Autosize` W	`Autosize`
`rated_cop_for_heating_at_speed_1` Rated COP for Heating at Speed 1	number W/W	`3.0`	Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_at_speed_1` Normalized Heating Capacity Function of Temperature Curve Name at Speed 1	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_at_speed_1` Heating Energy Input Ratio Function of Temperature Curve Name at Speed 1	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_at_speed_1` Heating Energy Input Ratio Function of PLR Curve Name at Speed 1	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_heating_capacity_at_speed_2` Rated Heating Capacity at Speed 2	number or `Autosize` W	`Autosize`
`rated_cop_for_heating_at_speed_2` Rated COP for Heating at Speed 2	number W/W		Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_at_speed_2` Normalized Heating Capacity Function of Temperature Curve Name at Speed 2	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_at_speed_2` Heating Energy Input Ratio Function of Temperature Curve Name at Speed 2	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_at_speed_2` Heating Energy Input Ratio Function of PLR Curve Name at Speed 2	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_heating_capacity_at_speed_3` Rated Heating Capacity at Speed 3	number or `Autosize` W	`Autosize`
`rated_cop_for_heating_at_speed_3` Rated COP for Heating at Speed 3	number W/W		Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_at_speed_3` Normalized Heating Capacity Function of Temperature Curve Name at Speed 3	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_at_speed_3` Heating Energy Input Ratio Function of Temperature Curve Name at Speed 3	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_at_speed_3` Heating Energy Input Ratio Function of PLR Curve Name at Speed 3	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_heating_capacity_at_speed_4` Rated Heating Capacity at Speed 4	number or `Autosize` W	`Autosize`
`rated_cop_for_heating_at_speed_4` Rated COP for Heating at Speed 4	number W/W		Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_at_speed_4` Normalized Heating Capacity Function of Temperature Curve Name at Speed 4	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_at_speed_4` Heating Energy Input Ratio Function of Temperature Curve Name at Speed 4	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_at_speed_4` Heating Energy Input Ratio Function of PLR Curve Name at Speed 4	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_heating_capacity_at_speed_5` Rated Heating Capacity at Speed 5	number or `Autosize` W	`Autosize`
`rated_cop_for_heating_at_speed_5` Rated COP for Heating at Speed 5	number W/W		Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_at_speed_5` Normalized Heating Capacity Function of Temperature Curve Name at Speed 5	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_at_speed_5` Heating Energy Input Ratio Function of Temperature Curve Name at Speed 5	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_at_speed_5` Heating Energy Input Ratio Function of PLR Curve Name at Speed 5	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`booster_mode_on_heating` Booster Mode On Heating	choice	`No`	One of `No`, `Yes`
`rated_heating_capacity_in_booster_mode` Rated Heating Capacity in Booster Mode	number W		Range: > 0
`rated_heating_cop_in_booster_mode` Rated Heating COP in Booster Mode	number W/W	`3.0`	Range: > 0
`normalized_heating_capacity_function_of_temperature_curve_name_in_booster_mode` Normalized Heating Capacity Function of Temperature Curve Name in Booster Mode	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_temperature_curve_name_in_booster_mode` Heating Energy Input Ratio Function of Temperature Curve Name in Booster Mode	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heating_energy_input_ratio_function_of_plr_curve_name_in_booster_mode` Heating Energy Input Ratio Function of PLR Curve Name in Booster Mode	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`number_of_speeds_for_cooling` Number of Speeds for Cooling	integer	`1`	the number of speed levels in cooling mode if there's only heating component, set this field to 0 Range: ≥ 0, ≤ 5
`rated_cooling_capacity_at_speed_1` Rated Cooling Capacity at Speed 1	number or `Autosize` W	`Autosize`
`rated_cop_for_cooling_at_speed_1` Rated COP for Cooling at Speed 1	number W/W	`3.0`	Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_at_speed_1` Normalized Cooling Capacity Function of Temperature Curve Name at Speed 1	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_at_speed_1` Cooling Energy Input Ratio Function of Temperature Curve Name at Speed 1	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_at_speed_1` Cooling Energy Input Ratio Function of PLR Curve Name at Speed 1	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_cooling_capacity_at_speed_2` Rated Cooling Capacity at Speed 2	number or `Autosize` W	`Autosize`
`rated_cop_for_cooling_at_speed_2` Rated COP for Cooling at Speed 2	number W/W		Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_at_speed_2` Normalized Cooling Capacity Function of Temperature Curve Name at Speed 2	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_at_speed_2` Cooling Energy Input Ratio Function of Temperature Curve Name at Speed 2	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_at_speed_2` Cooling Energy Input Ratio Function of PLR Curve Name at Speed 2	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_cooling_capacity_at_speed_3` Rated Cooling Capacity at Speed 3	number or `Autosize` W	`Autosize`
`rated_cop_for_cooling_at_speed_3` Rated COP for Cooling at Speed 3	number W/W		Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_at_speed_3` Normalized Cooling Capacity Function of Temperature Curve Name at Speed 3	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_at_speed_3` Cooling Energy Input Ratio Function of Temperature Curve Name at Speed 3	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_at_speed_3` Cooling Energy Input Ratio Function of PLR Curve Name at Speed 3	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_cooling_capacity_at_speed_4` Rated Cooling Capacity at Speed 4	number or `Autosize` W	`Autosize`
`rated_cop_for_cooling_at_speed_4` Rated COP for Cooling at Speed 4	number W/W		Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_at_speed_4` Normalized Cooling Capacity Function of Temperature Curve Name at Speed 4	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_at_speed_4` Cooling Energy Input Ratio Function of Temperature Curve Name at Speed 4	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_at_speed_4` Cooling Energy Input Ratio Function of PLR Curve Name at Speed 4	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_cooling_capacity_at_speed_5` Rated Cooling Capacity at Speed 5	number or `Autosize` W	`Autosize`
`rated_cop_for_cooling_at_speed_5` Rated COP for Cooling at Speed 5	number W/W		Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_at_speed_5` Normalized Cooling Capacity Function of Temperature Curve Name at Speed 5	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_at_speed_5` Cooling Energy Input Ratio Function of Temperature Curve Name at Speed 5	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_at_speed_5` Cooling Energy Input Ratio Function of PLR Curve Name at Speed 5	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`booster_mode_on_cooling` Booster Mode On Cooling	choice	`No`	One of `No`, `Yes`
`rated_cooling_capacity_in_booster_mode` Rated Cooling Capacity in Booster Mode	number W		Range: > 0
`rated_cooling_cop_in_booster_mode` Rated Cooling COP in Booster Mode	number W/W	`3.0`	Range: > 0
`normalized_cooling_capacity_function_of_temperature_curve_name_in_booster_mode` Normalized Cooling Capacity Function of Temperature Curve Name in Booster Mode	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_temperature_curve_name_in_booster_mode` Cooling Energy Input Ratio Function of Temperature Curve Name in Booster Mode	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table of air and water temperature. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`cooling_energy_input_ratio_function_of_plr_curve_name_in_booster_mode` Cooling Energy Input Ratio Function of PLR Curve Name in Booster Mode	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

HeatPump:AirToWater:FuelFired:Cooling¶

from idfpy.models import HeatPumpAirToWaterFuelFiredCooling

The object defines a fuel-fired absorption heat pump based on equation-fit models.

Field	Type	Default	Details
`name` Name required	string		Name of the fuel fired absorption heat pump system system
`water_inlet_node_name` Water Inlet Node Name required	string		Inlet node name of the water side connection
`water_outlet_node_name` Water Outlet Node Name required	string		Outlet node name of the water side connection
`air_source_node_name` Air Source Node Name	reference		This is the air source node name, which is the condenser side of the heat pump in cooling mode. Enter the name of an OutdoorAir:Node object. Names a OutdoorAir:Node
`companion_heating_heat_pump_name` Companion Heating Heat Pump Name	reference		The name of the companion HeatPump:AirToWater:FuelFired:Heating object This field is used for a heat pump with switchable heating and cooling mode. Names a HeatPump:AirToWater:FuelFired:Heating
`fuel_type` Fuel Type	choice	`NaturalGas`	Fuel Type (NaturalGas, Propane, Gasoline, Diesel etc.) One of `Coal`, `Diesel`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`nominal_cooling_capacity` Nominal Cooling Capacity	number or `Autosize` W		Nominal Cooling Capacity in [W] (autosizable)
`nominal_cop` Nominal COP	number W/W	`1.0`	Nominal COP (Coefficient of Performance) Range: > 0
`design_flow_rate` Design Flow Rate	number or `Autosize` m3/s		Design Flow Rate in m3/s (autosizable)
`design_supply_temperature` Design Supply Temperature	number C	`7.0`	Design Supply Temperature in [degree C]
`design_temperature_lift` Design Temperature Lift	number or `Autosize` deltaC	`11.1`	Design Temperature Lift in [degree C]
`sizing_factor` Sizing Factor	number	`1.0`	Sizing Factor for equipment sizing Range: ≥ 0
`flow_mode` Flow Mode	choice	`NotModulated`	Flow Mode for the water side of the fuel-fired absorption heat pump One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`outdoor_air_temperature_curve_input_variable` Outdoor Air Temperature Curve Input Variable	choice	`DryBulb`	Outdoor air temperature curve input variable; The options are Outdoor Air Dry Bulb or Wet Bulb temperature for curves One of `DryBulb`, `WetBulb`
`water_temperature_curve_input_variable` Water Temperature Curve Input Variable	choice	`EnteringEvaporator`	Water Temperature curve input variable - Condenser Entering or Leaving Water Temperature for curves One of `EnteringEvaporator`, `LeavingEvaporator`
`normalized_capacity_function_of_temperature_curve_name` Normalized Capacity Function of Temperature Curve Name required	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_energy_input_ratio_function_of_temperature_curve_name` Fuel Energy Input Ratio Function of Temperature Curve Name required	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_energy_input_ratio_function_of_plr_curve_name` Fuel Energy Input Ratio Function of PLR Curve Name required	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	Minimum Part Load Ratio (PLR) in between 0 and 1 Range: > 0, ≤ 1
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Maximum Part Load Ratio (PLR) in between 0 and 1 Range: > 0, ≤ 1
`cycling_ratio_factor_curve_name` Cycling Ratio Factor Curve Name	reference		Cycling Ratio Factor (CRF) Curve Name, which is a cubic curve or a lookup table function of Cycling Ratio (defined as = PLR/PLRmin); if left blank, no adjustment will be made. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`nominal_auxiliary_electric_power` Nominal Auxiliary Electric Power	number W		Nominal Auxiliary Electric Power in [W] Range: ≥ 0
`auxiliary_electric_energy_input_ratio_function_of_temperature_curve_name` Auxiliary Electric Energy Input Ratio Function of Temperature Curve Name	reference		Auxiliary Electric EIRFT - Auxiliary Electric Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. which accounts for system internal fans, pumps, and electronics Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`auxiliary_electric_energy_input_ratio_function_of_plr_curve_name` Auxiliary Electric Energy Input Ratio Function of PLR Curve Name	reference		Auxiliary Electric EIRFPLR - Auxiliary Electric Energy Input Ratio Function of PLR (Part Load Ratio) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`standby_electric_power` Standby Electric Power	number W	`0.0`	Standby Electric Power in [W] Range: ≥ 0
`minimum_unloading_ratio` Minimum Unloading Ratio	number	`0.25`	Minimum modulation level of the gas-fired heat pump. Typically less than 1.0 and slightly higher than the minimum part load ratio. Range: ≥ 0, ≤ 1

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:AirToWater:FuelFired:Heating

HeatPump:AirToWater:FuelFired:Heating¶

from idfpy.models import HeatPumpAirToWaterFuelFiredHeating

The object defines a fuel-fired absorption heat pump based on equation-fit models.

Field	Type	Default	Details
`name` Name required	string		Name of the fuel fired absorption heat pump system system
`water_inlet_node_name` Water Inlet Node Name required	string		Inlet node name of the water side connection
`water_outlet_node_name` Water Outlet Node Name required	string		Outlet node name of the water side connection
`air_source_node_name` Air Source Node Name	reference		This is the air source node name, which is the evaporator side of the heat pump in heating mode. Enter the name of an OutdoorAir:Node object. Names a OutdoorAir:Node
`companion_cooling_heat_pump_name` Companion Cooling Heat Pump Name	reference		The name of the companion HeatPump:AirToWater:FuelFired:Cooling object This field is used for a heat pump with switchable heating and cooling mode. Names a HeatPump:AirToWater:FuelFired:Cooling
`fuel_type` Fuel Type	choice	`NaturalGas`	Fuel Type (NaturalGas, Propane, Gasoline, Diesel etc.) One of `Coal`, `Diesel`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`nominal_heating_capacity` Nominal Heating Capacity	number or `Autosize` W		Nominal Heating Capacity in [W] (autosizable)
`nominal_cop` Nominal COP	number W/W	`1.0`	Nominal COP (Coefficient of Performance) Range: > 0
`design_flow_rate` Design Flow Rate	number or `Autosize` m3/s		Design Flow Rate in m3/s (autosizable)
`design_supply_temperature` Design Supply Temperature	number C	`60.0`	Design Supply Temperature in [degree C]
`design_temperature_lift` Design Temperature Lift	number or `Autosize` deltaC	`11.1`	Design Temperature Lift in [degree C]
`sizing_factor` Sizing Factor	number	`1.0`	Sizing Factor for equipment sizing Range: ≥ 0
`flow_mode` Flow Mode	choice	`NotModulated`	Flow Mode for the water side of the fuel-fired absorption heat pump One of `ConstantFlow`, `LeavingSetpointModulated`, `NotModulated`
`outdoor_air_temperature_curve_input_variable` Outdoor Air Temperature Curve Input Variable	choice	`DryBulb`	Outdoor air temperature curve input variable; The options are Outdoor Air Dry Bulb or Wet Bulb temperature for curves One of `DryBulb`, `WetBulb`
`water_temperature_curve_input_variable` Water Temperature Curve Input Variable	choice	`EnteringCondenser`	Water Temperature curve input variable - Condenser Entering or Leaving Water Temperature for curves One of `EnteringCondenser`, `LeavingCondenser`
`normalized_capacity_function_of_temperature_curve_name` Normalized Capacity Function of Temperature Curve Name required	reference		CAPFT - Normalized Capacity Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_energy_input_ratio_function_of_temperature_curve_name` Fuel Energy Input Ratio Function of Temperature Curve Name required	reference		EIRFT - Fuel Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fuel_energy_input_ratio_function_of_plr_curve_name` Fuel Energy Input Ratio Function of PLR Curve Name required	reference		EIRFPLR - Fuel Energy Input Ratio Function of Part Load Ratio(PLR) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.1`	Minimum Part Load Ratio (PLR) in between 0 and 1 Range: > 0, ≤ 1
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Maximum Part Load Ratio (PLR) in between 0 and 1 Range: > 0, ≤ 1
`defrost_control_type` Defrost Control Type	choice	`Timed`	Defrost operation control type: Timed or OnDemand One of `OnDemand`, `Timed`
`defrost_operation_time_fraction` Defrost Operation Time Fraction	number	`0.0`	Defrost operation time fraction, which will be used only for Timed Defrost Control Type. Range: ≥ 0, ≤ 1
`fuel_energy_input_ratio_defrost_adjustment_curve_name` Fuel Energy Input Ratio Defrost Adjustment Curve Name	reference		EIRDEFROST - Energy Input Ratio Defrost Adjustment Curve Name, which is a cubic curve or a lookup table function of Outdoor Air Temperature. This field is only used when OnDemand Defrost Control Type is selected. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`resistive_defrost_heater_capacity` Resistive Defrost Heater Capacity	number W	`0.0`	The heating power of electric resistive defrost heater. Only used for timed defrost control type. Range: ≥ 0
`maximum_outdoor_dry_bulb_temperature_for_defrost_operation` Maximum Outdoor Dry-bulb Temperature for Defrost Operation	number C	`5.0`	There will be no defrost operation when outdoor air is above this temperature. Range: ≥ 0, ≤ 10
`cycling_ratio_factor_curve_name` Cycling Ratio Factor Curve Name	reference		Cycling Ratio Factor (CRF) Curve Name, which is a cubic curve or a lookup table function of Cycling Ratio (defined as = PLR/PLRmin); if left blank, no adjustment will be made. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`nominal_auxiliary_electric_power` Nominal Auxiliary Electric Power	number W		Nominal Auxiliary Electric Power in [W] Range: ≥ 0
`auxiliary_electric_energy_input_ratio_function_of_temperature_curve_name` Auxiliary Electric Energy Input Ratio Function of Temperature Curve Name	reference		Auxiliary Electric EIRFT - Auxiliary Electric Energy Input Ratio Function of Temperature Curve Name, which is a biquadratic curve or a lookup table. which accounts for system internal fans, pumps, and electronics Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`auxiliary_electric_energy_input_ratio_function_of_plr_curve_name` Auxiliary Electric Energy Input Ratio Function of PLR Curve Name	reference		Auxiliary Electric EIRFPLR - Auxiliary Electric Energy Input Ratio Function of PLR (Part Load Ratio) Curve Name, which is a cubic curve or a lookup table. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`standby_electric_power` Standby Electric Power	number W	`0.0`	Standby Electric Power in [W] Range: ≥ 0
`minimum_unloading_ratio` Minimum Unloading Ratio	number	`0.25`	Minimum modulation level of the gas-fired heat pump. Typically less than 1.0 and slightly higher than the minimum part load ratio. Range: ≥ 0, ≤ 1

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:AirToWater:FuelFired:Cooling

HeatPump:PlantLoop:EIR:Cooling¶

from idfpy.models import HeatPumpPlantLoopEIRCooling

An EIR formulated water to water heat pump model, cooling operation.

Field	Type	Default	Details
`name` Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`condenser_type` Condenser Type	choice	`WaterSource`	One of `AirSource`, `WaterSource`
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string		Not available with water source condenser type
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string		Not available with water source condenser type
`companion_heat_pump_name` Companion Heat Pump Name	reference		This field allows the user to specify a companion heating object for this cooling object. The companion is used in sizing the heat pump as well as to allow checks for unexpected simultaneous operation of the two objects. Names a HeatPump:PlantLoop:EIR:Heating
`load_side_reference_flow_rate` Load Side Reference Flow Rate	number or `Autosize` m3/s	`Autosize`	This component is currently a constant-flow device, meaning it will always try to request the full design flow from the central plant manager.
`source_side_reference_flow_rate` Source Side Reference Flow Rate	number or `Autosize` m3/s	`Autosize`
`heat_recovery_reference_flow_rate` Heat Recovery Reference Flow Rate	number or `Autosize` m3/s	`Autosize`	Not available with water source condenser type
`reference_capacity` Reference Capacity	number or `Autosize` W	`Autosize`
`reference_coefficient_of_performance` Reference Coefficient of Performance	number W/W	`3.0`	Range: > 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized load side reference flow rate which is then used to autosize the capacity Range: > 0
`capacity_modifier_function_of_temperature_curve_name` Capacity Modifier Function of Temperature Curve Name required	reference		Cooling capacity modifier as a function of CW supply temp and entering condenser temp curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_output_ratio_modifier_function_of_temperature_curve_name` Electric Input to Output Ratio Modifier Function of Temperature Curve Name required	reference		Electric Input Ratio (EIR) modifier as a function of temperature EIR = 1/COP curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_output_ratio_modifier_function_of_part_load_ratio_curve_name` Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name required	reference		Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR) EIR = 1/COP quadratic curve = a + bPLR + cPLR**2 is typical, other univariate curves may be used PLR = part load ratio (cooling load/steady state capacity) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`control_type` Control Type	choice	`Load`	Heat pump can be controlled on leaving water temperature set point or plant load One of `Load`, `Setpoint`
`flow_mode` Flow Mode	choice	`ConstantFlow`	Select operating mode for fluid flow through the chiller. "ConstantFlow" is for constant pumping with flow controlled by chiller to operate at full design flow rate. "VariableSpeedPumping" is for variable pumping with flow proportional to chiller operating part load ratio. One of `ConstantFlow`, `VariableSpeedPumping`
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Below this operating limit compressor cycling will occur Range: ≥ 0
`minimum_source_inlet_temperature` Minimum Source Inlet Temperature	number C	`-100.0`	Enter the minimum inlet outdoor air dry-bulb temperature for air-cooled units or minimum inlet water temperature for water-cooled units. The unit is disabled below this temperature.
`maximum_source_inlet_temperature` Maximum Source Inlet Temperature	number C	`100.0`	Enter the maximum inlet outdoor air dry-bulb temperature for air-cooled units or maximum inlet water temperature for water-cooled units. The unit is disabled above this temperature.
`minimum_supply_water_temperature_curve_name` Minimum Supply Water Temperature Curve Name	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_supply_water_temperature_curve_name` Maximum Supply Water Temperature Curve Name	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_heat_recovery_outlet_temperature` Maximum Heat Recovery Outlet Temperature	number C	`60.0`	Enter the maximum heat recovery leaving water temperature limit The hot water temperature is not allowed to exceed this value Not available with water source condenser type
`heat_recovery_capacity_modifier_function_of_temperature_curve_name` Heat Recovery Capacity Modifier Function of Temperature Curve Name	reference		Cooling capacity modifier as a function of CW supply temp and condenser entering fluid temp curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) If this field is blank, the AWHP curve without heat recovery will be used Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heat_recovery_electric_input_to_output_ratio_modifier_function_of_temperature_curve_name` Heat Recovery Electric Input to Output Ratio Modifier Function of Temperature Curve Name	reference		Electric Input Ratio (EIR) modifier as a function of temperature EIR = 1/COP curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) chilled water temperature(C) ECT = entering condenser fluid temperature(C) If this field is blank, the AWHP curve without heat recovery will be used Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`thermosiphon_capacity_fraction_curve_name` Thermosiphon Capacity Fraction Curve Name	reference		quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used Tevap, out = evaporator outlet temperature Tcond, in = condenser inlet temperature If this field is blank the thermosiphon model is disabled. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`thermosiphon_minimum_temperature_difference` Thermosiphon Minimum Temperature Difference	number	`0.0`	Thermosiphon model is disabled below this minimum limit and when the load is greater than calculated using the previous field. Range: ≥ 0

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:PlantLoop:EIR:Heating, PlantEquipmentList, PlantEquipmentOperation:ChillerHeaterChangeover

HeatPump:PlantLoop:EIR:Heating¶

from idfpy.models import HeatPumpPlantLoopEIRHeating

An EIR formulated water to water heat pump model, heating operation

Field	Type	Default	Details
`name` Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`condenser_type` Condenser Type	choice	`WaterSource`	One of `AirSource`, `WaterSource`
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`heat_recovery_inlet_node_name` Heat Recovery Inlet Node Name	string		Not available with water source condenser type
`heat_recovery_outlet_node_name` Heat Recovery Outlet Node Name	string		Not available with water source condenser type
`companion_heat_pump_name` Companion Heat Pump Name	reference		This field allows the user to specify a companion cooling object for this heating object. The companion is used in sizing the heat pump as well as to allow checks for unexpected simultaneous operation of the two objects. Names a HeatPump:PlantLoop:EIR:Cooling
`load_side_reference_flow_rate` Load Side Reference Flow Rate	number or `Autosize` m3/s	`Autosize`	This component is currently a constant-flow device, meaning it will always try to request the full design flow from the central plant manager.
`source_side_reference_flow_rate` Source Side Reference Flow Rate	number or `Autosize` m3/s	`Autosize`
`heat_recovery_reference_flow_rate` Heat Recovery Reference Flow Rate	number or `Autosize` m3/s	`Autosize`	Not available with water source condenser type
`reference_capacity` Reference Capacity	number or `Autosize` W	`Autosize`
`reference_coefficient_of_performance` Reference Coefficient of Performance	number W/W	`3.0`	Range: > 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized load side reference flow rate which is then used to autosize the capacity Range: > 0
`capacity_modifier_function_of_temperature_curve_name` Capacity Modifier Function of Temperature Curve Name required	reference		Heating capacity modifier as a function of CW supply temp and entering condenser temp curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) hot water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_output_ratio_modifier_function_of_temperature_curve_name` Electric Input to Output Ratio Modifier Function of Temperature Curve Name required	reference		Electric Input Ratio (EIR) modifier as a function of temperature EIR = 1/COP curve = a + bCWS + cCWS*2 + dECT + eECT2 + fCWS*ECT CWS = supply (leaving) hot water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`electric_input_to_output_ratio_modifier_function_of_part_load_ratio_curve_name` Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name required	reference		Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR) EIR = 1/COP quadratic curve = a + bPLR + cPLR**2 is typical, other univariate curves may be used PLR = part load ratio (hot load/steady state capacity) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`heating_to_cooling_capacity_sizing_ratio` Heating To Cooling Capacity Sizing Ratio	number	`1.0`	Multiplies the autosized heating capacity Range: ≥ 0
`heat_pump_sizing_method` Heat Pump Sizing Method	choice	`CoolingCapacity`	Specifies sizing method when companion coil exists One of `CoolingCapacity`, `GreaterOfHeatingOrCooling`, `HeatingCapacity`
`control_type` Control Type	choice	`Load`	Heat pump can be controlled on leaving water temperature set point or plant load One of `Load`, `Setpoint`
`flow_mode` Flow Mode	choice	`ConstantFlow`	Select operating mode for fluid flow through the chiller. "ConstantFlow" is for constant pumping with flow controlled by chiller to operate at full design flow rate. "VariableSpeedPumping" is for variable pumping with flow proportional to chiller operating part load ratio. One of `ConstantFlow`, `VariableSpeedPumping`
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Below this operating limit compressor cycling will occur Range: ≥ 0
`minimum_source_inlet_temperature` Minimum Source Inlet Temperature	number C	`-100.0`	Enter the minimum inlet outdoor air dry-bulb temperature for air-cooled units or minimum inlet water temperature for water-cooled units. The unit is disabled below this temperature.
`maximum_source_inlet_temperature` Maximum Source Inlet Temperature	number C	`100.0`	Enter the maximum inlet outdoor air dry-bulb temperature for air-cooled units or maximum inlet water temperature for water-cooled units. The unit is disabled above this temperature.
`minimum_supply_water_temperature_curve_name` Minimum Supply Water Temperature Curve Name	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_supply_water_temperature_curve_name` Maximum Supply Water Temperature Curve Name	reference		quadratic curve = a + b*OAT is typical, other univariate curves may be used OAT = Outdoor Dry-Bulb Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`dry_outdoor_correction_factor_curve_name` Dry Outdoor Correction Factor Curve Name	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`maximum_outdoor_dry_bulb_temperature_for_defrost_operation` Maximum Outdoor Dry Bulb Temperature For Defrost Operation	number	`10.0`	defrost operation will not be active above this outdoor temperature
`heat_pump_defrost_control` Heat Pump Defrost Control	choice		A blank field is the same as None. One of `None`, `OnDemand`, `Timed`, `TimedEmpirical`
`heat_pump_defrost_time_period_fraction` Heat Pump Defrost Time Period Fraction	number	`0.058333`	Nominal fraction of time in defrost mode only applicable if Timed or TimedEmpirical heat pump defrost control is specified Range: ≥ 0
`defrost_energy_input_ratio_function_of_temperature_curve_name` Defrost Energy Input Ratio Function of Temperature Curve Name	reference		univariate curve = a + bOAT is typical, other univariate curves may be used bivariate curve = a + bWB + cWB2 + dOAT + eOAT2 + fWB*OAT OAT = outdoor air dry-bulb temperature (C) WB = wet-bulb temperature (C) of air entering the indoor coil only required if Timed or OnDemand defrost strategy is specified Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`timed_empirical_defrost_frequency_curve_name` Timed Empirical Defrost Frequency Curve Name	reference		univariate curve = a + b*OAT is typical, other univariate curves may be used OAT = outdoor air dry-bulb temperature (C) Timed Empirical Defrost Frequency fraction in hours = curve output only applicable if TimedEmpirical defrost control is specified Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`timed_empirical_defrost_heat_load_penalty_curve_name` Timed Empirical Defrost Heat Load Penalty Curve Name	reference		univariate curve = a + bOAT is typical, other univariate curves may be used bivariate curve = a + bWB + cWB2 + dOAT + eOAT2 + fWBOAT OAT = outdoor air dry-bulb temperature (C) WB = wet-bulb temperature (C) of air entering the indoor coil Timed Empirical Defrost Heat Load Penalty in watts = hot load curve output only applicable if TimedEmpirical defrost control is specified Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more
`timed_empirical_defrost_heat_input_energy_fraction_curve_name` Timed Empirical Defrost Heat Input Energy Fraction Curve Name	reference		univariate curve = a + bOAT is typical, other univariate curves may be used bivariate curve = a + bWB + cWB2 + dOAT + eOAT2 + fWBOAT OAT = outdoor air dry-bulb temperature (C) WB = wet-bulb temperature (C) of air entering the indoor coil Timed Empirical Defrost Heat Input Energy in watts = rated hot load curve output only applicable if TimedEmpirical defrost control is specified Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more
`minimum_heat_recovery_outlet_temperature` Minimum Heat Recovery Outlet Temperature	number C	`4.5`	Enter the minimum heat recovery leaving water temperature limit The chilled water temperature is not allowed to drop below this value Not available with water source condenser type
`heat_recovery_capacity_modifier_function_of_temperature_curve_name` Heat Recovery Capacity Modifier Function of Temperature Curve Name	reference		Heating capacity modifier as a function of HW supply temp and entering condenser fluid temp curve = a + bHWS + cHWS*2 + dECT + eECT2 + fHWS*ECT HWS = supply (leaving) hot water temperature(C) ECT = entering condenser fluid temperature(C) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`heat_recovery_electric_input_to_output_ratio_modifier_function_of_temperature_curve_name` Heat Recovery Electric Input to Output Ratio Modifier Function of Temperature Curve Name	reference		Electric Input Ratio (EIR) modifier as a function of temperature EIR = 1/COP curve = a + bHWS + cHWS*2 + dECT + eECT2 + fHWS*ECT HWS = supply (leaving) hot water temperature(C) ECT = entering condenser fluid temperature(C) If this field is blank, the AWHP curve without heat recovery will be used Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:PlantLoop:EIR:Cooling, PlantEquipmentList, PlantEquipmentOperation:ChillerHeaterChangeover

HeatPump:WaterToWater:EquationFit:Cooling¶

from idfpy.models import HeatPumpWaterToWaterEquationFitCooling

simple water-water heat pump curve-fit model

Field	Type	Default	Details
`name` Name required	string
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`reference_load_side_flow_rate` Reference Load Side Flow Rate required	number or `Autosize` m3/s
`reference_source_side_flow_rate` Reference Source Side Flow Rate required	number or `Autosize` m3/s
`reference_cooling_capacity` Reference Cooling Capacity required	number or `Autosize` W
`reference_cooling_power_consumption` Reference Cooling Power Consumption required	number or `Autosize` W
`cooling_capacity_curve_name` Cooling Capacity Curve Name required	reference		Names a Curve:QuadLinear, Table:Lookup
`cooling_compressor_power_curve_name` Cooling Compressor Power Curve Name required	reference		Names a Curve:QuadLinear, Table:Lookup
`reference_coefficient_of_performance` Reference Coefficient of Performance	number W/W	`8.0`	This optional field is used to autosize Reference Cooling Power Consumption COP = Rated Cooling Capacity / Rated Cooling Power Consumption Range: > 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`companion_heating_heat_pump_name` Companion Heating Heat Pump Name	reference		This optional field is used to coordinate sizing calculations between heating and cooling modes. Names a HeatPump:WaterToWater:EquationFit:Heating

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:WaterToWater:EquationFit:Heating, PlantEquipmentList

HeatPump:WaterToWater:EquationFit:Heating¶

from idfpy.models import HeatPumpWaterToWaterEquationFitHeating

simple water-water hp curve-fit model

Field	Type	Default	Details
`name` Name required	string
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`reference_load_side_flow_rate` Reference Load Side Flow Rate required	number or `Autosize` m3/s
`reference_source_side_flow_rate` Reference Source Side Flow Rate required	number or `Autosize` m3/s
`reference_heating_capacity` Reference Heating Capacity required	number or `Autosize` W
`reference_heating_power_consumption` Reference Heating Power Consumption required	number or `Autosize` W
`heating_capacity_curve_name` Heating Capacity Curve Name required	reference		Names a Curve:QuadLinear, Table:Lookup
`heating_compressor_power_curve_name` Heating Compressor Power Curve Name required	reference		Names a Curve:QuadLinear, Table:Lookup
`reference_coefficient_of_performance` Reference Coefficient of Performance	number W/W	`7.5`	This optional field is used to autosize Reference Heating Power Consumption COP = Reference Heating Capacity / Reference Heating Power Consumption Range: > 0
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`companion_cooling_heat_pump_name` Companion Cooling Heat Pump Name	reference		Names a HeatPump:WaterToWater:EquationFit:Cooling

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, HeatPump:WaterToWater:EquationFit:Cooling, PlantEquipmentList

HeatPump:WaterToWater:ParameterEstimation:Cooling¶

from idfpy.models import HeatPumpWaterToWaterParameterEstimationCooling

OSU parameter estimation model

Field	Type	Default	Details
`name` Name required	string
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`nominal_cop` Nominal COP	number W/W		Range: > 0
`nominal_capacity` Nominal Capacity	number W		Range: > 0
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`load_side_flow_rate` Load Side Flow Rate	number m3/s		Range: > 0
`source_side_flow_rate` Source Side Flow Rate	number m3/s		Range: > 0
`load_side_heat_transfer_coefficient` Load Side Heat Transfer Coefficient	number W/K		Range: > 0
`source_side_heat_transfer_coefficient` Source Side Heat Transfer Coefficient	number W/K		Range: > 0
`piston_displacement` Piston Displacement	number m3/s		Range: > 0
`compressor_clearance_factor` Compressor Clearance Factor	number		Range: > 0
`compressor_suction_and_discharge_pressure_drop` Compressor Suction and Discharge Pressure Drop	number Pa		Range: > 0
`superheating` Superheating	number C		Range: > 0
`constant_part_of_electromechanical_power_losses` Constant Part of Electromechanical Power Losses	number W		Range: > 0
`loss_factor` Loss Factor	number		Used to define electromechanical loss that is proportional to the theoretical power % Range: > 0
`high_pressure_cut_off` High Pressure Cut Off	number Pa	`500000000.0`	Range: ≥ 0
`low_pressure_cut_off` Low Pressure Cut Off	number Pa	`0.0`	Range: ≥ 0

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

HeatPump:WaterToWater:ParameterEstimation:Heating¶

from idfpy.models import HeatPumpWaterToWaterParameterEstimationHeating

OSU parameter estimation model

Field	Type	Default	Details
`name` Name required	string
`source_side_inlet_node_name` Source Side Inlet Node Name required	string
`source_side_outlet_node_name` Source Side Outlet Node Name required	string
`load_side_inlet_node_name` Load Side Inlet Node Name required	string
`load_side_outlet_node_name` Load Side Outlet Node Name required	string
`nominal_cop` Nominal COP	number W/W		Range: > 0
`nominal_capacity` Nominal Capacity	number W		Range: > 0
`minimum_part_load_ratio` Minimum Part Load Ratio	number		Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number		Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number		Range: ≥ 0
`load_side_flow_rate` Load Side Flow Rate	number m3/s		Range: > 0
`source_side_flow_rate` Source Side Flow Rate	number m3/s		Range: > 0
`load_side_heat_transfer_coefficient` Load Side Heat Transfer Coefficient	number W/K		Range: > 0
`source_side_heat_transfer_coefficient` Source Side Heat Transfer Coefficient	number W/K		Range: > 0
`piston_displacement` Piston Displacement	number m3/s		Range: > 0
`compressor_clearance_factor` Compressor Clearance Factor	number		Range: > 0
`compressor_suction_and_discharge_pressure_drop` Compressor Suction and Discharge Pressure Drop	number Pa		Range: > 0
`superheating` Superheating	number C		Range: > 0
`constant_part_of_electromechanical_power_losses` Constant Part of Electromechanical Power Losses	number W		Range: > 0
`loss_factor` Loss Factor	number		Used to define electromechanical loss that is proportional to the theoretical power % Range: > 0
`high_pressure_cut_off` High Pressure Cut Off	number Pa	`500000000.0`	Range: ≥ 0
`low_pressure_cut_off` Low Pressure Cut Off	number Pa	`0.0`	Range: ≥ 0

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

PlantComponent:TemperatureSource¶

from idfpy.models import PlantComponentTemperatureSource

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

Field	Type	Details
`name` Name required	string	Component Name
`inlet_node` Inlet Node required	string	Name of the source inlet node
`outlet_node` Outlet Node required	string	Name of the source outlet node
`design_volume_flow_rate` Design Volume Flow Rate required	number or `Autosize` m3/s	The design volumetric flow rate for this source
`temperature_specification_type` Temperature Specification Type	choice	One of `Constant`, `Scheduled`
`source_temperature` Source Temperature	number C	Used if Temperature Specification Type = Constant
`source_temperature_schedule_name` Source Temperature Schedule Name	reference C	Used if Temperature Specification Type = Scheduled Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList