honeybee_energy_ph.properties.materials.opaque module

Passive House properties for honeybee_energy.material.opaque.EnergyMaterial Objects

exception honeybee_energy_ph.properties.materials.opaque.CellPositionError(msg)

Bases: Exception

An error for when a cell position is out of range.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

class honeybee_energy_ph.properties.materials.opaque.EnergyMaterialNoMassPhProperties(_host: EnergyMaterialNoMass | None = None)

Bases: object

ToString()

apply_properties_from_dict(abridged_data: dict) → None

duplicate(new_host: EnergyMaterialNoMass | None = None) → EnergyMaterialNoMassPhProperties

classmethod from_dict(_input_dict: dict, _host: EnergyMaterialNoMass | None) → EnergyMaterialNoMassPhProperties

to_dict(abridged: bool = False) → dict[str, dict]

property ph_color: PhColor | None

class honeybee_energy_ph.properties.materials.opaque.EnergyMaterialPhProperties(_host: EnergyMaterial | None = None)

Bases: object

Passive House properties for EnergyMaterial objects.

ToString()

add_base_material(_hb_material: Any) → NoReturn

apply_properties_from_dict(abridged_data: Any) → None

clear_base_materials() → NoReturn

duplicate(new_host: EnergyMaterial | None = None) → EnergyMaterialPhProperties

classmethod from_dict(_input_dict: dict, _host: EnergyMaterial | None) → EnergyMaterialPhProperties

to_dict(abridged: bool = False) → dict[str, dict]

property base_material

property base_materials: NoReturn

property percentage_of_assembly: NoReturn

property ph_color: PhColor | None

class honeybee_energy_ph.properties.materials.opaque.EnergyMaterialVegetationPhProperties(_host: EnergyMaterialVegetation | None = None)

Bases: object

ToString()

apply_properties_from_dict(abridged_data)

duplicate(new_host: EnergyMaterialVegetation | None = None) → EnergyMaterialVegetationPhProperties

classmethod from_dict(_input_dict: dict[str, Any], _host: EnergyMaterialVegetation | None) → EnergyMaterialVegetationPhProperties

to_dict(abridged: bool = False) → dict[str, dict]

property ph_color: PhColor | None

class honeybee_energy_ph.properties.materials.opaque.PhDivisionCell(_row: int, _column: int, _hbe_material: EnergyMaterial)

Bases: object

A single cell in a PhLayerDivisionGrid.

ToString()

duplicate() → PhDivisionCell

Duplicate the cell.

classmethod from_dict(_input_dict: dict[str, Any]) → PhDivisionCell

to_dict() → dict[str, Any]

class honeybee_energy_ph.properties.materials.opaque.PhDivisionGrid

Bases: object

A grid of PhDivisionCell to support ‘mixed’ materials.

The Cell grid is ordered from top-left to bottom-right:

| C0 | C1 | C2 | …

|:---|:—:|:---:|:—:|:—: | R0 | 0,0 | 1,0 | 2,0 | … | R1 | 0,1 | 1,1 | 2,1 | … | R2 | 0,2 | 1,2 | 2,2 | …

ToString()

add_new_column(_column_width: float) → None

Add a new COLUMN to the grid with the given width.

add_new_row(_row_height: float) → None

Add a new ROW to the grid with the given height.

duplicate() → PhDivisionGrid

Duplicate the grid.

classmethod from_dict(_input_dict: dict[str, Any]) → PhDivisionGrid

get_base_material() → EnergyMaterial | None

Returns the ‘base’ material (the most common material in the grid, by area).

get_cell(_column: int, _row: int) → PhDivisionCell | None

Get the PhDivisionCell at the given column and row position.

get_cell_area(_column_num: int, _row_num: int) → float

Get the area of a specific cell in the grid by its column/row position.

get_cell_height_m(_cell: PhDivisionCell) → float

Get the height (mm) of a specific cell.

get_cell_material(_column_num: int, _row_num: int) → EnergyMaterial | None

Get the PhxMaterial for a specific cell in the grid by its column/row position.

get_cell_width_m(_cell: PhDivisionCell) → float

Get the width (mm) of a specific cell.

get_equivalent_conductivity() → float

Return an area-weighted average of the conductivities of all materials in the grid.

set_cell_material(_column_num: int, _row_num: int, _hbe_material: EnergyMaterial) → None

Set the EnergyMaterial for a specific cell in the grid by its column/row position.

Cells are indexed by their column and row position stating from top-left:

| C0 | C1 | C2 | …

|---|——|-----|—–|—- |R0 | 0,0 | 1,0 | 2,0 | … |R1 | 0,1 | 1,1 | 2,1 | … |R2 | 0,2 | 1,2 | 2,2 | …

set_column_widths(_column_widths: Iterable[float]) → None

Set the column widths of the grid.

set_row_heights(_row_heights: Iterable[float]) → None

Set the row heights of the grid.

to_dict() → dict[str, Any]

property cell_count: int

Return the total number of cells in the grid.

property cells: List[PhDivisionCell]

Return the list of all the cells in the grid, sorted by row/column.

property column_count: int

Return the number of columns in the grid.

property column_widths: List[float]

Return the list of column widths.

property is_a_steel_stud_cavity: bool

Check if the grid is a steel stud cavity by checking if the spacing is set.

property row_count: int

Return the number of rows in the grid.

property row_heights: List[float]

Return the list of row heights.