foxes 1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

foxes/models/wake_models/induction/vortex_sheet.py

@@ -10,7 +10,10 @@ class VortexSheet(TurbineInductionModel):
     """
     The Vortex Sheet model implemented with a radial dependency
 
-    Ref: Medici, D., et al. "The upstream flow of a wind turbine: blockage effect." Wind Energy 14.5 (2011): 691-697.
+    Notes
+    -----
+    Reference:
+    Medici, D., et al. "The upstream flow of a wind turbine: blockage effect." Wind Energy 14.5 (2011): 691-697.
     https://doi.org/10.1002/we.451
 
     Attributes
@@ -24,29 +27,35 @@ class VortexSheet(TurbineInductionModel):
 
     """
 
-    def __init__(self, pre_rotor_only=False, induction="Madsen"):
+    def __init__(
+        self,
+        superposition="ws_linear",
+        induction="Madsen",
+        pre_rotor_only=False,
+    ):
         """
         Constructor.
 
         Parameters
         ----------
-        pre_rotor_only: bool
-            Calculate only the pre-rotor region
+        superposition: str
+            The wind speed superposition
         induction: foxes.core.AxialInductionModel or str
             The induction model
-
-        :group: models.wake_models.induction
+        pre_rotor_only: bool
+            Calculate only the pre-rotor region
 
         """
         super().__init__()
         self.induction = induction
         self.pre_rotor_only = pre_rotor_only
+        self._superp_name = superposition
 
     def __repr__(self):
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
-        return f"{type(self).__name__}, induction={iname})"
+        return f"{type(self).__name__}({self._superp_name}, induction={iname})"
 
     def sub_models(self):
         """
@@ -58,7 +67,7 @@ class VortexSheet(TurbineInductionModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self._superp, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -74,6 +83,7 @@ class VortexSheet(TurbineInductionModel):
             Overwrite existing data
 
         """
+        self._superp = algo.mbook.wake_superpositions[self._superp_name]
         if isinstance(self.induction, str):
             self.induction = algo.mbook.axial_induction[self.induction]
         super().initialize(algo, verbosity, force)
@@ -129,7 +139,7 @@ class VortexSheet(TurbineInductionModel):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         wake_coos: numpy.ndarray
             The wake frame coordinates of the evaluation
             points, shape: (n_states, n_targets, n_tpoints, 3)
@@ -159,18 +169,6 @@ class VortexSheet(TurbineInductionModel):
             downwind_index=downwind_index,
         )
 
-        # get ws
-        ws = self.get_data(
-            FV.REWS,
-            FC.STATE_TARGET_TPOINT,
-            lookup="w",
-            algo=algo,
-            fdata=fdata,
-            tdata=tdata,
-            upcast=True,
-            downwind_index=downwind_index,
-        )
-
         # get D
         D = self.get_data(
             FV.D,
@@ -184,44 +182,84 @@ class VortexSheet(TurbineInductionModel):
         )
 
         sp_sel = (ct > 1e-8) & (x <= 0)
-        ws_sel = ws[sp_sel]
         ct_sel = ct[sp_sel]
         r_sph_sel = r_sph[sp_sel]
         D_sel = D[sp_sel]
 
         if np.any(sp_sel):
-            blockage = (
-                ws_sel
-                * (
-                    1
-                    - self.induction.ct2a(ct_sel)
-                    * ((1 + 2 * r_sph_sel / D_sel) * (1 + (2 * r_sph_sel / D_sel) ** 2))
-                    ** (-0.5)
-                )
-            ) - ws_sel
-            wake_deltas[FV.WS][sp_sel] += blockage
+            blockage = self.induction.ct2a(ct_sel) * (
+                (1 + 2 * r_sph_sel / D_sel) * (1 + (2 * r_sph_sel / D_sel) ** 2)
+            ) ** (-0.5)
+
+            self._superp.add_wake(
+                algo,
+                mdata,
+                fdata,
+                tdata,
+                downwind_index,
+                sp_sel,
+                FV.WS,
+                wake_deltas[FV.WS],
+                -blockage,
+            )
 
         if not self.pre_rotor_only:
             sp_sel = (
                 (ct > 1e-8) & (x > 0) & (r > D / 2)
             )  # mirror in rotor plane and inverse blockage, but not directly behind rotor
-            ws_sel = ws[sp_sel]
             ct_sel = ct[sp_sel]
             r_sph_sel = r_sph[sp_sel]
             D_sel = D[sp_sel]
             if np.any(sp_sel):
-                blockage = (
-                    ws_sel
-                    * (
-                        1
-                        - self.induction.ct2a(ct_sel)
-                        * (
-                            (1 + 2 * r_sph_sel / D_sel)
-                            * (1 + (2 * r_sph_sel / D_sel) ** 2)
-                        )
-                        ** (-0.5)
-                    )
-                ) - ws_sel
-                wake_deltas[FV.WS][sp_sel] += -blockage
+                blockage = self.induction.ct2a(ct_sel) * (
+                    (1 + 2 * r_sph_sel / D_sel) * (1 + (2 * r_sph_sel / D_sel) ** 2)
+                ) ** (-0.5)
+
+                self._superp.add_wake(
+                    algo,
+                    mdata,
+                    fdata,
+                    tdata,
+                    downwind_index,
+                    sp_sel,
+                    FV.WS,
+                    wake_deltas[FV.WS],
+                    blockage,
+                )
 
         return wake_deltas
+
+    def finalize_wake_deltas(
+        self,
+        algo,
+        mdata,
+        fdata,
+        amb_results,
+        wake_deltas,
+    ):
+        """
+        Finalize the wake calculation.
+
+        Modifies wake_deltas on the fly.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        mdata: foxes.core.MData
+            The model data
+        fdata: foxes.core.FData
+            The farm data
+        amb_results: dict
+            The ambient results, key: variable name str,
+            values: numpy.ndarray with shape
+            (n_states, n_targets, n_tpoints)
+        wake_deltas: dict
+            The wake deltas object at the selected target
+            turbines. Key: variable str, value: numpy.ndarray
+            with shape (n_states, n_targets, n_tpoints)
+
+        """
+        wake_deltas[FV.WS] = self._superp.calc_final_wake_delta(
+            algo, mdata, fdata, FV.WS, amb_results[FV.WS], wake_deltas[FV.WS]
+        )

foxes/models/wake_models/ti/crespo_hernandez.py

@@ -278,8 +278,9 @@ class CrespoHernandezTIWake(TopHatWakeModel):
             fdata=fdata,
             tdata=tdata,
             downwind_index=downwind_index,
-            upcast=True,
-        )[st_sel]
+            upcast=False,
+            selection=st_sel,
+        )
 
         # get TI:
         ti = self.get_data(
@@ -290,8 +291,9 @@ class CrespoHernandezTIWake(TopHatWakeModel):
             fdata=fdata,
             tdata=tdata,
             downwind_index=downwind_index,
-            upcast=True,
-        )[st_sel]
+            upcast=False,
+            selection=st_sel,
+        )
 
         # calculate induction factor:
         twoa = 2 * self.induction.ct2a(ct)

foxes/models/wake_models/ti/iec_ti.py

@@ -169,7 +169,7 @@ class IECTIWake(TopHatWakeModel):
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
-                upcast=True,
+                upcast=False,
                 downwind_index=downwind_index,
             )
             return D / 2 + k * x
@@ -228,8 +228,9 @@ class IECTIWake(TopHatWakeModel):
             fdata=fdata,
             tdata=tdata,
             downwind_index=downwind_index,
-            upcast=True,
-        )[st_sel]
+            upcast=False,
+            selection=st_sel,
+        )
 
         # get ws:
         ws = self.get_data(
@@ -240,8 +241,9 @@ class IECTIWake(TopHatWakeModel):
             fdata=fdata,
             tdata=tdata,
             downwind_index=downwind_index,
-            upcast=True,
-        )[st_sel]
+            upcast=False,
+            selection=st_sel,
+        )
 
         # calculate wind deficit:
         if self.iec_type == "2005":

foxes/models/wake_models/wind/bastankhah14.py

@@ -157,8 +157,9 @@ class Bastankhah2014(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # get k:
             k = self.wake_k(
@@ -167,8 +168,9 @@ class Bastankhah2014(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # calculate sigma:
             # beta = 0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct)

foxes/models/wake_models/wind/bastankhah16.py

@@ -191,7 +191,8 @@ class Bastankhah2016Model(Model):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
+                upcast=False,
+                selection=st_sel,
             )
 
             # get TI:
@@ -203,7 +204,8 @@ class Bastankhah2016Model(Model):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
+                upcast=False,
+                selection=st_sel,
             )
 
             # get alpha:
@@ -215,7 +217,8 @@ class Bastankhah2016Model(Model):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
+                upcast=False,
+                selection=st_sel,
             )
 
             # get beta:
@@ -227,19 +230,16 @@ class Bastankhah2016Model(Model):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
+                upcast=False,
+                selection=st_sel,
             )
 
             # apply filter:
             x = x[st_sel]
             D = D[st_sel]
             ct = ct[st_sel]
-            ws = ws[st_sel]
-            ti = ti[st_sel]
             k = k[st_sel]
             gamma = gamma[st_sel]
-            alpha = alpha[st_sel]
-            beta = beta[st_sel]
 
             # calc theta_c0, Eq. (6.12):
             cosg = np.cos(gamma)
@@ -552,7 +552,7 @@ class Bastankhah2016(DistSlicedWakeModel):
                 upcast=True,
                 downwind_index=downwind_index,
             )
-            gamma *= np.pi / 180
+            gamma = gamma * np.pi / 180
 
             # get k:
             k = self.wake_k(

foxes/models/wake_models/wind/jensen.py

@@ -156,8 +156,9 @@ class JensenWake(TopHatWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
             / 2
         )
 

foxes/models/wake_models/wind/turbopark.py

@@ -175,8 +175,9 @@ class TurbOParkWake(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # get TI:
             ati = self.get_data(
@@ -187,7 +188,8 @@ class TurbOParkWake(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
+                upcast=False,
+                selection=st_sel,
             )
 
             # get k:
@@ -197,11 +199,10 @@ class TurbOParkWake(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
                 amb_ti=ati,
-            )[st_sel]
-
-            ati = ati[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # calculate sigma:
             # beta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))
@@ -458,8 +459,9 @@ class TurbOParkWakeIX(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # get k:
             k = self.wake_k(
@@ -468,8 +470,9 @@ class TurbOParkWakeIX(GaussianWakeModel):
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
 
             # calculate sigma:
             # beta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))

foxes/models/wake_superpositions/ti_linear.py

@@ -63,7 +63,7 @@ class TILinear(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ti_max.py

@@ -63,7 +63,7 @@ class TIMax(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ti_pow.py

@@ -70,7 +70,7 @@ class TIPow(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ti_quadratic.py

@@ -63,7 +63,7 @@ class TIQuadratic(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ws_linear.py

@@ -7,7 +7,7 @@ import foxes.constants as FC
 
 class WSLinear(WakeSuperposition):
     """
-    Linear supersposition of wind deficit results
+    Linear superposition of wind deficit results
 
     Attributes
     ----------
@@ -94,7 +94,7 @@ class WSLinear(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str
@@ -121,14 +121,15 @@ class WSLinear(WakeSuperposition):
         if np.any(st_sel):
             scale = self.get_data(
                 FV.AMB_REWS if self.scale_amb else FV.REWS,
-                FC.STATE_TARGET,
+                FC.STATE_TARGET_TPOINT,
                 lookup="w",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel, None]
+                upcast=False,
+                selection=st_sel,
+            )
 
             wake_delta[st_sel] += scale * wake_model_result
 
@@ -182,7 +183,7 @@ class WSLinear(WakeSuperposition):
 
 class WSLinearLocal(WakeSuperposition):
     """
-    Local linear supersposition of wind deficit results
+    Local linear superposition of wind deficit results
 
     Attributes
     ----------
@@ -261,7 +262,7 @@ class WSLinearLocal(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ws_max.py

@@ -7,7 +7,7 @@ import foxes.constants as FC
 
 class WSMax(WakeSuperposition):
     """
-    Max supersposition of wind deficit results
+    Max superposition of wind deficit results
 
     Attributes
     ----------
@@ -94,7 +94,7 @@ class WSMax(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str
@@ -121,14 +121,15 @@ class WSMax(WakeSuperposition):
         if np.any(st_sel):
             scale = self.get_data(
                 FV.AMB_REWS if self.scale_amb else FV.REWS,
-                FC.STATE_TARGET,
+                FC.STATE_TARGET_TPOINT,
                 lookup="w",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel, None]
+                upcast=False,
+                selection=st_sel,
+            )
 
             wake_model_result = np.abs(scale * wake_model_result)
             odelta = wake_delta[st_sel]
@@ -185,7 +186,7 @@ class WSMax(WakeSuperposition):
 
 class WSMaxLocal(WakeSuperposition):
     """
-    Local max supersposition of wind deficit results
+    Local max superposition of wind deficit results
 
     Attributes
     ----------
@@ -264,7 +265,7 @@ class WSMaxLocal(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ws_pow.py

@@ -7,7 +7,7 @@ import foxes.constants as FC
 
 class WSPow(WakeSuperposition):
     """
-    Power supersposition of wind deficit results
+    Power superposition of wind deficit results
 
     Attributes
     ----------
@@ -99,7 +99,7 @@ class WSPow(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str
@@ -126,14 +126,15 @@ class WSPow(WakeSuperposition):
         if np.any(st_sel):
             scale = self.get_data(
                 FV.AMB_REWS if self.scale_amb else FV.REWS,
-                FC.STATE_TARGET,
+                FC.STATE_TARGET_TPOINT,
                 lookup="w",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel, None]
+                upcast=False,
+                selection=st_sel,
+            )
 
             wake_delta[st_sel] += np.abs(scale * wake_model_result) ** self.pow
 
@@ -187,7 +188,7 @@ class WSPow(WakeSuperposition):
 
 class WSPowLocal(WakeSuperposition):
     """
-    Local power supersposition of wind deficit results
+    Local power superposition of wind deficit results
 
     Attributes
     ----------
@@ -272,7 +273,7 @@ class WSPowLocal(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/models/wake_superpositions/ws_product.py

@@ -7,7 +7,7 @@ import foxes.constants as FC
 
 class WSProduct(WakeSuperposition):
     """
-    Product supersposition of wind deficit results
+    Product superposition of wind deficit results
 
     This is based on the idea that the dimensionless
     wind deficit should be rescaled with the wake
@@ -95,7 +95,7 @@ class WSProduct(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str
@@ -119,10 +119,10 @@ class WSProduct(WakeSuperposition):
                 f"Superposition '{self.name}': Expecting wind speed variable, got {variable}"
             )
 
-        if np.any(st_sel):
-            if np.max(np.abs(wake_delta)) < 1e-14:
-                wake_delta[:] = 1
+        if np.max(np.abs(wake_delta)) < 1e-14:
+            wake_delta[:] = 1
 
+        if np.any(st_sel):
             wake_delta[st_sel] *= 1 + wake_model_result
 
         return wake_delta