Unit Systems and Values

class energyplus_pet.units.BaseValueWithUnit(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: object

This class represents an abstract floating point value with units attached. In this library, if a component is trying to define an interface, for example, defining a header column, it should just use the UnitType enumeration, because there is no value associated with that column. This class is mostly just used while tabular forms are open to handle users entering data in various units and normalizing them before sending the properly formed data to the equipment processing routines.

abstract static base_ip_unit_id() → str

abstract static base_si_unit() → str

abstract static calculation_unit_id() → str

abstract convert_to_calculation_unit()

classmethod get_id_from_unit_string(current_units_string: str) → str

Looks up the ID of a unit for the current type given the unit string

Parameters:

current_units_string – A string of units to search for, such as ‘kg/s’

Returns:

An internal string ID of the unit matching what comes from get_unit_ids()

abstract static get_unit_ids() → List[str]

abstract static get_unit_string_map() → OrderedDict[str, str]

abstract get_unit_type() → UnitType

class energyplus_pet.units.DimensionlessValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

Dimensionless = 'DimensionlessValue-'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.FlowValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

CFM = 'FlowValueCFM'

GPM = 'FlowValueGPM'

M3S = 'FlowValueM3S'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.LengthValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

Centimeters = 'LengthValueCM'

Feet = 'LengthValueFt'

Inches = 'LengthValueIn'

Meters = 'LengthValueM'

Millimeters = 'LengthValueMM'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.PowerValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

BTU_hour = 'PowerValueBtuH'

Kilowatts = 'PowerValuekW'

MBTU_hour = 'PowerValueMBtuH'

Watts = 'PowerValueW'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.PressureValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

Atm = 'PressureValueAtm'

KPa = 'PressureValuekPa'

PSI = 'PressureValuePSI'

Pa = 'PressureValuePa'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.RotationSpeedValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

RadiansPerSecond = 'RotationSpeedValueRadPs'

RevsPerMinute = 'RotationSpeedValueRpm'

RevsPerSecond = 'RotationSpeedValueRps'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[str]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.TemperatureValue(initial_value: float, name: str = '<Unnamed>', description: str = '<...>', initial_unit_id: str = None)

Bases: BaseValueWithUnit

C = 'TemperatureValueC'

F = 'TemperatureValueF'

K = 'TemperatureValueK'

static base_ip_unit_id() → str

static base_si_unit() → str

static calculation_unit_id() → str

convert_to_calculation_unit()

static get_unit_ids() → List[int]

static get_unit_string_map() → OrderedDict[str, str]

get_unit_type() → UnitType

class energyplus_pet.units.UnitType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Dimensionless = 4

Flow = 2

Length = 6

Power = 1

Pressure = 5

RotationalSpeed = 7

Temperature = 3

energyplus_pet.units.unit_class_factory(unit_type: UnitType) → Type[BaseValueWithUnit]

energyplus_pet.units.unit_instance_factory(value: float, unit_type: UnitType) → BaseValueWithUnit