foxes 0.7.2__py3-none-any.whl → 0.7.3__py3-none-any.whl

foxes/models/wake_models/ti/iec_ti.py

@@ -1,5 +1,6 @@
 import numpy as np
 
+from foxes.core import WakeK
 from foxes.models.wake_models.top_hat import TopHatWakeModel
 import foxes.variables as FV
 import foxes.constants as FC
@@ -21,11 +22,8 @@ class IECTIWake(TopHatWakeModel):
 
     Attributes
     ----------
-    opening_angle: float
-        The wake opening angle. The wake growth parameter k is calculated
-        based on the wake opening angle.
-    k_var: str
-        The variable name for k
+    wake_k: foxes.core.WakeK
+        Handler for the wake growth parameter k
 
     :group: models.wake_models.ti
 
@@ -36,8 +34,8 @@ class IECTIWake(TopHatWakeModel):
         superposition,
         opening_angle=21.6,
         iec_type="2019",
-        k_var=FV.K,
-        **kwargs,
+        induction="Betz",
+        **wake_k,
     ):
         """
         Constructor.
@@ -46,37 +44,48 @@ class IECTIWake(TopHatWakeModel):
         ----------
         superposition: str
             The TI wake superposition.
-        opening_angle: float
+        opening_angle: float, optional
             The wake opening angle. The wake growth parameter k is calculated
             based on the wake opening angle.
-        k_var: str
-            The variable name for k
-        kwargs: dict, optional
-            Additional parameters for the base class
+        iec_type: str
+            Either '2005' or '2019'/'Frandsen'
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
-        super().__init__(superpositions={FV.TI: superposition}, **kwargs)
+        super().__init__(superpositions={FV.TI: superposition}, induction=induction)
 
-        k = float(np.tan(np.deg2rad(opening_angle / 2.0)))
+        if opening_angle is not None:
+            if "k" in wake_k or "ka" in wake_k or "kb" in wake_k:
+                raise KeyError(
+                    f"Can handle 'opening_angle' or ('k', 'ka', 'kb') parameters, not both"
+                )
+            wake_k["k"] = float(np.tan(np.deg2rad(opening_angle / 2.0)))
 
         self.iec_type = iec_type
-        self.k_var = k_var
-        setattr(self, k_var, k)
+        self.wake_k = WakeK(**wake_k)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.TI]}, induction={iname}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += ")"
+        s += f"({self.superpositions[FV.TI]}, induction={iname}, "
+        s += self.wake_k.repr() + ")"
         return s
 
+    def sub_models(self):
+        """
+        List of all sub-models
+
+        Returns
+        -------
+        smdls: list of foxes.core.Model
+            All sub models
+
+        """
+        return [self.wake_k]
+
     def new_wake_deltas(self, algo, mdata, fdata, tdata):
         """
         Creates new empty wake delta arrays.
@@ -138,10 +147,8 @@ class IECTIWake(TopHatWakeModel):
             The wake radii, shape: (n_states, n_targets)
 
         """
-        k = self.get_data(
-            self.k_var,
+        k = self.wake_k(
             FC.STATE_TARGET,
-            lookup="sw",
             algo=algo,
             fdata=fdata,
             tdata=tdata,

foxes/models/wake_models/wind/bastankhah14.py

@@ -1,5 +1,6 @@
 import numpy as np
 
+from foxes.core import WakeK
 from foxes.models.wake_models.gaussian import GaussianWakeModel
 import foxes.variables as FV
 import foxes.constants as FC
@@ -18,28 +19,18 @@ class Bastankhah2014(GaussianWakeModel):
 
     Attributes
     ----------
-    k: float
-        The wake growth parameter k. If not given here
-        it will be searched in the farm data.
     sbeta_factor: float
         Factor multiplying sbeta
-    k_var: str
-        The variable name for k
     induction: foxes.core.AxialInductionModel or str
         The induction model
+    wake_k: foxes.core.WakeK
+        Handler for the wake growth parameter k
 
     :group: models.wake_models.wind
 
     """
 
-    def __init__(
-        self,
-        superposition,
-        k=None,
-        sbeta_factor=0.2,
-        k_var=FV.K,
-        induction="Madsen",
-    ):
+    def __init__(self, superposition, sbeta_factor=0.2, induction="Madsen", **wake_k):
         """
         Constructor.
 
@@ -47,37 +38,27 @@ class Bastankhah2014(GaussianWakeModel):
         ----------
         superposition: str
             The wind speed deficit superposition.
-        k: float, optional
-            The wake growth parameter k. If not given here
-            it will be searched in the farm data.
         sbeta_factor: float
             Factor multiplying sbeta
-        k_var: str
-            The variable name for k
         induction: foxes.core.AxialInductionModel or str
             The induction model
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
         super().__init__(superpositions={FV.WS: superposition})
 
         self.sbeta_factor = sbeta_factor
-        self.k_var = k_var
         self.induction = induction
-
-        setattr(self, k_var, k)
+        self.wake_k = WakeK(**wake_k)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.WS]}, induction={iname}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += ")"
+        s += f"({self.superpositions[FV.WS]}, induction={iname}, "
+        s += self.wake_k.repr() + ")"
         return s
 
     def sub_models(self):
@@ -90,7 +71,7 @@ class Bastankhah2014(GaussianWakeModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self.wake_k, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -180,10 +161,8 @@ class Bastankhah2014(GaussianWakeModel):
             )[st_sel]
 
             # get k:
-            k = self.get_data(
-                self.k_var,
+            k = self.wake_k(
                 FC.STATE_TARGET,
-                lookup="sw",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,

foxes/models/wake_models/wind/bastankhah16.py

@@ -1,7 +1,7 @@
 import numpy as np
 
 from foxes.models.wake_models.dist_sliced import DistSlicedWakeModel
-from foxes.core.model import Model
+from foxes.core import Model, WakeK
 import foxes.variables as FV
 import foxes.constants as FC
 
@@ -48,7 +48,7 @@ class Bastankhah2016Model(Model):
     SIGMA_Z_FAR = "sigma_z_far"
     DELTA_FAR = "delta_far"
 
-    def __init__(self, alpha=0.58, beta=0.07, induction="Madsen"):
+    def __init__(self, alpha, beta, induction):
         """
         Constructor.
 
@@ -401,14 +401,17 @@ class Bastankhah2016(DistSlicedWakeModel):
         The model for computing common data
     model_pars: dict
         Model parameters
-    K: float
-        The wake growth parameter k. If not given here
-        it will be searched in the farm data.
     YAWM: float
         The yaw misalignment YAWM. If not given here
         it will be searched in the farm data.
-    k_var: str
-        The variable name for k
+    alpha: float
+        model parameter used to determine onset of far wake region
+    beta: float
+        model parameter used to determine onset of far wake region
+    induction: foxes.core.AxialInductionModel or str
+        The induction model
+    wake_k: dict, optional
+        Parameters for the WakeK class
 
     :group: models.wake_models.wind
 
@@ -417,9 +420,10 @@ class Bastankhah2016(DistSlicedWakeModel):
     def __init__(
         self,
         superposition,
-        k=None,
-        k_var=FV.K,
-        **kwargs,
+        alpha=0.58,
+        beta=0.07,
+        induction="Madsen",
+        **wake_k,
     ):
         """
         Constructor.
@@ -428,9 +432,6 @@ class Bastankhah2016(DistSlicedWakeModel):
         ----------
         superposition: str
             The wind deficit superposition
-        k: float
-            The wake growth parameter k. If not given here
-            it will be searched in the farm data, by default None
         ct_max: float
             The maximal value for ct, values beyond will be limited
             to this number, by default 0.9999
@@ -438,32 +439,27 @@ class Bastankhah2016(DistSlicedWakeModel):
             model parameter used to determine onset of far wake region
         beta: float
             model parameter used to determine onset of far wake region
-        k_var: str
-            The variable name for k
-        kwargs: dict, optional
-            Additional parameters for the Bastankhah2016Model,
-            if not found in wake model
+        induction: foxes.core.AxialInductionModel or str
+            The induction model
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
         super().__init__(superpositions={FV.WS: superposition})
 
         self.model = None
-        self.model_pars = kwargs
-        self.k_var = k_var
+        self.alpha = alpha
+        self.beta = beta
+        self.induction = induction
+        self.wake_k = WakeK(**wake_k)
 
-        setattr(self, k_var, k)
         setattr(self, FV.YAWM, 0.0)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
-        iname = self.model_pars.get("induction", "Madsen")
+        iname = self.induction
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.WS]}, induction={iname}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += ")"
+        s += f"({self.superpositions[FV.WS]}, induction={iname}, "
+        s += self.wake_k.repr() + ")"
         return s
 
     def sub_models(self):
@@ -476,7 +472,7 @@ class Bastankhah2016(DistSlicedWakeModel):
             Names of all sub models
 
         """
-        return [self.model]
+        return [self.wake_k, self.model]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -493,7 +489,9 @@ class Bastankhah2016(DistSlicedWakeModel):
 
         """
         if not self.initialized:
-            self.model = Bastankhah2016Model(**self.model_pars)
+            self.model = Bastankhah2016Model(
+                alpha=self.alpha, beta=self.beta, induction=self.induction
+            )
         super().initialize(algo, verbosity, force)
 
     def calc_wakes_x_yz(
@@ -556,10 +554,8 @@ class Bastankhah2016(DistSlicedWakeModel):
             gamma *= np.pi / 180
 
             # get k:
-            k = self.get_data(
-                self.k_var,
+            k = self.wake_k(
                 FC.STATE_TARGET,
-                lookup="sw",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,

foxes/models/wake_models/wind/jensen.py

@@ -1,5 +1,4 @@
-import numpy as np
-
+from foxes.core import WakeK
 from foxes.models.wake_models.top_hat import TopHatWakeModel
 import foxes.variables as FV
 import foxes.constants as FC
@@ -11,17 +10,14 @@ class JensenWake(TopHatWakeModel):
 
     Attributes
     ----------
-    k: float, optional
-        The wake growth parameter k. If not given here
-        it will be searched in the farm data.
-    k_var: str
-        The variable name for k
+    wake_k: foxes.core.WakeK
+        Handler for the wake growth parameter k
 
     :group: models.wake_models.wind
 
     """
 
-    def __init__(self, superposition, k=None, k_var=FV.K, **kwargs):
+    def __init__(self, superposition, induction="Betz", **wake_k):
         """
         Constructor.
 
@@ -29,32 +25,22 @@ class JensenWake(TopHatWakeModel):
         ----------
         superposition: str
             The wind deficit superposition
-        k: float, optional
-            The wake growth parameter k. If not given here
-            it will be searched in the farm data.
-        k_var: str
-            The variable name for k
-        kwargs: dict, optional
-            Additional parameters for the base class
+        induction: foxes.core.AxialInductionModel or str
+            The induction model
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
-        super().__init__(superpositions={FV.WS: superposition}, **kwargs)
-
-        self.k_var = k_var
-        setattr(self, k_var, k)
+        super().__init__(superpositions={FV.WS: superposition}, induction=induction)
+        self.wake_k = WakeK(**wake_k)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.WS]}, induction={iname}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += ")"
+        s += f"({self.superpositions[FV.WS]}, induction={iname}, "
+        s += self.wake_k.repr() + ")"
         return s
 
     def calc_wake_radius(
@@ -105,10 +91,8 @@ class JensenWake(TopHatWakeModel):
             upcast=False,
         )
 
-        k = self.get_data(
-            self.k_var,
+        k = self.wake_k(
             FC.STATE_TARGET,
-            lookup="sw",
             algo=algo,
             fdata=fdata,
             tdata=tdata,

foxes/models/wake_models/wind/turbopark.py

@@ -1,5 +1,6 @@
 import numpy as np
 
+from foxes.core import WakeK
 from foxes.models.wake_models.gaussian import GaussianWakeModel
 import foxes.variables as FV
 import foxes.constants as FC
@@ -18,8 +19,6 @@ class TurbOParkWake(GaussianWakeModel):
 
     Attributes
     ----------
-    k: float
-        The wake growth parameter k.
     sbeta_factor: float
         Factor multiplying sbeta
     c1: float
@@ -28,6 +27,8 @@ class TurbOParkWake(GaussianWakeModel):
         Factor from Frandsen turbulence model
     induction: foxes.core.AxialInductionModel or str
         The induction model
+    wake_k: foxes.core.WakeK
+        Handler for the wake growth parameter k
 
     :group: models.wake_models.wind
 
@@ -36,12 +37,11 @@ class TurbOParkWake(GaussianWakeModel):
     def __init__(
         self,
         superposition,
-        k=None,
         sbeta_factor=0.25,
         c1=1.5,
         c2=0.8,
-        k_var=FV.K,
         induction="Madsen",
+        **wake_k,
     ):
         """
         Constructor.
@@ -50,19 +50,16 @@ class TurbOParkWake(GaussianWakeModel):
         ----------
         superposition: str
             The wind deficit superposition
-        k: float, optional
-            The wake growth parameter k. If not given here
-            it will be searched in the farm data.
         sbeta_factor: float
             Factor multiplying sbeta
         c1: float
             Factor from Frandsen turbulence model
         c2: float
             Factor from Frandsen turbulence model
-        k_var: str
-            The variable name for k
         induction: foxes.core.AxialInductionModel or str
             The induction model
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
         super().__init__(superpositions={FV.WS: superposition})
@@ -70,23 +67,16 @@ class TurbOParkWake(GaussianWakeModel):
         self.sbeta_factor = sbeta_factor
         self.c1 = c1
         self.c2 = c2
-        self.k_var = k_var
         self.induction = induction
-
-        setattr(self, k_var, k)
+        self.wake_k = WakeK(**wake_k)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.WS]}, induction={iname}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += ")"
+        s += f"({self.superpositions[FV.WS]}, induction={iname}, "
+        s += self.wake_k.repr() + ")"
         return s
 
     def sub_models(self):
@@ -99,7 +89,7 @@ class TurbOParkWake(GaussianWakeModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self.wake_k, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -198,20 +188,21 @@ class TurbOParkWake(GaussianWakeModel):
                 tdata=tdata,
                 downwind_index=downwind_index,
                 upcast=True,
-            )[st_sel]
+            )
 
             # get k:
-            k = self.get_data(
-                self.k_var,
+            k = self.wake_k(
                 FC.STATE_TARGET,
-                lookup="sw",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
                 upcast=True,
+                amb_ti=ati,
             )[st_sel]
 
+            ati = ati[st_sel]
+
             # calculate sigma:
             # beta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))
             a = self.induction.ct2a(ct)
@@ -270,20 +261,16 @@ class TurbOParkWakeIX(GaussianWakeModel):
     ----------
     dx: float
         The step size of the integral
-    k: float
-        The wake growth parameter k.
     sbeta_factor: float
         Factor multiplying sbeta
-    k_var: str
-        The variable name for k
-    ti_var:  str
-        The TI variable
     self_wake: bool
         Flag for considering only own wake in ti integral
     induction: foxes.core.AxialInductionModel or str
         The induction model
     ipars: dict
         Additional parameters for centreline integration
+    wake_k: foxes.core.WakeK
+        Handler for the wake growth parameter k
 
     :group: models.wake_models.wind
 
@@ -293,13 +280,11 @@ class TurbOParkWakeIX(GaussianWakeModel):
         self,
         superposition,
         dx,
-        k=None,
         sbeta_factor=0.25,
-        k_var=FV.K,
-        ti_var=FV.TI,
         self_wake=True,
         induction="Madsen",
-        **ipars,
+        ipars={},
+        **wake_k,
     ):
         """
         Constructor.
@@ -310,48 +295,35 @@ class TurbOParkWakeIX(GaussianWakeModel):
             The wind deficit superposition
         dx: float
             The step size of the integral
-        k: float, optional
-            The wake growth parameter k. If not given here
-            it will be searched in the farm data.
         sbeta_factor: float
             Factor multiplying sbeta
-        k_var: str
-            The variable name for k
-        ti_var:  str
-            The TI variable
         self_wake: bool
             Flag for considering only own wake in ti integral
         induction: foxes.core.AxialInductionModel or str
             The induction model
-        ipars: dict, optional
+        ipars: dict
             Additional parameters for centreline integration
+        wake_k: dict, optional
+            Parameters for the WakeK class
 
         """
         super().__init__(superpositions={FV.WS: superposition})
 
         self.dx = dx
         self.sbeta_factor = sbeta_factor
-        self.k_var = k_var
-        self.ti_var = ti_var
         self.ipars = ipars
         self._tiwakes = None
         self.self_wake = self_wake
         self.induction = induction
-
-        setattr(self, k_var, k)
+        self.wake_k = WakeK(**wake_k)
 
     def __repr__(self):
-        k = getattr(self, self.k_var)
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
         s = f"{type(self).__name__}"
-        s += f"({self.superpositions[FV.WS]}, induction={iname}, dx={self.dx}"
-        if k is None:
-            s += f", k_var={self.k_var}"
-        else:
-            s += f", {self.k_var}={k}"
-        s += f", ti_var={self.ti_var})"
+        s += f"({self.superpositions[FV.WS]}, induction={iname}, dx={self.dx}, "
+        s += self.wake_k.repr() + ")"
         return s
 
     def sub_models(self):
@@ -364,7 +336,7 @@ class TurbOParkWakeIX(GaussianWakeModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self.wake_k, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -411,11 +383,11 @@ class TurbOParkWakeIX(GaussianWakeModel):
         for w in algo.wake_models.values():
             if w is not self:
                 wdel = w.new_wake_deltas(algo, mdata, fdata, tdata)
-                if self.ti_var in wdel:
+                if self.wake_k.ti_var in wdel:
                     self._tiwakes.append(w)
-        if self.ti_var not in FV.amb2var and len(self._tiwakes) == 0:
+        if self.wake_k.ti_var not in FV.amb2var and len(self._tiwakes) == 0:
             raise KeyError(
-                f"Model '{self.name}': Missing wake model that computes wake delta for variable {self.ti_var}"
+                f"Model '{self.name}': Missing wake model that computes wake delta for variable {self.wake_k.ti_var}"
             )
 
         return super().new_wake_deltas(algo, mdata, fdata, tdata)
@@ -490,10 +462,8 @@ class TurbOParkWakeIX(GaussianWakeModel):
             )[st_sel]
 
             # get k:
-            k = self.get_data(
-                self.k_var,
+            k = self.wake_k(
                 FC.STATE_TARGET,
-                lookup="sw",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
@@ -514,7 +484,7 @@ class TurbOParkWakeIX(GaussianWakeModel):
                 mdata,
                 fdata,
                 downwind_index,
-                [self.ti_var],
+                [self.wake_k.ti_var],
                 x,
                 dx=self.dx,
                 wake_models=self._tiwakes,