Correction Factor

class energyplus_pet.correction_factor.CorrectionFactor(name: str)[source]

Bases: object

This class represents a small data set that is used to modify the base data and create a larger final data set. Often times manufacturers will provide equipment data with some independent variables held constant. From this data alone, it is not possible to generate a curve fit that is a function of that variable. It is common for the manufacturers to provide small separate tables of correction factor data that describe how the dependent variables behave as those originally constant values change, using multipliers for the dependent data.

check_ok(db_column: int, wb_column: int, summary_only: bool = False) bool[source]

Checks values of this correction factor and returns True or False to indicate success. If False, the client can check the .check_ok_last_message for a string message about what is wrong

Parameters:
  • db_column – The dry-bulb column from the current equipment headers().get_db_column()

  • wb_column – The wet-bulb column from the current equipment headers().get_wb_column()

  • summary_only – If this is True, it will only check summary data, not the full data set

Returns:

True if everything looks good, False if not

property columns_to_modify: List[int]

Returns the list of columns that this correction factor is designed to modify

describe() str[source]

Returns a multiline descriptive string for this correction factor

class energyplus_pet.correction_factor.CorrectionFactorType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

CombinedDbWb = 3
Multiplier = 1
Replacement = 2