pyidf.zone_hvac_radiative module

Data objects in group “Zone HVAC Radiative”

class pyidf.zone_hvac_radiative.ZoneHvacBaseboardConvectiveElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Baseboard:Convective:Electric Electric baseboard heater, convection-only. Natural convection electric heating unit.

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

efficiency

field Efficiency

Default value: 1.0

value <= 1.0

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

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area 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

class pyidf.zone_hvac_radiative.ZoneHvacBaseboardConvectiveWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Baseboard:Convective:Water Hot water baseboard heater, convection-only. Natural convection hydronic heating unit.

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

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

inlet_node_name

field Inlet Node Name

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

maximum_water_flow_rate

field Maximum Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

name

field Name

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

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

ufactor_times_area_value

field U-Factor Times Area Value

Units: W/K

Parameters:value (float or “Autosize”) – value for IDD Field U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of ufactor_times_area_value or None if not set Return type:float or “Autosize”

class pyidf.zone_hvac_radiative.ZoneHvacBaseboardRadiantConvectiveElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Baseboard:RadiantConvective:Electric The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

add_extensible(surface_1_name=None, fraction_of_radiant_energy_to_surface_1=None)

Add values for extensible fields

Parameters:

• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• fraction_of_radiant_energy_to_surface_1 (float) – value for IDD Field Fraction of Radiant Energy to Surface 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

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

efficiency

field Efficiency

Default value: 1.0

value <= 1.0

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

extensibles

Get list of all extensibles

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

fraction_of_radiant_energy_incident_on_people

field Fraction of Radiant Energy Incident on People

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Radiant Energy Incident on People Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_radiant_energy_incident_on_people or None if not set Return type:float

fraction_radiant

field Fraction Radiant

value <= 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area 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

class pyidf.zone_hvac_radiative.ZoneHvacBaseboardRadiantConvectiveSteam

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Baseboard:RadiantConvective:Steam The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

add_extensible(surface_1_name=None, fraction_of_radiant_energy_to_surface_1=None)

Add values for extensible fields

Parameters:

• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• fraction_of_radiant_energy_to_surface_1 (float) – value for IDD Field Fraction of Radiant Energy to Surface 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

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

degree_of_subcooling

field Degree of SubCooling

Units: deltaC

Default value: 5.0

value >= 1.0

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

extensibles

Get list of all extensibles

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

fraction_of_radiant_energy_incident_on_people

field Fraction of Radiant Energy Incident on People

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Radiant Energy Incident on People Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_radiant_energy_incident_on_people or None if not set Return type:float

fraction_radiant

field Fraction Radiant

value <= 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

inlet_node_name

field Inlet Node Name

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

maximum_steam_flow_rate

field Maximum Steam Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_steam_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

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

class pyidf.zone_hvac_radiative.ZoneHvacBaseboardRadiantConvectiveWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:Baseboard:RadiantConvective:Water The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

add_extensible(surface_1_name=None, fraction_of_radiant_energy_to_surface_1=None)

Add values for extensible fields

Parameters:

• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• fraction_of_radiant_energy_to_surface_1 (float) – value for IDD Field Fraction of Radiant Energy to Surface 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

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

extensibles

Get list of all extensibles

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

fraction_of_radiant_energy_incident_on_people

field Fraction of Radiant Energy Incident on People

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Radiant Energy Incident on People Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_radiant_energy_incident_on_people or None if not set Return type:float

fraction_radiant

field Fraction Radiant

value <= 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity. Required field when the heating design capacity method

HeatingDesignCapacity. This input field is rated heating capacity. Users must multiply the

actual finned length published in the literature to determine the rated capacity. Rated

Capacity is for an inlet air dry-bulb temperature of 18.0C, the Rated Water Mass Flow Rate

of 0.063kg/s or 0.252kg/s, and the Rated Average Water Temperature between 32.2C and 115.6C.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

inlet_node_name

field Inlet Node Name

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

maximum_water_flow_rate

field Maximum Water Flow Rate

Units: m3/s

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

name

field Name

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

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

rated_average_water_temperature

field Rated Average Water Temperature

Rated average water temperature is the average of the inlet and outlet water temperatures

at rated conditions.

Units: C

Default value: 87.78

value >= 20.0

value <= 150.0

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

rated_water_mass_flow_rate

field Rated Water Mass Flow Rate

Standard is I=B=R Rating document where all baseboards are rated at either 0.063 kg/s (1 gpm)

or 0.252 kg/s (4 gpm). It is recommended that users find data for the baseboard heater that

corresponds to performance at 0.063 kg/s unless the flow rate is expected to be above 0.252 kg/s.

If the flow rate is expected to be above 0.252 kg/s, this field should be 0.252 kg/s.

Units: Kg/s

Default value: 0.063

value <= 10.0

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

class pyidf.zone_hvac_radiative.ZoneHvacHighTemperatureRadiant

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:HighTemperatureRadiant The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

add_extensible(surface_1_name=None, fraction_of_radiant_energy_to_surface_1=None)

Add values for extensible fields

Parameters:

• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• fraction_of_radiant_energy_to_surface_1 (float) – value for IDD Field Fraction of Radiant Energy to Surface 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

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

combustion_efficiency

field Combustion Efficiency

Not used for non-gas radiant heaters

Default value: 0.9

value <= 1.0

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

extensibles

Get list of all extensibles

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

fraction_of_input_converted_to_latent_energy

field Fraction of Input Converted to Latent Energy

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Input Converted to Latent Energy Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_input_converted_to_latent_energy or None if not set Return type:float

fraction_of_input_converted_to_radiant_energy

field Fraction of Input Converted to Radiant Energy

Radiant+latent+lost fractions must sum to 1 or less, remainder is considered convective heat

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Input Converted to Radiant Energy Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_input_converted_to_radiant_energy or None if not set Return type:float

fraction_of_input_that_is_lost

field Fraction of Input that Is Lost

Fraction of input vented to outdoor environment

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Input that Is Lost Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_input_that_is_lost or None if not set Return type:float

fraction_of_radiant_energy_incident_on_people

field Fraction of Radiant Energy Incident on People

This will affect thermal comfort but from an energy balance standpoint this value

gets added to the convective gains from the radiant heater

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Radiant Energy Incident on People Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_radiant_energy_incident_on_people or None if not set Return type:float

fuel_type

field Fuel Type

Natural gas or electricity

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the maximum heating power input capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

heating_setpoint_temperature_schedule_name

field Heating Setpoint Temperature Schedule Name

This setpoint is an “operative temperature” setpoint

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

heating_throttling_range

field Heating Throttling Range

Units: deltaC

Default value: 2.0

Parameters:value (float) – value for IDD Field Heating Throttling Range Raises:ValueError – if value is not a valid value Returns:the value of heating_throttling_range 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

temperature_control_type

field Temperature Control Type

Temperature type used to control unit

Default value: OperativeTemperature

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

zone_name

field Zone Name

Name of zone system is serving

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

class pyidf.zone_hvac_radiative.ZoneHvacLowTemperatureRadiantConstantFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:LowTemperatureRadiant:ConstantFlow Low temperature hydronic radiant heating and/or cooling system embedded in a building surface (wall, ceiling, or floor). Controlled by varying the hot or chilled water temperature circulating through the unit.

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

circuit_length

field Circuit Length

Units: m

Default value: 106.7

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

condensation_control_dewpoint_offset

field Condensation Control Dewpoint Offset

Units: C

Default value: 1.0

Parameters:value (float) – value for IDD Field Condensation Control Dewpoint Offset Raises:ValueError – if value is not a valid value Returns:the value of condensation_control_dewpoint_offset or None if not set Return type:float

condensation_control_type

field Condensation Control Type

Default value: SimpleOff

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

cooling_high_control_temperature_schedule_name

field Cooling High Control Temperature Schedule Name

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

cooling_high_water_temperature_schedule_name

field Cooling High Water Temperature Schedule Name

See note for Heating High Water Temperature Schedule above for

interpretation information (or see the Input/Output Reference).

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

cooling_low_control_temperature_schedule_name

field Cooling Low Control Temperature Schedule Name

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

cooling_low_water_temperature_schedule_name

field Cooling Low Water Temperature Schedule Name

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

cooling_water_inlet_node_name

field Cooling Water Inlet Node Name

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

cooling_water_outlet_node_name

field Cooling Water Outlet Node Name

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

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Motor Inefficiencies to Fluid Stream Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_motor_inefficiencies_to_fluid_stream or None if not set Return type:float

heating_high_control_temperature_schedule_name

field Heating High Control Temperature Schedule Name

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

heating_high_water_temperature_schedule_name

field Heating High Water Temperature Schedule Name

Water and control temperatures for heating work together to provide

a linear function that determines the water temperature sent to the

radiant system. The current control temperature (see Temperature Control Type above) is

compared to the high and low control temperatures at the current time.

If the control temperature is above the high temperature, then the

inlet water temperature is set to the low water temperature. If the

control temperature is below the low temperature, then the inlet

water temperature is set to the high water temperature. If the control

temperature is between the high and low value, then the inlet water

temperature is linearly interpolated between the low and high water

temperature values.

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

heating_low_control_temperature_schedule_name

field Heating Low Control Temperature Schedule Name

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

heating_low_water_temperature_schedule_name

field Heating Low Water Temperature Schedule Name

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

heating_water_inlet_node_name

field Heating Water Inlet Node Name

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

heating_water_outlet_node_name

field Heating Water Outlet Node Name

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

hydronic_tubing_inside_diameter

field Hydronic Tubing Inside Diameter

Units: m

Default value: 0.013

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

hydronic_tubing_length

field Hydronic Tubing Length

Total length of pipe embedded in surface

Units: m

Default value: “autosize”

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

motor_efficiency

field Motor Efficiency

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Motor Efficiency Raises:ValueError – if value is not a valid value Returns:the value of motor_efficiency 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_circuits

field Number of Circuits

Default value: OnePerSurface

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the Rated Flow Rate of the pump on a time basis

the default is that the pump is ON and runs according to its other

operational requirements specified above. The schedule is for special

pump operations. Values here are between 0 and 1 and are multipliers

on the previous field (Rated Flow Rate).

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

rated_flow_rate

field Rated Flow Rate

Units: m3/s

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

rated_power_consumption

field Rated Power Consumption

Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

Default value: 179352.0

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

surface_name_or_radiant_surface_group_name

field Surface Name or Radiant Surface Group Name

Identifies surfaces that radiant system is embedded in.

For a system with multiple surfaces, enter the name of

a ZoneHVAC:LowTemperatureRadiant:SurfaceGroup object.

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

temperature_control_type

field Temperature Control Type

Temperature used to control system

Default value: MeanAirTemperature

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

zone_name

field Zone Name

Name of zone system is serving

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

class pyidf.zone_hvac_radiative.ZoneHvacLowTemperatureRadiantElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:LowTemperatureRadiant:Electric Electric resistance low temperature radiant system

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

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the maximum electrical heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

heating_setpoint_temperature_schedule_name

field Heating Setpoint Temperature Schedule Name

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

heating_throttling_range

field Heating Throttling Range

Units: deltaC

Parameters:value (float) – value for IDD Field Heating Throttling Range Raises:ValueError – if value is not a valid value Returns:the value of heating_throttling_range 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

surface_name_or_radiant_surface_group_name

field Surface Name or Radiant Surface Group Name

Identifies surfaces that radiant system is embedded in.

For a system with multiple surfaces, enter the name of

a ZoneHVAC:LowTemperatureRadiant:SurfaceGroup object.

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

temperature_control_type

field Temperature Control Type

Temperature used to control unit

Default value: MeanAirTemperature

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

zone_name

field Zone Name

Name of zone system is serving

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

class pyidf.zone_hvac_radiative.ZoneHvacLowTemperatureRadiantSurfaceGroup

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:LowTemperatureRadiant:SurfaceGroup This is used to allow the coordinate control of several radiant system surfaces. Note that the following flow fractions must sum up to 1.0 The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

add_extensible(surface_1_name=None, flow_fraction_for_surface_1=None)

Add values for extensible fields

Parameters:

• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• flow_fraction_for_surface_1 (float) – value for IDD Field Flow Fraction for Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

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

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:LowTemperatureRadiant:VariableFlow Low temperature hydronic radiant heating and/or cooling system embedded in a building surface (wall, ceiling, or floor). Controlled by varying the hot or chilled water flow to the unit.

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

circuit_length

field Circuit Length

Units: m

Default value: 106.7

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

condensation_control_dewpoint_offset

field Condensation Control Dewpoint Offset

Units: C

Default value: 1.0

Parameters:value (float) – value for IDD Field Condensation Control Dewpoint Offset Raises:ValueError – if value is not a valid value Returns:the value of condensation_control_dewpoint_offset or None if not set Return type:float

condensation_control_type

field Condensation Control Type

Default value: SimpleOff

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

cooling_control_temperature_schedule_name

field Cooling Control Temperature Schedule Name

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

cooling_control_throttling_range

field Cooling Control Throttling Range

Units: deltaC

Default value: 0.5

value >= 0.5

Parameters:value (float) – value for IDD Field Cooling Control Throttling Range Raises:ValueError – if value is not a valid value Returns:the value of cooling_control_throttling_range or None if not set Return type:float

cooling_design_capacity

field Cooling Design Capacity

Enter the design cooling capacity. Required field when the cooling design capacity method

CoolingDesignCapacity.

Units: W

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

cooling_design_capacity_method

field Cooling Design Capacity Method

Enter the method used to determine the cooling design capacity for scalable sizing.

CoolingDesignCapacity => selected when the design cooling capacity value is specified or

auto-sized. CapacityPerFloorArea => selected when the design cooling capacity is determined

from user specified cooling capacity per floor area and total floor area of cooled zone

served by the hydrolic unit. FractionOfAutosizedCoolingCapacity => is selected when the

design cooling capacity is determined from a user specified fraction and the auto-sized

design cooling capacity of the system.

Default value: CoolingDesignCapacity

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

cooling_design_capacity_per_floor_area

field Cooling Design Capacity Per Floor Area

Enter the cooling design capacity per total floor area of cooled zones served by the unit.

Required field when the cooling design capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Cooling Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of cooling_design_capacity_per_floor_area or None if not set Return type:float

cooling_water_inlet_node_name

field Cooling Water Inlet Node Name

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

cooling_water_outlet_node_name

field Cooling Water Outlet Node Name

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

fraction_of_autosized_cooling_design_capacity

field Fraction of Autosized Cooling Design Capacity

Enter the fraction of auto-sized cooling design capacity. Required field when the cooling

design capacity method field is FractionOfAutosizedCoolingCapacity.

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

fraction_of_autosized_heating_design_capacity

field Fraction of Autosized Heating Design Capacity

Enter the fraction of auto - sized heating design capacity.Required field when capacity the

heating design capacity method field is FractionOfAutosizedHeatingCapacity.

Default value: 1.0

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

heating_control_temperature_schedule_name

field Heating Control Temperature Schedule Name

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

heating_control_throttling_range

field Heating Control Throttling Range

Units: deltaC

Default value: 0.5

value >= 0.5

Parameters:value (float) – value for IDD Field Heating Control Throttling Range Raises:ValueError – if value is not a valid value Returns:the value of heating_control_throttling_range or None if not set Return type:float

heating_design_capacity

field Heating Design Capacity

Enter the design heating capacity.Required field when the heating design capacity method

HeatingDesignCapacity.

Units: W

IP-Units: W

Default value: “autosize”

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

heating_design_capacity_method

field Heating Design Capacity Method

Enter the method used to determine the heating design capacity.

HeatingDesignCapacity = > selected when the design heating capacity value or autosize

is specified. CapacityPerFloorArea = > selected when the design heating capacity is

determine from user specified heating capacity per floor area and zone floor area.

FractionOfAutosizedHeatingCapacity = > is selected when the design heating capacity is

determined from a user specified fraction and the auto-sized design heating capacity.

Default value: HeatingDesignCapacity

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

heating_design_capacity_per_floor_area

field Heating Design Capacity Per Floor Area

Enter the heating design capacity per zone floor area.Required field when the heating design

capacity method field is CapacityPerFloorArea.

Units: W/m2

Parameters:value (float) – value for IDD Field Heating Design Capacity Per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of heating_design_capacity_per_floor_area or None if not set Return type:float

heating_water_inlet_node_name

field Heating Water Inlet Node Name

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

heating_water_outlet_node_name

field Heating Water Outlet Node Name

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

hydronic_tubing_inside_diameter

field Hydronic Tubing Inside Diameter

Units: m

IP-Units: in

Default value: 0.013

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

hydronic_tubing_length

field Hydronic Tubing Length

(total length of pipe embedded in surface)

Units: m

Default value: “autosize”

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

maximum_cold_water_flow

field Maximum Cold Water Flow

Units: m3/s

IP-Units: gal/min

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

maximum_hot_water_flow

field Maximum Hot Water Flow

Units: m3/s

IP-Units: gal/min

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Hot Water Flow Raises:ValueError – if value is not a valid value Returns:the value of maximum_hot_water_flow 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

number_of_circuits

field Number of Circuits

Default value: OnePerSurface

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

surface_name_or_radiant_surface_group_name

field Surface Name or Radiant Surface Group Name

Identifies surfaces that radiant system is embedded in.

For a system with multiple surfaces, enter the name of

a ZoneHVAC:LowTemperatureRadiant:SurfaceGroup object.

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

temperature_control_type

field Temperature Control Type

(Temperature on which unit is controlled)

Default value: MeanAirTemperature

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

zone_name

field Zone Name

Name of zone system is serving

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

class pyidf.zone_hvac_radiative.ZoneHvacVentilatedSlab

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:VentilatedSlab Ventilated slab system where outdoor air flows through hollow cores in a building surface (wall, ceiling, or floor).

availability_manager_list_name

field Availability Manager List Name

Enter the name of an AvailabilityManagerAssignmentList object.

Parameters:value (str) – value for IDD Field Availability Manager List Name Raises:ValueError – if value is not a valid value Returns:the value of availability_manager_list_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

coil_option_type

field Coil Option Type

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

cold_water_inlet_node_name

field Cold Water Inlet Node Name

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_high_air_temperature_schedule_name

field Cooling High Air Temperature Schedule Name

See note for heating high air temperature schedule above for

interpretation information (or see the Input/Output Reference).

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

cooling_high_control_temperature_schedule_name

field Cooling High Control Temperature Schedule Name

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

cooling_low_air_temperature_schedule_name

field Cooling Low Air Temperature Schedule Name

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

cooling_low_control_temperature_schedule_name

field Cooling Low Control Temperature Schedule Name

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

design_specification_zonehvac_sizing_object_name

field Design Specification ZoneHVAC Sizing Object Name

Enter the name of a DesignSpecificationZoneHVACSizing object.

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

fan_name

field Fan Name

Allowable fan type is 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_outlet_node_name

field Fan Outlet Node Name

This is the node name of the fan outlet.

Parameters:value (str) – value for IDD Field Fan Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of fan_outlet_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_high_air_temperature_schedule_name

field Heating High Air Temperature Schedule Name

Air and control temperatures for heating work together to provide

a linear function that determines the air temperature sent to the

radiant system. The current control temperature (see A14) is

compared to the high and low control temperatures at the current time.

If the control temperature is above the high temperature, then the

inlet air temperature is set to the low air temperature. If the

control temperature is below the low temperature, then the inlet

air temperature is set to the high air temperature. If the control

temperature is between the high and low value, then the inlet air

temperature is linearly interpolated between the low and high air

temperature values.

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

heating_high_control_temperature_schedule_name

field Heating High Control Temperature Schedule Name

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

heating_low_air_temperature_schedule_name

field Heating Low Air Temperature Schedule Name

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

heating_low_control_temperature_schedule_name

field Heating Low Control Temperature Schedule Name

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

hollow_core_inside_diameter

field Hollow Core Inside Diameter

Units: m

IP-Units: in

Default value: 0.05

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

hollow_core_length

field Hollow Core Length

(length of core cavity embedded in surface)

Units: m

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

hot_water_or_steam_inlet_node_name

field Hot Water or Steam Inlet Node Name

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_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

schedule values multiply the minimum outdoor air flow rate

Units: m3/s

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

maximum_outdoor_air_fraction_or_temperature_schedule_name

field Maximum Outdoor Air Fraction or Temperature Schedule Name

Note that this depends on the control type as to whether schedule values are a fraction or temperature

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

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

minimum_outdoor_air_schedule_name

field Minimum Outdoor Air Schedule Name

Parameters:value (str) – value for IDD Field Minimum Outdoor Air Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_air_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

number_of_cores

field Number of Cores

flow will be divided evenly among the cores

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

outdoor_air_control_type

field Outdoor Air Control Type

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

outdoor_air_mixer_outlet_node_name

field Outdoor Air Mixer Outlet Node Name

This is the node name leaving the outdoor air mixer and entering the fan and coil(s).

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

outdoor_air_node_name

field Outdoor Air Node Name

This node is the outdoor air inlet to the ventilated slab oa mixer.

This node should also be specified in an OutdoorAir:Node or OutdoorAir:NodeList object.

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

relief_air_node_name

field Relief Air Node Name

This node is the relief air node from the ventilated slab outdoor air mixer.

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

return_air_node_name

field Return Air Node Name

This is the zone return air inlet to the ventilated slab system outdoor air mixer.

This node is typically a zone exhaust node (do not connect to “Zone Return Air Node”).

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

slab_in_node_name

field Slab In Node Name

This is the node entering the slab or series of slabs after the fan and coil(s).

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

surface_name_or_radiant_surface_group_name

field Surface Name or Radiant Surface Group Name

(name of surface system is embedded in) or list of surfaces

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

system_configuration_type

field System Configuration Type

Default value: SlabOnly

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

temperature_control_type

field Temperature Control Type

(temperature on which unit is controlled)

Default value: OutdoorDryBulbTemperature

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

zone_name

field Zone Name

(name of zone system is serving)

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

zone_supply_air_node_name

field Zone Supply Air Node Name

This is the node name exiting the slab.

This node is typically a zone inlet node.

Leave blank when the system configuration is SlabOnly or SeriesSlabs.

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

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:VentilatedSlab:SlabGroup This is used to allow the coordinate control of several ventilated slab system surfaces. Note that the flow fractions must sum up to 1.0. The number of surfaces can be expanded beyond 10, if necessary, by adding more groups to the end of the list

add_extensible(zone_1_name=None, surface_1_name=None, core_diameter_for_surface_1=None, core_length_for_surface_1=None, core_numbers_for_surface_1=None, slab_inlet_node_name_for_surface_1=None, slab_outlet_node_name_for_surface_1=None)

Add values for extensible fields

Parameters:

• zone_1_name (str) – value for IDD Field Zone 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• core_diameter_for_surface_1 (float) – value for IDD Field Core Diameter for Surface 1 Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• core_length_for_surface_1 (float) – value for IDD Field Core Length for Surface 1 Units: m if value is None it will not be checked against the specification and is assumed to be a missing value
• core_numbers_for_surface_1 (float) – value for IDD Field Core Numbers for Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• slab_inlet_node_name_for_surface_1 (str) – value for IDD Field Slab Inlet Node Name for Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• slab_outlet_node_name_for_surface_1 (str) – value for IDD Field Slab Outlet Node Name for Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

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