-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 HBJSONs between different bindings.
- Loading branch information
1 parent
059468e
commit 3026b11
Showing
4 changed files
with
75 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
"""Model DOE-2 properties.""" | ||
from pydantic import Field, constr | ||
from typing import Union | ||
|
||
from .._base import NoExtraBaseModel | ||
from ..altnumber import Autocalculate | ||
|
||
|
||
class RoomDoe2Properties(NoExtraBaseModel): | ||
|
||
type: constr(regex='^RoomDoe2Properties$') = \ | ||
'RoomDoe2Properties' | ||
|
||
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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters