feat(doe2): Document newly added properties for DOE-2

I don't think we necessarily need to expose these properties on the UI yet but, if people assign them, I do not want them to be lost as we send DFJSONs between different bindings.

Author: chriswmackey

dragonfly_schema/doe2/__init__.py

@@ -0,0 +1,64 @@
+"""Model DOE-2 properties."""
+from pydantic import Field, constr
+from typing import Union
+
+from honeybee_schema._base import NoExtraBaseModel
+from honeybee_schema.altnumber import Autocalculate
+
+
+class Room2DDoe2Properties(NoExtraBaseModel):
+
+    type: constr(regex='^Room2DDoe2Properties$') = \
+        'Room2DDoe2Properties'
+
+    assigned_flow: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the design supply air flow rate for the zone '
+        'the Room is assigned to (cfm). This establishes the minimum allowed '
+        'design air flow. Note that the actual design flow may be larger. If '
+        'Autocalculate, this parameter will not be written into the INP.'
+    )
+
+    flow_per_area: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the design supply air flow rate to the zone '
+        'per unit floor area (cfm/ft2). If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+    min_flow_ratio: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the minimum allowable zone '
+        'air supply flow rate, expressed as a fraction of design flow rate. Applicable '
+        'to variable-volume type systems only. If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+    min_flow_per_area: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        description='A number for the minimum air flow per square foot of '
+        'floor area (cfm/ft2). This is an alternative way of specifying the '
+        'min_flow_ratio. If Autocalculate, this parameter will not be written '
+        'into the INP.'
+    )
+
+    hmax_flow_ratio: Union[Autocalculate, float] = Field(
+        Autocalculate(),
+        ge=0,
+        le=1,
+        description='A number between 0 and 1 for the ratio of the maximum (or fixed) '
+        'heating airflow to the cooling airflow. The specific meaning varies according '
+        'to the type of zone terminal. If Autocalculate, this parameter will '
+        'not be written into the INP.'
+    )
+
+
+class ModelDoe2Properties(NoExtraBaseModel):
+
+    type: constr(regex='^ModelDoe2Properties$') = \
+        'ModelDoe2Properties'

dragonfly_schema/doe2/properties.py

@@ -22,6 +22,7 @@
 from .radiance.properties import Room2DRadiancePropertiesAbridged, \
     StoryRadiancePropertiesAbridged, BuildingRadiancePropertiesAbridged, \
     ContextShadeRadiancePropertiesAbridged, ModelRadianceProperties
+from .doe2.properties import Room2DDoe2Properties, ModelDoe2Properties
 from .comparison.properties import Room2DComparisonProperties, ModelComparisonProperties
 
 
@@ -37,6 +38,10 @@ class Room2DPropertiesAbridged(BaseModel):
         default=None
     )
 
+    doe2: Room2DDoe2Properties = Field(
+        default=None
+    )
+
     comparison: Room2DComparisonProperties = Field(
         default=None
     )
@@ -412,6 +417,10 @@ class ModelProperties(BaseModel):
         default=None
     )
 
+    doe2: ModelDoe2Properties = Field(
+        default=None
+    )
+
     comparison: ModelComparisonProperties = Field(
         default=None
     )