feat(material): Adding Initial Energy Materials

honeybee_energy/lib/construction.py

@@ -3,7 +3,14 @@
 TODO: Make the decision on how we will be using OpenStudio standards to generate
 constructions and materials.
 """
-from honeybee_energy.construction import Construction
+from honeybee_energy.construction import OpaqueConstruction
+from honeybee_energy.material.opaque import EnergyMaterial
 
 # TODO(): add materials library and replace the libraries with real materials
-generic_wall = Construction('generic_wall', materials=[])
+concrete = EnergyMaterial('Concrete', 0.15, 2.31, 2322, 832)
+insulation = EnergyMaterial('Insulation', 0.05, 0.049, 265, 836)
+wall_gap = EnergyMaterial('Wall Air Gap', 0.1, 0.67, 1.2925, 1006.1)
+gypsum = EnergyMaterial('Gypsum', 0.0127, 0.16, 784.9, 830)
+
+generic_wall = OpaqueConstruction(
+        'Generic Wall', materials=[concrete, insulation, wall_gap, gypsum])

honeybee_energy/material/__init__.py

@@ -0,0 +1 @@
+"""honeybee-energy materials."""

honeybee_energy/material/_base.py

@@ -0,0 +1,121 @@
+# coding=utf-8
+"""Base energy material."""
+from __future__ import division
+
+from honeybee.typing import valid_ep_string
+
+import re
+
+
+class _EnergyMaterialBase(object):
+    """Base energy material.
+
+    Properties:
+        name
+    """
+    def __init__(self, name):
+        """Initialize energy material base.
+
+        Args:
+            name: Text string for material name. Must be <= 100 characters.
+                Can include spaces but special characters will be stripped out.
+        """
+        self.name = name
+
+    @property
+    def name(self):
+        """Get or set the text string for material name."""
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        self._name = valid_ep_string(name, 'material name')
+
+    def duplicate(self):
+        """Get a copy of this construction."""
+        return self.__copy__()
+
+    @staticmethod
+    def _parse_ep_string(ep_string, test_string=None):
+        """Parse an EnergyPlus material string into a tuple of values."""
+        ep_string = ep_string.strip()
+        if test_string is not None:
+            assert ep_string.startswith(test_string), 'Expected EnergyPlus {} ' \
+                'but received a differet object: {}'.format(test_string, ep_string)
+        ep_strings = ep_string.split(';')
+        assert len(ep_strings) == 2, 'Received more than one object in ep_string.'
+        ep_string = re.sub(r'!.*\n', '', ep_strings[0])
+        ep_strs = [e_str.strip() for e_str in ep_string.split(',')]
+        ep_strs.pop(0)  # remove the EnergyPlus object name
+        return ep_strs
+
+    @staticmethod
+    def _generate_ep_string(object_type, values, comments=None):
+        """Get an EnergyPlus string representation from values and comments."""
+        if comments is not None:
+            space_count = tuple((25 - len(str(n))) for n in values)
+            spaces = tuple(s_c * ' ' if s_c > 0 else ' ' for s_c in space_count)
+            ep_str = object_type + ',\n ' + '\n '.join(
+                '{},{}!- {}'.format(val, space, com) for val, space, com in
+                zip(values[:-1], spaces[:-1], comments[:-1]))
+            ep_str = ep_str + '\n {};{}!- {}'.format(
+                values[-1], spaces[-1], comments[-1])
+        else:
+            ep_str = object_type + ',\n ' + '\n '.join(
+                '{},'.format(val) for val in values[:-1])
+            ep_str = ep_str + '\n {};'.format(values[-1])
+        return ep_str
+
+    def __copy__(self):
+        return self.__class__(self.name)
+
+    def ToString(self):
+        """Overwrite .NET ToString."""
+        return self.__repr__()
+
+    def __repr__(self):
+        return 'Base Energy Material:\n{}'.format(self.name)
+
+
+class _EnergyMaterialOpaqueBase(_EnergyMaterialBase):
+    """Base energy material for all opaque material types."""
+    _is_window_material = False
+    ROUGHTYPES = ('VeryRough', 'Rough', 'MediumRough',
+                  'MediumSmooth', 'Smooth', 'VerySmooth')
+    RADIANCEROUGHTYPES = {'VeryRough': 0.3, 'Rough': 0.2, 'MediumRough': 0.15,
+                          'MediumSmooth': 0.1, 'Smooth': 0.05, 'VerySmooth': 0}
+
+    @property
+    def is_window_material(self):
+        """Boolean to note whether the material can be used for window surfaces."""
+        return False
+
+    def __repr__(self):
+        return 'Base Opaque Energy Material:\n{}'.format(self.name)
+
+
+class _EnergyMaterialWindowBase(_EnergyMaterialBase):
+    """Base energy material for all window material types."""
+
+    @property
+    def is_window_material(self):
+        """Boolean to note whether the material can be used for window surfaces."""
+        return True
+
+    @property
+    def is_glazing_material(self):
+        """Boolean to note whether the material is a glazing layer."""
+        return False
+
+    @property
+    def is_gas_material(self):
+        """Boolean to note whether the material is a gas gap layer."""
+        return False
+
+    @property
+    def is_shade_material(self):
+        """Boolean to note whether the material is a shade layer."""
+        return False
+
+    def __repr__(self):
+        return 'Base Window Energy Material:\n{}'.format(self.name)