honeybee_energy_ph.construction.thermal_bridge module

HBPH Thermal Bridge Objects

class honeybee_energy_ph.construction.thermal_bridge.PhThermalBridge(_identifier: Any, _geometry: Polyline3D | LineSegment3D)

Bases: _Base

A single PhThermalBridge object

ToString()

duplicate() → PhThermalBridge

classmethod from_dict(_input_dict: dict) → PhThermalBridge

move(moving_vec3D: Vector3D) → PhThermalBridge

Move the TB-Geometry along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(plane: Plane) → PhThermalBridge

Reflected the TB-Geometry across a plane.

Parameters:

normal_vec3D – A Plane representing the plane across which to reflect.

rotate(axis_vec3D: Vector3D, angle_degrees: float, origin_pt3D: Point3D) → PhThermalBridge

Rotate the TB-Geometry by a certain angle around an axis and origin.

Right hand rule applies: If axis has a positive orientation, rotation will be clockwise. If axis has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis representing the axis of rotation.

• angle_degrees – An angle for rotation in degrees.

• origin_pt3D – A Point3D for the origin around which the object will be rotated.

rotate_xy(angle_degrees: float, origin_pt3D: Point3D) → PhThermalBridge

Rotate the TB-Geometry counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

• origin_pt3D – A Point3D for the origin around which the object will be rotated.

scale(scale_factor: float, origin_pt3D: Point3D | None = None) → PhThermalBridge

Scale the TB-Geometry by a factor from an origin point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

• origin_pt3D – A Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

set_base_attrs_from_dict(_input_dict: dict[str, Any]) → None

Set all the Base attribute values from an input dict.

set_base_attrs_from_obj(other: _Base) → None

Sets the base attributes based on another object. Used during __copy__.

to_dict() → dict[str, Any]

Return all the base attribute values as a dict.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property group_type: PhThermalBridgeType

property identifier

Get the text string for unique construction identifier.

property length: float

property user_data: dict

Get an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

class honeybee_energy_ph.construction.thermal_bridge.PhThermalBridgeType(_value: str | int = 15, _index_offset: int = 0)

Bases: CustomEnum

ToString()

classmethod from_dict(_dict: dict[str, Any]) → CustomEnum

to_dict() → dict[str, Any]

allowed: list[str] = ['', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '15-Ambient', '16-Perimeter', '17-FS/BC']

property allowed_upper: list[str]

property number: int

Returns the index pos of self.value (usually 1-based)

property value: str