pyidf.humidifiers_and_dehumidifiers module

Data objects in group “Humidifiers and Dehumidifiers”

class pyidf.humidifiers_and_dehumidifiers.DehumidifierDesiccantNoFans

Bases: pyidf.helper.DataObject

Corresponds to IDD object Dehumidifier:Desiccant:NoFans This object models a solid desiccant dehumidifier. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. This object determines the process air outlet conditions, the load on the regeneration heating coil, the electric power consumption for the wheel rotor motor, and the regeneration air fan mass flow rate. All other heat exchangers are modeled as separate objects connected to the inlet and outlet nodes of the dehumidifier. The solid desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.
If this field is blank, the system is always available.
Parameters:value (str) – value for IDD Field Availability Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of availability_schedule_name or None if not set
Return type:str
control_type

field Control Type

Type of setpoint control:
LeavingMaximumHumidityRatioSetpoint means that the unit is controlled
to deliver air at the Leaving Max Humidity Ratio Setpoint (see below),
SystemNodeMaximumHumidityRatioSetpoint means that the leaving humidity
ratio setpoint is the System Node Humidity Ratio Max property
of the Process Air Outlet Node. A Setpoint
object must be used to control this setpoint.
Both control types use bypass dampers to prevent over drying.
Parameters:value (str) – value for IDD Field Control Type
Raises:ValueError – if value is not a valid value
Returns:the value of control_type or None if not set
Return type:str
leaving_drybulb_function_of_air_velocity_curve_name

field Leaving Dry-Bulb Function of Air Velocity Curve Name

Leaving dry-bulb of process air as a function of air velocity,
quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Parameters:value (str) – value for IDD Field Leaving Dry-Bulb Function of Air Velocity Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of leaving_drybulb_function_of_air_velocity_curve_name or None if not set
Return type:str
leaving_drybulb_function_of_entering_drybulb_and_humidity_ratio_curve_name

field Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio Curve Name

Leaving dry-bulb of process air as a function of entering dry-bulb
and entering humidity ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering dry-bulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Parameters:value (str) – value for IDD Field Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of leaving_drybulb_function_of_entering_drybulb_and_humidity_ratio_curve_name or None if not set
Return type:str
leaving_humidity_ratio_function_of_air_velocity_curve_name

field Leaving Humidity Ratio Function of Air Velocity Curve Name

Leaving humidity ratio of process air as a function of
process air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Parameters:value (str) – value for IDD Field Leaving Humidity Ratio Function of Air Velocity Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of leaving_humidity_ratio_function_of_air_velocity_curve_name or None if not set
Return type:str
leaving_humidity_ratio_function_of_entering_drybulb_and_humidity_ratio_curve_name

field Leaving Humidity Ratio Function of Entering Dry-Bulb and Humidity Ratio Curve Name

Leaving humidity ratio of process air as a function of entering dry-bulb
and entering humidity ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering dry-bulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Parameters:value (str) – value for IDD Field Leaving Humidity Ratio Function of Entering Dry-Bulb and Humidity Ratio Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of leaving_humidity_ratio_function_of_entering_drybulb_and_humidity_ratio_curve_name or None if not set
Return type:str
leaving_maximum_humidity_ratio_setpoint

field Leaving Maximum Humidity Ratio Setpoint

Fixed setpoint for maximum process air leaving humidity ratio
Applicable only when Control Type = LeavingMaximumHumidityRatioSetpoint.
Units: kgWater/kgDryAir
Parameters:value (float) – value for IDD Field Leaving Maximum Humidity Ratio Setpoint
Raises:ValueError – if value is not a valid value
Returns:the value of leaving_maximum_humidity_ratio_setpoint or None if not set
Return type:float
name

field Name

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

field Nominal Process Air Flow Rate

Process air flow rate at nominal conditions
Units: m3/s
Parameters:value (float) – value for IDD Field Nominal Process Air Flow Rate
Raises:ValueError – if value is not a valid value
Returns:the value of nominal_process_air_flow_rate or None if not set
Return type:float
nominal_process_air_velocity

field Nominal Process Air Velocity

Process air velocity at nominal flow
When using Performance Model Type of Default, must be 2.032 to 4.064 m/s (400 to 800 fpm)
Units: m/s
value <= 6.0
Parameters:value (float) – value for IDD Field Nominal Process Air Velocity
Raises:ValueError – if value is not a valid value
Returns:the value of nominal_process_air_velocity or None if not set
Return type:float
nominal_regeneration_temperature

field Nominal Regeneration Temperature

Nominal regen temperature upon which the regen energy modifier
curve is based. Not used if Default if chosen for the field Performance Mode Type.
121 C is a commonly used value.
Units: C
value >= 40.0
value <= 250.0
Parameters:value (float) – value for IDD Field Nominal Regeneration Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of nominal_regeneration_temperature or None if not set
Return type:float
performance_model_type

field Performance Model Type

Specifies whether the default performance model or user-specified
curves should be used to model the performance. The default model
is a generic solid desiccant wheel using performance curves of the form:
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*vel + C7*vel**2
+ C8*edb*ew + C9*edb**2*ew**2 + C10*edb*vel + C11*edb**2*vel**2
+ C12*ew*vel + C13*ew**2*vel**2 + C14*ALOG(edb) + C15*ALOG(ew) + C16*ALOG(vel)
edb = process entering dry-bulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
vel = process air velocity [m/s]
If UserCurves are specified, then performance is calculated as follows:
Leaving Dry-Bulb = (Leaving Dry-Bulb fTW Curve) * (Leaving Dry-Bulb fV Curve)
Leaving Humidity Ratio = (Leaving Humidity Ratio fTW Curve) * (Leaving Humidity Ratio fV Curve)
Regen Energy = (Regen Energy fTW Curve) * (Regen Energy fV Curve)
Regen Velocity = (Regen Velocity fTW Curve) * (Regen Velocity fV Curve)
Parameters:value (str) – value for IDD Field Performance Model Type
Raises:ValueError – if value is not a valid value
Returns:the value of performance_model_type or None if not set
Return type:str
process_air_inlet_node_name

field Process Air Inlet Node Name

This is the node entering the process side of the desiccant wheel.
Parameters:value (str) – value for IDD Field Process Air Inlet Node Name
Raises:ValueError – if value is not a valid value
Returns:the value of process_air_inlet_node_name or None if not set
Return type:str
process_air_outlet_node_name

field Process Air Outlet Node Name

This is the node leaving the process side of the desiccant wheel.
Parameters:value (str) – value for IDD Field Process Air Outlet Node Name
Raises:ValueError – if value is not a valid value
Returns:the value of process_air_outlet_node_name or None if not set
Return type:str
regeneration_air_inlet_node_name

field Regeneration Air Inlet Node Name

This is the node entering the regeneration side of the desiccant wheel
after the regeneration coil.
Parameters:value (str) – value for IDD Field Regeneration Air Inlet Node Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_air_inlet_node_name or None if not set
Return type:str
regeneration_coil_name

field Regeneration Coil Name

Name of heating coil object for regeneration air
Parameters:value (str) – value for IDD Field Regeneration Coil Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_coil_name or None if not set
Return type:str
regeneration_coil_object_type

field Regeneration Coil Object Type

heating coil type
works with gas, electric, hot water and steam heating coils
Parameters:value (str) – value for IDD Field Regeneration Coil Object Type
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_coil_object_type or None if not set
Return type:str
regeneration_energy_function_of_air_velocity_curve_name

field Regeneration Energy Function of Air Velocity Curve Name

Regeneration energy [J/kg of water removed] as a function of
process air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Parameters:value (str) – value for IDD Field Regeneration Energy Function of Air Velocity Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_energy_function_of_air_velocity_curve_name or None if not set
Return type:str
regeneration_energy_function_of_entering_drybulb_and_humidity_ratio_curve_name

field Regeneration Energy Function of Entering Dry-Bulb and Humidity Ratio Curve Name

Regeneration energy [J/kg of water removed] as a function of
entering dry-bulb and entering humidity ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering dry-bulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Parameters:value (str) – value for IDD Field Regeneration Energy Function of Entering Dry-Bulb and Humidity Ratio Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_energy_function_of_entering_drybulb_and_humidity_ratio_curve_name or None if not set
Return type:str
regeneration_fan_inlet_node_name

field Regeneration Fan Inlet Node Name

Node for air entering the regeneration fan, mass flow is set
by the desiccant dehumidifier module.
Parameters:value (str) – value for IDD Field Regeneration Fan Inlet Node Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_fan_inlet_node_name or None if not set
Return type:str
regeneration_fan_name

field Regeneration Fan Name

Name of fan object for regeneration air
Parameters:value (str) – value for IDD Field Regeneration Fan Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_fan_name or None if not set
Return type:str
regeneration_fan_object_type

field Regeneration Fan Object Type

Type of fan object for regeneration air. When using the Default
Performance Model Type (see below), only Fan:VariableVolume is valid.
Parameters:value (str) – value for IDD Field Regeneration Fan Object Type
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_fan_object_type or None if not set
Return type:str
regeneration_velocity_function_of_air_velocity_curve_name

field Regeneration Velocity Function of Air Velocity Curve Name

Regeneration velocity [m/s] as a function of
process air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Parameters:value (str) – value for IDD Field Regeneration Velocity Function of Air Velocity Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_velocity_function_of_air_velocity_curve_name or None if not set
Return type:str
regeneration_velocity_function_of_entering_drybulb_and_humidity_ratio_curve_name

field Regeneration Velocity Function of Entering Dry-Bulb and Humidity Ratio Curve Name

Regeneration velocity [m/s] as a function of
entering dry-bulb and entering humidity ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering dry-bulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Parameters:value (str) – value for IDD Field Regeneration Velocity Function of Entering Dry-Bulb and Humidity Ratio Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_velocity_function_of_entering_drybulb_and_humidity_ratio_curve_name or None if not set
Return type:str
rotor_power

field Rotor Power

Power input to wheel rotor motor
Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Rotor Power
Raises:ValueError – if value is not a valid value
Returns:the value of rotor_power or None if not set
Return type:float
class pyidf.humidifiers_and_dehumidifiers.DehumidifierDesiccantSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object Dehumidifier:Desiccant:System This compound object models a desiccant heat exchanger, an optional heater, and associated fans. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. The desiccant heat exchanger transfers both sensible and latent energy between the process and regeneration air streams. The desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.
If this field is blank, the system is always available.
Parameters:value (str) – value for IDD Field Availability Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of availability_schedule_name or None if not set
Return type:str
companion_coil_regeneration_air_heating

field Companion Coil Regeneration Air Heating

Default value: No
Parameters:value (str) – value for IDD Field Companion Coil Regeneration Air Heating
Raises:ValueError – if value is not a valid value
Returns:the value of companion_coil_regeneration_air_heating or None if not set
Return type:str
companion_cooling_coil_name

field Companion Cooling Coil Name

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

field Companion Cooling Coil Object Type

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

field Companion Cooling Coil Upstream of Dehumidifier Process Inlet

Select Yes if the companion cooling coil is located directly upstream
of the desiccant heat exchanger’s process air inlet node.
Default value: No
Parameters:value (str) – value for IDD Field Companion Cooling Coil Upstream of Dehumidifier Process Inlet
Raises:ValueError – if value is not a valid value
Returns:the value of companion_cooling_coil_upstream_of_dehumidifier_process_inlet or None if not set
Return type:str
desiccant_heat_exchanger_name

field Desiccant Heat Exchanger Name

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

field Desiccant Heat Exchanger Object Type

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

field Exhaust Fan Maximum Flow Rate

Units: m3/s
Parameters:value (float) – value for IDD Field Exhaust Fan Maximum Flow Rate
Raises:ValueError – if value is not a valid value
Returns:the value of exhaust_fan_maximum_flow_rate or None if not set
Return type:float
exhaust_fan_maximum_power

field Exhaust Fan Maximum Power

Units: W
Parameters:value (float) – value for IDD Field Exhaust Fan Maximum Power
Raises:ValueError – if value is not a valid value
Returns:the value of exhaust_fan_maximum_power or None if not set
Return type:float
exhaust_fan_power_curve_name

field Exhaust Fan Power Curve Name

Curve object type must be Curve:Quadratic or Curve:Cubic
Parameters:value (str) – value for IDD Field Exhaust Fan Power Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of exhaust_fan_power_curve_name or None if not set
Return type:str
name

field Name

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

field Regeneration Air Fan Name

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

field Regeneration Air Fan Object Type

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

field Regeneration Air Fan Placement

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

field Regeneration Air Heater Name

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

field Regeneration Air Heater Object Type

works with gas, electric, hot water and steam heating coils
Parameters:value (str) – value for IDD Field Regeneration Air Heater Object Type
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_air_heater_object_type or None if not set
Return type:str
regeneration_inlet_air_setpoint_temperature

field Regeneration Inlet Air Setpoint Temperature

Units: C
Parameters:value (float) – value for IDD Field Regeneration Inlet Air Setpoint Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of regeneration_inlet_air_setpoint_temperature or None if not set
Return type:float
sensor_node_name

field Sensor Node Name

Parameters:value (str) – value for IDD Field Sensor Node Name
Raises:ValueError – if value is not a valid value
Returns:the value of sensor_node_name or None if not set
Return type:str
class pyidf.humidifiers_and_dehumidifiers.HumidifierSteamElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object Humidifier:Steam:Electric Electrically heated steam humidifier with fan.

air_inlet_node_name

field Air Inlet Node Name

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

field Air Outlet Node Name

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

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.
If this field is blank, the system is always available.
Parameters:value (str) – value for IDD Field Availability Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of availability_schedule_name or None if not set
Return type:str
name

field Name

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

field Rated Capacity

Capacity is m3/s of water at 5.05 C
Units: m3/s
IP-Units: gal/min
Parameters:value (float or “Autosize”) – value for IDD Field Rated Capacity
Raises:ValueError – if value is not a valid value
Returns:the value of rated_capacity or None if not set
Return type:float or “Autosize”
rated_fan_power

field Rated Fan Power

Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Rated Fan Power
Raises:ValueError – if value is not a valid value
Returns:the value of rated_fan_power or None if not set
Return type:float
rated_power

field Rated Power

if autosized the rated power is calculated from the rated capacity
and enthalpy rise of water from 20.0C to 100.0C steam and assumes
electric to thermal energy conversion efficiency of 100.0%
Units: W
IP-Units: W
Parameters:value (float or “Autosize”) – value for IDD Field Rated Power
Raises:ValueError – if value is not a valid value
Returns:the value of rated_power or None if not set
Return type:float or “Autosize”
standby_power

field Standby Power

Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Standby Power
Raises:ValueError – if value is not a valid value
Returns:the value of standby_power or None if not set
Return type:float
water_storage_tank_name

field Water Storage Tank Name

Parameters:value (str) – value for IDD Field Water Storage Tank Name
Raises:ValueError – if value is not a valid value
Returns:the value of water_storage_tank_name or None if not set
Return type:str
class pyidf.humidifiers_and_dehumidifiers.HumidifierSteamGas

Bases: pyidf.helper.DataObject

Corresponds to IDD object Humidifier:Steam:Gas Natural gas fired steam humidifier with optional blower fan.

air_inlet_node_name

field Air Inlet Node Name

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

field Air Outlet Node Name

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

field Auxiliary Electric Power

The auxiliary electric power input in watts. This amount of power will be consumed
whenever the unit is available (as defined by the availability schedule). This
electric power is used for control purpose only.
Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Auxiliary Electric Power
Raises:ValueError – if value is not a valid value
Returns:the value of auxiliary_electric_power or None if not set
Return type:float
availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.
If this field is blank, the system is always available.
Parameters:value (str) – value for IDD Field Availability Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of availability_schedule_name or None if not set
Return type:str
inlet_water_temperature_option

field Inlet Water Temperature Option

The inlet water temperature can be fixed at 20C as it is done for electric steam
humidifier or it can be allowed to vary with temperature of the water source.
Currently allowed water sources are main water or water storage tank in water use objects.
if FixedInletWaterTemperature is specified, then a fixed 20C water temperature will be
used, or else if VariableInletWaterTemperature is specified, then inlet water will vary
depending the source water temperature. If this input field is left blank, then fixed
inlet water temperature of 20C will be assumed.
Default value: FixedInletWaterTemperature
Parameters:value (str) – value for IDD Field Inlet Water Temperature Option
Raises:ValueError – if value is not a valid value
Returns:the value of inlet_water_temperature_option or None if not set
Return type:str
name

field Name

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

field Rated Capacity

Capacity is m3/s of water at 5.05 C
The nominal full capacity water addition rate in m3/s of water at 5.05 C
Units: m3/s
IP-Units: gal/min
Parameters:value (float or “Autosize”) – value for IDD Field Rated Capacity
Raises:ValueError – if value is not a valid value
Returns:the value of rated_capacity or None if not set
Return type:float or “Autosize”
rated_fan_power

field Rated Fan Power

The nominal full capacity electric power input to the blower fan in Watts. If no
blower fan is required to inject the dry steam to the supply air stream, then
this input field is set to zero.
Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Rated Fan Power
Raises:ValueError – if value is not a valid value
Returns:the value of rated_fan_power or None if not set
Return type:float
rated_gas_use_rate

field Rated Gas Use Rate

if auto-sized, the rated gas use rate is calculated from the rated
capacity and enthalpy rise of water from 20.0C to 100.0C steam and user
input thermal efficiency value specified in the next input field. If this
input field is hard-sized and Inlet Water Temperature Option input field is
selected as FixedInletWaterTemperature, then the thermal efficiency input
field will not be used or else if the Inlet Water Temperature Option input
field is selected as VariableInletWaterTemperature, then the thermal efficiency
input value is overridden by a value calculated from the capacity, rated gas use
rate and design condition.
Units: W
IP-Units: W
Parameters:value (float or “Autosize”) – value for IDD Field Rated Gas Use Rate
Raises:ValueError – if value is not a valid value
Returns:the value of rated_gas_use_rate or None if not set
Return type:float or “Autosize”
thermal_efficiency

field Thermal Efficiency

Based on the higher heating value of fuel.
If “Rated Gas Use Rate” in the field above is not auto-sized and the Inlet Water
Temperature Option input field is specified as FixedInletWaterTemperature, then the
thermal efficiency specified will not be used in the calculation, or else if the
Inlet Water Temperature Option input field is selected as VariableInletWaterTemperature,
then the thermal efficiency value is overridden by a value calculated from the capacity,
rated gas use rate and design condition.
Units: dimensionless
Default value: 0.8
value <= 1.0
Parameters:value (float) – value for IDD Field Thermal Efficiency
Raises:ValueError – if value is not a valid value
Returns:the value of thermal_efficiency or None if not set
Return type:float
thermal_efficiency_modifier_curve_name

field Thermal Efficiency Modifier Curve Name

Linear, Quadratic and Cubic efficiency curves are solely a function of PLR.
Linear = C1 + C2*PLR
Quadratic = C1 + C2*PLR + C3*PLR^2
Cubic = C1 + C2*PLR + C3*PLR^2 + C4*PLR^3
This is thermal efficiency modifier curve name of gas fired steam humidifier.
This curve is normalized, i.e., curve output value at rated condition is 1.0.
Parameters:value (str) – value for IDD Field Thermal Efficiency Modifier Curve Name
Raises:ValueError – if value is not a valid value
Returns:the value of thermal_efficiency_modifier_curve_name or None if not set
Return type:str
water_storage_tank_name

field Water Storage Tank Name

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