pyidf.internal_gains module¶

Data objects in group “Internal Gains”

class pyidf.internal_gains.ComfortViewFactorAngles¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ComfortViewFactorAngles Used to specify radiant view factors for thermal comfort calculations.

angle_factor_1¶

field Angle Factor 1

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_1 or None if not set
Return type:	float

angle_factor_10¶

field Angle Factor 10

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 10
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_10 or None if not set
Return type:	float

angle_factor_11¶

field Angle Factor 11

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 11
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_11 or None if not set
Return type:	float

angle_factor_12¶

field Angle Factor 12

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 12
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_12 or None if not set
Return type:	float

angle_factor_13¶

field Angle Factor 13

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 13
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_13 or None if not set
Return type:	float

angle_factor_14¶

field Angle Factor 14

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 14
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_14 or None if not set
Return type:	float

angle_factor_15¶

field Angle Factor 15

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 15
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_15 or None if not set
Return type:	float

angle_factor_16¶

field Angle Factor 16

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 16
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_16 or None if not set
Return type:	float

angle_factor_17¶

field Angle Factor 17

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 17
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_17 or None if not set
Return type:	float

angle_factor_18¶

field Angle Factor 18

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 18
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_18 or None if not set
Return type:	float

angle_factor_19¶

field Angle Factor 19

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 19
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_19 or None if not set
Return type:	float

angle_factor_2¶

field Angle Factor 2

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_2 or None if not set
Return type:	float

angle_factor_20¶

field Angle Factor 20

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 20
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_20 or None if not set
Return type:	float

angle_factor_3¶

field Angle Factor 3

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_3 or None if not set
Return type:	float

angle_factor_4¶

field Angle Factor 4

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_4 or None if not set
Return type:	float

angle_factor_5¶

field Angle Factor 5

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_5 or None if not set
Return type:	float

angle_factor_6¶

field Angle Factor 6

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 6
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_6 or None if not set
Return type:	float

angle_factor_7¶

field Angle Factor 7

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 7
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_7 or None if not set
Return type:	float

angle_factor_8¶

field Angle Factor 8

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 8
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_8 or None if not set
Return type:	float

angle_factor_9¶

field Angle Factor 9

value <= 1.0

Parameters:	value (float) – value for IDD Field Angle Factor 9
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of angle_factor_9 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_10_name¶

field Surface 10 Name

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

surface_11_name¶

field Surface 11 Name

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

surface_12_name¶

field Surface 12 Name

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

surface_13_name¶

field Surface 13 Name

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

surface_14_name¶

field Surface 14 Name

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

surface_15_name¶

field Surface 15 Name

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

surface_16_name¶

field Surface 16 Name

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

surface_17_name¶

field Surface 17 Name

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

surface_18_name¶

field Surface 18 Name

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

surface_19_name¶

field Surface 19 Name

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

surface_1_name¶

field Surface 1 Name

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

surface_20_name¶

field Surface 20 Name

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

surface_2_name¶

field Surface 2 Name

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

surface_3_name¶

field Surface 3 Name

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

surface_4_name¶

field Surface 4 Name

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

surface_5_name¶

field Surface 5 Name

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

surface_6_name¶

field Surface 6 Name

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

surface_7_name¶

field Surface 7 Name

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

surface_8_name¶

field Surface 8 Name

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

surface_9_name¶

field Surface 9 Name

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

zone_name¶

field Zone Name

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.internal_gains.ElectricEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricEquipment Sets internal gains for electric equipment in the zone. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

design_level¶

field Design Level

Units: W

IP-Units: W

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

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of electric equipment
for this set of attributes
Choices: EquipmentLevel => Equipment Level – simply enter watts of equipment
Watts/Area => Watts per Zone Floor Area – enter the number to apply.  Value * Floor Area = Equipment Level
Watts/Person => Watts per Person – enter the number to apply.  Value * Occupants = Equipment Level
Default value: EquipmentLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

fraction_latent¶

field Fraction Latent

value <= 1.0

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

fraction_lost¶

field Fraction Lost

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction Lost
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_lost 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

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

schedule_name¶

field Schedule Name

units in schedule should be fraction applied to design level of electric equipment, generally (0.0 - 1.0)

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

watts_per_person¶

field Watts per Person

Units: W/person

IP-Units: W/person

Parameters:	value (float) – value for IDD Field Watts per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_person or None if not set
Return type:	float

watts_per_zone_floor_area¶

field Watts per Zone Floor Area

Units: W/m2

IP-Units: W/ft2

Parameters:	value (float) – value for IDD Field Watts per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_zone_floor_area or None if not set
Return type:	float

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.ElectricEquipmentIteAirCooled¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricEquipment:ITE:AirCooled This object describes air-cooled electric information technology equipment (ITE) which has variable power consumption as a function of loading and temperature.

air_flow_function_of_loading_and_air_temperature_curve_name¶

field Air Flow Function of Loading and Air Temperature Curve Name

The name of a two-variable curve or table lookup object which modifies the cooling
air flow rate as a function of CPU loading (x) and air inlet node temperature (y).
This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and
Design Entering Air Temperature).

Parameters:	value (str) – value for IDD Field Air Flow Function of Loading and Air Temperature Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_flow_function_of_loading_and_air_temperature_curve_name or None if not set
Return type:	str

air_inlet_connection_type¶

field Air Inlet Connection Type

Specifies the type of connection between the zone and the ITE air inlet node.
AdjustedSupply = ITE inlet temperature will be the current Supply Air Node temperature
adjusted by the current recirculation fraction.
All heat output is added to the zone air heat balance as a convective gain.
ZoneAirNode = ITE air inlet condition is  the average zone condition.
All heat output is added to the zone air heat balance as a convective gain.
RoomAirModel = ITE air inlet and outlet are connected to room air model nodes.
Default value: AdjustedSupply

Parameters:	value (str) – value for IDD Field Air Inlet Connection Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_inlet_connection_type or None if not set
Return type:	str

air_inlet_room_air_model_node_name¶

field Air Inlet Room Air Model Node Name

Name of a RoomAir:Node object which is connected to the ITE air inlet.

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

air_outlet_room_air_model_node_name¶

field Air Outlet Room Air Model Node Name

Name of a RoomAir:Node object which is connected to the ITE air outlet.

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

cpu_enduse_subcategory¶

field CPU End-Use Subcategory

Default value: ITE-CPU

Parameters:	value (str) – value for IDD Field CPU End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cpu_enduse_subcategory or None if not set
Return type:	str

cpu_loading_schedule_name¶

field CPU Loading Schedule Name

CPU loading schedule for this equipment as a fraction from 0.0 (idle) to 1.0 (full load).

If this field is blank, the schedule is assumed to always be 1.0.

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

cpu_power_input_function_of_loading_and_air_temperature_curve_name¶

field CPU Power Input Function of Loading and Air Temperature Curve Name

The name of a two-variable curve or table lookup object which modifies the CPU power
input as a function of CPU loading (x) and air inlet node temperature (y).
This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and
Design Entering Air Temperature).

Parameters:	value (str) – value for IDD Field CPU Power Input Function of Loading and Air Temperature Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cpu_power_input_function_of_loading_and_air_temperature_curve_name or None if not set
Return type:	str

design_electric_power_supply_efficiency¶

field Design Electric Power Supply Efficiency

The efficiency of the power supply system serving this ITE
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Design Electric Power Supply Efficiency
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_electric_power_supply_efficiency or None if not set
Return type:	float

design_entering_air_temperature¶

field Design Entering Air Temperature

The entering air temperature at design conditions.
Units: C
Default value: 15.0

Parameters:	value (float) – value for IDD Field Design Entering Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_entering_air_temperature or None if not set
Return type:	float

design_fan_air_flow_rate_per_power_input¶

field Design Fan Air Flow Rate per Power Input

The cooling fan air flow rate per total electric power input at design conditions

Units: m3/s-W

Parameters:	value (float) – value for IDD Field Design Fan Air Flow Rate per Power Input
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_fan_air_flow_rate_per_power_input or None if not set
Return type:	float

design_fan_power_input_fraction¶

field Design Fan Power Input Fraction

The fraction of the total power input at design conditions which is for the cooling fan(s)

value <= 1.0

Parameters:	value (float) – value for IDD Field Design Fan Power Input Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_fan_power_input_fraction or None if not set
Return type:	float

design_power_input_calculation_method¶

field Design Power Input Calculation Method

The entered calculation method is used to specify the design power input
Watts/Unit => Watts per Unit – Design Power = Watts per Unit * Number of Units
Watts/Area => Watts per Zone Floor Area – Design Power = Watts per Zone Floor Area * Floor Area
Default value: Watts/Unit

Parameters:	value (str) – value for IDD Field Design Power Input Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_power_input_calculation_method or None if not set
Return type:	str

design_power_input_schedule_name¶

field Design Power Input Schedule Name

Operating schedule for this equipment, fraction applied to the design power input,
generally (0.0 - 1.0)
If this field is blank, the schedule is assumed to always be 1.0.

Parameters:	value (str) – value for IDD Field Design Power Input Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_power_input_schedule_name or None if not set
Return type:	str

design_recirculation_fraction¶

field Design Recirculation Fraction

The recirculation fraction for this equipment at design conditions. This field is used only
if the Air Node Connection Type = AdjustedSupply. The default is 0.0 (no recirculation).
value <= 0.5

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

electric_power_supply_efficiency_function_of_part_load_ratio_curve_name¶

field Electric Power Supply Efficiency Function of Part Load Ratio Curve Name

The name of a single-variable curve or table lookup object which modifies the electric
power supply efficiency as a function of part-load ratio (x).
This curve (table) should equal 1.0 at full load (PLR = 1.0).
If this curve is left blank, then the curve is assumed to always equal 1.0.

Parameters:	value (str) – value for IDD Field Electric Power Supply Efficiency Function of Part Load Ratio Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of electric_power_supply_efficiency_function_of_part_load_ratio_curve_name or None if not set
Return type:	str

electric_power_supply_enduse_subcategory¶

field Electric Power Supply End-Use Subcategory

Default value: ITE-UPS

Parameters:	value (str) – value for IDD Field Electric Power Supply End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of electric_power_supply_enduse_subcategory or None if not set
Return type:	str

environmental_class¶

field Environmental Class

Specifies the allowable operating conditions for the air inlet conditions.
Used for reporting time outside allowable conditions.
Default value: None

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

fan_enduse_subcategory¶

field Fan End-Use Subcategory

Default value: ITE-Fans

Parameters:	value (str) – value for IDD Field Fan End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fan_enduse_subcategory or None if not set
Return type:	str

fan_power_input_function_of_flow_curve_name¶

field Fan Power Input Function of Flow Curve Name

The name of a single-variable curve or table lookup object which modifies the cooling
fan power as a function of flow fraction (x).
This curve (table) should equal 1.0 at a flow fraction of 1.0.

Parameters:	value (str) – value for IDD Field Fan Power Input Function of Flow Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fan_power_input_function_of_flow_curve_name or None if not set
Return type:	str

fraction_of_electric_power_supply_losses_to_zone¶

field Fraction of Electric Power Supply Losses to Zone

Fraction of the electric power supply losses which are a heat gain to the zone
If this field is <1.0, the remainder of the losses are assumed to be lost to the outdoors.
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction of Electric Power Supply Losses to Zone
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_of_electric_power_supply_losses_to_zone 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_units¶

field Number of Units

Default value: 1.0

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

recirculation_function_of_loading_and_supply_temperature_curve_name¶

field Recirculation Function of Loading and Supply Temperature Curve Name

The name of a two-variable curve or table lookup object which modifies the recirculation
fractionas a function of CPU loading (x) and supply air node temperature (y).
This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and
Design Entering Air Temperature).This field is used only if the
Air Node Connection Type = AdjustedSupply. If this curve is left blank, then the curve
is assumed to always equal 1.0.

Parameters:	value (str) – value for IDD Field Recirculation Function of Loading and Supply Temperature Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of recirculation_function_of_loading_and_supply_temperature_curve_name or None if not set
Return type:	str

supply_air_node_name¶

field Supply Air Node Name

Name of the supply air inlet node serving this ITE. Required if the
Air Node Connection Type = AdjustedSupply. Also required if reporting of
Supply Heat Index is desired.

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

watts_per_unit¶

field Watts per Unit

Units: W

IP-Units: W

Parameters:	value (float) – value for IDD Field Watts per Unit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_unit or None if not set
Return type:	float

watts_per_zone_floor_area¶

field Watts per Zone Floor Area

Units: W/m2

IP-Units: W/ft2

Parameters:	value (float) – value for IDD Field Watts per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_zone_floor_area or None if not set
Return type:	float

zone_name¶

field Zone Name

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.internal_gains.GasEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object GasEquipment Sets internal gains and contaminant rates for gas equipment in the zone. If you use a ZoneList in the Zone name field then this definition applies to all those zones.

carbon_dioxide_generation_rate¶

field Carbon Dioxide Generation Rate

CO2 generation rate per unit of power input
The default value assumes the equipment is fully vented.
For unvented equipment, a suggested value is 3.45E-8 m3/s-W. This value is
converted from a natural gas CO2 emission rate of 117 lbs CO2 per million Btu.
The maximum value assumes to be 10 times of the recommended value.
Units: m3/s-W
IP-Units: (ft3/min)/(Btu/h)
value <= 4e-07

Parameters:	value (float) – value for IDD Field Carbon Dioxide Generation Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of carbon_dioxide_generation_rate or None if not set
Return type:	float

design_level¶

field Design Level

Units: W

IP-Units: Btu/h

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

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of gas equipment
for this set of attributes
Choices: EquipmentLevel => Design Level – simply enter power input of equipment
Watts/Area or Power/Area => Power per Zone Floor Area – enter the number to apply.  Value * Floor Area = Equipment Level
Watts/Person or Power/Person => Power per Person – enter the number to apply.  Value * Occupants = Equipment Level
Default value: EquipmentLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

fraction_latent¶

field Fraction Latent

value <= 1.0

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

fraction_lost¶

field Fraction Lost

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction Lost
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_lost 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

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

power_per_person¶

field Power per Person

Units: W/Person

IP-Units: Btu/h-person

Parameters:	value (float) – value for IDD Field Power per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_person or None if not set
Return type:	float

power_per_zone_floor_area¶

field Power per Zone Floor Area

Units: W/m2

IP-Units: Btu/h-ft2

Parameters:	value (float) – value for IDD Field Power per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_zone_floor_area or None if not set
Return type:	float

schedule_name¶

field Schedule Name

units in Schedule should be fraction applied to design level of gas equipment, generally (0.0 - 1.0)

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.HotWaterEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object HotWaterEquipment Sets internal gains for hot water equipment in the zone. If you use a ZoneList in the Zone name field then this definition applies to all those zones.

design_level¶

field Design Level

Units: W

IP-Units: Btu/h

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

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of hot water equipment
for this set of attributes
Choices: EquipmentLevel => Design Level – simply enter power input of equipment
Watts/Area or Power/Area => Power per Zone Floor Area – enter the number to apply.  Value * Floor Area = Equipment Level
Watts/Person or Power/Person => Power per Person – enter the number to apply.  Value * Occupants = Equipment Level
Default value: EquipmentLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

fraction_latent¶

field Fraction Latent

value <= 1.0

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

fraction_lost¶

field Fraction Lost

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction Lost
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_lost 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

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

power_per_person¶

field Power per Person

Units: W/Person

IP-Units: Btu/h-person

Parameters:	value (float) – value for IDD Field Power per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_person or None if not set
Return type:	float

power_per_zone_floor_area¶

field Power per Zone Floor Area

Units: W/m2

IP-Units: Btu/h-ft2

Parameters:	value (float) – value for IDD Field Power per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_zone_floor_area or None if not set
Return type:	float

schedule_name¶

field Schedule Name

units in Schedule should be fraction applied to design level of hot water equipment, generally (0.0 - 1.0)

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.Lights¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Lights Sets internal gains for lights in the zone. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of lights
for this set of attributes
Choices: LightingLevel => Lighting Level – simply enter watts of lights
Watts/Area => Watts per Zone Floor Area – enter the number to apply.  Value * Floor Area = Lights
Watts/Person => Watts per Person – enter the number to apply.  Value * Occupants = Lights
Default value: LightingLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

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

fraction_replaceable¶

field Fraction Replaceable

For Daylighting:Controls and Daylighting:DElight:Controls,
must be 0 or 1:  0 = no dimming control, 1 = full dimming control
Default value: 1.0
value <= 1.0

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

fraction_visible¶

field Fraction Visible

value <= 1.0

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

lighting_level¶

field Lighting Level

Units: W

IP-Units: W

Parameters:	value (float) – value for IDD Field Lighting Level
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of lighting_level 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

return_air_fraction¶

field Return Air Fraction

Used only for sizing calculation if return-air-fraction
coefficients are specified.
value <= 1.0

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

return_air_fraction_calculated_from_plenum_temperature¶

field Return Air Fraction Calculated from Plenum Temperature

Default value: No

Parameters:	value (str) – value for IDD Field Return Air Fraction Calculated from Plenum Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of return_air_fraction_calculated_from_plenum_temperature or None if not set
Return type:	str

return_air_fraction_function_of_plenum_temperature_coefficient_1¶

field Return Air Fraction Function of Plenum Temperature Coefficient 1

Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes

Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC)

Parameters:	value (float) – value for IDD Field Return Air Fraction Function of Plenum Temperature Coefficient 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of return_air_fraction_function_of_plenum_temperature_coefficient_1 or None if not set
Return type:	float

return_air_fraction_function_of_plenum_temperature_coefficient_2¶

field Return Air Fraction Function of Plenum Temperature Coefficient 2

Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes
Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC)
Units: 1/K

Parameters:	value (float) – value for IDD Field Return Air Fraction Function of Plenum Temperature Coefficient 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of return_air_fraction_function_of_plenum_temperature_coefficient_2 or None if not set
Return type:	float

schedule_name¶

field Schedule Name

units in schedule should be fraction applied to design level of lights, generally (0.0 - 1.0)

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

watts_per_person¶

field Watts per Person

Units: W/person

IP-Units: W/person

Parameters:	value (float) – value for IDD Field Watts per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_person or None if not set
Return type:	float

watts_per_zone_floor_area¶

field Watts per Zone Floor Area

Units: W/m2

IP-Units: W/ft2

Parameters:	value (float) – value for IDD Field Watts per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of watts_per_zone_floor_area or None if not set
Return type:	float

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.OtherEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object OtherEquipment Sets internal gains or losses for “other” equipment in the zone.

design_level¶

field Design Level

Units: W

IP-Units: Btu/h

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

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of other equipment.
to set a loss, use a negative value in the following fields.
for this set of attributes
Choices: EquipmentLevel => Design Level – simply enter power input of equipment
Watts/Area or Power/Area => Power per Zone Floor Area – enter the number to apply.  Value * Floor Area = Equipment Level
Watts/Person or Power/Person => Power per Person – enter the number to apply.  Value * Occupants = Equipment Level
Default value: EquipmentLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

fraction_latent¶

field Fraction Latent

value <= 1.0

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

fraction_lost¶

field Fraction Lost

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction Lost
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_lost 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

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

power_per_person¶

field Power per Person

Units: W/Person

IP-Units: Btu/h-person

Parameters:	value (float) – value for IDD Field Power per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_person or None if not set
Return type:	float

power_per_zone_floor_area¶

field Power per Zone Floor Area

Units: W/m2

IP-Units: Btu/h-ft2

Parameters:	value (float) – value for IDD Field Power per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_zone_floor_area or None if not set
Return type:	float

schedule_name¶

field Schedule Name

units in Schedule should be fraction applied to design level of other equipment, generally (0.0 - 1.0)

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.People¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object People Sets internal gains and contaminant rates for occupants in the zone. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

activity_level_schedule_name¶

field Activity Level Schedule Name

Note that W has to be converted to mets in TC routine

units in schedule are W/person

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

air_velocity_schedule_name¶

field Air Velocity Schedule Name

units in the schedule are m/s

optional (only required for thermal comfort runs)

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

carbon_dioxide_generation_rate¶

field Carbon Dioxide Generation Rate

CO2 generation rate per unit of activity level.
The default value is obtained from ASHRAE Std 62.1 at 0.0084 cfm/met/person over
the general adult population.
Units: m3/s-W
Default value: 3.82e-08
value <= 3.82e-07

Parameters:	value (float) – value for IDD Field Carbon Dioxide Generation Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of carbon_dioxide_generation_rate or None if not set
Return type:	float

clothing_insulation_calculation_method¶

field Clothing Insulation Calculation Method

Default value: ClothingInsulationSchedule

Parameters:	value (str) – value for IDD Field Clothing Insulation Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of clothing_insulation_calculation_method or None if not set
Return type:	str

clothing_insulation_calculation_method_schedule_name¶

field Clothing Insulation Calculation Method Schedule Name

a schedule value of 1 for the Scheduled method, and 2 for the DynamicClothingModelASHRAE55 method

Parameters:	value (str) – value for IDD Field Clothing Insulation Calculation Method Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of clothing_insulation_calculation_method_schedule_name or None if not set
Return type:	str

clothing_insulation_schedule_name¶

field Clothing Insulation Schedule Name

use “Clo” from ASHRAE or Thermal Comfort guides

optional (only required for thermal comfort runs)

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

enable_ashrae_55_comfort_warnings¶

field Enable ASHRAE 55 Comfort Warnings

Default value: No

Parameters:	value (str) – value for IDD Field Enable ASHRAE 55 Comfort Warnings
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enable_ashrae_55_comfort_warnings or None if not set
Return type:	str

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

mean_radiant_temperature_calculation_type¶

field Mean Radiant Temperature Calculation Type

optional (only required for thermal comfort runs)

Default value: ZoneAveraged

Parameters:	value (str) – value for IDD Field Mean Radiant Temperature Calculation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of mean_radiant_temperature_calculation_type 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_people¶

field Number of People

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

number_of_people_calculation_method¶

field Number of People Calculation Method

The entered calculation method is used to create the maximum number of people
for this set of attributes (i.e. sensible fraction, schedule, etc)
Choices: People – simply enter number of occupants.
People per Zone Floor Area – enter the number to apply.  Value * Floor Area = Number of people
Zone Floor Area per Person – enter the number to apply.  Floor Area / Value = Number of people
Default value: People

Parameters:	value (str) – value for IDD Field Number of People Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_people_calculation_method or None if not set
Return type:	str

number_of_people_schedule_name¶

field Number of People Schedule Name

units in schedule should be fraction applied to number of people (0.0 - 1.0)

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

people_per_zone_floor_area¶

field People per Zone Floor Area

Units: person/m2

Parameters:	value (float) – value for IDD Field People per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of people_per_zone_floor_area or None if not set
Return type:	float

sensible_heat_fraction¶

field Sensible Heat Fraction

if input, overrides program calculated sensible/latent split
Default value: “autocalculate”
value <= 1.0

Parameters:	value (float or “Autocalculate”) – value for IDD Field Sensible Heat Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of sensible_heat_fraction or None if not set
Return type:	float or “Autocalculate”

surface_name_or_angle_factor_list_name¶

field Surface Name/Angle Factor List Name

optional (only required for thermal comfort runs)

Parameters:	value (str) – value for IDD Field Surface Name/Angle Factor List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of surface_name_or_angle_factor_list_name or None if not set
Return type:	str

thermal_comfort_model_1_type¶

field Thermal Comfort Model 1 Type

optional (only needed for people thermal comfort results reporting)

Parameters:	value (str) – value for IDD Field Thermal Comfort Model 1 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of thermal_comfort_model_1_type or None if not set
Return type:	str

thermal_comfort_model_2_type¶

field Thermal Comfort Model 2 Type

optional (second type of thermal comfort model and results reporting)

Parameters:	value (str) – value for IDD Field Thermal Comfort Model 2 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of thermal_comfort_model_2_type or None if not set
Return type:	str

thermal_comfort_model_3_type¶

field Thermal Comfort Model 3 Type

optional (third thermal comfort model and report type)

Parameters:	value (str) – value for IDD Field Thermal Comfort Model 3 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of thermal_comfort_model_3_type or None if not set
Return type:	str

thermal_comfort_model_4_type¶

field Thermal Comfort Model 4 Type

optional (fourth thermal comfort model and report type)

Parameters:	value (str) – value for IDD Field Thermal Comfort Model 4 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of thermal_comfort_model_4_type or None if not set
Return type:	str

thermal_comfort_model_5_type¶

field Thermal Comfort Model 5 Type

optional (fifth thermal comfort model and report type)

Parameters:	value (str) – value for IDD Field Thermal Comfort Model 5 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of thermal_comfort_model_5_type or None if not set
Return type:	str

work_efficiency_schedule_name¶

field Work Efficiency Schedule Name

units in schedule are 0.0 to 1.0

optional (only required for thermal comfort runs)

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

zone_floor_area_per_person¶

field Zone Floor Area per Person

Units: m2/person

Parameters:	value (float) – value for IDD Field Zone Floor Area per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zone_floor_area_per_person or None if not set
Return type:	float

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.SteamEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object SteamEquipment Sets internal gains for steam equipment in the zone.

design_level¶

field Design Level

Units: W

IP-Units: Btu/h

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

design_level_calculation_method¶

field Design Level Calculation Method

The entered calculation method is used to create the maximum amount of steam equipment
for this set of attributes
Choices: EquipmentLevel => Design Level – simply enter power input of equipment
Watts/Area or Power/Area => Power per Zone Floor Area – enter the number to apply.  Value * Floor Area = Equipment Level
Watts/Person or Power/Person => Power per Person – enter the number to apply.  Value * Occupants = Equipment Level
Default value: EquipmentLevel

Parameters:	value (str) – value for IDD Field Design Level Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_level_calculation_method or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

fraction_latent¶

field Fraction Latent

value <= 1.0

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

fraction_lost¶

field Fraction Lost

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction Lost
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_lost 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

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

power_per_person¶

field Power per Person

Units: W/Person

IP-Units: Btu/h-person

Parameters:	value (float) – value for IDD Field Power per Person
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_person or None if not set
Return type:	float

power_per_zone_floor_area¶

field Power per Zone Floor Area

Units: W/m2

IP-Units: Btu/h-ft2

Parameters:	value (float) – value for IDD Field Power per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of power_per_zone_floor_area or None if not set
Return type:	float

schedule_name¶

field Schedule Name

units in Schedule should be fraction applied to design level of steam equipment, generally (0.0 - 1.0)

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.internal_gains.SurfaceContaminantSourceAndSinkGenericBoundaryLayerDiffusion¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

henry_adsorption_constant_or_partition_coefficient¶

field Henry adsorption constant or partition coefficient

Units: dimensionless

Parameters:	value (float) – value for IDD Field Henry adsorption constant or partition coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of henry_adsorption_constant_or_partition_coefficient or None if not set
Return type:	float

mass_transfer_coefficient¶

field Mass Transfer Coefficient

Units: m/s

Parameters:	value (float) – value for IDD Field Mass Transfer Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of mass_transfer_coefficient 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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the
Initial Emission Rate. When the value is equal to 1.0, the time will be reset to
zero.

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

surface_name¶

field Surface Name

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

class pyidf.internal_gains.SurfaceContaminantSourceAndSinkGenericDepositionVelocitySink¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

deposition_velocity¶

field Deposition Velocity

Units: m/s

Parameters:	value (float) – value for IDD Field Deposition Velocity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of deposition_velocity 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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the
Initial Emission Rate. When the value is equal to 1.0, the time will be reset to
zero.

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

surface_name¶

field Surface Name

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

class pyidf.internal_gains.SurfaceContaminantSourceAndSinkGenericPressureDriven¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceContaminantSourceAndSink:Generic:PressureDriven Simulate generic contaminant source driven by the pressure difference across a surface.

design_generation_rate_coefficient¶

field Design Generation Rate Coefficient

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Generation Rate Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_generation_rate_coefficient or None if not set
Return type:	float

generation_exponent¶

field Generation Exponent

Units: dimensionless

value <= 1.0

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

generation_schedule_name¶

field Generation Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the

Design Generation Rate Coefficient

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

surface_name¶

field Surface Name

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

class pyidf.internal_gains.SwimmingPoolIndoor¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object SwimmingPool:Indoor

activity_factor_schedule_name¶

field Activity Factor Schedule Name

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

average_depth¶

field Average Depth

Units: m

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

cover_convection_factor¶

field Cover Convection Factor

value <= 1.0

Parameters:	value (float) – value for IDD Field Cover Convection Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cover_convection_factor or None if not set
Return type:	float

cover_evaporation_factor¶

field Cover Evaporation Factor

value <= 1.0

Parameters:	value (float) – value for IDD Field Cover Evaporation Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cover_evaporation_factor or None if not set
Return type:	float

cover_longwavelength_radiation_factor¶

field Cover Long-Wavelength Radiation Factor

value <= 1.0

Parameters:	value (float) – value for IDD Field Cover Long-Wavelength Radiation Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cover_longwavelength_radiation_factor or None if not set
Return type:	float

cover_schedule_name¶

field Cover Schedule Name

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

cover_shortwavelength_radiation_factor¶

field Cover Short-Wavelength Radiation Factor

value <= 1.0

Parameters:	value (float) – value for IDD Field Cover Short-Wavelength Radiation Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cover_shortwavelength_radiation_factor or None if not set
Return type:	float

makeup_water_supply_schedule_name¶

field Make-up Water Supply Schedule Name

Parameters:	value (str) – value for IDD Field Make-up Water Supply Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of makeup_water_supply_schedule_name or None if not set
Return type:	str

maximum_number_of_people¶

field Maximum Number of People

Parameters:	value (float) – value for IDD Field Maximum Number of People
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_number_of_people 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

people_heat_gain_schedule¶

field People Heat Gain Schedule

Parameters:	value (str) – value for IDD Field People Heat Gain Schedule
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of people_heat_gain_schedule or None if not set
Return type:	str

people_schedule¶

field People Schedule

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

pool_heating_system_maximum_water_flow_rate¶

field Pool Heating System Maximum Water Flow Rate

Units: m3/s

Parameters:	value (float) – value for IDD Field Pool Heating System Maximum Water Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pool_heating_system_maximum_water_flow_rate or None if not set
Return type:	float

pool_miscellaneous_equipment_power¶

field Pool Miscellaneous Equipment Power

Power input per pool water flow rate

Units: W/(m3/s)

Parameters:	value (float) – value for IDD Field Pool Miscellaneous Equipment Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pool_miscellaneous_equipment_power or None if not set
Return type:	float

pool_water_inlet_node¶

field Pool Water Inlet Node

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

pool_water_outlet_node¶

field Pool Water Outlet Node

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

setpoint_temperature_schedule¶

field Setpoint Temperature Schedule

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

surface_name¶

field Surface Name

To be matched with a construction in this input file

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

class pyidf.internal_gains.ZoneBaseboardOutdoorTemperatureControlled¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneBaseboard:OutdoorTemperatureControlled Specifies outside temperature-controlled electric baseboard heating.

capacity_at_high_temperature¶

field Capacity at High Temperature

Units: W

Parameters:	value (float) – value for IDD Field Capacity at High Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of capacity_at_high_temperature or None if not set
Return type:	float

capacity_at_low_temperature¶

field Capacity at Low Temperature

Units: W

Parameters:	value (float) – value for IDD Field Capacity at Low Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of capacity_at_low_temperature or None if not set
Return type:	float

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

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

high_temperature¶

field High Temperature

Units: C

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

low_temperature¶

field Low Temperature

Units: C

Parameters:	value (float) – value for IDD Field Low Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of low_temperature 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

schedule_name¶

field Schedule Name

units in Schedule should be fraction applied to capacity of the baseboard heat equipment, generally (0.0 - 1.0)

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

zone_name¶

field Zone Name

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.internal_gains.ZoneContaminantSourceAndSinkCarbonDioxide¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneContaminantSourceAndSink:CarbonDioxide Represents internal CO2 gains and sinks in the zone.

design_generation_rate¶

field Design Generation Rate

Positive values represent sources and negative values represent sinks.

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Generation Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_generation_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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate

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

zone_name¶

field Zone Name

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.internal_gains.ZoneContaminantSourceAndSinkGenericConstant¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneContaminantSourceAndSink:Generic:Constant Sets internal generic contaminant gains and sinks in a zone with constant values.

design_generation_rate¶

field Design Generation Rate

The values represent source.

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Generation Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_generation_rate or None if not set
Return type:	float

design_removal_coefficient¶

field Design Removal Coefficient

The value represent sink.

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Removal Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_removal_coefficient or None if not set
Return type:	float

generation_schedule_name¶

field Generation Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate

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

removal_schedule_name¶

field Removal Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the

Design removal Coefficient

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

zone_name¶

field Zone Name

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.internal_gains.ZoneContaminantSourceAndSinkGenericCutoffModel¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneContaminantSourceAndSink:Generic:CutoffModel Simulate generic contaminant source driven by the cutoff concentration model.

cutoff_generic_contaminant_at_which_emission_ceases¶

field Cutoff Generic Contaminant at which Emission Ceases

When the zone concentration level is greater than the cutoff level, emission stops,
and the source level is zero.
Units: ppm

Parameters:	value (float) – value for IDD Field Cutoff Generic Contaminant at which Emission Ceases
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cutoff_generic_contaminant_at_which_emission_ceases or None if not set
Return type:	float

design_generation_rate_coefficient¶

field Design Generation Rate Coefficient

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Generation Rate Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_generation_rate_coefficient 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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the

Design Generation Rate Coefficient

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

zone_name¶

field Zone Name

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.internal_gains.ZoneContaminantSourceAndSinkGenericDecaySource¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneContaminantSourceAndSink:Generic:DecaySource Simulate generic contaminant source driven by the cutoff concentration model.

delay_time_constant¶

field Delay Time Constant

Units: s

Parameters:	value (float) – value for IDD Field Delay Time Constant
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of delay_time_constant or None if not set
Return type:	float

initial_emission_rate¶

field Initial Emission Rate

Units: m3/s

Parameters:	value (float) – value for IDD Field Initial Emission Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_emission_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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the
Initial Emission Rate. When the value is equal to 1.0, the time will be reset to
zero.

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

zone_name¶

field Zone Name

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.internal_gains.ZoneContaminantSourceAndSinkGenericDepositionRateSink¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneContaminantSourceAndSink:Generic:DepositionRateSink Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

deposition_rate¶

field Deposition Rate

Units: m/s

Parameters:	value (float) – value for IDD Field Deposition Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of deposition_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

schedule_name¶

field Schedule Name

Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the
Initial Emission Rate. When the value is equal to 1.0, the time will be reset to
zero.

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

zone_name¶

field Zone Name

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

pyidf.internal_gains module¶

Related Topics

This Page