pyidf.system_availability_managers module

Data objects in group “System Availability Managers”

class pyidf.system_availability_managers.AvailabilityManagerAssignmentList

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManagerAssignmentList Defines the applicable managers used for an AirLoopHVAC or PlantLoop. The priority of availability managers is based on a set of rules and are specific to the type of loop. The output from each availability manager is an availability status flag: NoAction, ForceOff, CycleOn, or CycleOnZoneFansOnly (used only for air loops).

add_extensible(availability_manager_1_object_type=None, availability_manager_1_name=None)

Add values for extensible fields

Parameters:

• availability_manager_1_object_type (str) – value for IDD Field Availability Manager 1 Object Type if value is None it will not be checked against the specification and is assumed to be a missing value
• availability_manager_1_name (str) – value for IDD Field Availability Manager 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.system_availability_managers.AvailabilityManagerDifferentialThermostat

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:DifferentialThermostat Overrides fan/pump schedules depending on temperature difference between two nodes.

cold_node_name

field Cold Node Name

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

hot_node_name

field Hot Node Name

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

name

field Name

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

temperature_difference_off_limit

field Temperature Difference Off Limit

Defaults to Temperature Difference On Limit.

Units: deltaC

Parameters:value (float) – value for IDD Field Temperature Difference Off Limit Raises:ValueError – if value is not a valid value Returns:the value of temperature_difference_off_limit or None if not set Return type:float

temperature_difference_on_limit

field Temperature Difference On Limit

Units: deltaC

Parameters:value (float) – value for IDD Field Temperature Difference On Limit Raises:ValueError – if value is not a valid value Returns:the value of temperature_difference_on_limit or None if not set Return type:float

class pyidf.system_availability_managers.AvailabilityManagerHighTemperatureTurnOff

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:HighTemperatureTurnOff Overrides fan/pump schedules depending on temperature at sensor node.

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

sensor_node_name

field Sensor Node Name

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

temperature

field Temperature

Units: C

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

class pyidf.system_availability_managers.AvailabilityManagerHighTemperatureTurnOn

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:HighTemperatureTurnOn Overrides fan/pump schedules depending on temperature at sensor node.

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

sensor_node_name

field Sensor Node Name

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

temperature

field Temperature

Units: C

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

class pyidf.system_availability_managers.AvailabilityManagerHybridVentilation

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:HybridVentilation Depending on zone and outdoor conditions overrides window/door opening controls to maximize natural ventilation and turn off an HVAC system when ventilation control conditions are met. This object (zone ventilation object name) has not been instrumented to work with global Zone or Zone List names option for Ventilation:DesignFlowRate. In order to use, you must enter the single <Ventilation:DesignFlowRate> name in that field. If it is a part of a global ventilation assignment the name will be <Zone Name> <global Ventilation:DesignFlowRate> name. Currently, hybrid ventilation manager is restricted to one per zone. It can either be applied through the air loop or directly to the zone. If hybrid ventilation manager is applied to an air loop and one of the zones served by that air loop also has hybrid ventilation manager, then zone hybrid ventilation manager is disabled.

airflownetwork_control_type_schedule_name

field AirflowNetwork Control Type Schedule Name

The schedule is used to incorporate operation of AirflowNetwork large opening

objects and HVAC system operation.

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

controlled_zone_name

field Controlled Zone Name

the controlled zone name should be a zone where a thermostat or humidistat is located

served by an air primary loop.

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

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC or HVACTemplate:System:* object.

If this field is left blank, hybrid ventilation managers will be

simulated for zone equipment control

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

maximum_outdoor_dewpoint

field Maximum Outdoor Dewpoint

this is the outdoor dewpoint above which ventilation is shutoff

Applicable only if Ventilation Control Mode = 3

Units: C

Default value: 100.0

value >= -100.0

value <= 100.0

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

maximum_outdoor_enthalpy

field Maximum Outdoor Enthalpy

this is the outdoor Enthalpy above which ventilation is shutoff

Units: J/kg

value < 300000.0

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

maximum_outdoor_temperature

field Maximum Outdoor Temperature

this is the outdoor temperature above which ventilation is shutoff

Units: C

Default value: 100.0

value >= -100.0

value <= 100.0

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

maximum_wind_speed

field Maximum Wind Speed

this is the wind speed above which ventilation is shutoff

Units: m/s

Default value: 40.0

value <= 40.0

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

minimum_outdoor_dewpoint

field Minimum Outdoor Dewpoint

this is the outdoor temperature below which ventilation is shutoff

Applicable only if Ventilation Control Mode = 3

Units: C

Default value: -100.0

value >= -100.0

value <= 100.0

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

minimum_outdoor_enthalpy

field Minimum Outdoor Enthalpy

this is the outdoor Enthalpy below which ventilation is shutoff

Units: J/kg

value < 300000.0

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

minimum_outdoor_temperature

field Minimum Outdoor Temperature

this is the outdoor temperature below which ventilation is shutoff

Units: C

Default value: -100.0

value >= -100.0

value <= 100.0

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

minimum_outdoor_ventilation_air_schedule_name

field Minimum Outdoor Ventilation Air Schedule Name

Used only if Ventilation Control Mode = 4

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

name

field Name

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

opening_factor_function_of_wind_speed_curve_name

field Opening Factor Function of Wind Speed Curve Name

linear curve = a + b*WS

quadratic curve = a + b*WS + c*WS**2

WS = wind speed (m/s)

Parameters:value (str) – value for IDD Field Opening Factor Function of Wind Speed Curve Name Raises:ValueError – if value is not a valid value Returns:the value of opening_factor_function_of_wind_speed_curve_name or None if not set Return type:str

simple_airflow_control_type_schedule_name

field Simple Airflow Control Type Schedule Name

The schedule is used to incorporate operation of simple airflow objects and HVAC

system operation.

The simple airflow objects are Ventilation and Mixing only

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

use_weather_file_rain_indicators

field Use Weather File Rain Indicators

If Yes, ventilation is shutoff when there is rain

If No, there is no rain control

Default value: Yes

Parameters:value (str) – value for IDD Field Use Weather File Rain Indicators Raises:ValueError – if value is not a valid value Returns:the value of use_weather_file_rain_indicators or None if not set Return type:str

ventilation_control_mode_schedule_name

field Ventilation Control Mode Schedule Name

The Ventilation control mode contains appropriate integer control types.

0 - uncontrolled (Natural ventilation and HVAC system are controlled by themselves)

1 = Temperature control

2 = Enthalpy control

3 = Dewpoint control

4 = Outdoor ventilation air control

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

zoneventilation_object_name

field ZoneVentilation Object Name

This field has not been instrumented to work with

global Zone or Zone List names option for Ventilation:DesignFlowRate. In order to

use, you must enter the single <Ventilation:DesignFlowRate> name in this field.

If it is a part of a global ventilation assignment the name will be

<Zone Name> <global Ventilation:DesignFlowRate> name.

The other ZoneVentilation:* and ZoneMixing objects controlled in the same AirLoopHVAC

will work in the same way as this ventilation object.

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

class pyidf.system_availability_managers.AvailabilityManagerLowTemperatureTurnOff

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:LowTemperatureTurnOff Overrides fan/pump schedules depending on temperature at sensor node.

applicability_schedule_name

field Applicability Schedule Name

If blank, defaults to always active

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

sensor_node_name

field Sensor Node Name

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

temperature

field Temperature

Units: C

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

class pyidf.system_availability_managers.AvailabilityManagerLowTemperatureTurnOn

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:LowTemperatureTurnOn Overrides fan/pump schedules depending on temperature at sensor node.

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

sensor_node_name

field Sensor Node Name

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

temperature

field Temperature

Units: C

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

class pyidf.system_availability_managers.AvailabilityManagerNightCycle

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:NightCycle Determines the availability of a loop or system: whether it is on or off. Depending on zone temperatures, overrides Schedules and forces system Fans on.

applicability_schedule_name

field Applicability Schedule Name

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

control_type

field Control Type

When AvailabilityManager:NightCycle is used in the zone component availability

manager assignment list, the key choices for Control Type would only be

StayOff and CycleOnControlZone

Default value: StayOff

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

control_zone_name

field Control Zone Name

When AvailabilityManager:NightCycle is used in the zone component availability

manager assignment list, the Control Zone Name should be the name of the zone in which the

zone component is.

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

cycling_run_time

field Cycling Run Time

Units: s

Default value: 3600.0

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

fan_schedule_name

field Fan Schedule Name

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

thermostat_tolerance

field Thermostat Tolerance

Units: deltaC

Default value: 1.0

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

class pyidf.system_availability_managers.AvailabilityManagerNightVentilation

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:NightVentilation depending on zone and outdoor conditions overrides fan schedule to do precooling with outdoor air

applicability_schedule_name

field Applicability Schedule Name

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

control_zone_name

field Control Zone Name

When AvailabilityManager:NightVentilation is used in the zone component availability

manager assignment list, the Control Zone Name should be the name of the zone in which the

zone component is.

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

fan_schedule_name

field Fan Schedule Name

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

night_venting_flow_fraction

field Night Venting Flow Fraction

the fraction (could be > 1) of the design system Flow Rate at which

night ventilation will be done

Default value: 1.0

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

ventilation_temperature_difference

field Ventilation Temperature Difference

The outdoor air temperature minus the control zone temperature

must be greater than the ventilation delta T

Units: deltaC

Default value: 2.0

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

ventilation_temperature_low_limit

field Ventilation Temperature Low Limit

Night ventilation is disabled if any conditioned zone served by

the system falls below this temperature

Units: C

Default value: 15.0

Parameters:value (float) – value for IDD Field Ventilation Temperature Low Limit Raises:ValueError – if value is not a valid value Returns:the value of ventilation_temperature_low_limit or None if not set Return type:float

ventilation_temperature_schedule_name

field Ventilation Temperature Schedule Name

One zone temperature must be above this scheduled temperature

for night ventilation to be enabled

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

class pyidf.system_availability_managers.AvailabilityManagerOptimumStart

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:OptimumStart Determines the optimal start of HVAC systems before occupancy.

applicability_schedule_name

field Applicability Schedule Name

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

constant_start_time

field Constant Start Time

this is the number of hours before occupancy for a system

Units: hr

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

constant_temperature_gradient_during_cooling

field Constant Temperature Gradient during Cooling

Units: deltaC/hr

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

constant_temperature_gradient_during_heating

field Constant Temperature Gradient during Heating

Units: deltaC/hr

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

control_algorithm

field Control Algorithm

Default value: AdaptiveASHRAE

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

control_type

field Control Type

Default value: ControlZone

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

control_zone_name

field Control Zone Name

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

fan_schedule_name

field Fan Schedule Name

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

initial_temperature_gradient_during_cooling

field Initial Temperature Gradient during Cooling

Units: deltaC/hr

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

initial_temperature_gradient_during_heating

field Initial Temperature Gradient during Heating

Units: deltaC/hr

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

maximum_value_for_optimum_start_time

field Maximum Value for Optimum Start Time

this is the maximum number of hours that a system can start before occupancy

Units: hr

Default value: 6.0

Parameters:value (float) – value for IDD Field Maximum Value for Optimum Start Time Raises:ValueError – if value is not a valid value Returns:the value of maximum_value_for_optimum_start_time 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_previous_days

field Number of Previous Days

this is the number of days that their actual temperature

gradients will be used in the AdaptiveTemperatureGradient method

Units: days

Default value: 2

value >= 2

value <= 5

Parameters:value (int) – value for IDD Field Number of Previous Days Raises:ValueError – if value is not a valid value Returns:the value of number_of_previous_days or None if not set Return type:int

zone_list_name

field Zone List Name

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

class pyidf.system_availability_managers.AvailabilityManagerScheduled

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:Scheduled Determines the availability of a loop or system: whether it is on or off. Schedule overrides fan/pump schedule.

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

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

class pyidf.system_availability_managers.AvailabilityManagerScheduledOff

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:ScheduledOff Determines the availability of a loop or system: only controls the turn off action. Schedule overrides fan/pump schedule.

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

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

class pyidf.system_availability_managers.AvailabilityManagerScheduledOn

Bases: pyidf.helper.DataObject

Corresponds to IDD object AvailabilityManager:ScheduledOn Determines the availability of a loop or system: only controls the turn on action. Schedule overrides fan/pump schedule.

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

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