Fix bug where max_raynolds_number was not set with Cigre601WithSolarRadiation model (#94)

Author: DavidSAmundsen

linerate/models/cigre207.py

@@ -35,9 +35,7 @@ def compute_joule_heating(
         )
 
     @_copy_method_docstring(ThermalModel)
-    def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_solar_heating(self) -> WattPerMeter:
         alpha_s = self.span.conductor.solar_absorptivity
         phi = self.span.latitude
         gamma_c = self.span.conductor_azimuth
@@ -74,9 +72,7 @@ def compute_solar_heating(
         )
 
     @_copy_method_docstring(ThermalModel)
-    def compute_convective_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_convective_cooling(self, conductor_temperature: Celsius) -> WattPerMeter:
         D = self.span.conductor.conductor_diameter
         d = self.span.conductor.outer_layer_strand_diameter
         V = self.weather.wind_speed
@@ -126,10 +122,11 @@ def compute_convective_cooling(
 
     @_copy_method_docstring(ThermalModel)
     def compute_radiative_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
+        conductor_temperature: Celsius,
     ) -> WattPerMeter:
         return super().compute_radiative_cooling(
-            conductor_temperature=conductor_temperature, current=current
+            conductor_temperature=conductor_temperature,
         )
 
     @_copy_method_docstring(ThermalModel)

linerate/models/cigre601.py

@@ -22,12 +22,14 @@
 
 
 class BaseCigre601(ThermalModel):
+    DEFAULT_MAX_REYNOLDS_NUMBER = 4000.0  # Max value of the angle correction in CIGRE601
+
     def __init__(
         self,
         span: Span,
         weather: BaseWeather,
         time: Date,
-        max_reynolds_number: Unitless = 4000.0,  # Max value of the angle correction in CIGRE601
+        max_reynolds_number: Unitless = DEFAULT_MAX_REYNOLDS_NUMBER,
     ):
         super().__init__(span, weather)
         self.time = time
@@ -49,7 +51,8 @@ def compute_joule_heating(
 
     @_copy_method_docstring(ThermalModel)
     def compute_convective_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
+        conductor_temperature: Celsius,
     ) -> WattPerMeter:
         D = self.span.conductor.conductor_diameter
         d = self.span.conductor.outer_layer_strand_diameter
@@ -105,10 +108,11 @@ def compute_convective_cooling(
 
     @_copy_method_docstring(ThermalModel)
     def compute_radiative_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
+        conductor_temperature: Celsius,
     ) -> WattPerMeter:
         return super().compute_radiative_cooling(
-            conductor_temperature=conductor_temperature, current=current
+            conductor_temperature=conductor_temperature,
         )
 
     def compute_temperature_gradient(
@@ -142,22 +146,22 @@ def compute_temperature_gradient(
 
 
 class Cigre601(BaseCigre601):
+    """Extension of the BaseCigre601 model that uses the solar radiation parametrisation in CIGRE601."""
+
     def __init__(
         self,
         span: Span,
         weather: Weather,
         time: Date,
-        max_reynolds_number: Unitless = 4000.0,  # Max value of the angle correction in CIGRE601
+        max_reynolds_number: Unitless = BaseCigre601.DEFAULT_MAX_REYNOLDS_NUMBER,
     ):
         self.span = span
         self.weather = weather
         self.time = time
         self.max_reynolds_number = max_reynolds_number
 
     @_copy_method_docstring(ThermalModel)
-    def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_solar_heating(self) -> WattPerMeter:
         alpha_s = self.span.conductor.solar_absorptivity
         F = self.weather.ground_albedo
         y = self.span.conductor_altitude
@@ -183,18 +187,22 @@ def compute_solar_heating(
 
 
 class Cigre601WithSolarRadiation(BaseCigre601):
-    """Extension of the Cigre601 model that accepts external solar radiation data for direct and diffuse solar
+    """Extension of the BaseCigre601 model that accepts external solar radiation data for direct and diffuse solar
     radiation."""
 
-    def __init__(self, span: Span, weather: WeatherWithSolarRadiation, time: Date):
+    def __init__(
+        self,
+        span: Span,
+        weather: WeatherWithSolarRadiation,
+        time: Date,
+        max_reynolds_number: Unitless = BaseCigre601.DEFAULT_MAX_REYNOLDS_NUMBER,
+    ):
         self.span = span
         self.weather = weather
         self.time = time
-        self.weather = weather
+        self.max_reynolds_number = max_reynolds_number
 
-    def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_solar_heating(self) -> WattPerMeter:
         alpha_s = self.span.conductor.solar_absorptivity
         F = self.weather.ground_albedo
         D = self.span.conductor.conductor_diameter

linerate/models/ieee738.py

@@ -34,7 +34,7 @@ def compute_joule_heating(
 
     @_copy_method_docstring(ThermalModel)
     def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
     ) -> WattPerMeter:
         alpha_s = self.span.conductor.solar_absorptivity  # alpha in IEEE
         phi = self.span.latitude  # Lat in IEEE
@@ -56,9 +56,7 @@ def compute_solar_heating(
         return ieee738.solar_heating.compute_solar_heating(alpha_s, Q_se, cos_theta, D)
 
     @_copy_method_docstring(ThermalModel)
-    def compute_convective_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_convective_cooling(self, conductor_temperature: Celsius) -> WattPerMeter:
         D = self.span.conductor.conductor_diameter  # D_0 in IEEE
         y = self.span.conductor_altitude  # H_e in IEEE
         V = self.weather.wind_speed  # V_w in IEEE
@@ -83,9 +81,7 @@ def compute_convective_cooling(
         return ieee738.convective_cooling.compute_convective_cooling(q_cf, q_cn)
 
     @_copy_method_docstring(ThermalModel)
-    def compute_radiative_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
-    ) -> WattPerMeter:
+    def compute_radiative_cooling(self, conductor_temperature: Celsius) -> WattPerMeter:
         return super().compute_radiative_cooling(
-            conductor_temperature=conductor_temperature, current=current
+            conductor_temperature=conductor_temperature,
         )

linerate/models/thermal_model.py

@@ -84,17 +84,10 @@ def compute_joule_heating(
 
     @abstractmethod
     def compute_solar_heating(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
     ) -> WattPerMeter:
         r"""Compute the solar heating, :math:`P_S~\left[\text{W}~\text{m}^{-1}\right]`.
 
-        Parameters
-        ----------
-        conductor_temperature:
-            :math:`T_\text{av}~\left[^\circ\text{C}\right]`. The average conductor temperature.
-        current:
-            :math:`I~\left[\text{A}\right]`. The current.
-
         Returns
         -------
         Union[float, float64, ndarray[Any, dtype[float64]]]
@@ -104,16 +97,15 @@ def compute_solar_heating(
 
     @abstractmethod
     def compute_convective_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
+        conductor_temperature: Celsius,
     ) -> WattPerMeter:
         r"""Compute the convective cooling, :math:`P_c~\left[\text{W}~\text{m}^{-1}\right]`.
 
         Parameters
         ----------
         conductor_temperature:
             :math:`T_\text{av}~\left[^\circ\text{C}\right]`. The average conductor temperature.
-        current:
-            :math:`I~\left[\text{A}\right]`. The current.
 
         Returns
         -------
@@ -124,16 +116,15 @@ def compute_convective_cooling(
 
     @abstractmethod
     def compute_radiative_cooling(
-        self, conductor_temperature: Celsius, current: Ampere
+        self,
+        conductor_temperature: Celsius,
     ) -> WattPerMeter:
         r"""Compute the radiative cooling, :math:`P_r~\left[\text{W}~\text{m}^{-1}\right]`.
 
         Parameters
         ----------
         conductor_temperature:
             :math:`T_\text{av}~\left[^\circ\text{C}\right]`. The average conductor temperature.
-        current:
-            :math:`I~\left[\text{A}\right]`. The current.
 
         Returns
         -------
@@ -163,9 +154,9 @@ def compute_heat_balance(self, conductor_temperature: Celsius, current: Ampere)
             :math:`P_J + P_s - P_c - P_r~\left[\text{W}~\text{m}^{-1}\right]`. The heat balance.
         """
         P_j = self.compute_joule_heating(conductor_temperature, current)
-        P_s = self.compute_solar_heating(conductor_temperature, current)
-        P_c = self.compute_convective_cooling(conductor_temperature, current)
-        P_r = self.compute_radiative_cooling(conductor_temperature, current)
+        P_s = self.compute_solar_heating()
+        P_c = self.compute_convective_cooling(conductor_temperature)
+        P_r = self.compute_radiative_cooling(conductor_temperature)
         return P_j + P_s - P_c - P_r
 
     def compute_info(
@@ -186,10 +177,10 @@ def compute_info(
             A dictionary with the magnitude of the different heating and cooling effects.
         """
         return {
-            "convective_cooling": self.compute_convective_cooling(conductor_temperature, current),
-            "radiative_cooling": self.compute_radiative_cooling(conductor_temperature, current),
+            "convective_cooling": self.compute_convective_cooling(conductor_temperature),
+            "radiative_cooling": self.compute_radiative_cooling(conductor_temperature),
             "joule_heating": self.compute_joule_heating(conductor_temperature, current),
-            "solar_heating": self.compute_solar_heating(conductor_temperature, current),
+            "solar_heating": self.compute_solar_heating(),
         }
 
     def compute_steady_state_ampacity(

linerate/units.py

@@ -12,6 +12,7 @@
 BoolOrBoolArray = Union[bool, np.bool_, npt.NDArray[np.bool_]]
 
 OhmPerMeter = Annotated[FloatOrFloatArray, "Ω/m"]
+OhmPerMeterPerCelsius = Annotated[FloatOrFloatArray, "Ω/(m °C)"]
 Ampere = Annotated[FloatOrFloatArray, "A"]
 Radian = Annotated[FloatOrFloatArray, "rad"]
 Degrees = Annotated[FloatOrFloatArray, "°"]

tests/acceptance_tests/test_cigre_ampacity_cases.py

@@ -4,37 +4,39 @@
 import pytest
 from pytest import approx
 
-import linerate
+from linerate.models.cigre601 import Cigre601
+from linerate.models.thermal_model import ThermalModel
+from linerate.types import Conductor, Span, Tower, Weather
 
 
-def test_example_a_convective_cooling(example_model_1_conductors):
-    assert example_model_1_conductors.compute_convective_cooling(100, None) == approx(77.6, abs=0.5)
+def test_example_a_convective_cooling(example_model_1_conductors: ThermalModel):
+    assert example_model_1_conductors.compute_convective_cooling(100) == approx(77.6, abs=0.5)
 
 
-def test_example_a_radiative_cooling(example_model_1_conductors):
-    assert example_model_1_conductors.compute_radiative_cooling(100, None) == approx(39.1, abs=0.5)
+def test_example_a_radiative_cooling(example_model_1_conductors: ThermalModel):
+    assert example_model_1_conductors.compute_radiative_cooling(100) == approx(39.1, abs=0.5)
 
 
-def test_example_a_solar_heating(example_model_1_conductors):
-    assert example_model_1_conductors.compute_solar_heating(100, None) == approx(27.2, abs=0.5)
+def test_example_a_solar_heating(example_model_1_conductors: ThermalModel):
+    assert example_model_1_conductors.compute_solar_heating() == approx(27.2, abs=0.5)
 
 
-def test_example_a_resistance(example_model_1_conductors):
-    assert example_model_1_conductors.compute_resistance(100, None) == approx(
+def test_example_a_resistance(example_model_1_conductors: ThermalModel):
+    assert example_model_1_conductors.compute_resistance(100, np.nan) == approx(
         9.3905e-5, abs=0.0001e-5
     )
 
 
-def test_example_a_ampacity(example_model_1_conductors):
+def test_example_a_ampacity(example_model_1_conductors: ThermalModel):
     # There are noticable roundoff errors in the report
     assert example_model_1_conductors.compute_steady_state_ampacity(100, tolerance=1e-8) == approx(
         976, abs=1.5
     )
 
 
 @pytest.fixture
-def drake_conductor_b():
-    return linerate.Conductor(
+def drake_conductor_b() -> Conductor:
+    return Conductor(
         core_diameter=10.4e-3,
         conductor_diameter=28.1e-3,
         outer_layer_strand_diameter=2.2e-3,
@@ -52,8 +54,8 @@ def drake_conductor_b():
 
 
 @pytest.fixture
-def example_weather_b():
-    return linerate.Weather(
+def example_weather_b() -> Weather:
+    return Weather(
         air_temperature=20,
         wind_direction=np.radians(80),  # Conductor azimuth is 0, so angle of attack is 80
         wind_speed=1.66,
@@ -63,51 +65,51 @@ def example_weather_b():
 
 
 @pytest.fixture()
-def example_span_b(drake_conductor_b):
-    start_tower = linerate.Tower(latitude=50 - 0.0045, longitude=0, altitude=500 - 88)
-    end_tower = linerate.Tower(latitude=50 + 0.0045, longitude=0, altitude=500 + 88)
-    return linerate.Span(
+def example_span_b(drake_conductor_b: Conductor) -> Span:
+    start_tower = Tower(latitude=50 - 0.0045, longitude=0, altitude=500 - 88)
+    end_tower = Tower(latitude=50 + 0.0045, longitude=0, altitude=500 + 88)
+    return Span(
         conductor=drake_conductor_b,
         start_tower=start_tower,
         end_tower=end_tower,
         num_conductors=1,
     )
 
 
-def test_example_span_b_has_correct_altitude(example_span_b):
+def test_example_span_b_has_correct_altitude(example_span_b: Span):
     assert example_span_b.conductor_altitude == approx(500, abs=0.5)
 
 
-def test_example_span_b_has_correct_inclination(example_span_b):
+def test_example_span_b_has_correct_inclination(example_span_b: Span):
     assert np.degrees(example_span_b.inclination) == approx(10, abs=0.5)
 
 
-def test_example_span_b_has_correct_latitude(example_span_b):
+def test_example_span_b_has_correct_latitude(example_span_b: Span):
     assert example_span_b.latitude == approx(50)
 
 
 @pytest.fixture()
-def example_model_b(example_span_b, example_weather_b):
-    return linerate.Cigre601(example_span_b, example_weather_b, np.datetime64("2016-10-03 14:00"))
+def example_model_b(example_span_b: Span, example_weather_b: Weather) -> Cigre601:
+    return Cigre601(example_span_b, example_weather_b, np.datetime64("2016-10-03 14:00"))
 
 
-def test_example_b_convective_cooling(example_model_b):
-    assert example_model_b.compute_convective_cooling(100, None) == approx(172.1, abs=0.5)
+def test_example_b_convective_cooling(example_model_b: ThermalModel):
+    assert example_model_b.compute_convective_cooling(100) == approx(172.1, abs=0.5)
 
 
-def test_example_b_radiative_cooling(example_model_b):
-    assert example_model_b.compute_radiative_cooling(100, None) == approx(54, abs=0.5)
+def test_example_b_radiative_cooling(example_model_b: ThermalModel):
+    assert example_model_b.compute_radiative_cooling(100) == approx(54, abs=0.5)
 
 
-def test_example_b_solar_heating(example_model_b):
-    assert example_model_b.compute_solar_heating(100, None) == approx(13.7, abs=0.5)
+def test_example_b_solar_heating(example_model_b: ThermalModel):
+    assert example_model_b.compute_solar_heating() == approx(13.7, abs=0.5)
 
 
-def test_example_b_resistance(example_model_b):
-    assert example_model_b.compute_resistance(100, None) == approx(9.3905e-5, abs=0.0001e-5)
+def test_example_b_resistance(example_model_b: ThermalModel):
+    assert example_model_b.compute_resistance(100, np.nan) == approx(9.3905e-5, abs=0.0001e-5)
 
 
-def test_example_b_ampacity(example_model_b):
+def test_example_b_ampacity(example_model_b: ThermalModel):
     # There are noticable roundoff errors in the report
     # There is a typo in the report, where it says that the ampacity is 1054, but it is 1504.
     assert example_model_b.compute_steady_state_ampacity(100, tolerance=1e-8) == approx(