pyidf.operational_faults module¶

Data objects in group “Operational Faults”

class pyidf.operational_faults.FaultModelEnthalpySensorOffsetOutdoorAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:EnthalpySensorOffset:OutdoorAir This object describes outdoor air enthalpy sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

enthalpy_sensor_offset¶

field Enthalpy Sensor Offset

Units: J/kg
value > -20000.0
value < 20000.0

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

name¶

field Name

Enter the name of the fault

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

severity_schedule_name¶

field Severity Schedule Name

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

class pyidf.operational_faults.FaultModelEnthalpySensorOffsetReturnAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:EnthalpySensorOffset:ReturnAir This object describes return air enthalpy sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

enthalpy_sensor_offset¶

field Enthalpy Sensor Offset

Units: J/kg
value > -20000.0
value < 20000.0

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

name¶

field Name

Enter the name of the fault

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

severity_schedule_name¶

field Severity Schedule Name

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

class pyidf.operational_faults.FaultModelFoulingAirFilter¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:Fouling:AirFilter This object describes fault of dirty air filters

availability_schedule_name¶

field Availability Schedule Name

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

fan_curve_name¶

field Fan Curve Name

The curve describes the relationship between

the fan pressure rise and air flow rate

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

fan_name¶

field Fan Name

Enter the name of a fan object

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

fan_object_type¶

field Fan Object Type

Choose the type of the fan

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

name¶

field Name

Enter the name of the fault

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

pressure_fraction_schedule_name¶

field Pressure Fraction Schedule Name

Enter the name of a schedule
describing the variations of the fan pressure rise
in terms of multipliers to the fan design pressure rise

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

class pyidf.operational_faults.FaultModelFoulingCoil¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:Fouling:Coil This object describes fouling water heating or cooling coils

air_side_fouling_factor¶

field Air Side Fouling Factor

For Fouling Input Method: FoulingFactor

Units: m2-K/W

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

availability_schedule_name¶

field Availability Schedule Name

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

coil_name¶

field Coil Name

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

fouling_input_method¶

field Fouling Input Method

Default value: FouledUARated

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

inside_to_outside_coil_surface_area_ratio¶

field Inside to Outside Coil Surface Area Ratio

For Fouling Input Method: FoulingFactor
Units: dimensionless
Default value: 0.07

Parameters:	value (float) – value for IDD Field Inside to Outside Coil Surface Area Ratio
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of inside_to_outside_coil_surface_area_ratio 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

outside_coil_surface_area¶

field Outside Coil Surface Area

For Fouling Input Method: FoulingFactor

Units: m2

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

severity_schedule_name¶

field Severity Schedule Name

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

uafouled¶

field UAFouled

Fouling coil UA value under rating conditions
For Fouling Input Method: FouledUARated
Units: W/K

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

water_side_fouling_factor¶

field Water Side Fouling Factor

For Fouling Input Method: FoulingFactor

Units: m2-K/W

Parameters:	value (float) – value for IDD Field Water Side Fouling Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_side_fouling_factor or None if not set
Return type:	float

class pyidf.operational_faults.FaultModelHumidistatOffset¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:HumidistatOffset This object describes fault of humidistat offset

availability_schedule_name¶

field Availability Schedule Name

This field is applicable for Type ThermostatOffsetIndependent

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

humidistat_name¶

field Humidistat Name

Enter the name of a ZoneControl:Humidistat object.

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

humidistat_offset_type¶

field Humidistat Offset Type

Two types are available:
Type ThermostatOffsetIndependent
Type ThermostatOffsetDependent
Default value: ThermostatOffsetIndependent

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

name¶

field Name

Enter the name of the fault

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

reference_humidistat_offset¶

field Reference Humidistat Offset

Required field for Type ThermostatOffsetIndependent
Units: percent
Default value: 5.0
value > -20.0
value < 20.0

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

related_thermostat_offset_fault_name¶

field Related Thermostat Offset Fault Name

Enter the name of a FaultModel:ThermostatOffset object

Required field for Type ThermostatOffsetDependent

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

severity_schedule_name¶

field Severity Schedule Name

This field is applicable for Type ThermostatOffsetIndependent

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

class pyidf.operational_faults.FaultModelHumiditySensorOffsetOutdoorAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:HumiditySensorOffset:OutdoorAir This object describes outdoor air humidity sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

humidity_sensor_offset¶

field Humidity Sensor Offset

Units: kgWater/kgDryAir
value > -0.02
value < 0.02

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

name¶

field Name

Enter the name of the fault

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

severity_schedule_name¶

field Severity Schedule Name

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

class pyidf.operational_faults.FaultModelPressureSensorOffsetOutdoorAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:PressureSensorOffset:OutdoorAir This object describes outdoor air pressure sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

name¶

field Name

Enter the name of the fault

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

pressure_sensor_offset¶

field Pressure Sensor Offset

Units: Pa
value > -10000.0
value < 10000.0

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

severity_schedule_name¶

field Severity Schedule Name

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

class pyidf.operational_faults.FaultModelTemperatureSensorOffsetOutdoorAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:TemperatureSensorOffset:OutdoorAir This object describes outdoor air temperature sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

name¶

field Name

Enter the name of the fault

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

severity_schedule_name¶

field Severity Schedule Name

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

temperature_sensor_offset¶

field Temperature Sensor Offset

Units: deltaC
value > -10.0
value < 10.0

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

class pyidf.operational_faults.FaultModelTemperatureSensorOffsetReturnAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:TemperatureSensorOffset:ReturnAir This object describes return air temperature sensor offset

availability_schedule_name¶

field Availability Schedule Name

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

controller_object_name¶

field Controller Object Name

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

controller_object_type¶

field Controller Object Type

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

name¶

field Name

Enter the name of the fault

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

severity_schedule_name¶

field Severity Schedule Name

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

temperature_sensor_offset¶

field Temperature Sensor Offset

Units: deltaC
value > -10.0
value < 10.0

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

class pyidf.operational_faults.FaultModelThermostatOffset¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FaultModel:ThermostatOffset This object describes fault of thermostat offset

availability_schedule_name¶

field Availability Schedule Name

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

Enter the name of the fault

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

reference_thermostat_offset¶

field Reference Thermostat Offset

Units: deltaC
Default value: 2.0
value > -10.0
value < 10.0

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

severity_schedule_name¶

field Severity Schedule Name

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

thermostat_name¶

field Thermostat Name

Enter the name of a ZoneControl:Thermostat object.

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

pyidf.operational_faults module¶

Related Topics

This Page