Merge pull request #311 from wouterpeere/issue310-add-__repr__

Initial implementation

Author: wouterpeere

CHANGELOG.md

@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [2.3.1] - unpublished
 
+## Added
+
+- __repr__ for every class (issue #310).
+
 ## Fixed
 
 - Problem with optimise energy profile (issue #306).

GHEtool/Borefield.py

@@ -2007,3 +2007,14 @@ def calculate_quadrant(self) -> int:
             # limited by minimum temperature
             return 3
         return 2
+
+    def __repr__(self):
+        return f'Maximum average fluid temperature [-]: {self.Tf_max}\n' \
+               f'Minimum average fluid temperature [-]: {self.Tf_min}\n' \
+               f'Average buried depth [m]: {self.D}\n' \
+               f'Average borehole depth [m]: {self.H}\n' \
+               f'Borehole diameter [mm]: {self.r_b * 2000:.0f}\n' \
+               f'Number of boreholes [m]: {self.number_of_boreholes}\n' \
+               f'{self.ground_data.__repr__()}\n' \
+               f'{self.borehole.__repr__()}\n' \
+               f'{self.load.__repr__()}'

GHEtool/Examples/combined_active_and_passive_cooling.py

@@ -40,7 +40,7 @@ def default_cooling_in_summer():
     # set variables
     load.eer = eer
     borefield.load = load
-
+    print(borefield)
     borefield.print_temperature_profile(plot_hourly=True)
 
     # get active cooling data

GHEtool/VariableClasses/Borehole.py

@@ -12,7 +12,6 @@
 
 
 class Borehole(BaseClass):
-
     """
     The borehole class contains all the functionalities related to the calculation of the equivalent
     borehole thermal resistance and contains a fluid and pipe class object.
@@ -239,3 +238,8 @@ def __eq__(self, other):
             if getattr(self, i) != getattr(other, i):
                 return False
         return True
+
+    def __repr__(self):
+        if self.use_constant_Rb:
+            return f'Borehole effective thermal resistance [(m·K)/W]: {self.Rb}'
+        return 'Borehole parameters:\n' + self.fluid_data.__repr__() + '\n' + self.pipe_data.__repr__()

GHEtool/VariableClasses/Efficiency/COP.py

@@ -114,3 +114,8 @@ def get_SCOP(self,
         w_array = np.array(power) / cop_array
 
         return np.sum(power) / np.sum(w_array)
+
+    def __repr__(self):
+        if self._has_part_load:
+            return 'Temperature and part-load dependent COP'
+        return 'Temperature dependent COP'

GHEtool/VariableClasses/Efficiency/EER.py

@@ -115,3 +115,8 @@ def get_SEER(self,
         w_array = np.array(power) / eer_array
 
         return np.sum(power) / np.sum(w_array)
+
+    def __repr__(self):
+        if self._has_part_load:
+            return 'Temperature and part-load dependent EER'
+        return 'Temperature dependent EER'

GHEtool/VariableClasses/Efficiency/EERCombined.py

@@ -197,3 +197,11 @@ def __eq__(self, other) -> bool:
             return False
 
         return True
+
+    def __repr__(self):
+        temp = f'\nActive cooling:\n\t{self.efficiency_active_cooling.__repr__()}\nPassive cooling:\n\t{self.efficiency_passive_cooling.__repr__()}'
+        if self.threshold_temperature is not None:
+            temp += f'\nWith active cooling above [°C]: {self.threshold_temperature}'
+        if self.months_active_cooling is not None:
+            temp += f'\nWith active cooling in months [-]: {self.months_active_cooling}'
+        return temp

GHEtool/VariableClasses/Efficiency/SCOP.py

@@ -74,3 +74,6 @@ def get_COP(self, *args, **kwargs) -> float:
             float
         """
         return self.SCOP
+
+    def __repr__(self):
+        return f'SCOP [-]: {self.SCOP}'

GHEtool/VariableClasses/Efficiency/SEER.py

@@ -75,3 +75,6 @@ def get_EER(self, *args, **kwargs) -> float:
             float
         """
         return self.SEER
+
+    def __repr__(self):
+        return f'SEER [-]: {self.SEER}'

GHEtool/VariableClasses/FluidData.py

@@ -154,3 +154,14 @@ def __eq__(self, other):
             if getattr(self, i) != getattr(other, i):
                 return False
         return True
+
+    def __repr__(self):
+        temp = f'Fluid parameters\n\tThermal conductivity of the fluid [W/(m·K)]: {self.k_f}\n\t' \
+               f'Density of the fluid [kg/m³]: {self.rho}\n\t' \
+               f'Thermal capacity of the fluid [J/(kg·K)]: {self.Cp}\n\t' \
+               f'Dynamic viscosity [Pa·s]: {self.mu}\n\t'
+        if self._vfr is not None:
+            temp += f'Volume flow rate [l/s]: {self.vfr}'
+        else:
+            temp += f'Mass flow rate [kg/s] : {self.mfr}'
+        return temp