API Reference building

building

Valid ‘types’ for Building Elements.

Source: PHX/building.py


ComponentFaceType

Classification of building component face orientations.

Inherits from: Enum

Values

MemberValueMeaning
NONE0Unclassified face type.
WALL1Vertical wall surface.
FLOOR2Horizontal floor surface.
ROOF_CEILING3Roof or ceiling surface.
WINDOW4Glazed window surface.
ADIABATIC5Adiabatic boundary (no heat flow).
CUSTOM6User-defined face type.
AIR_BOUNDARY7Air boundary between zones.

ComponentExposureExterior

Exterior exposure condition for a building component.

Inherits from: Enum

Values

MemberValueMeaning
NONE0No exposure assigned.
EXTERIOR-1Exposed to outdoor air.
GROUND-2In contact with ground.
SURFACE-3Exposed to another surface (interior boundary).

ComponentFaceOpacity

Opacity classification of a building component face.

Inherits from: Enum

Values

MemberValueMeaning
OPAQUE1Solid, non-transparent surface (walls, roofs, floors).
TRANSPARENT2Glazed or translucent surface (windows, curtain walls).
AIRBOUNDARY3Virtual air boundary between zones.

ComponentColor

Display color assignment for building components in WUFI visualization.

Inherits from: Enum

Values

MemberValueMeaning
EXT_WALL_INNER1Interior side of an exterior wall.
EXT_WALL_OUTER2Exterior side of an exterior wall.
INNER_WALL3Interior partition wall.
WINDOW4Window or glazed component.
FLOOR5Floor surface.
CEILING6Ceiling surface.
SLOPED_ROOF_OUTER7Exterior side of a sloped roof.
SLOPED_ROOF_INNER8Interior side of a sloped roof.
SLOPED_ROOF_THATCH9Thatch-style sloped roof.
FLAT_ROOF_OUTER10Exterior side of a flat roof.
FLAT_ROOF_INNER11Interior side of a flat roof.
SURFACE_GROUND_CONTACT12Surface in contact with ground.
GROUND_ABOVE13Ground surface above the component.
GROUND_BENEATH14Ground surface beneath the component.

ThermalBridgeType

Classification of thermal bridge boundary conditions.

Inherits from: Enum

Values

MemberValueMeaning
AMBIENT15Thermal bridge exposed to outdoor ambient air.
PERIMETER16Thermal bridge at the building perimeter (e.g. slab edge).
UNDERGROUND17Thermal bridge in contact with ground.

SpecificHeatCapacityType

Thermal mass classification for a building zone.

Inherits from: Enum

Values

MemberValueMeaning
LIGHTWEIGHT1Light construction (e.g. wood frame).
MIXED2Mixed construction weight.
MASSIVE3Heavy construction (e.g. concrete, masonry).
USER_DEFINED6User-specified heat capacity value.

SpecificHeatCapacityValueWhM2K

Specific heat capacity values in Wh/m2K for standard construction types.

Inherits from: Enum

Values

MemberValueMeaning
LIGHTWEIGHT6060 Wh/m2K for lightweight construction.
MIXED132132 Wh/m2K for mixed construction.
MASSIVE204204 Wh/m2K for massive construction.

WufiVolumeGrossMode

Method for determining gross building volume in WUFI.

Inherits from: Enum

Values

MemberValueMeaning
USER_DEFINED6Gross volume entered manually by the user.
FROM_VISUALIZED_COMPONENTS7Gross volume calculated from modeled component geometry.

WufiVolumeNetMode

Method for determining net interior volume in WUFI.

Inherits from: Enum

Values

MemberValueMeaning
ESTIMATED_FROM_GROSS4Net volume estimated as a fraction of gross volume.
FROM_GROSS_AND_COMPONETS5Net volume derived from gross volume minus component thicknesses.
USER_DEFINED6Net volume entered manually by the user.
FROM_VISUALIZED_COMPONENTS7Net volume calculated from modeled component geometry.

WufiWeightedFloorAreaMode

Method for determining weighted floor area (TFA/iCFA) in WUFI.

Inherits from: Enum

Values

MemberValueMeaning
FROM_VISUALIZED_GEOMETRY2Floor area calculated from modeled floor geometry.
ESTIMATED_FROM_GROSS_VOLUME4Floor area estimated from the gross volume.
USER_DEFINED6Floor area entered manually by the user.

ZoneType

Classification of thermal zones in the energy model.

Inherits from: Enum

Values

MemberValueMeaning
SIMULATED1Zone included in the active energy balance simulation.
ATTACHED2Adjacent unconditioned zone not directly simulated.

AttachedZoneType

Specific type of an attached (non-simulated) thermal zone.

Inherits from: Enum

Values

MemberValueMeaning
NONE0No attached zone type assigned.
UNHEATED_SPACE1Generic unheated adjacent space.
UNHEATED_CELLAR2Unheated basement or cellar.
UNHEATED_CRAWLSPACE3Unheated crawlspace below the building.
UNHEATED_WINTER_GARDEN4Unheated sunroom or winter garden.
UNHEATED_ATTIC5Unheated attic space.
CONDITIONED6Attached zone that is conditioned.

WindExposureType

Wind exposure classification for infiltration calculations.

Inherits from: Enum

Values

MemberValueMeaning
SEVERAL_SIDES_EXPOSED_NO_SCREENING1Multiple facades exposed, no wind screening.
SEVERAL_SIDES_EXPOSED_MODERATE_SCREENING2Multiple facades exposed, moderate wind screening.
SEVERAL_SIDES_EXPOSED_HIGH_SCREENING3Multiple facades exposed, high wind screening.
ONE_SIDE_EXPOSED_NO_SCREENING4Single facade exposed, no wind screening.
ONE_SIDE_EXPOSED_MODERATE_SCREENING5Single facade exposed, moderate wind screening.
ONE_SIDE_EXPOSED_HIGH_SCREENING7Single facade exposed, high wind screening.
USER_DEFINED6User-specified wind exposure coefficient.