Condenser Equipment and Heat Exchangers¶

21 object types from idfpy.models.condensers · EnergyPlus 26.2

Object	Summary
CoolingTower:SingleSpeed	This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 …
CoolingTower:TwoSpeed	This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 …
CoolingTower:VariableSpeed	This open wet tower model is based on purely empirical algorithms derived from manufacturer's performance …
CoolingTower:VariableSpeed:Merkel	This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 …
CoolingTowerPerformance:CoolTools	This object is used to define coefficients for the approach temperature correlation for a variable speed …
CoolingTowerPerformance:YorkCalc	This object is used to define coefficients for the approach temperature correlation for a variable speed …
EvaporativeFluidCooler:SingleSpeed	This model is based on Merkel's theory, which is also the basis for the cooling tower model in EnergyPlus.
EvaporativeFluidCooler:TwoSpeed	This model is based on Merkel's theory, which is also the basis for the cooling tower model in EnergyPlus.
FluidCooler:SingleSpeed	The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with single-speed fans …
FluidCooler:TwoSpeed	The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with two-speed fans …
GroundHeatExchanger:HorizontalTrench	This models a horizontal heat exchanger placed in a series of trenches The model uses the …
GroundHeatExchanger:Pond	A model of a shallow pond with immersed pipe loops.
GroundHeatExchanger:ResponseFactors	Response factor definitions from third-party tool, commonly referred to a "g-functions"
GroundHeatExchanger:Slinky	This models a slinky horizontal heat exchanger placed in a series of trenches The model uses the model …
GroundHeatExchanger:Surface	A hydronic surface/panel consisting of a multi-layer construction with embedded rows of tubes.
GroundHeatExchanger:System	Models vertical ground heat exchangers systems using the response factor approach developed by Eskilson.
GroundHeatExchanger:Vertical:Array
GroundHeatExchanger:Vertical:Properties	Properties for vertical ground heat exchanger systems
GroundHeatExchanger:Vertical:Single
GroundHeatExchanger:Vertical:Sizing:Rectangle	Specifies parameters to be used for Ground Heat Exchanger borehole field design and sizing.
HeatExchanger:FluidToFluid	A fluid/fluid heat exchanger designed to couple the supply side of one loop to the demand side of another …

CoolingTower:SingleSpeed¶

from idfpy.models import CoolingTowerSingleSpeed

This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a single-speed fan drawing air through the tower (induced-draft configuration). Added fluid bypass as an additional capacity control. 8/2008. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Field	Type	Default	Details
`name` Name required	string		Tower Name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of tower water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of tower water outlet node
`design_water_flow_rate` Design Water Flow Rate	number or `Autosize` m3/s		Leave field blank if tower performance input method is NominalCapacity
`design_air_flow_rate` Design Air Flow Rate required	number or `Autosize` m3/s
`design_fan_power` Design Fan Power required	number or `Autosize` W		This is the fan motor electric input power
`design_u_factor_times_area_value` Design U-Factor Times Area Value	number or `Autosize` W/K		Leave field blank if tower performance input method is NominalCapacity
`free_convection_regime_air_flow_rate` Free Convection Regime Air Flow Rate	number or `Autocalculate` m3/s	`0.0`
`free_convection_regime_air_flow_rate_sizing_factor` Free Convection Regime Air Flow Rate Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate. Range: > 0, < 1
`free_convection_regime_u_factor_times_area_value` Free Convection Regime U-Factor Times Area Value	number or `Autocalculate` W/K	`0.0`
`free_convection_u_factor_times_area_value_sizing_factor` Free Convection U-Factor Times Area Value Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate Range: > 0, < 1
`performance_input_method` Performance Input Method	choice	`UFactorTimesAreaAndDesignWaterFlowRate`	User can define tower thermal performance by specifying the tower UA, the Design Air Flow Rate and the Design Water Flow Rate, or by specifying the tower nominal capacity One of `NominalCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`
`heat_rejection_capacity_and_nominal_capacity_sizing_ratio` Heat Rejection Capacity and Nominal Capacity Sizing Ratio	number	`1.25`
`nominal_capacity` Nominal Capacity	number W		Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt (3 gpm/ton). Nominal tower capacity times (1.25) gives the actual tower heat rejection at these operating conditions. Range: > 0
`free_convection_capacity` Free Convection Capacity	number or `Autocalculate` W		Tower capacity in free convection regime with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt of nominal tower capacity (3 gpm/ton). Tower free convection capacity times (1.25) gives the actual tower heat rejection at these operating conditions.
`free_convection_nominal_capacity_sizing_factor` Free Convection Nominal Capacity Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate Range: > 0, < 1
`design_inlet_air_dry_bulb_temperature` Design Inlet Air Dry-Bulb Temperature	number C	`35.0`	Enter the tower's design inlet air dry-bulb temperature Range: ≥ 20
`design_inlet_air_wet_bulb_temperature` Design Inlet Air Wet-Bulb Temperature	number C	`25.6`	Enter the tower's design inlet air wet-bulb temperature Range: ≥ 10
`design_approach_temperature` Design Approach Temperature	number or `Autosize` deltaC	`Autosize`	Enter the approach temperature corresponding to the design inlet air wet-bulb temperature and design range temperature. Design approach temp = outlet water temperature minus inlet air wet-bulb temperature at design conditions. Autosized to 3.9 deltaC.
`design_range_temperature` Design Range Temperature	number or `Autosize` deltaC	`Autosize`	Enter the range temperature corresponding to the design inlet air wet-bulb temperature and design approach temperature. Design range = inlet water temperature minus outlet water temperature at design conditions. Autosized to 5.5 deltaC.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	This 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 water is not flowing through the tower. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	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		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
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K	`0.2`	Rate of water evaporation from the cooling tower and lost to the outdoor air [%/K] Evaporation loss is calculated as percentage of the circulating condenser water rate Value entered here is percent-per-degree K of temperature drop in the condenser water Typical values are from 0.15 to 0.27 [%/K].
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Rate of drift loss as a percentage of circulating condenser water flow rate Typical values are between 0.002 and 0.2% The default value is 0.008%
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the cooling tower. Blowdown is water intentionally drained from the tower in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5. The default value is 3. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining a small amount of water in the tower basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`capacity_control` Capacity Control	choice	`FanCycling`	One of `FanCycling`, `FluidBypass`
`number_of_cells` Number of Cells	integer	`1`	Range: ≥ 1
`cell_control` Cell Control	choice	`MaximalCell`	One of `MaximalCell`, `MinimalCell`
`cell_minimum_water_flow_rate_fraction` Cell Minimum Water Flow Rate Fraction	number	`0.33`	The allowable minimal fraction of the nominal flow rate per cell Range: > 0, ≤ 1
`cell_maximum_water_flow_rate_fraction` Cell Maximum Water Flow Rate Fraction	number	`2.5`	The allowable maximal fraction of the nominal flow rate per cell Range: ≥ 1
`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 7 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, FaultModel:Fouling:CoolingTower, FaultModel:TemperatureSensorOffset:CondenserSupplyWater, HVACTemplate:Plant:Tower:ObjectReference, PlantEquipmentList

CoolingTower:TwoSpeed¶

from idfpy.models import CoolingTowerTwoSpeed

This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a two-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Field	Type	Default	Details
`name` Name required	string		Tower Name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of tower Water Inlet Node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of tower Water Outlet Node
`design_water_flow_rate` Design Water Flow Rate	number or `Autosize` m3/s		Leave field blank if Tower Performance Input Method is NominalCapacity
`high_fan_speed_air_flow_rate` High Fan Speed Air Flow Rate required	number or `Autosize` m3/s
`high_fan_speed_fan_power` High Fan Speed Fan Power required	number or `Autosize` W		This is the fan motor electric input power at high speed
`high_fan_speed_u_factor_times_area_value` High Fan Speed U-Factor Times Area Value	number or `Autosize` W/K		Leave field blank if Tower Performance Input Method is NominalCapacity
`low_fan_speed_air_flow_rate` Low Fan Speed Air Flow Rate required	number or `Autocalculate` m3/s		Low speed air flow rate must be less than high speed air flow rate Low speed air flow rate must be greater than free convection air flow rate
`low_fan_speed_air_flow_rate_sizing_factor` Low Fan Speed Air Flow Rate Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate. Range: > 0, < 1
`low_fan_speed_fan_power` Low Fan Speed Fan Power required	number or `Autocalculate` W		This is the fan motor electric input power at low speed
`low_fan_speed_fan_power_sizing_factor` Low Fan Speed Fan Power Sizing Factor	number	`0.16`	This field is only used if the previous field is set to autocalculate. Range: > 0, < 1
`low_fan_speed_u_factor_times_area_value` Low Fan Speed U-Factor Times Area Value	number or `Autocalculate` W/K		Leave field blank if tower Performance Input Method is NominalCapacity Low speed tower UA must be less than high speed tower UA Low speed tower UA must be greater than free convection tower UA
`low_fan_speed_u_factor_times_area_sizing_factor` Low Fan Speed U-Factor Times Area Sizing Factor	number	`0.6`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate Range: > 0, < 1
`free_convection_regime_air_flow_rate` Free Convection Regime Air Flow Rate	number or `Autocalculate` m3/s	`0.0`
`free_convection_regime_air_flow_rate_sizing_factor` Free Convection Regime Air Flow Rate Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate. Range: > 0, < 1
`free_convection_regime_u_factor_times_area_value` Free Convection Regime U-Factor Times Area Value	number or `Autocalculate` W/K	`0.0`	Leave field blank if Tower Performance Input Method is NominalCapacity
`free_convection_u_factor_times_area_value_sizing_factor` Free Convection U-Factor Times Area Value Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate Range: > 0, < 1
`performance_input_method` Performance Input Method	choice	`UFactorTimesAreaAndDesignWaterFlowRate`	User can define tower thermal performance by specifying the tower UA, the Design Air Flow Rate and the Design Water Flow Rate, or by specifying the tower nominal capacity One of `NominalCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`
`heat_rejection_capacity_and_nominal_capacity_sizing_ratio` Heat Rejection Capacity and Nominal Capacity Sizing Ratio	number	`1.25`
`high_speed_nominal_capacity` High Speed Nominal Capacity	number W		Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature, with the tower fan operating at high speed. Design water flow rate assumed to be 5.382E-8 m3/s per watt(3 gpm/ton). Nominal tower capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat rejection at these operating conditions. Range: > 0
`low_speed_nominal_capacity` Low Speed Nominal Capacity	number or `Autocalculate` W		Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature, with the tower fan operating at low speed. Design water flow rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Nominal tower capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat rejection at these operating conditions.
`low_speed_nominal_capacity_sizing_factor` Low Speed Nominal Capacity Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate Range: > 0, < 1
`free_convection_nominal_capacity` Free Convection Nominal Capacity	number or `Autocalculate` W		Tower capacity in free convection regime with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Tower free convection capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat rejection at these operating conditions
`free_convection_nominal_capacity_sizing_factor` Free Convection Nominal Capacity Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate Range: > 0, < 1
`design_inlet_air_dry_bulb_temperature` Design Inlet Air Dry-Bulb Temperature	number C	`35.0`	Enter the tower's design inlet air dry-bulb temperature Range: ≥ 20
`design_inlet_air_wet_bulb_temperature` Design Inlet Air Wet-Bulb Temperature	number C	`25.6`	Enter the tower's design inlet air wet-bulb temperature Range: ≥ 10
`design_approach_temperature` Design Approach Temperature	number or `Autosize` deltaC	`Autosize`	Enter the approach temperature corresponding to the design inlet air wet-bulb temperature and design range temperature. Design approach temp = outlet water temperature minus inlet air wet-bulb temperature at design conditions. Autosized to 3.9 deltaC.
`design_range_temperature` Design Range Temperature	number or `Autosize` deltaC	`Autosize`	Enter the range temperature corresponding to the design inlet air wet-bulb temperature and design approach temperature. Design range = inlet water temperature minus outlet water temperature at design conditions. Autosized to 5.5 deltaC.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	This 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 water is not flowing through the tower. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	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		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
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K	`0.2`	Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K] Evaporation loss is calculated as percentage of the circulating condenser water rate Value entered here is percent-per-degree K of temperature drop in the condenser water Typical values are from 0.15 to 0.27 [%/K].
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Rate of drift loss as a percentage of circulating condenser water flow rate Typical values are between 0.002 and 0.2% The default value is 0.008%
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the cooling tower. Blowdown is water intentionally drained from the tower in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5. The default value is 3. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining some amount of water in the tower basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`number_of_cells` Number of Cells	integer	`1`	Range: ≥ 1
`cell_control` Cell Control	choice	`MaximalCell`	One of `MaximalCell`, `MinimalCell`
`cell_minimum_water_flow_rate_fraction` Cell Minimum Water Flow Rate Fraction	number	`0.33`	The allowable minimal fraction of the nominal flow rate per cell Range: > 0, ≤ 1
`cell_maximum_water_flow_rate_fraction` Cell Maximum Water Flow Rate Fraction	number	`2.5`	The allowable maximal fraction of the nominal flow rate per cell Range: ≥ 1
`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 7 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, FaultModel:Fouling:CoolingTower, FaultModel:TemperatureSensorOffset:CondenserSupplyWater, HVACTemplate:Plant:Tower:ObjectReference, PlantEquipmentList

CoolingTower:VariableSpeed¶

from idfpy.models import CoolingTowerVariableSpeed

This open wet tower model is based on purely empirical algorithms derived from manufacturer's performance data or field measurements. The user can select from two existing algorithms (CoolTools or YorkCalc), or they can enter their own correlation for approach temperature by using a variable speed tower model coefficient object. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Field	Type	Default	Details
`name` Name required	string		Tower Name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of tower water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of tower water outlet node
`model_type` Model Type	choice	`YorkCalc`	Determines the coefficients and form of the equation for calculating approach temperature One of `CoolToolsCrossFlow`, `CoolToolsUserDefined`, `YorkCalc`, `YorkCalcUserDefined`
`model_coefficient_name` Model Coefficient Name	reference		Name of the tower model coefficient object. Used only when tower Model Type is either CoolToolsUserDefined or YorkCalcUserDefined. Names a CoolingTowerPerformance:CoolTools, CoolingTowerPerformance:YorkCalc
`design_inlet_air_wet_bulb_temperature` Design Inlet Air Wet-Bulb Temperature	number C	`25.6`	Enter the tower's design inlet air wet-bulb temperature Range: ≥ 10
`design_approach_temperature` Design Approach Temperature	number deltaC	`3.9`	Enter the approach temperature corresponding to the design inlet air wet-bulb temperature and design range temperature. Design approach temp = outlet water temperature minus inlet air wet-bulb temperature at design conditions. Range: > 0
`design_range_temperature` Design Range Temperature	number deltaC	`5.6`	Enter the range temperature corresponding to the design inlet air wet-bulb temperature and design approach temperature. Design range = inlet water temperature minus outlet water temperature at design conditions. Range: > 0
`design_water_flow_rate` Design Water Flow Rate required	number or `Autosize` m3/s		Water flow rate through the tower at design conditions
`design_air_flow_rate` Design Air Flow Rate required	number or `Autosize` m3/s		Design (maximum) air flow rate through the tower
`design_fan_power` Design Fan Power required	number or `Autosize` W		Enter the fan motor electric input power at design (max) air flow through the tower Standard conversion for horsepower is 1 HP = 745.7 W
`fan_power_ratio_function_of_air_flow_rate_ratio_curve_name` Fan Power Ratio Function of Air Flow Rate Ratio Curve Name	reference		FPR = a + bAFR + cAFR*2 + dAFR**3 FPR = fraction of the design fan power AFR = fraction of the design air flow rate If left blank, then fan power is assumed to be proportional to (air flow rate ratio)^3 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_air_flow_rate_ratio` Minimum Air Flow Rate Ratio	number	`0.2`	Enter the minimum air flow rate ratio. This is typically determined by the variable speed drive that controls the fan motor speed. Valid entries are from 0.2 to 0.5. Range: ≥ 0.2, ≤ 0.5
`fraction_of_tower_capacity_in_free_convection_regime` Fraction of Tower Capacity in Free Convection Regime	number	`0.125`	Enter the fraction of tower capacity in the free convection regime. This is the fraction of the tower capacity, at the current inlet air wet-bulb temperature, that is available when the tower fan is off. Manufacturers typically estimate the free convection capacity at approximately 10-15%. Values are entered as a fraction and can range from 0 to 0.2. Range: ≥ 0, ≤ 0.2
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	This 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 water is not flowing through the tower. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	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		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
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K	`0.2`	Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K] Evaporation loss is calculated as percentage of the circulating condenser water rate Value entered here is percent-per-degree K of temperature drop in the condenser water Typical values are from 0.15 to 0.27 [percent/K].
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Rate of drift loss as a percentage of circulating condenser water flow rate Typical values are between 0.002 and 0.2% The default value is 0.008%
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the cooling tower. Blowdown is water intentionally drained from the tower in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5. The default value is 3. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining a small amount of water in the tower basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`number_of_cells` Number of Cells	integer	`1`	Range: ≥ 1
`cell_control` Cell Control	choice	`MaximalCell`	One of `MaximalCell`, `MinimalCell`
`cell_minimum_water_flow_rate_fraction` Cell Minimum Water Flow Rate Fraction	number	`0.33`	The allowable minimal fraction of the nominal flow rate per cell Range: > 0, ≤ 1
`cell_maximum_water_flow_rate_fraction` Cell Maximum Water Flow Rate Fraction	number	`2.5`	The allowable maximal fraction of the nominal flow rate per cell Range: ≥ 1
`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 6 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, FaultModel:TemperatureSensorOffset:CondenserSupplyWater, HVACTemplate:Plant:Tower:ObjectReference, PlantEquipmentList

CoolingTower:VariableSpeed:Merkel¶

from idfpy.models import CoolingTowerVariableSpeedMerkel

This tower model is based on Merkel's theory, which is also the basis for the tower model in ASHRAE's HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a variable-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Field	Type	Default	Details
`name` Name required	string		Tower Name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of tower water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of tower water outlet node
`performance_input_method` Performance Input Method	choice	`NominalCapacity`	User can define tower thermal performance by specifying the tower UA, the Design Air Flow Rate and the Design Water Flow Rate, or by specifying the tower nominal capacity One of `NominalCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`
`heat_rejection_capacity_and_nominal_capacity_sizing_ratio` Heat Rejection Capacity and Nominal Capacity Sizing Ratio	number	`1.25`
`nominal_capacity` Nominal Capacity	number or `Autosize` W		Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature, with the tower fan operating at Design Air Flow Rate (full speed). Design water flow rate is as set in Design Water Flow Rate per Unit of Nominal Capacity. Nominal tower capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat rejection at these operating conditions.
`free_convection_nominal_capacity` Free Convection Nominal Capacity	number or `Autocalculate` W		required field when performance method is NominalCapacity Tower capacity in free convection regime with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate is as set in Design Water Flow Rate per Unit of Nominal Capacity. Tower free convection capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat rejection at these operating conditions
`free_convection_nominal_capacity_sizing_factor` Free Convection Nominal Capacity Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate Range: > 0, < 1
`design_water_flow_rate` Design Water Flow Rate required	number or `Autosize` m3/s
`design_water_flow_rate_per_unit_of_nominal_capacity` Design Water Flow Rate per Unit of Nominal Capacity	number m3/s-W	`5.382e-08`	This field is only used if the previous is set to autocalculate and performance input method is NominalCapacity
`design_air_flow_rate` Design Air Flow Rate required	number or `Autocalculate` m3/s		This is the air flow rate at full fan speed
`design_air_flow_rate_per_unit_of_nominal_capacity` Design Air Flow Rate Per Unit of Nominal Capacity	number m3/s-W	`2.76316e-05`	This field is only used if the previous is set to autocalculate When field is left blank the default scaling factor is adjusted for elevation to increase volume flow at altitude When field has a value the scaling factor is used without adjusting for elevation
`minimum_air_flow_rate_ratio` Minimum Air Flow Rate Ratio	number	`0.2`	Enter the minimum air flow rate ratio. This is typically determined by the variable speed drive that controls the fan motor speed. Valid entries are from 0.1 to 0.5. Range: ≥ 0.1, ≤ 0.5
`design_fan_power` Design Fan Power required	number or `Autocalculate` W		This is the fan motor electric input power at high speed
`design_fan_power_per_unit_of_nominal_capacity` Design Fan Power Per Unit of Nominal Capacity	number dimensionless	`0.0105`	This field is only used if the previous is set to autocalculate [W/W] Watts of fan power per Watt of tower nominal capacity
`fan_power_modifier_function_of_air_flow_rate_ratio_curve_name` Fan Power Modifier Function of Air Flow Rate Ratio Curve Name required	reference		Any curve or table with one independent variable can be used cubic curve = a + bAFR + cAFR*2 + dAFR*3 quartic curve = a + bAFR + cAFR2 + dAFR*3 + eAFR**4 x = AFR = Ratio of current operating air flow rate to Design Air Flow Rate 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
`free_convection_regime_air_flow_rate` Free Convection Regime Air Flow Rate	number or `Autocalculate` m3/s	`0.0`
`free_convection_regime_air_flow_rate_sizing_factor` Free Convection Regime Air Flow Rate Sizing Factor	number	`0.1`	This field is only used if the previous field is set to autocalculate. Range: > 0, < 1
`design_air_flow_rate_u_factor_times_area_value` Design Air Flow Rate U-Factor Times Area Value	number or `Autosize` W/K		required field when performance method is UFactorTimesAreaAndDesignWaterFlowRate when performance method is NominalCapacity the program will solve for this UA
`free_convection_regime_u_factor_times_area_value` Free Convection Regime U-Factor Times Area Value	number or `Autocalculate` W/K	`0.0`	required field when performance input method is UFactorTimesAreaAndDesignWaterFlowRate Leave field blank if performance input method is NominalCapacity
`free_convection_u_factor_times_area_value_sizing_factor` Free Convection U-Factor Times Area Value Sizing Factor	number	`0.1`	required field when performance input method is UFactorTimesAreaAndDesignWaterFlowRate This field is only used if the previous field is set to autocalculate and the performance input method is UFactorTimesAreaAndDesignWaterFlowRate Range: > 0, < 1
`u_factor_times_area_modifier_function_of_air_flow_ratio_curve_name` U-Factor Times Area Modifier Function of Air Flow Ratio Curve Name required	reference		This curve describes how tower's design UA changes with variable air flow rate Any curve or table with one independent variable can be used cubic curve = a + bAFR + cAFR*2 + dAFR*3 quartic curve = a + bAFR + cAFR2 + dAFR*3 + eAFR**4 x = AFR = Ratio of current operating air flow rate to Design Air Flow Rate 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
`u_factor_times_area_modifier_function_of_wetbulb_temperature_difference_curve_name` U-Factor Times Area Modifier Function of Wetbulb Temperature Difference Curve Name required	reference		curve describes how tower UA changes with outdoor air wet-bulb temperature difference from design wet-bulb Any curve or table with one independent variable can be used cubic curve = a + bDeltaWB + cDeltaWB*2 + dDeltaWB*3 quartic curve = a + bDeltaWB + cDeltaWB2 + dDeltaWB*3 + eDeltaWB**4 x = DeltaWB = (design wet-bulb temperature in C - current wet-bulb temperature in C) where design wet-bulb temperature of entering air is 25.56C (78F) 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
`u_factor_times_area_modifier_function_of_water_flow_ratio_curve_name` U-Factor Times Area Modifier Function of Water Flow Ratio Curve Name required	reference		curve describes how tower UA changes with the flow rate of condenser water through the tower Any curve or table with one independent variable can be used cubic curve = a + bWFR + cWFR*2 + dWFR*3 quartic curve = a + bWFR + cWFR2 + dWFR*3 + eWFR**4 x = WFR = Ratio of current operating water flow rate to Design Water Flow Rate 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
`design_inlet_air_dry_bulb_temperature` Design Inlet Air Dry-Bulb Temperature	number C	`35.0`	Enter the tower's design inlet air dry-bulb temperature Range: ≥ 20
`design_inlet_air_wet_bulb_temperature` Design Inlet Air Wet-Bulb Temperature	number C	`25.6`	Enter the tower's design inlet air wet-bulb temperature Range: ≥ 10
`design_approach_temperature` Design Approach Temperature	number or `Autosize` deltaC	`Autosize`	Enter the approach temperature corresponding to the design inlet air wet-bulb temperature and design range temperature. Design approach temp = outlet water temperature minus inlet air wet-bulb temperature at design conditions. Autosized to 3.9 deltaC.
`design_range_temperature` Design Range Temperature	number or `Autosize` deltaC	`Autosize`	Enter the range temperature corresponding to the design inlet air wet-bulb temperature and design approach temperature. Design range = inlet water temperature minus outlet water temperature at design conditions. Autosized to 5.5 deltaC.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	This 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 water is not flowing through the tower. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	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		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
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K	`0.2`	Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K] Evaporation loss is calculated as percentage of the circulating condenser water rate Value entered here is percent-per-degree K of temperature drop in the condenser water Typical values are from 0.15 to 0.27 [%/K].
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Rate of drift loss as a percentage of circulating condenser water flow rate Typical values are between 0.002 and 0.2% The default value is 0.008%
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the cooling tower. Blowdown is water intentionally drained from the tower in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5. The default value is 3. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining some amount of water in the tower basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`number_of_cells` Number of Cells	integer	`1`	Range: ≥ 1
`cell_control` Cell Control	choice	`MaximalCell`	One of `MaximalCell`, `MinimalCell`
`cell_minimum_water_flow_rate_fraction` Cell Minimum Water Flow Rate Fraction	number	`0.33`	The allowable minimal fraction of the nominal flow rate per cell Range: > 0, ≤ 1
`cell_maximum_water_flow_rate_fraction` Cell Maximum Water Flow Rate Fraction	number	`2.5`	The allowable maximal fraction of the nominal flow rate per cell Range: ≥ 1
`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 7 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, FaultModel:Fouling:CoolingTower, FaultModel:TemperatureSensorOffset:CondenserSupplyWater, HVACTemplate:Plant:Tower:ObjectReference, PlantEquipmentList

CoolingTowerPerformance:CoolTools¶

from idfpy.models import CoolingTowerPerformanceCoolTools

This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as CoolToolsUserDefined in the object CoolingTower:VariableSpeed.

Field	Type	Details
`name` Name required	string
`minimum_inlet_air_wet_bulb_temperature` Minimum Inlet Air Wet-Bulb Temperature required	number C	Minimum valid inlet air wet-bulb temperature for this approach temperature correlation.
`maximum_inlet_air_wet_bulb_temperature` Maximum Inlet Air Wet-Bulb Temperature required	number C	Maximum valid inlet air wet-bulb temperature for this approach temperature correlation.
`minimum_range_temperature` Minimum Range Temperature required	number deltaC	Minimum valid range temperature for this approach temperature correlation.
`maximum_range_temperature` Maximum Range Temperature required	number deltaC	Maximum valid range temperature for this approach temperature correlation.
`minimum_approach_temperature` Minimum Approach Temperature required	number deltaC	Minimum valid approach temperature for this correlation.
`maximum_approach_temperature` Maximum Approach Temperature required	number deltaC	Maximum valid approach temperature for this correlation.
`minimum_water_flow_rate_ratio` Minimum Water Flow Rate Ratio required	number	Minimum valid water flow rate ratio for this approach temperature correlation.
`maximum_water_flow_rate_ratio` Maximum Water Flow Rate Ratio required	number	Maximum valid water flow rate ratio for this approach temperature correlation.
`coefficient_1` Coefficient 1 required	number
`coefficient_2` Coefficient 2 required	number
`coefficient_3` Coefficient 3 required	number
`coefficient_4` Coefficient 4 required	number
`coefficient_5` Coefficient 5 required	number
`coefficient_6` Coefficient 6 required	number
`coefficient_7` Coefficient 7 required	number
`coefficient_8` Coefficient 8 required	number
`coefficient_9` Coefficient 9 required	number
`coefficient_10` Coefficient 10 required	number
`coefficient_11` Coefficient 11 required	number
`coefficient_12` Coefficient 12 required	number
`coefficient_13` Coefficient 13 required	number
`coefficient_14` Coefficient 14 required	number
`coefficient_15` Coefficient 15 required	number
`coefficient_16` Coefficient 16 required	number
`coefficient_17` Coefficient 17 required	number
`coefficient_18` Coefficient 18 required	number
`coefficient_19` Coefficient 19 required	number
`coefficient_20` Coefficient 20 required	number
`coefficient_21` Coefficient 21 required	number
`coefficient_22` Coefficient 22 required	number
`coefficient_23` Coefficient 23 required	number
`coefficient_24` Coefficient 24 required	number
`coefficient_25` Coefficient 25 required	number
`coefficient_26` Coefficient 26 required	number
`coefficient_27` Coefficient 27 required	number
`coefficient_28` Coefficient 28 required	number
`coefficient_29` Coefficient 29 required	number
`coefficient_30` Coefficient 30 required	number
`coefficient_31` Coefficient 31 required	number
`coefficient_32` Coefficient 32 required	number
`coefficient_33` Coefficient 33 required	number
`coefficient_34` Coefficient 34 required	number
`coefficient_35` Coefficient 35 required	number

Referenced by 1 object types

CoolingTower:VariableSpeed

CoolingTowerPerformance:YorkCalc¶

from idfpy.models import CoolingTowerPerformanceYorkCalc

This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as YorkCalcUserDefined in the object CoolingTower:VariableSpeed.

Field	Type	Details
`name` Name required	string
`minimum_inlet_air_wet_bulb_temperature` Minimum Inlet Air Wet-Bulb Temperature required	number C	Minimum valid inlet air wet-bulb temperature for this approach temperature correlation.
`maximum_inlet_air_wet_bulb_temperature` Maximum Inlet Air Wet-Bulb Temperature required	number C	Maximum valid inlet air wet-bulb temperature for this approach temperature correlation.
`minimum_range_temperature` Minimum Range Temperature required	number deltaC	Minimum valid range temperature for this approach temperature correlation.
`maximum_range_temperature` Maximum Range Temperature required	number deltaC	Maximum valid range temperature for this approach temperature correlation.
`minimum_approach_temperature` Minimum Approach Temperature required	number deltaC	Minimum valid approach temperature for this correlation.
`maximum_approach_temperature` Maximum Approach Temperature required	number deltaC	Maximum valid approach temperature for this correlation.
`minimum_water_flow_rate_ratio` Minimum Water Flow Rate Ratio required	number	Minimum valid water flow rate ratio for this approach temperature correlation.
`maximum_water_flow_rate_ratio` Maximum Water Flow Rate Ratio required	number	Maximum valid water flow rate ratio for this approach temperature correlation.
`maximum_liquid_to_gas_ratio` Maximum Liquid to Gas Ratio required	number	Maximum liquid (water) to gas (air) ratio for this approach temperature correlation.
`coefficient_1` Coefficient 1 required	number
`coefficient_2` Coefficient 2 required	number
`coefficient_3` Coefficient 3 required	number
`coefficient_4` Coefficient 4 required	number
`coefficient_5` Coefficient 5 required	number
`coefficient_6` Coefficient 6 required	number
`coefficient_7` Coefficient 7 required	number
`coefficient_8` Coefficient 8 required	number
`coefficient_9` Coefficient 9 required	number
`coefficient_10` Coefficient 10 required	number
`coefficient_11` Coefficient 11 required	number
`coefficient_12` Coefficient 12 required	number
`coefficient_13` Coefficient 13 required	number
`coefficient_14` Coefficient 14 required	number
`coefficient_15` Coefficient 15 required	number
`coefficient_16` Coefficient 16 required	number
`coefficient_17` Coefficient 17 required	number
`coefficient_18` Coefficient 18 required	number
`coefficient_19` Coefficient 19 required	number
`coefficient_20` Coefficient 20 required	number
`coefficient_21` Coefficient 21 required	number
`coefficient_22` Coefficient 22 required	number
`coefficient_23` Coefficient 23 required	number
`coefficient_24` Coefficient 24 required	number
`coefficient_25` Coefficient 25 required	number
`coefficient_26` Coefficient 26 required	number
`coefficient_27` Coefficient 27 required	number

Referenced by 1 object types

CoolingTower:VariableSpeed

EvaporativeFluidCooler:SingleSpeed¶

from idfpy.models import EvaporativeFluidCoolerSingleSpeed

This model is based on Merkel's theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

Field	Type	Default	Details
`name` Name required	string		Fluid Cooler Name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of Fluid Cooler water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of Fluid Cooler water outlet node
`design_air_flow_rate` Design Air Flow Rate required	number or `Autosize` m3/s
`design_air_flow_rate_fan_power` Design Air Flow Rate Fan Power required	number or `Autosize` W		This is the fan motor electric input power
`design_spray_water_flow_rate` Design Spray Water Flow Rate required	number m3/s		Range: > 0
`performance_input_method` Performance Input Method required	choice		User can define fluid cooler thermal performance by specifying the fluid cooler UA and the Design Water Flow Rate, or by specifying the fluid cooler Standard Design Capacity or by specifying Design Capacity for Non standard conditions. One of `StandardDesignCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`, `UserSpecifiedDesignCapacity`
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`heat_rejection_capacity_and_nominal_capacity_sizing_ratio` Heat Rejection Capacity and Nominal Capacity Sizing Ratio	number	`1.25`
`standard_design_capacity` Standard Design Capacity	number W		Standard design capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt (3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler heat rejection at these operating conditions. Only used for Performance Input Method = StandardDesignCapacity; for other input methods, this field is ignored. The standard conditions mentioned above for Standard design capacity are already specified in the EnergyPlus. So the input fields such as design entering water temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if provided in the input, will be ignored for the StandardDesignCapacity performance input method. Also, the standard conditions are for water as a fluid type so this performance input method can only be used with water as a fluid type (as specified in CondenserLoop object). Range: > 0
`design_air_flow_rate_u_factor_times_area_value` Design Air Flow Rate U-factor Times Area Value	number or `Autosize` W/K		Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate; for other Performance Input Methods, this field is ignored.
`design_water_flow_rate` Design Water Flow Rate	number or `Autosize` m3/s		Input value is ignored if fluid cooler Performance Input Method= StandardDesignCapacity.
`user_specified_design_capacity` User Specified Design Capacity	number W		Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Range: > 0
`design_entering_water_temperature` Design Entering Water Temperature	number or `Autosize` C	`Autosize`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Water Temperature must be greater than Design Entering Air Temperature.
`design_entering_air_temperature` Design Entering Air Temperature	number C	`35.0`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Air Temperature must be greater than Design Entering Air Wet-bulb Temperature. Range: > 0
`design_entering_air_wet_bulb_temperature` Design Entering Air Wet-bulb Temperature	number C	`25.6`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Air Wet-bulb Temperature must be less than Design Entering Air Temperature. Range: > 0
`capacity_control` Capacity Control	choice	`FanCycling`	One of `FanCycling`, `FluidBypass`
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K		Rate of water evaporation from the Fluid Cooler and lost to the outdoor air [%/K] Empirical correlation is used to calculate default loss factor if it not explicitly provided.
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Rate of drift loss as a percentage of circulating spray water flow rate Default value for this field is under investigation. For now Cooling tower's drift loss percent default value is taken here.
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the Evaporative Fluid Cooler. Blowdown is water intentionally drained from the basin in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Default value for this field is under investigation. For now Cooling tower's Blowdown Concentration Ratio percent default value is taken here. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining a small amount of water in the Fluid Cooler basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

EvaporativeFluidCooler:TwoSpeed¶

from idfpy.models import EvaporativeFluidCoolerTwoSpeed

This model is based on Merkel's theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

Field	Type	Default	Details
`name` Name required	string		fluid cooler name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of fluid cooler water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of fluid cooler water outlet node
`high_fan_speed_air_flow_rate` High Fan Speed Air Flow Rate required	number or `Autosize` m3/s
`high_fan_speed_fan_power` High Fan Speed Fan Power required	number or `Autosize` W		This is the fan motor electric input power at high speed
`low_fan_speed_air_flow_rate` Low Fan Speed Air Flow Rate required	number or `Autocalculate` m3/s		Low speed air flow rate must be less than high speed air flow rate
`low_fan_speed_air_flow_rate_sizing_factor` Low Fan Speed Air Flow Rate Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate
`low_fan_speed_fan_power` Low Fan Speed Fan Power required	number or `Autocalculate` W		This is the fan motor electric input power at low speed
`low_fan_speed_fan_power_sizing_factor` Low Fan Speed Fan Power Sizing Factor	number	`0.16`	This field is only used if the previous field is set to autocalculate.
`design_spray_water_flow_rate` Design Spray Water Flow Rate required	number m3/s		Range: > 0
`performance_input_method` Performance Input Method required	choice		User can define fluid cooler thermal performance by specifying the fluid cooler UA and the Design Water Flow Rate, or by specifying the fluid cooler Standard Design Capacity or by specifying Design Capacity for Non standard conditions. One of `StandardDesignCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`, `UserSpecifiedDesignCapacity`
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node
`heat_rejection_capacity_and_nominal_capacity_sizing_ratio` Heat Rejection Capacity and Nominal Capacity Sizing Ratio	number	`1.25`
`high_speed_standard_design_capacity` High Speed Standard Design Capacity	number W		Standard design capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt (3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler heat rejection at these operating conditions. Only used for Performance Input Method = StandardDesignCapacity; for other input methods, this field is ignored. The standard conditions mentioned above for Standard design capacity are already specified in the EnergyPlus. So the input fields such as design entering water temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if provided in the input, will be ignored for the StandardDesignCapacity performance input method. Also, the standard conditions are for water as a fluid type so this performance input method can only be used with water as a fluid type (as specified in CondenserLoop object). Range: > 0
`low_speed_standard_design_capacity` Low Speed Standard Design Capacity	number or `Autocalculate` W		Standard design capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt (3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler heat rejection at these operating conditions. Only used for Performance Input Method = StandardDesignCapacity; for other input methods, this field is ignored. The standard conditions mentioned above for Standard design capacity are already specified in the EnergyPlus. So the input fields such as design entering water temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if provided in the input, will be ignored for the StandardDesignCapacity performance input method. Also, the standard conditions are for water as a fluid type so this performance input method can only be used with water as a fluid type (as specified in CondenserLoop object).
`low_speed_standard_capacity_sizing_factor` Low Speed Standard Capacity Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate
`high_fan_speed_u_factor_times_area_value` High Fan Speed U-factor Times Area Value	number or `Autosize` W/K		Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate; for other Performance Input Methods, this field is ignored.
`low_fan_speed_u_factor_times_area_value` Low Fan Speed U-factor Times Area Value	number or `Autocalculate` W/K		Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate; for other input methods, this field is ignored. Low speed fluid cooler UA must be less than high speed fluid cooler UA
`low_fan_speed_u_factor_times_area_sizing_factor` Low Fan Speed U-Factor Times Area Sizing Factor	number	`0.6`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate
`design_water_flow_rate` Design Water Flow Rate	number or `Autosize` m3/s		Input value is ignored if fluid cooler Performance Input Method= StandardDesignCapacity
`high_speed_user_specified_design_capacity` High Speed User Specified Design Capacity	number W		Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Range: > 0
`low_speed_user_specified_design_capacity` Low Speed User Specified Design Capacity	number or `Autocalculate` W		Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored.
`low_speed_user_specified_design_capacity_sizing_factor` Low Speed User Specified Design Capacity Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate
`design_entering_water_temperature` Design Entering Water Temperature	number or `Autosize` C	`Autosize`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Water Temperature must be greater than Design Entering Air Temperature.
`design_entering_air_temperature` Design Entering Air Temperature	number C	`35.0`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Air Temperature must be greater than Design Entering Air Wet-bulb Temperature. Range: > 0
`design_entering_air_wet_bulb_temperature` Design Entering Air Wet-bulb Temperature	number C	`25.6`	Only used for Performance Input Method = UserSpecifiedDesignCapacity; for other Performance Input Methods, this field is ignored. Design Entering Air Wet-bulb Temperature must be less than Design Entering Air Temperature. Range: > 0
`high_speed_sizing_factor` High Speed Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`evaporation_loss_mode` Evaporation Loss Mode	choice	`SaturatedExit`	One of `LossFactor`, `SaturatedExit`
`evaporation_loss_factor` Evaporation Loss Factor	number percent/K		Rate of water evaporation from the Fluid Cooler and lost to the outdoor air [%/K] Empirical correlation is used to calculate default loss factor if it not explicitly provided.
`drift_loss_percent` Drift Loss Percent	number percent	`0.008`	Default value is under investigation. For now cooling tower's default value is taken.
`blowdown_calculation_mode` Blowdown Calculation Mode	choice	`ConcentrationRatio`	One of `ConcentrationRatio`, `ScheduledRate`
`blowdown_concentration_ratio` Blowdown Concentration Ratio	number	`3.0`	Characterizes the rate of blowdown in the Evaporative Fluid Cooler. Blowdown is water intentionally drained from the Evaporative Fluid Cooler in order to offset the build up of solids in the water that would otherwise occur because of evaporation. Ratio of solids in the blowdown water to solids in the make up water. Default value is under investigation. For now cooling tower's default value is taken. Range: ≥ 2
`blowdown_makeup_water_usage_schedule_name` Blowdown Makeup Water Usage Schedule Name	reference		Makeup water usage due to blowdown results from occasionally draining some amount of water in the Evaporative Fluid Cooler basin to purge scale or other contaminants to reduce their concentration in order to maintain an acceptable level of water quality. Schedule values should reflect water usage in m3/s. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		Names a WaterUse:Storage

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

FluidCooler:SingleSpeed¶

from idfpy.models import FluidCoolerSingleSpeed

The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with single-speed fans (induced draft configuration).

Field	Type	Default	Details
`name` Name required	string		fluid cooler name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of fluid cooler water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of fluid cooler water outlet node
`performance_input_method` Performance Input Method	choice	`NominalCapacity`	User can define fluid cooler thermal performance by specifying the fluid cooler UA and the Design Water Flow Rate, or by specifying the fluid cooler nominal capacity One of `NominalCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`
`design_air_flow_rate_u_factor_times_area_value` Design Air Flow Rate U-factor Times Area Value	number or `Autosize` W/K		Leave field blank if fluid cooler Performance Input Method is NominalCapacity
`nominal_capacity` Nominal Capacity	number W		Nominal fluid cooler capacity Range: > 0
`design_entering_water_temperature` Design Entering Water Temperature required	number C		Design Entering Water Temperature must be specified for both the performance input methods and its value must be greater than Design Entering Air Temperature. Range: > 0
`design_entering_air_temperature` Design Entering Air Temperature required	number C		Design Entering Air Temperature must be specified for both the performance input methods and its value must be greater than Design Entering Air Wet-bulb Temperature. Range: > 0
`design_entering_air_wetbulb_temperature` Design Entering Air Wetbulb Temperature required	number C		Design Entering Air Wet-bulb Temperature must be specified for both the performance input methods and its value must be less than Design Entering Air Temperature. Range: > 0
`design_water_flow_rate` Design Water Flow Rate required	number or `Autosize` m3/s
`design_air_flow_rate` Design Air Flow Rate required	number or `Autosize` m3/s
`design_air_flow_rate_fan_power` Design Air Flow Rate Fan Power required	number or `Autosize` W		This is the fan motor electric input power
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string		Enter the name of an outdoor air node

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

FluidCooler:TwoSpeed¶

from idfpy.models import FluidCoolerTwoSpeed

The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with two-speed fans (induced draft configuration).

Field	Type	Default	Details
`name` Name required	string		fluid cooler name
`water_inlet_node_name` Water Inlet Node Name required	string		Name of fluid cooler water inlet node
`water_outlet_node_name` Water Outlet Node Name required	string		Name of fluid cooler water outlet node
`performance_input_method` Performance Input Method	choice	`NominalCapacity`	User can define fluid cooler thermal performance by specifying the fluid cooler UA and the Design Water Flow Rate, or by specifying the fluid cooler nominal capacity One of `NominalCapacity`, `UFactorTimesAreaAndDesignWaterFlowRate`
`high_fan_speed_u_factor_times_area_value` High Fan Speed U-factor Times Area Value	number or `Autosize` W/K		Leave field blank if fluid cooler Performance Input Method is NominalCapacity
`low_fan_speed_u_factor_times_area_value` Low Fan Speed U-factor Times Area Value	number or `Autocalculate` W/K		Leave field blank if fluid cooler Performance Input Method is NominalCapacity Low speed fluid cooler UA must be less than high speed fluid cooler UA Low speed fluid cooler UA must be greater than free convection fluid cooler UA
`low_fan_speed_u_factor_times_area_sizing_factor` Low Fan Speed U-Factor Times Area Sizing Factor	number	`0.6`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate
`high_speed_nominal_capacity` High Speed Nominal Capacity	number W		Nominal fluid cooler capacity at high fan speed Range: > 0
`low_speed_nominal_capacity` Low Speed Nominal Capacity	number or `Autocalculate` W		Nominal fluid cooler capacity at low fan speed
`low_speed_nominal_capacity_sizing_factor` Low Speed Nominal Capacity Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate and the Performance Input Method is NominalCapacity
`design_entering_water_temperature` Design Entering Water Temperature required	number C		Design Entering Water Temperature must be specified for both the performance input methods and its value must be greater than Design Entering Air Temperature. Range: > 0
`design_entering_air_temperature` Design Entering Air Temperature required	number C		Design Entering Air Temperature must be specified for both the performance input methods and its value must be greater than Design Entering Air Wet-bulb Temperature. Range: > 0
`design_entering_air_wet_bulb_temperature` Design Entering Air Wet-bulb Temperature required	number C		Design Entering Air Wet-bulb Temperature must be specified for both the performance input methods and its value must be less than Design Entering Air Temperature. Range: > 0
`design_water_flow_rate` Design Water Flow Rate required	number or `Autosize` m3/s
`high_fan_speed_air_flow_rate` High Fan Speed Air Flow Rate required	number or `Autosize` m3/s		Air Flow Rate at High Fan Speed must be greater than Air Flow Rate at Low Fan Speed
`high_fan_speed_fan_power` High Fan Speed Fan Power required	number or `Autosize` W		This is the fan motor electric input power at high speed
`low_fan_speed_air_flow_rate` Low Fan Speed Air Flow Rate required	number or `Autocalculate` m3/s		Air Flow Rate at Low Fan Speed must be less than Air Flow Rate at High Fan Speed
`low_fan_speed_air_flow_rate_sizing_factor` Low Fan Speed Air Flow Rate Sizing Factor	number	`0.5`	This field is only used if the previous field is set to autocalculate.
`low_fan_speed_fan_power` Low Fan Speed Fan Power required	number or `Autocalculate` W		This is the fan motor electric input power at low speed
`low_fan_speed_fan_power_sizing_factor` Low Fan Speed Fan Power Sizing Factor	number	`0.16`	This field is only used if the previous field is set to autocalculate.
`outdoor_air_inlet_node_name` Outdoor Air Inlet Node Name	string

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:HorizontalTrench¶

from idfpy.models import GroundHeatExchangerHorizontalTrench

This models a horizontal heat exchanger placed in a series of trenches The model uses the PipingSystem:Underground underlying algorithms, but provides a more usable input interface.

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`design_flow_rate` Design Flow Rate required	number m3/s		Range: > 0
`trench_length_in_pipe_axial_direction` Trench Length in Pipe Axial Direction	number m	`50.0`	This is the total pipe axial length of the heat exchanger If all pipe trenches are parallel, this is the length of a single trench. If a single, long run of pipe is used with one trench, this is the full length of the pipe run. Range: > 0
`number_of_trenches` Number of Trenches	integer	`1`	This is the number of horizontal legs that will be used in the entire heat exchanger, one pipe per trench Range: ≥ 1
`horizontal_spacing_between_pipes` Horizontal Spacing Between Pipes	number m	`1.0`	This represents the average horizontal spacing between any two trenches for heat exchangers that have multiple trenches Range: > 0
`pipe_inner_diameter` Pipe Inner Diameter	number m	`0.016`	Range: > 0
`pipe_outer_diameter` Pipe Outer Diameter	number m	`0.026`	Range: > 0
`burial_depth` Burial Depth	number m	`1.5`	This is the burial depth of the pipes, or the trenches containing the pipes Range: > 0
`soil_thermal_conductivity` Soil Thermal Conductivity	number W/m-K	`1.08`	Range: > 0
`soil_density` Soil Density	number kg/m3	`962.0`	Range: > 0
`soil_specific_heat` Soil Specific Heat	number J/kg-K	`2576.0`	Range: > 0
`pipe_thermal_conductivity` Pipe Thermal Conductivity	number W/m-K	`0.3895`	Range: > 0
`pipe_density` Pipe Density	number kg/m3	`641.0`	Range: > 0
`pipe_specific_heat` Pipe Specific Heat	number J/kg-K	`2405.0`	Range: > 0
`soil_moisture_content_percent` Soil Moisture Content Percent	number percent	`30.0`	Range: ≥ 0, ≤ 100
`soil_moisture_content_percent_at_saturation` Soil Moisture Content Percent at Saturation	number percent	`50.0`	Range: ≥ 0, ≤ 100
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`evapotranspiration_ground_cover_parameter` Evapotranspiration Ground Cover Parameter	number	`0.4`	This specifies the ground cover effects during evapotranspiration calculations. The value roughly represents the following cases: = 0 : concrete or other solid, non-permeable ground surface material = 0.5 : short grass, much like a manicured lawn = 1 : standard reference state (12 cm grass) = 1.5 : wild growth Range: ≥ 0, ≤ 1.5

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:Pond¶

from idfpy.models import GroundHeatExchangerPond

A model of a shallow pond with immersed pipe loops. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector.

Field	Type	Details
`name` Name required	string
`fluid_inlet_node_name` Fluid Inlet Node Name required	string
`fluid_outlet_node_name` Fluid Outlet Node Name required	string
`pond_depth` Pond Depth required	number m	Range: > 0
`pond_area` Pond Area required	number m2	Range: > 0
`hydronic_tubing_inside_diameter` Hydronic Tubing Inside Diameter required	number m	Range: > 0
`hydronic_tubing_outside_diameter` Hydronic Tubing Outside Diameter required	number m	Range: > 0
`hydronic_tubing_thermal_conductivity` Hydronic Tubing Thermal Conductivity required	number W/m-K	Range: > 0
`ground_thermal_conductivity` Ground Thermal Conductivity required	number W/m2-K	Range: > 0
`number_of_tubing_circuits` Number of Tubing Circuits required	integer	Range: ≥ 1
`length_of_each_tubing_circuit` Length of Each Tubing Circuit required	number m	Range: ≥ 0

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:ResponseFactors¶

from idfpy.models import GroundHeatExchangerResponseFactors extensible

Response factor definitions from third-party tool, commonly referred to a "g-functions"

Field	Type	Default	Details
`name` Name required	string
`ghe_vertical_properties_object_name` GHE:Vertical:Properties Object Name required	reference		Names a GroundHeatExchanger:Vertical:Properties
`number_of_boreholes` Number of Boreholes required	integer
`g_function_reference_ratio` G-Function Reference Ratio	number dimensionless	`0.0005`	Range: > 0
`g_functions`	list		Each item: `g_function_ln_t_ts_value`, `g_function_g_value`

Referenced by 1 object types

GroundHeatExchanger:System

GroundHeatExchanger:Slinky¶

from idfpy.models import GroundHeatExchangerSlinky

This models a slinky horizontal heat exchanger placed in a series of trenches The model uses the model developed by: Xiong, Z., D.E. Fisher, and J.D. Spitler. 2015. Development and Validation of a Slinky Ground Heat Exchanger Model. Applied Energy 141: 57-69.

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`design_flow_rate` Design Flow Rate	number m3/s	`0.002`	Range: > 0
`soil_thermal_conductivity` Soil Thermal Conductivity	number W/m-K	`1.08`	Range: > 0
`soil_density` Soil Density	number kg/m3	`962.0`	Range: > 0
`soil_specific_heat` Soil Specific Heat	number J/kg-K	`2576.0`	Range: > 0
`pipe_thermal_conductivity` Pipe Thermal Conductivity	number W/m-K	`0.4`	Range: > 0
`pipe_density` Pipe Density	number kg/m3	`641.0`	Range: > 0
`pipe_specific_heat` Pipe Specific Heat	number J/kg-K	`2405.0`	Range: > 0
`pipe_outer_diameter` Pipe Outer Diameter	number m	`0.02667`	Range: > 0
`pipe_thickness` Pipe Thickness	number m	`0.002413`	Range: > 0
`heat_exchanger_configuration` Heat Exchanger Configuration	choice		This is the orientation of the heat exchanger One of `Horizontal`, `Vertical`
`coil_diameter` Coil Diameter	number m	`1.0`	This is the diameter of the heat exchanger coil Range: > 0
`coil_pitch` Coil Pitch	number m	`0.2`	This is the center-to-center distance between coils Range: > 0
`trench_depth` Trench Depth	number m	`1.8`	This is the distance from the ground surface to the trench bottom Range: > 0
`trench_length` Trench Length	number m	`10.0`	This is the total length of a single trench This assumes the heat exchanger runs the full length of the trench Range: > 0
`number_of_trenches` Number of Trenches	integer	`1`	This is the number of parallel trenches that has a heat exchanger, one per trench Range: ≥ 1
`horizontal_spacing_between_pipes` Horizontal Spacing Between Pipes	number m	`2.0`	This represents the average horizontal spacing between any two trenches for heat exchangers that have multiple trenches Range: > 0
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`maximum_length_of_simulation` Maximum Length of Simulation	number years

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:Surface¶

from idfpy.models import GroundHeatExchangerSurface

A hydronic surface/panel consisting of a multi-layer construction with embedded rows of tubes. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector. The bottom surface may be defined as ground-coupled or exposed to wind (eg. bridge deck).

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`fluid_inlet_node_name` Fluid Inlet Node Name required	string
`fluid_outlet_node_name` Fluid Outlet Node Name required	string
`hydronic_tubing_inside_diameter` Hydronic Tubing Inside Diameter	number m		Range: > 0
`number_of_tubing_circuits` Number of Tubing Circuits	integer		Range: ≥ 1
`hydronic_tube_spacing` Hydronic Tube Spacing	number m		Range: > 0
`surface_length` Surface Length	number m		Range: > 0
`surface_width` Surface Width	number m		Range: > 0
`lower_surface_environment` Lower Surface Environment	choice	`Ground`	One of `Exposed`, `Ground`

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:System¶

from idfpy.models import GroundHeatExchangerSystem extensible

Models vertical ground heat exchangers systems using the response factor approach developed by Eskilson. Response factors are calculated using a finite line source model assuming uniform heat flux at the borehole wall if UHFcalc is specified, or uniform borehole wall temperature if UBHWTcalc is specified.

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`design_flow_rate` Design Flow Rate required	number m3/s		Range: > 0
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`ground_thermal_conductivity` Ground Thermal Conductivity required	number W/m-K		Range: > 0
`ground_thermal_heat_capacity` Ground Thermal Heat Capacity required	number J/m3-K		Range: > 0
`ghe_vertical_responsefactors_object_name` GHE:Vertical:ResponseFactors Object Name	reference		Names a GroundHeatExchanger:ResponseFactors
`g_function_calculation_method` g-Function Calculation Method	choice	`UHFcalc`	One of `FullDesign`, `UBHWTcalc`, `UHFcalc`
`ghe_vertical_sizing_object_type` GHE:Vertical:Sizing Object Type	choice		One of `GroundHeatExchanger:Vertical:Sizing:Rectangle`
`ghe_vertical_sizing_object_name` GHE:Vertical:Sizing Object Name	reference		Only needed when g-function calculation method is FullDesign Names a GroundHeatExchanger:Vertical:Sizing:Rectangle
`ghe_vertical_array_object_name` GHE:Vertical:Array Object Name	reference		Names a GroundHeatExchanger:Vertical:Array
`vertical_well_locations`	list		Each item: `ghe_vertical_single_object_name`

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

GroundHeatExchanger:Vertical:Array¶

from idfpy.models import GroundHeatExchangerVerticalArray

Field	Type	Details
`name` Name required	string
`ghe_vertical_properties_object_name` GHE:Vertical:Properties Object Name required	reference	Names a GroundHeatExchanger:Vertical:Properties
`number_of_boreholes_in_x_direction` Number of Boreholes in X-Direction required	integer	Range: ≥ 1
`number_of_boreholes_in_y_direction` Number of Boreholes in Y-Direction required	integer	Range: ≥ 1
`borehole_spacing` Borehole Spacing required	number m	Range: > 0

Referenced by 1 object types

GroundHeatExchanger:System

GroundHeatExchanger:Vertical:Properties¶

from idfpy.models import GroundHeatExchangerVerticalProperties

Properties for vertical ground heat exchanger systems

Field	Type	Details
`name` Name required	string
`depth_of_top_of_borehole` Depth of Top of Borehole required	number m	Range: ≥ 0
`borehole_length` Borehole Length required	number m	Range: > 0
`borehole_diameter` Borehole Diameter required	number m	Range: > 0
`grout_thermal_conductivity` Grout Thermal Conductivity required	number W/m-K	Range: > 0
`grout_thermal_heat_capacity` Grout Thermal Heat Capacity required	number J/m3-K	Range: > 0
`pipe_thermal_conductivity` Pipe Thermal Conductivity required	number W/m-K	Range: > 0
`pipe_thermal_heat_capacity` Pipe Thermal Heat Capacity required	number J/m3-K	Range: > 0
`pipe_outer_diameter` Pipe Outer Diameter required	number m	Range: > 0
`pipe_thickness` Pipe Thickness required	number m	Range: > 0
`u_tube_distance` U-Tube Distance required	number m	Range: > 0

Referenced by 3 object types

GroundHeatExchanger:ResponseFactors, GroundHeatExchanger:Vertical:Array, GroundHeatExchanger:Vertical:Single

GroundHeatExchanger:Vertical:Single¶

from idfpy.models import GroundHeatExchangerVerticalSingle

Field	Type	Details
`name` Name required	string
`ghe_vertical_properties_object_name` GHE:Vertical:Properties Object Name required	reference	Names a GroundHeatExchanger:Vertical:Properties
`x_location` X-Location required	number m
`y_location` Y-Location required	number m

Referenced by 1 object types

GroundHeatExchanger:System

GroundHeatExchanger:Vertical:Sizing:Rectangle¶

from idfpy.models import GroundHeatExchangerVerticalSizingRectangle

Specifies parameters to be used for Ground Heat Exchanger borehole field design and sizing.

Field	Type	Default	Details
`name` Name required	string
`sizingperiod_weatherfiledays_name` SizingPeriod:WeatherFileDays Name required	reference		Specifies the SizingPeriod:WeatherFileDays required to perform GHE sizing Names a SizingPeriod:WeatherFileDays
`design_flow_rate_per_borehole` Design Flow Rate Per Borehole	number m3/s	`0.0005`	Design flow rate per borehole used to size borehole field Range: > 0
`available_borehole_field_length` Available Borehole Field Length required	number m		Available length of the area available for designing the borehole field Range: > 0
`available_borehole_field_width` Available Borehole Field Width required	number m		Available width of the area available for designing the borehole field Range: > 0
`maximum_number_of_boreholes` Maximum Number of Boreholes required	number		User specified maximum number of boreholes Range: > 0
`minimum_borehole_spacing` Minimum Borehole Spacing	number m	`4.0`	Minimum borehole-to-borehole spacing Range: > 0
`maximum_borehole_spacing` Maximum Borehole Spacing	number m	`6.0`	Maximum borehole-to-borehole spacing Range: > 0
`minimum_borehole_vertical_length` Minimum Borehole Vertical Length	number m	`60.0`	Minimum drilled depth of the vertical borehole Range: > 0
`maximum_borehole_vertical_length` Maximum Borehole Vertical Length	number m	`135.0`	Maximum drilled depth of the vertical borehole Range: > 0
`minimum_exiting_fluid_temperature_for_sizing` Minimum Exiting Fluid Temperature for Sizing	number C	`5.0`	Minimum ground heat exchanger exiting fluid temperature used when designing the borehole field Range: > 0
`maximum_exiting_fluid_temperature_for_sizing` Maximum Exiting Fluid Temperature for Sizing	number C	`35.0`	Maximum ground heat exchanger exiting fluid temperature used when designing the borehole field Range: > 0

Referenced by 1 object types

GroundHeatExchanger:System

HeatExchanger:FluidToFluid¶

from idfpy.models import HeatExchangerFluidToFluid

A fluid/fluid heat exchanger designed to couple the supply side of one loop to the demand side of another loop Loops can be either plant or condenser loops but no air side connections are allowed

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. default is that heat exchanger is on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`loop_demand_side_inlet_node_name` Loop Demand Side Inlet Node Name required	string		This connection is to the demand side of a loop and is the inlet to the heat exchanger
`loop_demand_side_outlet_node_name` Loop Demand Side Outlet Node Name required	string		This connection is to the demand side of a loop
`loop_demand_side_design_flow_rate` Loop Demand Side Design Flow Rate required	number or `Autosize` m3/s
`loop_supply_side_inlet_node_name` Loop Supply Side Inlet Node Name required	string
`loop_supply_side_outlet_node_name` Loop Supply Side Outlet Node Name required	string
`loop_supply_side_design_flow_rate` Loop Supply Side Design Flow Rate required	number or `Autosize` m3/s
`heat_exchange_model_type` Heat Exchange Model Type	choice	`Ideal`	One of `CounterFlow`, `CrossFlowBothMixed`, `CrossFlowBothUnMixed`, `CrossFlowSupplyMixedDemandUnMixed`, `CrossFlowSupplyUnMixedDemandMixed`, `Ideal`, `ParallelFlow`
`heat_exchanger_u_factor_times_area_value` Heat Exchanger U-Factor Times Area Value required	number or `Autosize` W/K
`control_type` Control Type	choice	`UncontrolledOn`	One of `CoolingDifferentialOnOff`, `CoolingSetpointModulated`, `CoolingSetpointOnOff`, `CoolingSetpointOnOffWithComponentOverride`, `DualDeadbandSetpointModulated`, `DualDeadbandSetpointOnOff`, `HeatingSetpointModulated`, `HeatingSetpointOnOff`, `OperationSchemeModulated`, `OperationSchemeOnOff`, `UncontrolledOn`
`heat_exchanger_setpoint_node_name` Heat Exchanger Setpoint Node Name	string		Setpoint node is needed with any Control Type that is "Setpoint"
`minimum_temperature_difference_to_activate_heat_exchanger` Minimum Temperature Difference to Activate Heat Exchanger	number deltaC	`0.01`	Tolerance between control temperatures used to determine if heat exchanger should run. Range: ≥ 0, ≤ 50
`heat_transfer_metering_end_use_type` Heat Transfer Metering End Use Type	choice	`LoopToLoop`	This field controls end use reporting for heat transfer meters One of `FreeCooling`, `HeatRecoveryForCooling`, `HeatRecoveryForHeating`, `HeatRejection`, `LoopToLoop`
`component_override_loop_supply_side_inlet_node_name` Component Override Loop Supply Side Inlet Node Name	string		This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride
`component_override_loop_demand_side_inlet_node_name` Component Override Loop Demand Side Inlet Node Name	string		This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride
`component_override_cooling_control_temperature_mode` Component Override Cooling Control Temperature Mode	choice	`Loop`	This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride One of `DryBulbTemperature`, `Loop`, `WetBulbTemperature`
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized flow rates for this device Range: > 0
`operation_minimum_temperature_limit` Operation Minimum Temperature Limit	number C		Lower limit on inlet temperatures, heat exchanger will not operate if either inlet is below this limit
`operation_maximum_temperature_limit` Operation Maximum Temperature Limit	number C		Upper limit on inlet temperatures, heat exchanger will not operate if either inlet is above this limit

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList