Merge pull request #328 from MassimoCimmino/maintenance/issue327_version-2-3-1

Maintenance/issue327 version 2 3 1

Author: MassimoCimmino

.github/workflows/test.yml

@@ -5,10 +5,12 @@ on:
     branches:
       - master
       - maintenance/2.2.x
+      - maintenance/2.3.x
   pull_request:
     branches:
       - master
       - maintenance/2.2.x
+      - maintenance/2.3.x
     types: [opened, synchronize, reopened]
 
 jobs:

CHANGELOG.md

@@ -1,5 +1,16 @@
 # History of changes
 
+## Version 2.3.1 (2025-08-04)
+
+### New features
+
+* [Pull Request 325](https://github.com/MassimoCimmino/pygfunction/pull/325) - Borefields and boreholes can now be concatenated using the `+` operator, e.g. using `new_field = field_1 + field_2`.
+* [Pull Request 326](https://github.com/MassimoCimmino/pygfunction/pull/326) - Introduced `gFunction.from_static_params` and `Network.from_static_params` methods. These methods facilitate the creation of `Network` objects and the evaluation of g-functions by automatically evaluating the required thermal resistances for the creation of `Pipe` objects.
+
+### Other changes
+
+* [Issue 319](https://github.com/MassimoCimmino/pygfunction/issues/319) - Created `solvers` module. `Solver` classes are moved out of the `gfunction` module and into the new module.
+
 ## Version 2.3 (2025-04-29)
 
 ### New features

doc/source/conf.py

@@ -76,7 +76,7 @@
 # The short X.Y version.
 version = u'2.3'
 # The full version, including alpha/beta/rc tags.
-release = u'2.3.1.dev0'
+release = u'2.3.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/modules.rst

@@ -14,4 +14,5 @@ Modules
    modules/media
    modules/networks
    modules/pipes
+   modules/solvers
    modules/utilities

doc/source/modules/solvers.rst

@@ -0,0 +1,9 @@
+.. solvers:
+
+**************
+Solvers Module
+**************
+
+.. automodule:: pygfunction.solvers
+    :members:
+    :show-inheritance:

pygfunction/__init__.py

@@ -7,5 +7,6 @@
     media,
     networks,
     pipes,
+    solvers,
     utilities,
 )

pygfunction/borefield.py

@@ -107,6 +107,42 @@ def __ne__(
         check = not self == other_field
         return check
 
+    def __add__(self,
+                other_field: Union[Borehole, List[Borehole], Self]) -> Self:
+        """Add two borefields together"""
+        if not isinstance(other_field, (Borehole, list, self.__class__)):
+            raise TypeError(
+                f'Expected Borefield, list or Borehole input;'
+                f' got {other_field}'
+                )
+        # List of boreholes
+        field = self.to_boreholes()
+        # Convert other_field to a list if it is a Borehole
+        if isinstance(other_field, Borehole):
+            other_field = [other_field]
+        # Convert borefield to a list if it is a Borefield
+        if isinstance(other_field, self.__class__):
+            other_field = other_field.to_boreholes()
+        return Borefield.from_boreholes(field + other_field)
+
+    def __radd__(self,
+                other_field: Union[Borehole, List[Borehole], Self]) -> Self:
+        """Add two borefields together"""
+        if not isinstance(other_field, (Borehole, list, self.__class__)):
+            raise TypeError(
+                f'Expected Borefield, list or Borehole input;'
+                f' got {other_field}'
+                )
+        # List of boreholes
+        field = self.to_boreholes()
+        # Convert other_field to a list if it is a Borehole
+        if isinstance(other_field, Borehole):
+            other_field = [other_field]
+        # Convert borefield to a list if it is a Borefield
+        if isinstance(other_field, self.__class__):
+            other_field = other_field.to_boreholes()
+        return Borefield.from_boreholes(other_field + field)
+
     def evaluate_g_function(
             self,
             alpha: float,

pygfunction/boreholes.py

@@ -1,8 +1,10 @@
 # -*- coding: utf-8 -*-
+from typing import Union
 import warnings
 
 import numpy as np
 from scipy.spatial.distance import pdist
+from typing_extensions import Self  # for compatibility with Python <= 3.10
 
 from .utilities import _initialize_figure, _format_axes, _format_axes_3d
 
@@ -54,6 +56,56 @@ def __repr__(self):
              f' orientation={self.orientation})')
         return s
 
+    def __add__(self, other: Union[Self, list]):
+        """
+        Adds two boreholes together to form a borefield
+        """
+        if not isinstance(other, (self.__class__, list)):
+            # Check if other is a borefield and try the operation using
+            # other.__radd__
+            try:
+                field = other.__radd__(self)
+            except:
+                # Invalid input
+                raise TypeError(
+                    f'Expected Borefield, list or Borehole input;'
+                    f' got {other}'
+                    )
+        elif isinstance(other, list):
+            # Create a borefield from the borehole and a list
+            from .borefield import Borefield
+            field = Borefield.from_boreholes([self] + other)
+        else:
+            # Create a borefield from the two boreholes
+            from .borefield import Borefield
+            field = Borefield.from_boreholes([self, other])
+        return field
+
+    def __radd__(self, other: Union[Self, list]):
+        """
+        Adds two boreholes together to form a borefield
+        """
+        if not isinstance(other, (self.__class__, list)):
+            # Check if other is a borefield and try the operation using
+            # other.__radd__
+            try:
+                field = other.__add__(self)
+            except:
+                # Invalid input
+                raise TypeError(
+                    f'Expected Borefield, list or Borehole input;'
+                    f' got {other}'
+                    )
+        elif isinstance(other, list):
+            # Create a borefield from the borehole and a list
+            from .borefield import Borefield
+            field = Borefield.from_boreholes(other + [self])
+        else:
+            # Create a borefield from the two boreholes
+            from .borefield import Borefield
+            field = Borefield.from_boreholes([other, self])
+        return field
+
     def distance(self, target):
         """
         Evaluate the distance between the current borehole and a target

pygfunction/enums.py

@@ -0,0 +1,21 @@
+from enum import Enum, auto
+from typing import Annotated
+
+
+class PipeType(Enum):
+    """Enumerator for pipe configuration type."""
+    COAXIAL_ANNULAR_IN: Annotated[
+        int, "Coaxial pipe (annular inlet)"
+        ] = auto()
+    COAXIAL_ANNULAR_OUT: Annotated[
+        int, "Coaxial pipe (annular outlet)"
+        ] = auto()
+    DOUBLE_UTUBE_PARALLEL: Annotated[
+        int, "Double U-tube (parallel)"
+        ] = auto()
+    DOUBLE_UTUBE_SERIES: Annotated[
+        int, "Double U-tube (series)"
+        ] = auto()
+    SINGLE_UTUBE: Annotated[
+        int, "Single U-tube"
+        ] = auto()