honeybee-schema 1.59.1__py3-none-any.whl

honeybee_schema/energy/construction.py

@@ -0,0 +1,324 @@
+"""Construction Schema"""
+from pydantic import Field, constr
+from typing import List, Union
+from enum import Enum
+
+from ._base import IDdEnergyBaseModel
+from .material import EnergyMaterial, EnergyMaterialNoMass, EnergyMaterialVegetation, \
+    EnergyWindowMaterialGas, EnergyWindowMaterialGasCustom, \
+    EnergyWindowMaterialGasMixture, EnergyWindowMaterialSimpleGlazSys, \
+    EnergyWindowMaterialGlazing, EnergyWindowFrame, \
+    EnergyWindowMaterialShade, EnergyWindowMaterialBlind
+from .schedule import ScheduleRuleset, ScheduleFixedInterval
+
+
+class OpaqueConstructionAbridged(IDdEnergyBaseModel):
+    """Construction for opaque objects (Face, Shade, Door)."""
+
+    type: constr(regex='^OpaqueConstructionAbridged$') = 'OpaqueConstructionAbridged'
+
+    materials: List[constr(min_length=1, max_length=100)] = Field(
+        ...,
+        description='List of strings for opaque material identifiers. The order '
+        'of the materials is from exterior to interior.',
+        min_items=1,
+        max_items=10
+    )
+
+
+class OpaqueConstruction(OpaqueConstructionAbridged):
+    """Construction for opaque objects (Face, Shade, Door)."""
+
+    type: constr(regex='^OpaqueConstruction$') = 'OpaqueConstruction'
+
+    materials: List[
+        Union[EnergyMaterial, EnergyMaterialNoMass, EnergyMaterialVegetation]
+    ] = Field(
+        ...,
+        description='List of opaque material definitions. The order '
+        'of the materials is from exterior to interior.',
+        min_items=1,
+        max_items=10
+    )
+
+
+class WindowConstructionAbridged(IDdEnergyBaseModel):
+    """Construction for window objects (Aperture, Door)."""
+
+    type: constr(regex='^WindowConstructionAbridged$') = 'WindowConstructionAbridged'
+
+    materials: List[constr(min_length=1, max_length=100)] = Field(
+        ...,
+        description='List of strings for glazing or gas material identifiers. The '
+        'order of the materials is from exterior to interior. If a SimpleGlazSys '
+        'material is used, it must be the only material in the construction. '
+        'For multi-layered constructions, adjacent glass layers must be separated '
+        'by one and only one gas layer.',
+        min_items=1,
+        max_items=8
+    )
+
+    frame: str = Field(
+        None,
+        min_length=1,
+        max_length=100,
+        description='An optional identifier for a frame material that '
+        'surrounds the window construction.'
+    )
+
+
+class WindowConstruction(WindowConstructionAbridged):
+    """Construction for window objects (Aperture, Door)."""
+
+    type: constr(regex='^WindowConstruction$') = 'WindowConstruction'
+
+    materials: List[
+        Union[
+            EnergyWindowMaterialSimpleGlazSys, EnergyWindowMaterialGlazing,
+            EnergyWindowMaterialGas, EnergyWindowMaterialGasCustom,
+            EnergyWindowMaterialGasMixture
+        ]
+    ] = Field(
+        ...,
+        description='List of glazing and gas material definitions. The order '
+        'of the materials is from exterior to interior. If a SimpleGlazSys '
+        'material is used, it must be the only material in the construction. '
+        'For multi-layered constructions, adjacent glass layers must be separated '
+        'by one and only one gas layer.',
+        min_items=1,
+        max_items=8
+    )
+
+    frame: EnergyWindowFrame = Field(
+        None,
+        description='An optional window frame material for the frame that '
+        'surrounds the window construction.'
+    )
+
+
+class ShadeLocation(str, Enum):
+    """Choices for where a shade material is located in a window assembly."""
+    interior = 'Interior'
+    between = 'Between'
+    exterior = 'Exterior'
+
+
+class ControlType(str, Enum):
+    """Choices for how the shading device is controlled."""
+    always_on = 'AlwaysOn'
+    on_if_high_solar_on_window = 'OnIfHighSolarOnWindow'
+    on_if_high_horizontal_solar = 'OnIfHighHorizontalSolar'
+    on_if_high_outdoor_air_temperature = 'OnIfHighOutdoorAirTemperature'
+    on_if_high_zone_air_temperature = 'OnIfHighZoneAirTemperature'
+    on_if_high_zone_cooling = 'OnIfHighZoneCooling'
+    on_night_if_low_outdoor_temp_and_off_day = 'OnNightIfLowOutdoorTempAndOffDay'
+    on_night_if_low_inside_temp_and_off_day = 'OnNightIfLowInsideTempAndOffDay'
+    on_night_if_heating_and_off_day = 'OnNightIfHeatingAndOffDay'
+
+
+class WindowConstructionShadeAbridged(IDdEnergyBaseModel):
+    """Construction for window objects with an included shade layer."""
+
+    type: constr(regex='^WindowConstructionShadeAbridged$') = \
+        'WindowConstructionShadeAbridged'
+
+    window_construction: WindowConstructionAbridged = Field(
+        ...,
+        description='A WindowConstructionAbridged object that serves as the '
+        '"switched off" version of the construction (aka. the "bare construction"). '
+        'The shade_material and shade_location will be used to modify this '
+        'starting construction.'
+    )
+
+    shade_material: str = Field(
+        ...,
+        min_length=1,
+        max_length=100,
+        description='Identifier of a An EnergyWindowMaterialShade or an '
+        'EnergyWindowMaterialBlind that serves as the shading layer for this '
+        'construction. This can also be an EnergyWindowMaterialGlazing, which '
+        'will indicate that the WindowConstruction has a dynamically-controlled '
+        'glass pane like an electrochromic window assembly.'
+    )
+
+    shade_location: ShadeLocation = Field(
+        ShadeLocation.interior,
+        description='Text to indicate where in the window assembly the shade_material '
+        'is located.  Note that the WindowConstruction must have at least one gas '
+        'gap to use the "Between" option. Also note that, for a WindowConstruction '
+        'with more than one gas gap, the "Between" option defaults to using the '
+        'inner gap as this is the only option that EnergyPlus supports.'
+    )
+
+    control_type: ControlType = Field(
+        ControlType.always_on,
+        description='Text to indicate how the shading device is controlled, which '
+        'determines when the shading is “on” or “off.”'
+    )
+
+    setpoint: float = Field(
+        None,
+        description='A number that corresponds to the specified control_type. '
+        'This can be a value in (W/m2), (C) or (W) depending upon the control type.'
+        'Note that this value cannot be None for any control type except "AlwaysOn."'
+    )
+
+    schedule: str = Field(
+        None,
+        min_length=1,
+        max_length=100,
+        description='An optional schedule identifier to be applied on top of the '
+        'control_type. If None, the control_type will govern all behavior of '
+        'the construction.'
+    )
+
+
+class WindowConstructionShade(WindowConstructionShadeAbridged):
+    """Construction for window objects (Aperture, Door)."""
+
+    type: constr(regex='^WindowConstructionShade$') = 'WindowConstructionShade'
+
+    window_construction: WindowConstruction = Field(
+        ...,
+        description='A WindowConstruction object that serves as the "switched off" '
+        'version of the construction (aka. the "bare construction"). '
+        'The shade_material and shade_location will be used to modify this '
+        'starting construction.'
+    )
+
+    shade_material: Union[
+        EnergyWindowMaterialShade, EnergyWindowMaterialBlind,
+        EnergyWindowMaterialGlazing
+    ] = Field(
+        ...,
+        description='Identifier of a An EnergyWindowMaterialShade or an '
+        'EnergyWindowMaterialBlind that serves as the shading layer for this '
+        'construction. This can also be an EnergyWindowMaterialGlazing, which '
+        'will indicate that the WindowConstruction has a dynamically-controlled '
+        'glass pane like an electrochromic window assembly.'
+    )
+
+    schedule: Union[ScheduleRuleset, ScheduleFixedInterval] = Field(
+        None,
+        description='An optional ScheduleRuleset or ScheduleFixedInterval to be '
+        'applied on top of the control_type. If None, the control_type will govern '
+        'all behavior of the construction.'
+    )
+
+
+class WindowConstructionDynamicAbridged(IDdEnergyBaseModel):
+    """Construction for window objects with an included shade layer."""
+
+    type: constr(regex='^WindowConstructionDynamicAbridged$') = \
+        'WindowConstructionDynamicAbridged'
+
+    constructions: List[WindowConstructionAbridged] = Field(
+        ...,
+        description='A list of WindowConstructionAbridged objects that define the '
+        'various states that the dynamic window can assume.'
+    )
+
+    schedule: str = Field(
+        ...,
+        min_length=1,
+        max_length=100,
+        description='An identifier for a control schedule that dictates which '
+        'constructions are active at given times throughout the simulation. The values '
+        'of the schedule should be integers and range from 0 to one less then the '
+        'number of constructions. Zero indicates that the first construction is active, '
+        'one indicates that the second on is active, etc. The schedule type limits '
+        'of this schedule should be "Control Level." If building custom schedule '
+        'type limits that describe a particular range of states, the type limits '
+        'should be "Discrete" and the unit type should be "Mode," "Control," or '
+        'some other fractional unit.'
+    )
+
+
+class WindowConstructionDynamic(IDdEnergyBaseModel):
+    """Construction for window objects with an included shade layer."""
+
+    type: constr(regex='^WindowConstructionDynamic$') = \
+        'WindowConstructionDynamic'
+
+    constructions: List[WindowConstruction] = Field(
+        ...,
+        description='A list of WindowConstruction objects that define the '
+        'various states that the dynamic window can assume.'
+    )
+
+    schedule: Union[ScheduleRuleset, ScheduleFixedInterval] = Field(
+        ...,
+        description='A control schedule that dictates which constructions '
+        'are active at given times throughout the simulation. The values of the '
+        'schedule should be integers and range from 0 to one less then the number '
+        'of constructions. Zero indicates that the first construction is active, '
+        'one indicates that the second on is active, etc. The schedule type limits '
+        'of this schedule should be "Control Level." If building custom schedule '
+        'type limits that describe a particular range of states, the type limits '
+        'should be "Discrete" and the unit type should be "Mode," "Control," or '
+        'some other fractional unit.'
+    )
+
+
+class ShadeConstruction(IDdEnergyBaseModel):
+    """Construction for Shade objects."""
+
+    type: constr(regex='^ShadeConstruction$') = 'ShadeConstruction'
+
+    solar_reflectance: float = Field(
+        0.2,
+        ge=0,
+        le=1,
+        description='A number for the solar reflectance of the construction.'
+    )
+
+    visible_reflectance: float = Field(
+        0.2,
+        ge=0,
+        le=1,
+        description='A number for the visible reflectance of the construction.'
+    )
+
+    is_specular: bool = Field(
+        default=False,
+        description='Boolean to note whether the reflection off the shade is diffuse '
+        '(False) or specular (True). Set to True if the construction is '
+        'representing a glass facade or a mirror material.'
+    )
+
+
+class AirBoundaryConstructionAbridged(IDdEnergyBaseModel):
+    """Construction for Air Boundary objects."""
+
+    type: constr(regex='^AirBoundaryConstructionAbridged$') = \
+        'AirBoundaryConstructionAbridged'
+
+    air_mixing_per_area: float = Field(
+        0.1,
+        ge=0,
+        description='A positive number for the amount of air mixing between Rooms '
+        'across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds '
+        'to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is '
+        'typical of what would be induced by a HVAC system.'
+    )
+
+    air_mixing_schedule: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier of a fractional schedule for the air mixing schedule '
+        'across the construction. If unspecified, an Always On schedule will be assumed.'
+    )
+
+
+class AirBoundaryConstruction(AirBoundaryConstructionAbridged):
+    """Construction for Air Boundary objects."""
+
+    type: constr(regex='^AirBoundaryConstruction$') = 'AirBoundaryConstruction'
+
+    air_mixing_schedule: Union[ScheduleRuleset, ScheduleFixedInterval] = Field(
+        default=None,
+        description='A fractional schedule as a ScheduleRuleset or '
+        'ScheduleFixedInterval for the air mixing schedule across '
+        'the construction. If unspecified, an Always On schedule will be assumed.'
+    )

honeybee_schema/energy/constructionset.py

@@ -0,0 +1,359 @@
+"""ConstructionSet Schema"""
+from pydantic import Field, constr
+from typing import Union
+
+from .._base import NoExtraBaseModel
+from ._base import IDdEnergyBaseModel
+from .construction import OpaqueConstruction, WindowConstruction, ShadeConstruction, \
+    AirBoundaryConstruction, WindowConstructionShade, WindowConstructionDynamic
+
+
+class _FaceSubSetAbridged(NoExtraBaseModel):
+    """A set of constructions for wall, floor, or roof assemblies."""
+
+    interior_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for faces with a Surface or '
+        'Adiabatic boundary condition.'
+    )
+
+    exterior_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for faces with an Outdoors '
+        'boundary condition.'
+    )
+
+    ground_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for faces with a Ground '
+        'boundary condition.'
+    )
+
+
+class WallConstructionSetAbridged(_FaceSubSetAbridged):
+    """A set of constructions for wall assemblies."""
+
+    type: constr(regex='^WallConstructionSetAbridged$') = \
+        'WallConstructionSetAbridged'
+
+
+class FloorConstructionSetAbridged(_FaceSubSetAbridged):
+    """A set of constructions for floor assemblies."""
+
+    type: constr(regex='^FloorConstructionSetAbridged$') = \
+        'FloorConstructionSetAbridged'
+
+
+class RoofCeilingConstructionSetAbridged(_FaceSubSetAbridged):
+    """A set of constructions for roof and ceiling assemblies."""
+
+    type: constr(regex='^RoofCeilingConstructionSetAbridged$') = \
+        'RoofCeilingConstructionSetAbridged'
+
+
+class _FaceSubSet(NoExtraBaseModel):
+    """A set of constructions for wall, floor, or roof assemblies."""
+
+    interior_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for walls with a Surface or '
+        'Adiabatic boundary condition.'
+    )
+
+    exterior_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for walls with an Outdoors '
+        'boundary condition.'
+    )
+
+    ground_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for walls with a Ground '
+        'boundary condition.'
+    )
+
+
+class WallConstructionSet(_FaceSubSet):
+    """A set of constructions for wall assemblies."""
+
+    type: constr(regex='^WallConstructionSet$') = 'WallConstructionSet'
+
+
+class FloorConstructionSet(_FaceSubSet):
+    """A set of constructions for floor assemblies."""
+
+    type: constr(regex='^FloorConstructionSet$') = 'FloorConstructionSet'
+
+
+class RoofCeilingConstructionSet(_FaceSubSet):
+    """A set of constructions for roof and ceiling assemblies."""
+
+    type: constr(regex='^RoofCeilingConstructionSet$') = 'RoofCeilingConstructionSet'
+
+
+class ApertureConstructionSetAbridged(NoExtraBaseModel):
+    """A set of constructions for aperture assemblies."""
+
+    type: constr(regex='^ApertureConstructionSetAbridged$') = \
+        'ApertureConstructionSetAbridged'
+
+    interior_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for all apertures with a '
+        'Surface boundary condition.'
+    )
+
+    window_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for apertures with an '
+        'Outdoors boundary condition, False is_operable property, and a Wall '
+        'face type for their parent face.'
+    )
+
+    skylight_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for apertures with a Outdoors '
+        'boundary condition, False is_operable property, and a RoofCeiling or '
+        'Floor face type for their parent face.'
+    )
+
+    operable_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for all apertures with an '
+        'Outdoors boundary condition and True is_operable property.'
+    )
+
+
+class ApertureConstructionSet(NoExtraBaseModel):
+    """A set of constructions for aperture assemblies."""
+
+    type: constr(regex='^ApertureConstructionSet$') = 'ApertureConstructionSet'
+
+    interior_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None, description='A WindowConstruction for all apertures with a '
+        'Surface boundary condition.'
+    )
+
+    window_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None, description='A WindowConstruction for apertures with an '
+        'Outdoors boundary condition, False is_operable property, and a Wall '
+        'face type for their parent face.'
+    )
+
+    skylight_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None,
+        description='A WindowConstruction for apertures with a Outdoors boundary '
+        'condition, False is_operable property, and a RoofCeiling or '
+        'Floor face type for their parent face.'
+    )
+
+    operable_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None,
+        description='A WindowConstruction for all apertures with an '
+        'Outdoors boundary condition and True is_operable property.'
+    )
+
+
+class DoorConstructionSetAbridged(NoExtraBaseModel):
+    """A set of constructions for door assemblies."""
+
+    type: constr(regex='^DoorConstructionSetAbridged$') = 'DoorConstructionSetAbridged'
+
+    interior_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for all opaque doors with a '
+        'Surface boundary condition.'
+    )
+
+    exterior_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for opaque doors with an '
+        'Outdoors boundary condition and a Wall face type for their parent face.'
+    )
+
+    overhead_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for an OpaqueConstruction for opaque doors with an '
+        'Outdoors boundary condition and a RoofCeiling or Floor type for '
+        'their parent face.'
+    )
+
+    exterior_glass_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for all glass doors with an '
+        'Outdoors boundary condition.'
+    )
+
+    interior_glass_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='Identifier for a WindowConstruction for all glass doors with a '
+        'Surface boundary condition.'
+    )
+
+
+class DoorConstructionSet(NoExtraBaseModel):
+    """A set of constructions for door assemblies."""
+
+    type: constr(regex='^DoorConstructionSet$') = 'DoorConstructionSet'
+
+    interior_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for all opaque doors with a '
+        'Surface boundary condition.'
+    )
+
+    exterior_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for opaque doors with an '
+        'Outdoors boundary condition and a Wall face type for their parent face.'
+    )
+
+    overhead_construction: OpaqueConstruction = Field(
+        default=None,
+        description='An OpaqueConstruction for opaque doors with an '
+        'Outdoors boundary condition and a RoofCeiling or Floor type for '
+        'their parent face.'
+    )
+
+    exterior_glass_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None,
+        description='A WindowConstruction for all glass doors with an '
+        'Outdoors boundary condition.'
+    )
+
+    interior_glass_construction: Union[
+        WindowConstruction, WindowConstructionShade, WindowConstructionDynamic
+    ] = Field(
+        default=None,
+        description='A WindowConstruction for all glass doors with a '
+        'Surface boundary condition.'
+    )
+
+
+class ConstructionSetAbridged(IDdEnergyBaseModel):
+    """A set of constructions for different surface types and boundary conditions."""
+
+    type: constr(regex='^ConstructionSetAbridged$') = 'ConstructionSetAbridged'
+
+    wall_set: WallConstructionSetAbridged = Field(
+        default=None,
+        description='A WallConstructionSetAbridged object for this ConstructionSet.'
+    )
+
+    floor_set: FloorConstructionSetAbridged = Field(
+        default=None,
+        description='A FloorConstructionSetAbridged object for this ConstructionSet.'
+    )
+
+    roof_ceiling_set: RoofCeilingConstructionSetAbridged = Field(
+        default=None,
+        description='A RoofCeilingConstructionSetAbridged object for this '
+        'ConstructionSet.'
+    )
+
+    aperture_set: ApertureConstructionSetAbridged = Field(
+        default=None,
+        description='A ApertureConstructionSetAbridged object for this ConstructionSet.'
+    )
+
+    door_set: DoorConstructionSetAbridged = Field(
+        default=None,
+        description='A DoorConstructionSetAbridged object for this ConstructionSet.'
+    )
+
+    shade_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='The identifier of a ShadeConstruction to set the reflectance '
+        'properties of all outdoor shades of all objects to which this '
+        'ConstructionSet is assigned.'
+    )
+
+    air_boundary_construction: str = Field(
+        default=None,
+        min_length=1,
+        max_length=100,
+        description='The identifier of an AirBoundaryConstruction or OpaqueConstruction '
+        'to set the properties of Faces with an AirBoundary type.'
+    )
+
+
+class ConstructionSet(ConstructionSetAbridged):
+    """A set of constructions for different surface types and boundary conditions."""
+
+    type: constr(regex='^ConstructionSet$') = 'ConstructionSet'
+
+    wall_set: WallConstructionSet = Field(
+        default=None,
+        description='A WallConstructionSet object for this ConstructionSet.'
+    )
+
+    floor_set: FloorConstructionSet = Field(
+        default=None,
+        description='A FloorConstructionSet object for this ConstructionSet.'
+    )
+
+    roof_ceiling_set: RoofCeilingConstructionSet = Field(
+        default=None,
+        description='A RoofCeilingConstructionSet object for this ConstructionSet.'
+    )
+
+    aperture_set: ApertureConstructionSet = Field(
+        default=None,
+        description='A ApertureConstructionSet object for this ConstructionSet.'
+    )
+
+    door_set: DoorConstructionSet = Field(
+        default=None,
+        description='A DoorConstructionSet object for this ConstructionSet.'
+    )
+
+    shade_construction: ShadeConstruction = Field(
+        default=None,
+        description='A ShadeConstruction to set the reflectance '
+        'properties of all outdoor shades of all objects to which this '
+        'ConstructionSet is assigned.'
+    )
+
+    air_boundary_construction: Union[
+        AirBoundaryConstruction, OpaqueConstruction
+    ] = Field(
+        default=None,
+        description='An AirBoundaryConstruction or OpaqueConstruction to set '
+        'the properties of Faces with an AirBoundary type.'
+    )