fix(model): Add a function with specific checks for EnergyPlus

honeybee_doe2/_extend_honeybee.py

@@ -19,6 +19,7 @@
 ModelProperties._doe2 = None
 RoomProperties._doe2 = None
 
+
 def model_doe2_properties(self):
     if self._doe2 is None:
         self._doe2 = ModelDoe2Properties(self.host)
@@ -30,6 +31,7 @@ def room_doe2_properties(self):
         self._doe2 = RoomDoe2Properties(self.host)
     return self._doe2
 
+
 # add doe2 property methods to the Properties classes
 ModelProperties.doe2 = property(model_doe2_properties)
 RoomProperties.doe2 = property(room_doe2_properties)

honeybee_doe2/properties/model.py

@@ -21,6 +21,73 @@ def host(self):
         """Get the Model object hosting these properties."""
         return self._host
 
+    def check_for_extension(self, raise_exception=True, detailed=False):
+        """Check that the Model is valid for DOE-2 simulation.
+
+        This process includes all relevant honeybee-core checks as well as checks
+        that apply only for DOE-2.
+
+        Args:
+            raise_exception: Boolean to note whether a ValueError should be raised
+                if any errors are found. If False, this method will simply
+                return a text string with all errors that were found. (Default: True).
+            detailed: Boolean for whether the returned object is a detailed list of
+                dicts with error info or a string with a message. (Default: False).
+
+        Returns:
+            A text string with all errors that were found or a list if detailed is True.
+            This string (or list) will be empty if no errors were found.
+        """
+        # set up defaults to ensure the method runs correctly
+        detailed = False if raise_exception else detailed
+        msgs = []
+        tol = self.host.tolerance
+        ang_tol = self.host.angle_tolerance
+
+        # perform checks for duplicate identifiers, which might mess with other checks
+        msgs.append(self.host.check_all_duplicate_identifiers(False, detailed))
+
+        # perform several checks for the Honeybee schema geometry rules
+        msgs.append(self.host.check_planar(tol, False, detailed))
+        msgs.append(self.host.check_self_intersecting(tol, False, detailed))
+        msgs.append(self.host.check_degenerate_rooms(tol, False, detailed))
+
+        # perform geometry checks related to parent-child relationships
+        msgs.append(self.host.check_sub_faces_valid(tol, ang_tol, False, detailed))
+        msgs.append(self.host.check_sub_faces_overlapping(tol, False, detailed))
+        msgs.append(self.host.check_rooms_solid(tol, ang_tol, False, detailed))
+        msgs.append(self.host.check_upside_down_faces(ang_tol, False, detailed))
+
+        # perform checks related to adjacency relationships
+        msgs.append(self.host.check_room_volume_collisions(tol, False, detailed))
+        msgs.append(self.host.check_missing_adjacencies(False, detailed))
+        msgs.append(self.host.check_matching_adjacent_areas(tol, False, detailed))
+        msgs.append(self.host.check_all_air_boundaries_adjacent(False, detailed))
+
+        # perform checks that are specific to DOE-2
+        # perform checks for duplicate identifiers
+        e_prop = self.host.properties.energy
+        msgs.append(e_prop.check_duplicate_material_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_construction_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_construction_set_identifiers(False, detailed))
+        msgs.append(
+            e_prop.check_duplicate_schedule_type_limit_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_schedule_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_program_type_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_hvac_identifiers(False, detailed))
+        msgs.append(e_prop.check_duplicate_shw_identifiers(False, detailed))
+        # perform checks for specific energy simulation rules
+        msgs.append(e_prop.check_interior_constructions_reversed(False, detailed))
+
+        # output a final report of errors or raise an exception
+        full_msgs = [msg for msg in msgs if msg]
+        if detailed:
+            return [m for msg in full_msgs for m in msg]
+        full_msg = '\n'.join(full_msgs)
+        if raise_exception and len(full_msgs) != 0:
+            raise ValueError(full_msg)
+        return full_msg
+
     def to_dict(self):
         """Return Model DOE-2 properties as a dictionary."""
         return {'doe2': {'type': 'ModelDoe2Properties'}}