dragonfly-schema 1.12.8__py2.py3-none-any.whl → 1.13.0__py2.py3-none-any.whl

dragonfly_schema/energy/properties.py

@@ -124,6 +124,24 @@ class BuildingEnergyPropertiesAbridged(NoExtraBaseModel):
         'the Building. If None, the Model global_construction_set will be used.'
     )
 
+    ceiling_plenum_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier of an OpaqueConstruction for the bottoms of '
+        'ceiling plenums. Materials should be ordered from the plenum side '
+        'to the room side. By default, this is a simple acoustic tile construction.'
+    )
+
+    floor_plenum_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier of an OpaqueConstruction for the tops of floor '
+        'plenums. Materials should be ordered from the plenum side '
+        'to the room side. By default, this is a simple wood plank construction.'
+    )
+
 
 class ContextShadeEnergyPropertiesAbridged(NoExtraBaseModel):
 

dragonfly_schema/model.py

@@ -1,6 +1,7 @@
 """Model schema and the 3 geometry objects that define it."""
 from pydantic import BaseModel, Field, root_validator, constr, conlist
 from typing import List, Union
+from enum import Enum
 
 from honeybee_schema._base import IDdBaseModel
 from honeybee_schema.model import Room, Face3D, Mesh3D, Units
@@ -95,6 +96,26 @@ class Room2D(IDdBaseModel):
         'is a Room2D above this one with a has_floor property set to False.'
     )
 
+    ceiling_plenum_depth: float = Field(
+        0,
+        description='A number for the depth that a ceiling plenum extends into '
+        'the room. Setting this to a positive value will result in a separate '
+        'plenum room being split off of the Room2D volume during translation '
+        'from Dragonfly to Honeybee. The bottom of this ceiling plenum will '
+        'always be at this Room2D ceiling height minus the value specified here. '
+        'Setting this to zero indicates that the room has no ceiling plenum.'
+    )
+
+    floor_plenum_depth: float = Field(
+        0,
+        description='A number for the depth that a floor plenum extends into '
+        'the room. Setting this to a positive value will result in a separate '
+        'plenum room being split off of the Room2D volume during translation '
+        'from Dragonfly to Honeybee. The top of this floor plenum will always '
+        'be at this Room2D floor height plus the value specified here. '
+        'Setting this to zero indicates that the room has no floor plenum.'
+    )
+
     boundary_conditions: List[
         Union[Ground, Outdoors, Surface, Adiabatic, OtherSideTemperature]
     ] = Field(
@@ -182,6 +203,12 @@ class Room2D(IDdBaseModel):
         return values
 
 
+class StoryType(str, Enum):
+    standard = 'Standard'
+    ceiling_plenum = 'CeilingPlenum'
+    floor_plenum = 'FloorPlenum'
+
+
 class StoryPropertiesAbridged(BaseModel):
 
     type: constr(regex='^StoryPropertiesAbridged$') = 'StoryPropertiesAbridged'
@@ -236,11 +263,10 @@ class Story(IDdBaseModel):
         'multiplier is 1. If None, all Room2D ceilings will be flat.'
     )
 
-    is_plenum: bool = Field(
-        False,
-        description='A boolean noting whether the Room2Ds of the Story represent '
-        'plenums. If True, all Room2Ds in the Story are translated to 3D with a True '
-        'exclude_floor_area property.'
+    story_type: StoryType = Field(
+        StoryType.standard,
+        description='Text to indicate the type of story. Stories that are plenums '
+        'are translated to Honeybee with excluded floor areas.'
     )
 
     properties: StoryPropertiesAbridged = Field(

{dragonfly_schema-1.12.8.dist-info → dragonfly_schema-1.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragonfly-schema
-Version: 1.12.8
+Version: 1.13.0
 Summary: Dragonfly Data-Model Objects
 Home-page: https://github.com/ladybug-tools/dragonfly-schema
 Author: Ladybug Tools

{dragonfly_schema-1.12.8.dist-info → dragonfly_schema-1.13.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
 dragonfly_schema/__init__.py,sha256=Cp-YAOlfQuotiRooL-u9oPbSK_C4xBDYQUhlA67qxyI,36
-dragonfly_schema/model.py,sha256=lTgVsZZc4NdqAMBzM68gqke_Cm_UCRNCM0-2xNPcBTs,16918
+dragonfly_schema/model.py,sha256=1KCbgcRIOiPk3hfZFT8vQlVNEEHcKNdlWQ4Qw1CL6-A,18086
 dragonfly_schema/roof.py,sha256=A4cYdKrx01lqlBrPzAOwAO4jtEh9JdD46tB9wSW2p6w,746
 dragonfly_schema/shading_parameter.py,sha256=WI9XPX3eVXhIutvE_AD1ozJ4QxH85E3Frv9SKsIzCl8,3121
 dragonfly_schema/skylight_parameter.py,sha256=4uxsAHHEbpfZYndIw2KcQ9AJXU7AJcRZWo7up65vC2c,3137
 dragonfly_schema/window_parameter.py,sha256=nC1Q1E82sNjPLcsHOwZ0xh011NylLotmkCX12AFc_74,10871
 dragonfly_schema/energy/__init__.py,sha256=lLuzq9Sm9LUrW6VpOYxfS0Q_rXzOJoPDfzlxA3eFq2M,55
-dragonfly_schema/energy/properties.py,sha256=x7wJqW9kPVMapa9lhIhsmMe_9IDYSWjN-H7QctUgkSo,9116
+dragonfly_schema/energy/properties.py,sha256=d_0hPXWifkFSCXaIbOD0OFc4-pYPcGERUEnINz5q-Jw,9828
 dragonfly_schema/radiance/__init__.py,sha256=ok8w16ru1XXBUVjdghvNvwwXGPVSKKpHU-nmj4mf3IU,57
 dragonfly_schema/radiance/gridpar.py,sha256=ZQTnEdN1vmSsa2QMxfUdebg3cMnu6VvfcluiP11xHOs,4809
 dragonfly_schema/radiance/properties.py,sha256=Q_O_7fJohdtv5uwHTCZp1W67LoNUaZ45GB6GK7zKK4Y,3405
-dragonfly_schema-1.12.8.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
-dragonfly_schema-1.12.8.dist-info/METADATA,sha256=RN0moGIIHwR1hNcXDsup7SoJy3X9IqGCWaBOCuTdfrE,1943
-dragonfly_schema-1.12.8.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-dragonfly_schema-1.12.8.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
-dragonfly_schema-1.12.8.dist-info/RECORD,,
+dragonfly_schema-1.13.0.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
+dragonfly_schema-1.13.0.dist-info/METADATA,sha256=IcTgPxuuObEO8xom80v5VaIHMEQjDA_Tuh0bNCTmE9o,1943
+dragonfly_schema-1.13.0.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+dragonfly_schema-1.13.0.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
+dragonfly_schema-1.13.0.dist-info/RECORD,,