pyidf.zone_hvac_air_loop_terminal_units module

Data objects in group “Zone HVAC Air Loop Terminal Units”

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalDualDuctConstantVolume

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:DualDuct:ConstantVolume Central air system terminal unit, dual duct, constant volume.

air_outlet_node_name

field Air Outlet Node Name

The outlet node of the terminal unit.

This is also the zone inlet node.

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

cold_air_inlet_node_name

field Cold Air Inlet Node Name

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

hot_air_inlet_node_name

field Hot Air Inlet Node Name

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

name

field Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalDualDuctVav

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:DualDuct:VAV Central air system terminal unit, dual duct, variable volume.

air_outlet_node_name

field Air Outlet Node Name

The outlet node of the terminal unit.

This is also the zone inlet node.

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

cold_air_inlet_node_name

field Cold Air Inlet Node Name

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based on the current number of occupants in the zone.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

If this field is blank, then the terminal unit will not be controlled for outdoor air flow.

Parameters:value (str) – value for IDD Field Design Specification Outdoor Air Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_outdoor_air_object_name or None if not set Return type:str

hot_air_inlet_node_name

field Hot Air Inlet Node Name

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

maximum_damper_air_flow_rate

field Maximum Damper Air Flow Rate

Units: m3/s

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

name

field Name

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

zone_minimum_air_flow_fraction

field Zone Minimum Air Flow Fraction

fraction of maximum air flow

Default value: 0.2

value <= 1.0

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalDualDuctVavOutdoorAir

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:DualDuct:VAV:OutdoorAir Central air system terminal unit, dual duct, variable volume with special controls. One VAV duct is controlled to supply ventilation air and the other VAV duct is controlled to meet the zone cooling load.

air_outlet_node_name

field Air Outlet Node Name

The outlet node of the terminal unit.

This is also the zone inlet node.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based mode selected in the next field.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

Parameters:value (str) – value for IDD Field Design Specification Outdoor Air Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_outdoor_air_object_name or None if not set Return type:str

maximum_terminal_air_flow_rate

field Maximum Terminal Air Flow Rate

If autosized this is the sum of flow needed for cooling and maximum required outdoor air

Units: m3/s

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

name

field Name

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

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

per_person_ventilation_rate_mode

field Per Person Ventilation Rate Mode

CurrentOccupancy models demand controlled ventilation using the current number of people

DesignOccupancy uses the total Number of People in the zone and is constant

Parameters:value (str) – value for IDD Field Per Person Ventilation Rate Mode Raises:ValueError – if value is not a valid value Returns:the value of per_person_ventilation_rate_mode or None if not set Return type:str

recirculated_air_inlet_node_name

field Recirculated Air Inlet Node Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctConstantVolumeCooledBeam

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:ConstantVolume:CooledBeam Central air system terminal unit, single duct, constant volume, with cooled beam (active or passive).

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

beam_length

field Beam Length

Length of an individual beam unit

Units: m

Default value: “autosize”

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

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

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

coefficient_of_induction_kin

field Coefficient of Induction Kin

Default value: “Autocalculate”

value <= 4.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Coefficient of Induction Kin Raises:ValueError – if value is not a valid value Returns:the value of coefficient_of_induction_kin or None if not set Return type:float or “Autocalculate”

coil_surface_area_per_coil_length

field Coil Surface Area per Coil Length

Units: m2/m

Default value: 5.422

Parameters:value (float) – value for IDD Field Coil Surface Area per Coil Length Raises:ValueError – if value is not a valid value Returns:the value of coil_surface_area_per_coil_length or None if not set Return type:float

cooled_beam_type

field Cooled Beam Type

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

design_inlet_water_temperature

field Design Inlet Water Temperature

Units: C

Default value: 15.0

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

design_outlet_water_temperature

field Design Outlet Water Temperature

Units: C

Default value: 17.0

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

leaving_pipe_inside_diameter

field Leaving Pipe Inside Diameter

Units: m

Default value: 0.0145

Parameters:value (float) – value for IDD Field Leaving Pipe Inside Diameter Raises:ValueError – if value is not a valid value Returns:the value of leaving_pipe_inside_diameter or None if not set Return type:float

maximum_total_chilled_water_volumetric_flow_rate

field Maximum Total Chilled Water Volumetric Flow Rate

Units: m3/s

Default value: “autosize”

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

model_parameter_a

field Model Parameter a

Default value: 15.3

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

model_parameter_a0

field Model Parameter a0

Free area of the coil in plan view per unit beam length

Units: m2/m

Default value: 0.171

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

model_parameter_k1

field Model Parameter K1

Default value: 0.0057

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

model_parameter_n

field Model Parameter n

Default value: 0.4

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

model_parameter_n1

field Model Parameter n1

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

model_parameter_n2

field Model Parameter n2

Default value: 0.84

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

model_parameter_n3

field Model Parameter n3

Default value: 0.12

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

name

field Name

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

number_of_beams

field Number of Beams

Number of individual beam units in the zone

Default value: “autosize”

Parameters:value (int or “Autosize”) – value for IDD Field Number of Beams Raises:ValueError – if value is not a valid value Returns:the value of number_of_beams or None if not set Return type:int or “Autosize”

supply_air_inlet_node_name

field Supply Air Inlet Node Name

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

supply_air_outlet_node_name

field Supply Air Outlet Node Name

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

supply_air_volumetric_flow_rate

field Supply Air Volumetric Flow Rate

Units: m3/s

Default value: “autosize”

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctConstantVolumeFourPipeBeam

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam Central air system terminal unit, single duct, constant volume, with heating and/or cooling. Operates as two-pipe unit if heating or cooling water is omitted. Heating and/or cooling can be scheduled off for dedicated ventilation.

beam_cooling_capacity_air_flow_modification_factor_curve_name

field Beam Cooling Capacity Air Flow Modification Factor Curve Name

Adjusts beam cooling capacity when the primary air supply flow rate is different

than at the rating point. The single independent variable is the current normalized

air flow rate divided by the normalized air flow rate at the rating point.

This field is required when beam is connected to a chilled water plant.

Parameters:value (str) – value for IDD Field Beam Cooling Capacity Air Flow Modification Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of beam_cooling_capacity_air_flow_modification_factor_curve_name or None if not set Return type:str

beam_cooling_capacity_chilled_water_flow_modification_factor_curve_name

field Beam Cooling Capacity Chilled Water Flow Modification Factor Curve Name

Adjusts beam cooling capacity when the normalized chilled water flow rate is different

than at the rating point. The single independent variable is the current normalized

chilled water flow rate divided by the normalized chilled water flow rate at the rating point.

This field is required when beam is connected to a chilled water plant.

Parameters:value (str) – value for IDD Field Beam Cooling Capacity Chilled Water Flow Modification Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of beam_cooling_capacity_chilled_water_flow_modification_factor_curve_name or None if not set Return type:str

beam_cooling_capacity_temperature_difference_modification_factor_curve_name

field Beam Cooling Capacity Temperature Difference Modification Factor Curve Name

Adjusts beam cooling capacity when the temperature difference between entering water and zone air

is different than at the rating point. Single independent variable is the ratio of the current

temperature difference divided by the rating point temperature difference.

This field is required when beam is connected to a chilled water plant.

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

beam_heating_capacity_air_flow_modification_factor_curve_name

field Beam Heating Capacity Air Flow Modification Factor Curve Name

Adjusts beam heating capacity when the primary air supply flow rate is different

than at the rating point. The single independent variable is the current normalized

air flow rate divided by the normalized air flow rate at the rating point.

This field is required when beam is connected to a hot water plant.

Parameters:value (str) – value for IDD Field Beam Heating Capacity Air Flow Modification Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of beam_heating_capacity_air_flow_modification_factor_curve_name or None if not set Return type:str

beam_heating_capacity_hot_water_flow_modification_factor_curve_name

field Beam Heating Capacity Hot Water Flow Modification Factor Curve Name

Adjusts beam heating capacity when the normalized hot water flow rate is different

than at the rating point. The single independent variable is the current normalized

hot water flow rate divided by the normalized hot water flow rate at the rating point.

This field is required when beam is connected to a hot water plant.

Parameters:value (str) – value for IDD Field Beam Heating Capacity Hot Water Flow Modification Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of beam_heating_capacity_hot_water_flow_modification_factor_curve_name or None if not set Return type:str

beam_heating_capacity_temperature_difference_modification_factor_curve_name

field Beam Heating Capacity Temperature Difference Modification Factor Curve Name

Adjusts beam heating capacity when the temperature difference between entering water and zone air

is different than at the rating point. Single independent variable is the ratio of the current

temperature difference divided by the rating point temperature difference.

This field is required when beam is connected to a hot water plant.

Parameters:value (str) – value for IDD Field Beam Heating Capacity Temperature Difference Modification Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of beam_heating_capacity_temperature_difference_modification_factor_curve_name or None if not set Return type:str

beam_rated_chilled_water_volume_flow_rate_per_beam_length

field Beam Rated Chilled Water Volume Flow Rate per Beam Length

The volume flow rate of chilled water per meter of beam length at the rating point.

Units: m3/s-m

Default value: 5e-05

Parameters:value (float) – value for IDD Field Beam Rated Chilled Water Volume Flow Rate per Beam Length Raises:ValueError – if value is not a valid value Returns:the value of beam_rated_chilled_water_volume_flow_rate_per_beam_length or None if not set Return type:float

beam_rated_cooling_capacity_per_beam_length

field Beam Rated Cooling Capacity per Beam Length

Sensible cooling capacity per meter of beam length at the rating point.

Units: W/m

Default value: 600.0

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

beam_rated_cooling_room_air_chilled_water_temperature_difference

field Beam Rated Cooling Room Air Chilled Water Temperature Difference

Difference in temperature between the zone air and the entering chilled water at the rating point.

Units: deltaC

Default value: 10.0

Parameters:value (float) – value for IDD Field Beam Rated Cooling Room Air Chilled Water Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of beam_rated_cooling_room_air_chilled_water_temperature_difference or None if not set Return type:float

beam_rated_heating_capacity_per_beam_length

field Beam Rated Heating Capacity per Beam Length

Sensible heating capacity per meter of beam length at the rating point.

Units: W/m

Default value: 1500.0

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

beam_rated_heating_room_air_hot_water_temperature_difference

field Beam Rated Heating Room Air Hot Water Temperature Difference

Difference in temperature between the zone air and the entering hot water at the rating point.

Units: deltaC

Default value: 27.8

Parameters:value (float) – value for IDD Field Beam Rated Heating Room Air Hot Water Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of beam_rated_heating_room_air_hot_water_temperature_difference or None if not set Return type:float

beam_rated_hot_water_volume_flow_rate_per_beam_length

field Beam Rated Hot Water Volume Flow Rate per Beam Length

The volume flow rate of hoy water per meter of beam length at the rating point.

Units: m3/s-m

Default value: 5e-05

Parameters:value (float) – value for IDD Field Beam Rated Hot Water Volume Flow Rate per Beam Length Raises:ValueError – if value is not a valid value Returns:the value of beam_rated_hot_water_volume_flow_rate_per_beam_length or None if not set Return type:float

chilled_water_inlet_node_name

field Chilled Water Inlet Node Name

Name of the plant system node for chilled water entering the beam.

The two chilled water nodes can (only) be omitted to model a two-pipe heating only beam.

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

chilled_water_outlet_node_name

field Chilled Water Outlet Node Name

Name of the plant system node for chilled water leaving the beam.

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

cooling_availability_schedule_name

field Cooling Availability Schedule Name

Cooling operation can be controlled separately using this availability schedule.

Schedule value > 0 means beam cooling is available.

If this field is blank, the beam cooling is always available (as long as primary air is also available).

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

design_chilled_water_volume_flow_rate

field Design Chilled Water Volume Flow Rate

Units: m3/s

Default value: “autosize”

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

design_hot_water_volume_flow_rate

field Design Hot Water Volume Flow Rate

Units: m3/s

Default value: “autosize”

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

design_primary_air_volume_flow_rate

field Design Primary Air Volume Flow Rate

Units: m3/s

Default value: “autosize”

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

heating_availability_schedule_name

field Heating Availability Schedule Name

Heating operation can be controlled separately using this availability schedule.

Schedule value > 0 means beam heating is available.

If this field is blank, the beam heating is always available (as long as primary air is also available).

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

hot_water_inlet_node_name

field Hot Water Inlet Node Name

Name of the plant system node for hot water entering the beam.

The two hot water nodes can (only) be omitted to model a two-pipe cooling-only beam.

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

hot_water_outlet_node_name

field Hot Water Outlet Node Name

Name of the plant system node for hot water leaving the beam.

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

name

field Name

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

primary_air_availability_schedule_name

field Primary Air Availability Schedule Name

Primary air is supplied by central air handling unit and must be on for heating or cooling.

Schedule value > 0 means the primary air supply is available.

If this field is blank, the primary air supply is always available.

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

primary_air_inlet_node_name

field Primary Air Inlet Node Name

Name of the air system node for primary supply air entering the air distribution unit.

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

primary_air_outlet_node_name

field Primary Air Outlet Node Name

Name of the air system node for primary supply air leaving the air distribution unit and entering the zone.

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

rated_primary_air_flow_rate_per_beam_length

field Rated Primary Air Flow Rate per Beam Length

Primary air supply flow rate normalized by beam length.

Units: m3/s-m

Default value: 0.035

Parameters:value (float) – value for IDD Field Rated Primary Air Flow Rate per Beam Length Raises:ValueError – if value is not a valid value Returns:the value of rated_primary_air_flow_rate_per_beam_length or None if not set Return type:float

zone_total_beam_length

field Zone Total Beam Length

Sum of the length of all the beam units in the zone represented by this terminal unit.

Units: m

Default value: “autosize”

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctConstantVolumeFourPipeInduction

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction Central air system terminal unit, single duct, variable volume, induction unit with hot water reheat coil and chilled water recool coil.

air_outlet_node_name

field Air Outlet Node Name

should be a zone inlet node

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

cold_water_inlet_node_name

field Cold Water Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

cooling_coil_name

field Cooling Coil Name

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

cooling_coil_object_type

field Cooling Coil Object Type

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

cooling_convergence_tolerance

field Cooling Convergence Tolerance

Default value: 0.001

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

heating_coil_name

field Heating Coil Name

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

heating_coil_object_type

field Heating Coil Object Type

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

heating_convergence_tolerance

field Heating Convergence Tolerance

Default value: 0.001

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

hot_water_inlet_node_name

field Hot Water Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

induced_air_inlet_node_name

field Induced Air Inlet Node Name

should be a zone exhaust node, also the heating coil inlet node

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

induction_ratio

field Induction Ratio

ratio of induced air flow rate to primary air flow rate

Default value: 2.5

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

maximum_cold_water_flow_rate

field Maximum Cold Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

maximum_hot_water_flow_rate

field Maximum Hot Water Flow Rate

Not used when heating coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_total_air_flow_rate

field Maximum Total Air Flow Rate

Units: m3/s

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

minimum_cold_water_flow_rate

field Minimum Cold Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

minimum_hot_water_flow_rate

field Minimum Hot Water Flow Rate

Not used when heating coil type is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_flow_rate 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

supply_air_inlet_node_name

field Supply Air Inlet Node Name

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

zone_mixer_name

field Zone Mixer Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctConstantVolumeReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:ConstantVolume:Reheat Central air system terminal unit, single duct, constant volume, with reheat coil (hot water, electric, gas, or steam).

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

convergence_tolerance

field Convergence Tolerance

Default value: 0.001

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_or_steam_flow_rate 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

reheat_coil_name

field Reheat Coil Name

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

reheat_coil_object_type

field Reheat Coil Object Type

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctInletSideMixer

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:InletSideMixer The inlet side mixer air terminal unit provides a means of supplying central system air to the air inlet of a zone AC unit such as a four pipe fan coil. Normally the central air would be ventilation air from a dedicated outdoor air system (DOAS).

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

terminal_unit_outlet_node_name

field Terminal Unit Outlet Node Name

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

terminal_unit_primary_air_inlet_node_name

field Terminal Unit Primary Air Inlet Node Name

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

terminal_unit_secondary_air_inlet_node_name

field Terminal Unit Secondary Air Inlet Node Name

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

zonehvac_terminal_unit_name

field ZoneHVAC Terminal Unit Name

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

zonehvac_terminal_unit_object_type

field ZoneHVAC Terminal Unit Object Type

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctParallelPiuReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:ParallelPIU:Reheat Central air system terminal unit, single duct, variable volume, parallel powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

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

convergence_tolerance

field Convergence Tolerance

Default value: 0.001

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

fan_name

field Fan Name

Fan type must be Fan:ConstantVolume

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

fan_on_flow_fraction

field Fan On Flow Fraction

the fraction of the primary air flow at which fan turns on

value <= 1.0

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_primary_air_flow_rate

field Maximum Primary Air Flow Rate

Units: m3/s

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

maximum_secondary_air_flow_rate

field Maximum Secondary Air Flow Rate

Units: m3/s

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

minimum_primary_air_flow_fraction

field Minimum Primary Air Flow Fraction

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Minimum Primary Air Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of minimum_primary_air_flow_fraction or None if not set Return type:float or “Autosize”

name

field Name

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

outlet_node_name

field Outlet Node Name

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

reheat_coil_air_inlet_node_name

field Reheat Coil Air Inlet Node Name

mixer outlet node

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

reheat_coil_name

field Reheat Coil Name

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

reheat_coil_object_type

field Reheat Coil Object Type

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

secondary_air_inlet_node_name

field Secondary Air Inlet Node Name

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

supply_air_inlet_node_name

field Supply Air Inlet Node Name

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

zone_mixer_name

field Zone Mixer Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctSeriesPiuReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:SeriesPIU:Reheat Central air system terminal unit, single duct, variable volume, series powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

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

convergence_tolerance

field Convergence Tolerance

Default value: 0.001

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

fan_name

field Fan Name

Fan type must be Fan:ConstantVolume

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_primary_air_flow_rate

field Maximum Primary Air Flow Rate

Units: m3/s

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

minimum_primary_air_flow_fraction

field Minimum Primary Air Flow Fraction

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Minimum Primary Air Flow Fraction Raises:ValueError – if value is not a valid value Returns:the value of minimum_primary_air_flow_fraction or None if not set Return type:float or “Autosize”

name

field Name

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

outlet_node_name

field Outlet Node Name

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

reheat_coil_air_inlet_node_name

field Reheat Coil Air Inlet Node Name

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

reheat_coil_name

field Reheat Coil Name

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

reheat_coil_object_type

field Reheat Coil Object Type

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

secondary_air_inlet_node_name

field Secondary Air Inlet Node Name

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

supply_air_inlet_node_name

field Supply Air Inlet Node Name

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

zone_mixer_name

field Zone Mixer Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctSupplySideMixer

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:SupplySideMixer The supply side mixer air terminal unit provides a means of supplying central system air to the air outlet of a zone AC unit such as a four pipe fan coil. Normally the central air would be ventilation air from a dedicated outdoor air system (DOAS).

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

terminal_unit_outlet_node_name

field Terminal Unit Outlet Node Name

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

terminal_unit_primary_air_inlet_node_name

field Terminal Unit Primary Air Inlet Node Name

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

terminal_unit_secondary_air_inlet_node_name

field Terminal Unit Secondary Air Inlet Node Name

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

zonehvac_terminal_unit_name

field ZoneHVAC Terminal Unit Name

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

zonehvac_terminal_unit_object_type

field ZoneHVAC Terminal Unit Object Type

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctUncontrolled

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:Uncontrolled Central air system terminal unit, single duct, constant volume, no controls other than on/off schedule.

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

name

field Name

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

zone_supply_air_node_name

field Zone Supply Air Node Name

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctVavHeatAndCoolNoReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat Central air system terminal unit, single duct, variable volume for both cooling and heating, with no reheat coil.

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

The outlet node of the terminal unit.

This is also the zone inlet node.

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

name

field Name

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

zone_minimum_air_flow_fraction

field Zone Minimum Air Flow Fraction

fraction of maximum air flow

value <= 1.0

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctVavHeatAndCoolReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat Central air system terminal unit, single duct, variable volume for both cooling and heating, with reheat coil (hot water, electric, gas, or steam).

air_inlet_node_name

field Air Inlet Node Name

the inlet node to the terminal unit and the damper

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

The outlet node of the terminal unit and the reheat coil.

This is also the zone inlet node.

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

convergence_tolerance

field Convergence Tolerance

Default value: 0.001

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

damper_air_outlet_node_name

field Damper Air Outlet Node Name

the outlet node of the damper and the inlet node of the reheat coil

this is an internal node to the terminal unit and connects the damper and reheat coil

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_or_steam_flow_rate 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

reheat_coil_name

field Reheat Coil Name

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

reheat_coil_object_type

field Reheat Coil Object Type

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

zone_minimum_air_flow_fraction

field Zone Minimum Air Flow Fraction

fraction of maximum air flow

value <= 1.0

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

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctVavNoReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:VAV:NoReheat Central air system terminal unit, single duct, variable volume, with no reheat coil.

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

constant_minimum_air_flow_fraction

field Constant Minimum Air Flow Fraction

This field is used if the field Zone Minimum Air Flow Input Method is Constant

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional; if a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the following field are entered, the larger result is used.

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based on the current number of occupants in the zone.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

If this field is blank, then the terminal unit will not be controlled for outdoor air flow.

Parameters:value (str) – value for IDD Field Design Specification Outdoor Air Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_outdoor_air_object_name or None if not set Return type:str

fixed_minimum_air_flow_rate

field Fixed Minimum Air Flow Rate

This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate.

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional; if a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the previous field are entered, the larger result is used.

Units: m3/s

Parameters:value (float) – value for IDD Field Fixed Minimum Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of fixed_minimum_air_flow_rate or None if not set Return type:float

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

minimum_air_flow_fraction_schedule_name

field Minimum Air Flow Fraction Schedule Name

This field is used if the field Zone Minimum Air Flow Input Method is Scheduled

Schedule values are fractions, 0.0 to 1.0.

If the field Constant Minimum Air Flow Fraction is blank, then the average of the

minimum and maximum schedule values is used for sizing normal-action reheat coils.

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

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

zone_minimum_air_flow_input_method

field Zone Minimum Air Flow Input Method

Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate)

FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate)

Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow

Parameters:value (str) – value for IDD Field Zone Minimum Air Flow Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_minimum_air_flow_input_method or None if not set Return type:str

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctVavReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:VAV:Reheat Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam).

air_inlet_node_name

field Air Inlet Node Name

the inlet node to the terminal unit and the damper

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

The outlet node of the terminal unit and the reheat coil.

This is also the zone inlet node.

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

constant_minimum_air_flow_fraction

field Constant Minimum Air Flow Fraction

This field is used if the field Zone Minimum Air Flow Input Method is Constant

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional; if a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the following field are entered, the larger result is used.

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

convergence_tolerance

field Convergence Tolerance

Default value: 0.001

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

damper_air_outlet_node_name

field Damper Air Outlet Node Name

the outlet node of the damper and the inlet node of the reheat coil

this is an internal node to the terminal unit and connects the damper and reheat coil

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

damper_heating_action

field Damper Heating Action

Default value: Normal

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

design_specification_outdoor_air_object_name

field Design Specification Outdoor Air Object Name

When the name of a DesignSpecification:OutdoorAir object is entered, the terminal

unit will increase flow as needed to meet this outdoor air requirement.

If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will

be computed based on the current number of occupants in the zone.

At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate.

If this field is blank, then the terminal unit will not be controlled for outdoor air flow.

Parameters:value (str) – value for IDD Field Design Specification Outdoor Air Object Name Raises:ValueError – if value is not a valid value Returns:the value of design_specification_outdoor_air_object_name or None if not set Return type:str

fixed_minimum_air_flow_rate

field Fixed Minimum Air Flow Rate

This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate.

If the field Zone Minimum Air Flow Input Method is Scheduled, then this field

is optional; if a value is entered, then it is used for sizing normal-action reheat coils.

If both this field and the previous field are entered, the larger result is used.

Units: m3/s

Parameters:value (float) – value for IDD Field Fixed Minimum Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of fixed_minimum_air_flow_rate or None if not set Return type:float

maximum_air_flow_rate

field Maximum Air Flow Rate

Units: m3/s

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

maximum_flow_fraction_during_reheat

field Maximum Flow Fraction During Reheat

Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse

When autocalculating, the maximum flow fraction is set to the ratio of

0.002032 m3/s-m2 (0.4 cfm/sqft) multiplied by the zone floor area and the

Maximum Air Flow Rate.

This optional field limits the maximum flow allowed in reheat mode.

If this field and the previous field are left blank, the maximum flow will not be limited.

At no time will the maximum flow rate calculated here exceed the value of

Maximum Air Flow Rate.

Parameters:value (float or “Autocalculate”) – value for IDD Field Maximum Flow Fraction During Reheat Raises:ValueError – if value is not a valid value Returns:the value of maximum_flow_fraction_during_reheat or None if not set Return type:float or “Autocalculate”

maximum_flow_per_zone_floor_area_during_reheat

field Maximum Flow per Zone Floor Area During Reheat

Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse

When autocalculating, the maximum flow per zone is set to 0.002032 m3/s-m2 (0.4 cfm/sqft)

This optional field limits the maximum flow allowed in reheat mode.

If this field and the following field are left blank, the maximum flow will not be limited.

At no time will the maximum flow rate calculated here exceed the value of

Maximum Air Flow Rate.

Units: m3/s-m2

Parameters:value (float or “Autocalculate”) – value for IDD Field Maximum Flow per Zone Floor Area During Reheat Raises:ValueError – if value is not a valid value Returns:the value of maximum_flow_per_zone_floor_area_during_reheat or None if not set Return type:float or “Autocalculate”

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

maximum_reheat_air_temperature

field Maximum Reheat Air Temperature

Specifies the maximum allowable supply air temperature leaving the reheat coil.

If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended.

Units: C

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

minimum_air_flow_fraction_schedule_name

field Minimum Air Flow Fraction Schedule Name

This field is used if the field Zone Minimum Air Flow Input Method is Scheduled

Schedule values are fractions, 0.0 to 1.0.

If the field Constant Minimum Air Flow Fraction is blank, then the average of the

minimum and maximum schedule values is used for sizing normal-action reheat coils.

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when reheat coil type is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_or_steam_flow_rate 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

reheat_coil_name

field Reheat Coil Name

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

reheat_coil_object_type

field Reheat Coil Object Type

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

zone_minimum_air_flow_input_method

field Zone Minimum Air Flow Input Method

Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate)

FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate)

Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow

Parameters:value (str) – value for IDD Field Zone Minimum Air Flow Input Method Raises:ValueError – if value is not a valid value Returns:the value of zone_minimum_air_flow_input_method or None if not set Return type:str

class pyidf.zone_hvac_air_loop_terminal_units.AirTerminalSingleDuctVavReheatVariableSpeedFan

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam) and variable-speed fan. These units are usually employed in underfloor air distribution (UFAD) systems where the air is supplied at low static pressure through an underfloor plenum. The fan is used to control the flow of conditioned air that enters the space.

air_inlet_node_name

field Air Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field 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

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

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field 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

fan_name

field Fan Name

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

fan_object_type

field Fan Object Type

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

heating_coil_air_inlet_node_name

field Heating Coil Air Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

heating_coil_name

field Heating Coil Name

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

heating_coil_object_type

field Heating Coil Object Type

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

heating_convergence_tolerance

field Heating Convergence Tolerance

Default value: 0.001

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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

The required information is gotten internally or

not needed by the program.

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

maximum_cooling_air_flow_rate

field Maximum Cooling Air Flow Rate

Units: m3/s

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

maximum_heating_air_flow_rate

field Maximum Heating Air Flow Rate

Units: m3/s

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

maximum_hot_water_or_steam_flow_rate

field Maximum Hot Water or Steam Flow Rate

Not used when heating coil type is gas or electric

Units: m3/s

IP-Units: gal/min

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

minimum_hot_water_or_steam_flow_rate

field Minimum Hot Water or Steam Flow Rate

Not used when heating coil type is gas or electric

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Minimum Hot Water or Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_hot_water_or_steam_flow_rate 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

zone_minimum_air_flow_fraction

field Zone Minimum Air Flow Fraction

fraction of cooling air flow rate

value <= 1.0

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

class pyidf.zone_hvac_air_loop_terminal_units.ZoneHvacAirDistributionUnit

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:AirDistributionUnit Central air system air distribution unit, serves as a wrapper for a specific type of air terminal unit. This object is referenced in a ZoneHVAC:EquipmentList.

air_distribution_unit_outlet_node_name

field Air Distribution Unit Outlet Node Name

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

air_terminal_name

field Air Terminal Name

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

air_terminal_object_type

field Air Terminal Object Type

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

constant_downstream_leakage_fraction

field Constant Downstream Leakage Fraction

value <= 0.3

Parameters:value (float) – value for IDD Field Constant Downstream Leakage Fraction Raises:ValueError – if value is not a valid value Returns:the value of constant_downstream_leakage_fraction 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_upstream_leakage_fraction

field Nominal Upstream Leakage Fraction

fraction at system design Flow; leakage Flow constant, leakage fraction

varies with variable system Flow Rate.

value <= 0.3

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