pyidf.room_air_models module¶

Data objects in group “Room Air Models”

class pyidf.room_air_models.RoomAirModelType¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirModelType Selects the type of room air model to be used in a given zone. If no RoomAirModelType object is specified then the default Mixing model (all zone air at the same temperature) will be used.

air_temperature_coupling_strategy¶

field Air Temperature Coupling Strategy

Default value: Direct

Parameters:	value (str) – value for IDD Field Air Temperature Coupling Strategy
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_temperature_coupling_strategy 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

roomair_modeling_type¶

field Room-Air Modeling Type

Complete mixing air model
UserDefined Room Air Temperature Patterns
needs RoomAir:TemperaturePattern:UserDefined object referencing this Zone
Mundt roomair model for displacement ventilation with single floor air node
needs RoomAirSettings:OneNodeDisplacementVentilation object referencing this Zone
(ThreeNodeDisplacementVentilation = RoomAir modeling using UCSD three-node displacement ventilation model)
needs RoomAirSettings:ThreeNodeDisplacementVentilation object referencing this Zone
(CrossVentilation = RoomAir modeling using UCSD two-zone cross ventilation model)
needs RoomAirSettings:CrossVentilation object referencing this Zone
2-Node UFAD model for interior zones
needs RoomAirSettings:UnderFloorAirDistributionInterior object referencing this Zone
(UnderFloorAirDistributionExterior = RoomAir modeling using 2-Node UFAD model for exterior zones)
needs RoomAirSettings:UnderFloorAirDistributionExterior object referencing this Zone
(AirflowNetwork = RoomAir modeling using AirflowNetwork)
needs RoomAirSettings:AirflowNetwork object referencing this Zone
Default value: Mixing

Parameters:	value (str) – value for IDD Field Room-Air Modeling Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of roomair_modeling_type 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.room_air_models.RoomAirNode¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:Node Define an air node for some types of nodal room air models

height_of_nodal_control_volume_center¶

field Height of Nodal Control Volume Center

Units: m

Parameters:	value (float) – value for IDD Field Height of Nodal Control Volume Center
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of height_of_nodal_control_volume_center 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

node_type¶

field Node Type

Parameters:	value (str) – value for IDD Field Node Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of node_type 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_21_name¶

field Surface 21 Name

Parameters:	value (str) – value for IDD Field Surface 21 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of surface_21_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.room_air_models.RoomAirNodeAirflowNetwork¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:Node:AirflowNetwork define an air node for some types of nodal air models

fraction_of_zone_air_volume¶

field Fraction of Zone Air Volume

value <= 1.0

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

roomairnodeairflownetworkadjacentsurfacelist_name¶

field RoomAir:Node:AirflowNetwork:AdjacentSurfaceList Name

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

roomairnodeairflownetworkhvacequipment_name¶

field RoomAir:Node:AirflowNetwork:HVACEquipment Name

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

roomairnodeairflownetworkinternalgains_name¶

field RoomAir:Node:AirflowNetwork:InternalGains Name

Parameters:	value (str) – value for IDD Field RoomAir:Node:AirflowNetwork:InternalGains Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of roomairnodeairflownetworkinternalgains_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.room_air_models.RoomAirNodeAirflowNetworkAdjacentSurfaceList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:Node:AirflowNetwork:AdjacentSurfaceList

add_extensible(surface_1_name=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

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.room_air_models.RoomAirNodeAirflowNetworkHvacequipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:Node:AirflowNetwork:HVACEquipment define the zone equipment associated with one particular RoomAir:Node

add_extensible(zonehvac_or_air_terminal_equipment_object_type_1=None, zonehvac_or_air_terminal_equipment_object_name_1=None, fraction_of_output_or_supply_air_from_hvac_equipment_1=None, fraction_of_input_or_return_air_to_hvac_equipment_1=None)¶

Add values for extensible fields

Parameters:

zonehvac_or_air_terminal_equipment_object_type_1 (str) – value for IDD Field ZoneHVAC or Air Terminal Equipment Object Type 1 if value is None it will not be checked against the specification and is assumed to be a missing value
zonehvac_or_air_terminal_equipment_object_name_1 (str) – value for IDD Field ZoneHVAC or Air Terminal Equipment Object Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value
fraction_of_output_or_supply_air_from_hvac_equipment_1 (float) – value for IDD Field Fraction of Output or Supply Air from HVAC Equipment 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value
fraction_of_input_or_return_air_to_hvac_equipment_1 (float) – value for IDD Field Fraction of Input or Return Air to HVAC Equipment 1 value <= 1.0 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.room_air_models.RoomAirNodeAirflowNetworkInternalGains¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:Node:AirflowNetwork:InternalGains define the internal gains that are associated with one particular RoomAir:Node

add_extensible(internal_gain_object_1_type=None, internal_gain_object_1_name=None, fraction_of_gains_to_node_1=None, internal_gain_object_2_type=None)¶

Add values for extensible fields

Parameters:

internal_gain_object_1_type (str) – value for IDD Field Internal Gain Object 1 Type if value is None it will not be checked against the specification and is assumed to be a missing value
internal_gain_object_1_name (str) – value for IDD Field Internal Gain Object 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
fraction_of_gains_to_node_1 (float) – value for IDD Field Fraction of Gains to Node 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value
internal_gain_object_2_type (str) – value for IDD Field Internal Gain Object 2 Type 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.room_air_models.RoomAirSettingsAirflowNetwork¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:AirflowNetwork RoomAir modeling using Airflow pressure network solver

add_extensible(roomairflownetworknode_name_1=None)¶

Add values for extensible fields

Parameters:	roomairflownetworknode_name_1 (str) – value for IDD Field RoomAirflowNetwork:Node Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

control_point_roomairflownetworknode_name¶

field Control Point RoomAirflowNetwork:Node Name

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

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

zone_name¶

field Zone Name

Name of Zone being described. Any existing 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.room_air_models.RoomAirSettingsCrossVentilation¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:CrossVentilation This UCSD Cross Ventilation Room Air Model provides a simple model for heat transfer and vertical temperature profile prediction in cross ventilated rooms. The model distinguishes two regions in the room, the main jet region and the recirculations, and predicts characteristic airflow velocities and average air temperatures. Used with RoomAirModelType = CrossVentilation.

airflow_region_used_for_thermal_comfort_evaluation¶

field Airflow Region Used for Thermal Comfort Evaluation

Required field whenever thermal comfort is predicted
defines Air temperature and Airflow velocity that will be used in the Fanger model
conditions must refer to one of the two regions: jet or recirculation

Parameters:	value (str) – value for IDD Field Airflow Region Used for Thermal Comfort Evaluation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of airflow_region_used_for_thermal_comfort_evaluation or None if not set
Return type:	str

gain_distribution_schedule_name¶

field Gain Distribution Schedule Name

Distribution of the convective heat gains between the jet and recirculation zones.
0<= Accepted Value <= 1.
In the CV model 1 means all convective gains in the jet region.

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

zone_name¶

field Zone Name

Name of Zone being described. Any existing 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.room_air_models.RoomAirSettingsOneNodeDisplacementVentilation¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:OneNodeDisplacementVentilation The Mundt model for displacement ventilation

fraction_of_convective_internal_loads_added_to_floor_air¶

field Fraction of Convective Internal Loads Added to Floor Air

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction of Convective Internal Loads Added to Floor Air
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_of_convective_internal_loads_added_to_floor_air or None if not set
Return type:	float

fraction_of_infiltration_internal_loads_added_to_floor_air¶

field Fraction of Infiltration Internal Loads Added to Floor Air

value <= 1.0

Parameters:	value (float) – value for IDD Field Fraction of Infiltration Internal Loads Added to Floor Air
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_of_infiltration_internal_loads_added_to_floor_air 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.room_air_models.RoomAirSettingsThreeNodeDisplacementVentilation¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:ThreeNodeDisplacementVentilation The UCSD model for Displacement Ventilation

comfort_height¶

field Comfort Height

Height at which air temperature is calculated for comfort purposes
Units: m
Default value: 1.1

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

gain_distribution_schedule_name¶

field Gain Distribution Schedule Name

Distribution of the convective heat gains between the occupied and mixed zones.
0<= Accepted Value <= 1.
In the DV model 1 means all convective gains in the lower layer.

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

number_of_plumes_per_occupant¶

field Number of Plumes per Occupant

Used only in the UCSD displacement ventilation model.
Effective number of separate plumes per occupant in the occupied zone.
Plumes that merge together in the occupied zone count as one.
Default value: 1.0

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

temperature_difference_threshold_for_reporting¶

field Temperature Difference Threshold for Reporting

Minimum temperature difference between predicted upper and lower layer
temperatures above which DV auxiliary outputs are calculated.
These outputs are ‘DV Transition Height’, ‘DV Fraction Min Recommended Flow Rate’
‘DV Average Temp Gradient’ and ‘DV Maximum Temp Gradient’.  They
are set to negative values when the temperature difference is less than the
threshold and the output ‘DV Zone Is Mixed’ is set to 1
Units: deltaC
Default value: 0.4

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

thermostat_height¶

field Thermostat Height

Height of thermostat/temperature control sensor above floor
Units: m
Default value: 1.1

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

zone_name¶

field Zone Name

Name of Zone being described. Any existing 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.room_air_models.RoomAirSettingsUnderFloorAirDistributionExterior¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:UnderFloorAirDistributionExterior Applicable to exterior spaces that are served by an underfloor air distribution system. The dominant sources of heat gain should be from people, equipment, and other localized sources located in the occupied part of the room, as well as convective gain coming from a warm window. Used with RoomAirModelType = CrossVentilation.

coefficient_a_in_formula_kc_agammab_c_dgamma_egamma2¶

field Coefficient A in formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2

Kc is the fraction of the total zone load attributable to the lower subzone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Coefficient A in formula Kc = AGammaB + C + DGamma + EGamma*2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of coefficient_a_in_formula_kc_agammab_c_dgamma_egamma2 or None if not set
Return type:	float or “Autocalculate”

coefficient_b_in_formula_kc_agammab_c_dgamma_egamma2¶

field Coefficient B in formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2

Kc is the fraction of the total zone load attributable to the lower subzone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Coefficient B in formula Kc = AGammaB + C + DGamma + EGamma*2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of coefficient_b_in_formula_kc_agammab_c_dgamma_egamma2 or None if not set
Return type:	float or “Autocalculate”

coefficient_c_in_formula_kc_agammab_c_dgamma_egamma2¶

field Coefficient C in formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2

Kc is the fraction of the total zone load attributable to the lower subzone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Coefficient C in formula Kc = AGammaB + C + DGamma + EGamma*2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of coefficient_c_in_formula_kc_agammab_c_dgamma_egamma2 or None if not set
Return type:	float or “Autocalculate”

coefficient_d_in_formula_kc_agammab_c_dgamma_egamma2¶

field Coefficient D in formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2

Kc is the fraction of the total zone load attributable to the lower subzone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Coefficient D in formula Kc = AGammaB + C + DGamma + EGamma*2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of coefficient_d_in_formula_kc_agammab_c_dgamma_egamma2 or None if not set
Return type:	float or “Autocalculate”

coefficient_e_in_formula_kc_agammab_c_dgamma_egamma2¶

field Coefficient E in formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2

Kc is the fraction of the total zone load attributable to the lower subzone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Coefficient E in formula Kc = AGammaB + C + DGamma + EGamma*2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of coefficient_e_in_formula_kc_agammab_c_dgamma_egamma2 or None if not set
Return type:	float or “Autocalculate”

comfort_height¶

field Comfort Height

Height at which Air temperature is calculated for comfort purposes
Units: m
Default value: 1.1

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

design_effective_area_of_diffuser¶

field Design Effective Area of Diffuser

Units: m2

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Design Effective Area of Diffuser
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_effective_area_of_diffuser or None if not set
Return type:	float or “Autocalculate”

diffuser_slot_angle_from_vertical¶

field Diffuser Slot Angle from Vertical

Units: deg
Default value: “autocalculate”
value <= 90.0

Parameters:	value (float or “Autocalculate”) – value for IDD Field Diffuser Slot Angle from Vertical
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of diffuser_slot_angle_from_vertical or None if not set
Return type:	float or “Autocalculate”

floor_diffuser_type¶

field Floor Diffuser Type

Default value: Swirl

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

number_of_diffusers_per_zone¶

field Number of Diffusers per Zone

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Number of Diffusers per Zone
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_diffusers_per_zone or None if not set
Return type:	float or “Autocalculate”

power_per_plume¶

field Power per Plume

Units: W

Default value: “autocalculate”

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

temperature_difference_threshold_for_reporting¶

field Temperature Difference Threshold for Reporting

Minimum temperature difference between upper and lower layer
temperatures above which UFAD auxiliary outputs are calculated.
These outputs are ‘UF Transition Height’ and ‘UF Average Temp Gradient’.  They
are set to zero values when the temperature difference is less than the
threshold and the output ‘UF Zone Is Mixed’ is set to 1
Units: deltaC
Default value: 0.4

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

thermostat_height¶

field Thermostat Height

Height of thermostat/temperature control sensor above floor
Units: m
Default value: 1.2

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

transition_height¶

field Transition Height

User-specified height above floor of boundary between occupied and upper subzones
Units: m
Default value: 1.7

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

zone_name¶

field Zone Name

Name of Zone being described. Any existing 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.room_air_models.RoomAirSettingsUnderFloorAirDistributionInterior¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAirSettings:UnderFloorAirDistributionInterior This Room Air Model is applicable to interior spaces that are served by an underfloor air distribution system. The dominant sources of heat gain should be from people, equipment, and other localized sources located in the occupied part of the room. The model should be used with caution in zones which have large heat gains or losses through exterior walls or windows or which have considerable direct solar gain. Used with RoomAirModelType = UnderFloorAirDistributionInterior.

coefficient_a¶

field Coefficient A

Coefficient A in Formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2
Kc is the fraction of the total zone load attributable to the lower subzone
Default value: “Autocalculate”

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

coefficient_b¶

field Coefficient B

Coefficient B in Formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2
Kc is the fraction of the total zone load attributable to the lower subzone
Default value: “Autocalculate”

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

coefficient_c¶

field Coefficient C

Coefficient C in Formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2
Kc is the fraction of the total zone load attributable to the lower subzone
Default value: “Autocalculate”

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

coefficient_d¶

field Coefficient D

Coefficient D in Formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2
Kc is the fraction of the total zone load attributable to the lower subzone
Default value: “Autocalculate”

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

coefficient_e¶

field Coefficient E

Coefficient E in Formula Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2
Kc is the fraction of the total zone load attributable to the lower subzone
Default value: “Autocalculate”

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

comfort_height¶

field Comfort Height

Height at which air temperature is calculated for comfort purposes
Units: m
Default value: 1.1

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

design_effective_area_of_diffuser¶

field Design Effective Area of Diffuser

Units: m2

Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Design Effective Area of Diffuser
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_effective_area_of_diffuser or None if not set
Return type:	float or “Autocalculate”

diffuser_slot_angle_from_vertical¶

field Diffuser Slot Angle from Vertical

Units: deg
Default value: “Autocalculate”
value <= 90.0

Parameters:	value (float or “Autocalculate”) – value for IDD Field Diffuser Slot Angle from Vertical
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of diffuser_slot_angle_from_vertical or None if not set
Return type:	float or “Autocalculate”

floor_diffuser_type¶

field Floor Diffuser Type

Default value: Swirl

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

number_of_diffusers¶

field Number of Diffusers

Total number of diffusers in this zone

Default value: “autocalculate”

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

power_per_plume¶

field Power per Plume

Units: W

Default value: “autocalculate”

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

temperature_difference_threshold_for_reporting¶

field Temperature Difference Threshold for Reporting

Minimum temperature difference between predicted upper and lower layer
temperatures above which UFAD auxiliary outputs are calculated.
These outputs are ‘UF Transition Height’ and ‘UF Average Temp Gradient’.  They
are set to zero values when the temperature difference is less than the
threshold and the output ‘UF Zone Is Mixed’ is set to 1
Units: deltaC
Default value: 0.4

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

thermostat_height¶

field Thermostat Height

Height of thermostat/temperature control sensor above floor
Units: m
Default value: 1.2

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

transition_height¶

field Transition Height

user-specified height above floor of boundary between occupied and upper subzones
Units: m
Default value: 1.7

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

zone_name¶

field Zone Name

Name of Zone with underfloor air distribution

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.room_air_models.RoomAirTemperaturePatternConstantGradient¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:TemperaturePattern:ConstantGradient Used to model room air with a fixed temperature gradient in the vertical direction. Used in combination with RoomAir:TemperaturePattern:UserDefined.

control_integer_for_pattern_control_schedule_name¶

field Control Integer for Pattern Control Schedule Name

reference this entry in Schedule Name

Parameters:	value (int) – value for IDD Field Control Integer for Pattern Control Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_integer_for_pattern_control_schedule_name or None if not set
Return type:	int

exhaust_air_offset¶

field Exhaust Air Offset

= (Texhaust - Mean Air Temp) deg C

Units: deltaC

Parameters:	value (float) – value for IDD Field Exhaust Air Offset
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of exhaust_air_offset 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_offset¶

field Return Air Offset

= (Tleaving - Mean Air Temp )

Units: deltaC

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

temperature_gradient¶

field Temperature Gradient

Slope of temperature change in vertical direction

Units: K/m

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

thermostat_offset¶

field Thermostat Offset

= (Temp at thermostat- Mean Air Temp)

Units: deltaC

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

class pyidf.room_air_models.RoomAirTemperaturePatternNondimensionalHeight¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:TemperaturePattern:NondimensionalHeight Defines a distribution pattern for air temperatures relative to the current mean air temperature as a function of height. The height, referred to as Zeta, is nondimensional by normalizing with the zone ceiling height. Used in combination with RoomAir:TemperaturePattern:UserDefined.

add_extensible(pair_1_zeta_nondimensional_height=None, pair_1_delta_adjacent_air_temperature=None)¶

Add values for extensible fields

Parameters:

pair_1_zeta_nondimensional_height (float) – value for IDD Field Pair 1 Zeta Nondimensional Height if value is None it will not be checked against the specification and is assumed to be a missing value
pair_1_delta_adjacent_air_temperature (float) – value for IDD Field Pair 1 Delta Adjacent Air Temperature Units: deltaC value >= -10.0 value <= 20.0 if value is None it will not be checked against the specification and is assumed to be a missing value

control_integer_for_pattern_control_schedule_name¶

field Control Integer for Pattern Control Schedule Name

this value should appear in as a schedule value

Parameters:	value (int) – value for IDD Field Control Integer for Pattern Control Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_integer_for_pattern_control_schedule_name or None if not set
Return type:	int

exhaust_air_offset¶

field Exhaust Air Offset

= (Temp exhaust - Mean Air Temp) deg C
the remaining fields have pairs that describe the relative
temperature pattern in the vertical direction of a zone
Zeta is the nondimensional height (in z-direction). on [0..1]
DeltaTai =  (Tai - MAT) in units of deg. C
relative deg C on [-10.0 .. 20.0 ]
Units: deltaC

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

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

return_air_offset¶

field Return Air Offset

= (Temp leaving - Mean Air Temp ) deg C

Units: deltaC

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

thermostat_offset¶

field Thermostat Offset

= (Temp at thermostat- Mean Air Temp)

Units: deltaC

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

class pyidf.room_air_models.RoomAirTemperaturePatternSurfaceMapping¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:TemperaturePattern:SurfaceMapping Defines a distribution pattern for the air temperatures adjacent to individual surfaces. This allows controlling the adjacent air temperature on a surface-by-surface basis rather than by height. This allows modeling different adjacent air temperatures on the opposite sides of the zone. Used in combination with RoomAir:TemperaturePattern:UserDefined.

add_extensible(surface_name_pair_1=None, delta_adjacent_air_temperature_pair_1=None)¶

Add values for extensible fields

Parameters:

surface_name_pair_1 (str) – value for IDD Field Surface Name Pair 1 if value is None it will not be checked against the specification and is assumed to be a missing value
delta_adjacent_air_temperature_pair_1 (float) – value for IDD Field Delta Adjacent Air Temperature Pair 1 Units: deltaC if value is None it will not be checked against the specification and is assumed to be a missing value

control_integer_for_pattern_control_schedule_name¶

field Control Integer for Pattern Control Schedule Name

reference this entry in schedule

Parameters:	value (int) – value for IDD Field Control Integer for Pattern Control Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_integer_for_pattern_control_schedule_name or None if not set
Return type:	int

exhaust_air_offset¶

field Exhaust Air Offset

= (Texhaust - Mean Air Temp) deg C

Units: deltaC

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

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

return_air_offset¶

field Return Air Offset

= (Tleaving - Mean Air Temp ) deg C

Units: deltaC

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

thermostat_offset¶

field Thermostat Offset

= (Temp at thermostat- Mean Air Temp)

Units: deltaC

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

class pyidf.room_air_models.RoomAirTemperaturePatternTwoGradient¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:TemperaturePattern:TwoGradient Used to model room air with two temperature gradients in the vertical direction. Used in combination with RoomAir:TemperaturePattern:UserDefined.

control_integer_for_pattern_control_schedule_name¶

field Control Integer for Pattern Control Schedule Name

reference this entry in Schedule Name

Parameters:	value (int) – value for IDD Field Control Integer for Pattern Control Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_integer_for_pattern_control_schedule_name or None if not set
Return type:	int

exhaust_air_height¶

field Exhaust Air Height

= Distance from floor of zone

Units: m

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

gradient_interpolation_mode¶

field Gradient Interpolation Mode

Parameters:	value (str) – value for IDD Field Gradient Interpolation Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of gradient_interpolation_mode or None if not set
Return type:	str

lower_heat_rate_bound¶

field Lower Heat Rate Bound

Units: W

Parameters:	value (float) – value for IDD Field Lower Heat Rate Bound
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of lower_heat_rate_bound or None if not set
Return type:	float

lower_temperature_bound¶

field Lower Temperature Bound

Units: C

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

field Return Air Height

= Distance from floor of zone

Units: m

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

temperature_gradient_lower_bound¶

field Temperature Gradient Lower Bound

Slope of temperature change in vertical direction

Units: K/m

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

temperature_gradient_upper_bound¶

field Temperature Gradient Upper Bound

Slope of temperature change in vertical direction

Units: K/m

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

thermostat_height¶

field Thermostat Height

= Distance from floor of zone

Units: m

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

upper_heat_rate_bound¶

field Upper Heat Rate Bound

Units: W

Parameters:	value (float) – value for IDD Field Upper Heat Rate Bound
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of upper_heat_rate_bound or None if not set
Return type:	float

upper_temperature_bound¶

field Upper Temperature Bound

Units: C

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

class pyidf.room_air_models.RoomAirTemperaturePatternUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoomAir:TemperaturePattern:UserDefined Used to explicitly define temperature patterns that are to be applied to the mean air temperature within a thermal zone. Used with RoomAirModelType = UserDefined.

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this model. Schedule value > 0 means the model is
active. Schedule value = 0 means the model is inactive and the zone will be modeled
as fully mixed (Mixing). If this field is blank, the model is always active.

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

name¶

field Name

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

pattern_control_schedule_name¶

field Pattern Control Schedule Name

The schedule should contain integer values that
correspond to unique Control Integer fields in
one of the RoomAir:TemperaturePattern:* objects.

Parameters:	value (str) – value for IDD Field Pattern Control Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pattern_control_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.room_air_models module¶

Related Topics

This Page