pyidf.performance_curves module

Data objects in group “Performance Curves”

class pyidf.performance_curves.CurveBicubic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Bicubic Cubic curve with two independent variables. Input consists of the curve name, the ten coefficients, and the minimum and maximum values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y + C7*x**3 + C8*y**3 + C9*x**2*y + C10*x*y**2

coefficient10_xy2

field Coefficient10 x*y**2

Parameters:value (float) – value for IDD Field Coefficient10 x*y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient10_xy2 or None if not set Return type:float

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_y

field Coefficient4 y

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

coefficient5_y2

field Coefficient5 y**2

Parameters:value (float) – value for IDD Field Coefficient5 y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient5_y2 or None if not set Return type:float

coefficient6_xy

field Coefficient6 x*y

Parameters:value (float) – value for IDD Field Coefficient6 x*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient6_xy or None if not set Return type:float

coefficient7_x3

field Coefficient7 x**3

Parameters:value (float) – value for IDD Field Coefficient7 x**3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient7_x3 or None if not set Return type:float

coefficient8_y3

field Coefficient8 y**3

Parameters:value (float) – value for IDD Field Coefficient8 y**3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient8_y3 or None if not set Return type:float

coefficient9_x2y

field Coefficient9 x**2*y

Parameters:value (float) – value for IDD Field Coefficient9 x**2*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient9_x2y or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for Y

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A4

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A4

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

Parameters:value (float) – value for IDD Field Minimum Value of y Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_y 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveBiquadratic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Biquadratic Quadratic curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_y

field Coefficient4 y

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

coefficient5_y2

field Coefficient5 y**2

Parameters:value (float) – value for IDD Field Coefficient5 y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient5_y2 or None if not set Return type:float

coefficient6_xy

field Coefficient6 x*y

Parameters:value (float) – value for IDD Field Coefficient6 x*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient6_xy or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for Y

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A4

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A4

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

Parameters:value (float) – value for IDD Field Minimum Value of y Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_y 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveChillerPartLoadWithLift

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:ChillerPartLoadWithLift This chiller part-load performance curve has three independent variables. Input consists of the curve name, the twelve coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y + C7*x**3 + C8*y**3 + C9*x**2*y + C10*x*y**2 + C11*x**2*y**2 + C12*z*y**3 x = dT* = normalized fractional Lift = dT / dTref y = PLR = part load ratio (cooling load/steady state capacity) z = Tdev* = normalized Tdev = Tdev / dTref Where: dT = Lift = Leaving Condenser Water Temperature - Leaving Chilled Water Temperature dTref = dT at the reference condition Tdev = Leaving Chilled Water Temperature - Reference Chilled Water Temperature

coefficient10_c10

field Coefficient10 C10

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

coefficient11_c11

field Coefficient11 C11

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

coefficient12_c12

field Coefficient12 C12

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

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

coefficient4_c4

field Coefficient4 C4

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

coefficient5_c5

field Coefficient5 C5

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

coefficient6_c6

field Coefficient6 C6

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

coefficient7_c7

field Coefficient7 C7

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

coefficient8_c8

field Coefficient8 C8

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

coefficient9_c9

field Coefficient9 C9

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for y

Default value: Dimensionless

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

input_unit_type_for_z

field Input Unit Type for z

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A5

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

maximum_value_of_z

field Maximum Value of z

Units are based on field A4

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A5

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

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

minimum_value_of_z

field Minimum Value of z

Units are based on field A4

Parameters:value (float) – value for IDD Field Minimum Value of z Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_z 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveCubic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Cubic Cubic curve with one independent variable. Input for a cubic curve consists of the curve name, the 4 coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*x**3

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_x3

field Coefficient4 x**3

Parameters:value (float) – value for IDD Field Coefficient4 x**3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient4_x3 or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveCubicLinear

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:CubicLinear Cubic-linear curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = (C1 + C2*x + C3*x**2 + C4*x**3) + (C5 + C6*x)*y

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_x3

field Coefficient4 x**3

Parameters:value (float) – value for IDD Field Coefficient4 x**3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient4_x3 or None if not set Return type:float

coefficient5_y

field Coefficient5 y

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

coefficient6_xy

field Coefficient6 x*y

Parameters:value (float) – value for IDD Field Coefficient6 x*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient6_xy or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for Y

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A4

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A4

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

Parameters:value (float) – value for IDD Field Minimum Value of y Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_y 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveDoubleExponentialDecay

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:DoubleExponentialDecay Double exponential decay curve with one independent variable. Input consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2*exp(C3*x)+C4*exp(C5*x)

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

coefficient3_c4

field Coefficient3 C4

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

coefficient3_c5

field Coefficient3 C5

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveExponent

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Exponent Exponent curve with one independent variable. Input for a exponent curve consists of the curve name, the 3 coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x**C3 The independent variable x is raised to the C3 power, multiplied by C2, and C1 is added to the result.

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_constant

field Coefficient2 Constant

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

coefficient3_constant

field Coefficient3 Constant

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

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Specify the maximum value of the independent variable x allowed

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Specify the minimum value of the independent variable x allowed

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveExponentialDecay

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:ExponentialDecay Exponential decay curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2*exp(C3*x)

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveExponentialSkewNormal

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:ExponentialSkewNormal Exponential-modified skew normal curve with one independent variable. Input consists of the curve name, the four coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = see Input Output Reference

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

coefficient4_c4

field Coefficient4 C4

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

name

field Name

See InputOut Reference for curve description

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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveFanPressureRise

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:FanPressureRise Special curve type with two independent variables. Input for the fan total pressure rise curve consists of the curve name, the four coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1*Qfan**2+C2*Qfan+C3*Qfan*(Psm-Po)**0.5+C4*(Psm-Po) Po assumed to be zero See InputOut Reference for curve details

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

coefficient4_c4

field Coefficient4 C4

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units: Pa

IP-Units: Pa

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

maximum_value_of_psm

field Maximum Value of Psm

Units: Pa

IP-Units: Pa

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

maximum_value_of_qfan

field Maximum Value of Qfan

Units: m3/s

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units: Pa

IP-Units: Pa

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

minimum_value_of_psm

field Minimum Value of Psm

Units: Pa

IP-Units: Pa

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

minimum_value_of_qfan

field Minimum Value of Qfan

Units: m3/s

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

name

field Name

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

class pyidf.performance_curves.CurveFunctionalPressureDrop

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Functional:PressureDrop Sets up curve information for minor loss and/or friction calculations in plant pressure simulations Expression: DeltaP = {K + f*(L/D)} * (rho * V^2) / 2

diameter

field Diameter

“D” in above expression, used to also calculate local velocity

Units: m

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

fixed_friction_factor

field Fixed Friction Factor

Optional way to set a constant value for “f”, instead of using

internal Moody-chart approximations

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

length

field Length

“L” in above expression

Units: m

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

minor_loss_coefficient

field Minor Loss Coefficient

“K” in above expression

Units: dimensionless

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

name

field Name

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

roughness

field Roughness

This will be used to calculate “f” from Moody-chart approximations

Units: m

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

class pyidf.performance_curves.CurveLinear

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Linear Linear curve with one independent variable. Input for the linear curve consists of a curve name, the two coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveQuadLinear

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:QuadLinear Linear curve with four independent variables. Input for the linear curve consists of a curve name, the two coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*w + C3*x + C4*y + C5*z

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_w

field Coefficient2 w

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

coefficient3_x

field Coefficient3 x

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

coefficient4_y

field Coefficient4 y

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

coefficient5_z

field Coefficient5 z

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

input_unit_type_for_w

field Input Unit Type for w

Default value: Dimensionless

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for y

Default value: Dimensionless

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

input_unit_type_for_z

field Input Unit Type for z

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A4

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

maximum_value_of_w

field Maximum Value of w

Units are based on field A2

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A3

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A4

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

maximum_value_of_z

field Maximum Value of z

Units are based on field A5

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A4

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

minimum_value_of_w

field Minimum Value of w

Units are based on field A2

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A3

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A4

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

minimum_value_of_z

field Minimum Value of z

Units are based on field A5

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

name

field Name

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

class pyidf.performance_curves.CurveQuadratic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Quadratic Quadratic curve with one independent variable. Input for a quadratic curve consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveQuadraticLinear

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:QuadraticLinear Quadratic-linear curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = (C1 + C2*x + C3*x**2) + (C4 + C5*x + C6*x**2)*y

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_y

field Coefficient4 y

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

coefficient5_xy

field Coefficient5 x*y

Parameters:value (float) – value for IDD Field Coefficient5 x*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient5_xy or None if not set Return type:float

coefficient6_x2y

field Coefficient6 x**2*y

Parameters:value (float) – value for IDD Field Coefficient6 x**2*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient6_x2y or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for Y

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A4

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A4

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

Parameters:value (float) – value for IDD Field Minimum Value of y Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_y 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveQuartic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Quartic Quartic (fourth order polynomial) curve with one independent variable. Input for a Quartic curve consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*x**3 + C5*x**4

coefficient1_constant

field Coefficient1 Constant

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

coefficient2_x

field Coefficient2 x

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

coefficient3_x2

field Coefficient3 x**2

Parameters:value (float) – value for IDD Field Coefficient3 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient3_x2 or None if not set Return type:float

coefficient4_x3

field Coefficient4 x**3

Parameters:value (float) – value for IDD Field Coefficient4 x**3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient4_x3 or None if not set Return type:float

coefficient5_x4

field Coefficient5 x**4

Parameters:value (float) – value for IDD Field Coefficient5 x**4 Raises:ValueError – if value is not a valid value Returns:the value of coefficient5_x4 or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveRectangularHyperbola1

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:RectangularHyperbola1 Rectangular hyperbola type 1 curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = ((C1*x)/(C2+x))+C3

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveRectangularHyperbola2

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:RectangularHyperbola2 Rectangular hyperbola type 2 curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = ((C1*x)/(C2+x))+(C3*x)

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

Parameters:value (float) – value for IDD Field Minimum Value of x Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_x 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveSigmoid

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Sigmoid Sigmoid curve with one independent variable. Input consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2/[1+exp((C3-x)/C4)]**C5

coefficient1_c1

field Coefficient1 C1

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

coefficient2_c2

field Coefficient2 C2

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

coefficient3_c3

field Coefficient3 C3

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

coefficient4_c4

field Coefficient4 C4

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

coefficient5_c5

field Coefficient5 C5

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

input_unit_type_for_x

field Input Unit Type for x

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A3

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A3

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

name

field Name

See InputOut Reference for curve description

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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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

class pyidf.performance_curves.CurveTriquadratic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Curve:Triquadratic Quadratic curve with three independent variables. Input consists of the curve name, the twenty seven coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = a0 + a1*x**2 + a2*x + a3*y**2 + a4*y + a5*z**2 + a6*z + a7*x**2*y**2 + a8*x*y + a9*x*y**2 + a10*x**2*y + a11*x**2*z**2 + a12*x*z + a13*x*z**2 + a14*x**2*z + a15*y**2*z**2 + a16*y*z + a17*y*z**2 + a18*y**2*z + a19*x**2*y**2*z**2 + a20*x**2*y**2*z + a21*x**2*y*z**2 + a22*x*y**2*z**2 + a23*x**2*y*z + a24*x*y**2*z + a25*x*y*z**2 +a26*x*y*z

coefficient10_xy2

field Coefficient10 x*y**2

Parameters:value (float) – value for IDD Field Coefficient10 x*y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient10_xy2 or None if not set Return type:float

coefficient11_x2y

field Coefficient11 x**2*y

Parameters:value (float) – value for IDD Field Coefficient11 x**2*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient11_x2y or None if not set Return type:float

coefficient12_x2z2

field Coefficient12 x**2*z**2

Parameters:value (float) – value for IDD Field Coefficient12 x**2*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient12_x2z2 or None if not set Return type:float

coefficient13_xz

field Coefficient13 x*z

Parameters:value (float) – value for IDD Field Coefficient13 x*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient13_xz or None if not set Return type:float

coefficient14_xz2

field Coefficient14 x*z**2

Parameters:value (float) – value for IDD Field Coefficient14 x*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient14_xz2 or None if not set Return type:float

coefficient15_x2z

field Coefficient15 x**2*z

Parameters:value (float) – value for IDD Field Coefficient15 x**2*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient15_x2z or None if not set Return type:float

coefficient16_y2z2

field Coefficient16 y**2*z**2

Parameters:value (float) – value for IDD Field Coefficient16 y**2*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient16_y2z2 or None if not set Return type:float

coefficient17_yz

field Coefficient17 y*z

Parameters:value (float) – value for IDD Field Coefficient17 y*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient17_yz or None if not set Return type:float

coefficient18_yz2

field Coefficient18 y*z**2

Parameters:value (float) – value for IDD Field Coefficient18 y*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient18_yz2 or None if not set Return type:float

coefficient19_y2z

field Coefficient19 y**2*z

Parameters:value (float) – value for IDD Field Coefficient19 y**2*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient19_y2z or None if not set Return type:float

coefficient1_constant

field Coefficient1 Constant

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

coefficient20_x2y2z2

field Coefficient20 x**2*y**2*z**2

Parameters:value (float) – value for IDD Field Coefficient20 x**2*y**2*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient20_x2y2z2 or None if not set Return type:float

coefficient21_x2y2z

field Coefficient21 x**2*y**2*z

Parameters:value (float) – value for IDD Field Coefficient21 x**2*y**2*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient21_x2y2z or None if not set Return type:float

coefficient22_x2yz2

field Coefficient22 x**2*y*z**2

Parameters:value (float) – value for IDD Field Coefficient22 x**2*y*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient22_x2yz2 or None if not set Return type:float

coefficient23_xy2z2

field Coefficient23 x*y**2*z**2

Parameters:value (float) – value for IDD Field Coefficient23 x*y**2*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient23_xy2z2 or None if not set Return type:float

coefficient24_x2yz

field Coefficient24 x**2*y*z

Parameters:value (float) – value for IDD Field Coefficient24 x**2*y*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient24_x2yz or None if not set Return type:float

coefficient25_xy2z

field Coefficient25 x*y**2*z

Parameters:value (float) – value for IDD Field Coefficient25 x*y**2*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient25_xy2z or None if not set Return type:float

coefficient26_xyz2

field Coefficient26 x*y*z**2

Parameters:value (float) – value for IDD Field Coefficient26 x*y*z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient26_xyz2 or None if not set Return type:float

coefficient27_xyz

field Coefficient27 x*y*z

Parameters:value (float) – value for IDD Field Coefficient27 x*y*z Raises:ValueError – if value is not a valid value Returns:the value of coefficient27_xyz or None if not set Return type:float

coefficient2_x2

field Coefficient2 x**2

Parameters:value (float) – value for IDD Field Coefficient2 x**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient2_x2 or None if not set Return type:float

coefficient3_x

field Coefficient3 x

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

coefficient4_y2

field Coefficient4 y**2

Parameters:value (float) – value for IDD Field Coefficient4 y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient4_y2 or None if not set Return type:float

coefficient5_y

field Coefficient5 y

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

coefficient6_z2

field Coefficient6 z**2

Parameters:value (float) – value for IDD Field Coefficient6 z**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient6_z2 or None if not set Return type:float

coefficient7_z

field Coefficient7 z

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

coefficient8_x2y2

field Coefficient8 x**2*y**2

Parameters:value (float) – value for IDD Field Coefficient8 x**2*y**2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient8_x2y2 or None if not set Return type:float

coefficient9_xy

field Coefficient9 x*y

Parameters:value (float) – value for IDD Field Coefficient9 x*y Raises:ValueError – if value is not a valid value Returns:the value of coefficient9_xy or None if not set Return type:float

input_unit_type_for_x

field Input Unit Type for X

Default value: Dimensionless

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

input_unit_type_for_y

field Input Unit Type for Y

Default value: Dimensionless

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

input_unit_type_for_z

field Input Unit Type for Z

Default value: Dimensionless

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

maximum_curve_output

field Maximum Curve Output

Specify the maximum value calculated by this curve object

Units are based on field A5

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

maximum_value_of_x

field Maximum Value of x

Units are based on field A2

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

maximum_value_of_y

field Maximum Value of y

Units are based on field A3

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

maximum_value_of_z

field Maximum Value of z

Units are based on field A4

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

minimum_curve_output

field Minimum Curve Output

Specify the minimum value calculated by this curve object

Units are based on field A5

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

minimum_value_of_x

field Minimum Value of x

Units are based on field A2

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

minimum_value_of_y

field Minimum Value of y

Units are based on field A3

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

minimum_value_of_z

field Minimum Value of z

Units are based on field A4

Parameters:value (float) – value for IDD Field Minimum Value of z Raises:ValueError – if value is not a valid value Returns:the value of minimum_value_of_z 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

output_unit_type

field Output Unit Type

Default value: Dimensionless

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