__add__ function for Borehole class

Author: wouterpeere

pygfunction/borefield.py

@@ -110,6 +110,8 @@ def __ne__(
     def __add__(self,
                 other_field: Union[Borehole, List[Borehole], Self]) -> Self:
         """Add two borefields together"""
+        from .boreholes import Borehole
+
         if isinstance(other_field, Borehole):
             return Borefield.from_boreholes(self.to_boreholes() + [other_field])
         if isinstance(other_field, list):

pygfunction/boreholes.py

@@ -3,9 +3,13 @@
 
 import numpy as np
 from scipy.spatial.distance import pdist
+from typing import TYPE_CHECKING
 
 from .utilities import _initialize_figure, _format_axes, _format_axes_3d
 
+if TYPE_CHECKING:
+    from .borefield import Borefield
+
 
 class Borehole(object):
     """
@@ -242,6 +246,15 @@ def _segment_midpoints(self, nSegments, segment_ratios=None):
             + segment_ratios * self.H / 2
         return z
 
+    def __add__(self, other):
+        """
+        Adds two boreholes together to form a borefield
+        """
+        from .borefield import Borefield
+        if isinstance(other, self):
+            return Borefield.from_boreholes([self, other])
+        return other.__add__(self)
+
 
 class _EquivalentBorehole(object):
     """

tests/borefield_test.py

@@ -80,6 +80,7 @@ def test_borefield_add():
     borefield = gt.borefield.Borefield.rectangle_field(2, 1, 6, 6, 100, 1, 0.075)
     borefield_2 = gt.borefield.Borefield.from_boreholes([borehole, gt.boreholes.Borehole(110, 1, 0.075, 20, 15)])
     assert borefield + borehole == gt.borefield.Borefield.from_boreholes(borefield.to_boreholes() + [borehole])
+    assert borehole + borefield == gt.borefield.Borefield.from_boreholes(borefield.to_boreholes() + [borehole])
     assert borefield + [borehole] == gt.borefield.Borefield.from_boreholes(borefield.to_boreholes() + [borehole])
     assert borefield + borefield_2 == gt.borefield.Borefield.from_boreholes(borefield.to_boreholes()+borefield_2.to_boreholes())
 

tests/boreholes_test.py

@@ -307,3 +307,9 @@ def test_circle_field(N, R):
          len(field) == 1 or np.isclose(np.min(dis), B_min),
          len(field) == 1 or np.max(dis) <= (2 + 1e-6) * R,
          ])
+
+
+def test_add_boreholes():
+    borehole1 = gt.boreholes.Borehole(100, 1, 0.075, 0, 0)
+    borehole2 = gt.boreholes.Borehole(110, 1, 0.075, 0, 0)
+    assert gt.borefield.Borefield.from_boreholes([borehole1, borehole2]) == borehole1 + borehole2