API Reference hvac

hvac

Valid ‘types’ for Mech Equipment Options.

Source: PHX/hvac.py


PhxFuelType

Fuel type for combustion-based heating equipment.

Inherits from: Enum

Values

MemberValueMeaning
NATURAL_GAS1Natural gas fuel.
OIL2Fuel oil.
WOOD_LOG3Wood log fuel.
WOOD_PELLET4Wood pellet fuel.

SystemType

Classification of mechanical system types in the energy model.

Inherits from: Enum

Values

MemberValueMeaning
ANY0Matches any system type (wildcard).
VENTILATION1Mechanical ventilation system (HRV/ERV).
ELECTRIC2Direct electric heating system.
BOILER3Combustion boiler system.
DISTRICT_HEAT4District heating connection.
HEAT_PUMP5Heat pump system.
USER_DEFINED7User-specified custom system.
WATER_STORAGE8Hot water storage tank system.
PHOTOVOLTAIC10Photovoltaic solar panel system.

DeviceType

Classification of individual HVAC device types.

Inherits from: Enum

Values

MemberValueMeaning
VENTILATION1Ventilation unit (HRV/ERV).
ELECTRIC2Direct electric heating device.
BOILER3Combustion boiler device.
DISTRICT_HEAT4District heating device.
HEAT_PUMP5Heat pump device.
WATER_STORAGE8Hot water storage tank.
PHOTOVOLTAIC10Photovoltaic panel array.

HeatPumpType

Heat pump performance data entry method.

Inherits from: Enum

Values

MemberValueMeaning
COMBINED2Combined heating and cooling heat pump.
ANNUAL3Annual average COP performance data.
RATED_MONTHLY4Monthly rated COP performance data.
HOT_WATER5Dedicated domestic hot water heat pump.

CoolingType

Classification of active cooling delivery methods.

Inherits from: Enum

Values

MemberValueMeaning
NONE0No active cooling.
VENTILATION1Cooling via the ventilation supply air.
RECIRCULATION2Cooling via recirculated air.
DEHUMIDIFICATION3Cooling via dehumidification.
PANEL4Cooling via radiant panels.

PhxHotWaterPipingCalcMethod

Calculation method for hot water distribution piping losses.

Inherits from: Enum

Values

MemberValueMeaning
SIMPLIFIED_INDIVIDUAL_PIPES1Simplified method specifying individual pipe runs.
SIMPLIFIED_HOT_WATER_CALCULATOR2Simplified method using the hot water calculator.
HOT_WATER_PIPING_UNIT_METHOD3Detailed method based on per-unit piping lengths.
HOT_WATER_PIPING_FLOOR_METHOD4Detailed method based on per-floor piping lengths.

PhxHotWaterPipingMaterial

Material type for hot water distribution piping.

Inherits from: Enum

Values

MemberValueMeaning
COPPER_M1Copper pipe, Type M (thin wall).
COPPER_L2Copper pipe, Type L (medium wall).
COPPER_K3Copper pipe, Type K (thick wall).
CPVC_CTS_SDR4CPVC pipe, CTS SDR rating.
CPVC_SCH_405CPVC pipe, Schedule 40.
PEX6Cross-linked polyethylene (PEX) pipe.
PE7Polyethylene (PE) pipe.
PEX_CTS_SDR8PEX pipe, CTS SDR rating.

PhxHotWaterPipingInchDiameterType

Nominal pipe diameter in inches for hot water piping.

Inherits from: Enum


PhxHotWaterInputOptions

Input method for hot water storage tank loss specification.

Inherits from: Enum

Values

MemberValueMeaning
SPEC_TOTAL_LOSSES1Specify total storage losses directly.
SPEC_STANDBY_LOSSES2Specify standby losses from the tank data sheet.
TOTAL_LOSSES3Use calculated total losses.

PhxHotWaterTankType

Hot water storage tank usage classification.

Inherits from: Enum

Values

MemberValueMeaning
NONE0No storage tank.
DHW_AND_HEATING1Tank serves both domestic hot water and space heating.
DHW_ONLY2Tank serves domestic hot water only.

PhxHotWaterSelectionUnitsOrFloors

Selection basis for hot water piping calculation scope.

Inherits from: Enum

Values

MemberValueMeaning
PH_CASE1Use the PH case default (number of dwelling units).
USER_DETERMINED2User specifies the number of units or floors.

PhxExhaustVentType

Type of dedicated exhaust ventilation device.

Inherits from: Enum

Values

MemberValueMeaning
DRYER1Clothes dryer exhaust.
KITCHEN_HOOD2Kitchen range hood exhaust.
USER_DEFINED3User-specified exhaust device.

PhxVentDuctType

Ventilation duct direction classification.

Inherits from: Enum

Values

MemberValueMeaning
SUPPLY1Supply air duct (outdoor air to rooms).
EXHAUST2Exhaust air duct (rooms to outdoors).

PhxSupportiveDeviceType

Type of supportive (auxiliary) mechanical device.

Inherits from: Enum

Values

MemberValueMeaning
HEAT_CIRCULATING_PUMP4Circulation pump for the heating loop.
DHW_CIRCULATING_PUMP6Recirculation pump for the DHW loop.
DHW_STORAGE_LOAD_PUMP7Pump loading the DHW storage tank.
OTHER10Other auxiliary device.

PhxSummerBypassMode

Summer bypass mode for the heat recovery ventilator.

Inherits from: Enum

Values

MemberValueMeaning
NONE1No summer bypass.
TEMP_CONTROLLED2Bypass activated by temperature differential.
ENTHALPY_CONTROLLED3Bypass activated by enthalpy differential.
ALWAYS4Bypass always active in summer.

PhxNighttimeVentilationControl

Control strategy for nighttime ventilation cooling.

Inherits from: Enum

Values

MemberValueMeaning
TEMPERATURE_CONTROLLED1Nighttime ventilation activated by temperature.
HUMIDITY_CONTROLLED2Nighttime ventilation activated by humidity.