Skip to content

Commit

Permalink
fix(doe2): Document the new optional Room space_polygon_geometry
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey authored and Chris Mackey committed Jul 3, 2024
1 parent 8e4b145 commit b1761e8
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions honeybee_schema/doe2/properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from .._base import NoExtraBaseModel
from ..altnumber import Autocalculate
from ..geometry import Face3D


class RoomDoe2Properties(NoExtraBaseModel):
Expand Down Expand Up @@ -57,6 +58,16 @@ class RoomDoe2Properties(NoExtraBaseModel):
'not be written into the INP.'
)

space_polygon_geometry: Face3D = Field(
default=None,
description='An optional horizontal Face3D object, which will '
'be used to set the SPACE polygon during export to INP. If None, '
'the SPACE polygon is auto-calculated from the 3D Room geometry. '
'Specifying a geometry here can help overcome some limitations of '
'this auto-calculation, particularly for cases where the floors '
'of the Room are composed of AirBoundaries.'
)


class ModelDoe2Properties(NoExtraBaseModel):

Expand Down

0 comments on commit b1761e8

Please sign in to comment.