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

foxes/models/turbine_types/wsti2PCt_from_two.py

@@ -37,11 +37,11 @@ class WsTI2PCtFromTwo(TurbineType):
     rpars_ct: dict, optional
         Parameters for pandas ct file reading
     ipars_P: dict, optional
-        Parameters for scipy.interpolate.interpn()
+        Parameters for scipy.interpolate.interpn
     ipars_ct: dict, optional
-        Parameters for scipy.interpolate.interpn()
+        Parameters for scipy.interpolate.interpn
     rho: float
-        The air densitiy for which the data is valid
+        The air density for which the data is valid
         or None for no correction
 
     :group: models.turbine_types
@@ -73,7 +73,7 @@ class WsTI2PCtFromTwo(TurbineType):
         data_source_ct: str or pandas.DataFrame
             The file path for the ct curve, static name, or data
         rho: float, optional
-            The air densitiy for which the data is valid
+            The air density for which the data is valid
             or None for no correction
         p_ct: float
             The exponent for yaw dependency of ct
@@ -88,9 +88,9 @@ class WsTI2PCtFromTwo(TurbineType):
         pd_file_read_pars_ct:  dict
             Parameters for pandas ct file reading
         interpn_pars_P: dict, optional
-            Parameters for scipy.interpolate.interpn()
+            Parameters for scipy.interpolate.interpn
         interpn_pars_ct: dict, optional
-            Parameters for scipy.interpolate.interpn()
+            Parameters for scipy.interpolate.interpn
         parameters: dict, optional
             Additional parameters for TurbineType class
 
@@ -129,7 +129,7 @@ class WsTI2PCtFromTwo(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -141,7 +141,7 @@ class WsTI2PCtFromTwo(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -241,7 +241,7 @@ class WsTI2PCtFromTwo(TurbineType):
         print()
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/vertical_profiles/__init__.py

@@ -1,5 +1,5 @@
 """
-Verctical profile models.
+Vertical profile models.
 """
 
 from .uniform import UniformProfile

foxes/models/wake_frames/dynamic_wakes.py

@@ -120,7 +120,7 @@ class DynamicWakes(WakeFrame):
         self.UPDATE = self.var("update")
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -347,7 +347,7 @@ class DynamicWakes(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_frames/farm_order.py

@@ -69,7 +69,7 @@ class FarmOrder(WakeFrame):
         return [self.base_frame]
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -118,7 +118,7 @@ class FarmOrder(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_frames/rotor_wd.py

@@ -36,7 +36,7 @@ class RotorWD(WakeFrame):
         self.var_wd = var_wd
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -86,7 +86,7 @@ class RotorWD(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_frames/seq_dynamic_wakes.py

@@ -96,7 +96,7 @@ class SeqDynamicWakes(FarmOrder):
         )
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -142,7 +142,7 @@ class SeqDynamicWakes(FarmOrder):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------
@@ -230,7 +230,6 @@ class SeqDynamicWakes(FarmOrder):
         tdata,
         target,
         states0=None,
-        upcast=False,
     ):
         """
         Return data that is required for computing the
@@ -253,17 +252,12 @@ class SeqDynamicWakes(FarmOrder):
             FC.STATE_TARGET, FC.STATE_TARGET_TPOINT
         states0: numpy.ndarray, optional
             The states of wake creation
-        upcast: bool
-            Flag for ensuring targets dimension,
-            otherwise dimension 1 is entered
 
         Returns
         -------
         data: numpy.ndarray
             Data for wake modelling, shape:
             (n_states, n_turbines) or (n_states, n_target)
-        dims: tuple
-            The data dimensions
 
         """
         if states0 is None and FC.STATE_SOURCE_ORDERI in tdata:
@@ -288,9 +282,9 @@ class SeqDynamicWakes(FarmOrder):
                     data = data[:, :, 0]
                 else:
                     data = np.einsum("stp,p->st", data, tdata[FC.TWEIGHTS])
-                return data, (FC.STATE, FC.TARGET)
+                return data
             elif target == FC.STATE_TARGET_TPOINT:
-                return data, (FC.STATE, FC.TARGET, FC.TPOINT)
+                return data
             else:
                 raise ValueError(
                     f"Cannot handle target '{target}', choices are {FC.STATE_TARGET}, {FC.STATE_TARGET_TPOINT}"
@@ -298,7 +292,7 @@ class SeqDynamicWakes(FarmOrder):
 
         else:
             return super().get_wake_modelling_data(
-                algo, variable, downwind_index, fdata, tdata, target, states0, upcast
+                algo, variable, downwind_index, fdata, tdata, target, states0
             )
 
     def get_centreline_points(self, algo, mdata, fdata, downwind_index, x):

foxes/models/wake_frames/streamlines.py

@@ -165,7 +165,7 @@ class Streamlines2D(WakeFrame):
         return coos.reshape(n_states, n_targets, n_tpoints, 3)
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -230,7 +230,7 @@ class Streamlines2D(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_frames/timelines.py

@@ -264,7 +264,7 @@ class Timelines(WakeFrame):
             self.timelines_data = data.pop("data")
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -312,7 +312,7 @@ class Timelines(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_frames/yawed_wakes.py

@@ -137,7 +137,7 @@ class YawedWakes(WakeFrame):
         super().initialize(algo, verbosity, force)
 
     def calc_order(self, algo, mdata, fdata):
-        """ "
+        """
         Calculates the order of turbine evaluation.
 
         This function is executed on a single chunk of data,
@@ -177,7 +177,7 @@ class YawedWakes(WakeFrame):
             downwind_index=downwind_index,
             accept_nan=False,
         )
-        gamma *= np.pi / 180
+        gamma = gamma * np.pi / 180
 
         # get k:
         k = self.wake_k(
@@ -248,7 +248,7 @@ class YawedWakes(WakeFrame):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
 
         Returns
         -------

foxes/models/wake_models/dist_sliced.py

@@ -142,7 +142,7 @@ class DistSlicedWakeModel(WakeModel):
             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)

foxes/models/wake_models/induction/rankine_half_body.py

@@ -134,7 +134,7 @@ class RankineHalfBody(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)

foxes/models/wake_models/induction/rathmann.py

@@ -31,27 +31,35 @@ class Rathmann(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
+        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):
         """
@@ -63,7 +71,7 @@ class Rathmann(TurbineInductionModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self._superp, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -79,6 +87,7 @@ class Rathmann(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)
@@ -133,7 +142,7 @@ class Rathmann(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)
@@ -155,18 +164,6 @@ class Rathmann(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
         R = 0.5 * self.get_data(
             FV.D,
@@ -203,8 +200,19 @@ class Rathmann(TurbineInductionModel):
         if np.any(sp_sel):
             xr = x_R[sp_sel]
             a = self.induction.ct2a(ct[sp_sel])
-            blockage = ws[sp_sel] * a * mu(xr) * G(xr, r_R[sp_sel])  # eqn 10
-            wake_deltas[FV.WS][sp_sel] += -blockage
+            blockage = a * mu(xr) * G(xr, r_R[sp_sel])  # eqn 10
+
+            self._superp.add_wake(
+                algo,
+                mdata,
+                fdata,
+                tdata,
+                downwind_index,
+                sp_sel,
+                FV.WS,
+                wake_deltas[FV.WS],
+                -blockage,
+            )
 
         # ws delta behind rotor
         if not self.pre_rotor_only:
@@ -213,7 +221,53 @@ class Rathmann(TurbineInductionModel):
             if np.any(sp_sel):
                 xr = x_R[sp_sel]
                 a = self.induction.ct2a(ct[sp_sel])
-                blockage = ws[sp_sel] * a * mu(-xr) * G(-xr, r_R[sp_sel])  # eqn 10
-                wake_deltas[FV.WS][sp_sel] += blockage
+                blockage = a * mu(-xr) * G(-xr, r_R[sp_sel])  # eqn 10
+
+                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/induction/self_similar.py

@@ -38,30 +38,39 @@ class SelfSimilar(TurbineInductionModel):
 
     """
 
-    def __init__(self, pre_rotor_only=False, induction="Madsen", gamma=1.1):
+    def __init__(
+        self,
+        superposition="ws_linear",
+        induction="Madsen",
+        gamma=1.1,
+        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
         gamma: float, default=1.1
             The parameter that multiplies Ct in the ct2a calculation
+        pre_rotor_only: bool
+            Calculate only the pre-rotor region
 
         """
         super().__init__()
         self.induction = induction
         self.pre_rotor_only = pre_rotor_only
         self.gamma = gamma
+        self._superp_name = superposition
 
     def __repr__(self):
         iname = (
             self.induction if isinstance(self.induction, str) else self.induction.name
         )
-        return f"{type(self).__name__}(gamma={self.gamma}, induction={iname})"
+        return f"{type(self).__name__}({self._superp_name}, induction={iname}, gamma={self.gamma})"
 
     def sub_models(self):
         """
@@ -73,7 +82,7 @@ class SelfSimilar(TurbineInductionModel):
             All sub models
 
         """
-        return [self.induction]
+        return [self._superp, self.induction]
 
     def initialize(self, algo, verbosity=0, force=False):
         """
@@ -89,6 +98,7 @@ class SelfSimilar(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)
@@ -163,7 +173,7 @@ class SelfSimilar(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)
@@ -185,18 +195,6 @@ class SelfSimilar(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 R
         R = 0.5 * self.get_data(
             FV.D,
@@ -218,10 +216,19 @@ class SelfSimilar(TurbineInductionModel):
         if np.any(sp_sel):
             # velocity eqn 10 from [1]
             xr = x_R[sp_sel]
-            blockage = (
-                ws[sp_sel] * self._a(ct[sp_sel], xr) * self._rad_fn(xr, r_R[sp_sel])
+            blockage = self._a(ct[sp_sel], xr) * self._rad_fn(xr, r_R[sp_sel])
+
+            self._superp.add_wake(
+                algo,
+                mdata,
+                fdata,
+                tdata,
+                downwind_index,
+                sp_sel,
+                FV.WS,
+                wake_deltas[FV.WS],
+                -blockage,
             )
-            wake_deltas[FV.WS][sp_sel] -= blockage
 
         # set area behind to mirrored value EXCEPT for area behind turbine
         if not self.pre_rotor_only:
@@ -229,11 +236,54 @@ class SelfSimilar(TurbineInductionModel):
             if np.any(sp_sel):
                 # velocity eqn 10 from [1]
                 xr = x_R[sp_sel]
-                blockage = (
-                    ws[sp_sel]
-                    * self._a(ct[sp_sel], -xr)
-                    * self._rad_fn(-xr, r_R[sp_sel])
+                blockage = self._a(ct[sp_sel], -xr) * self._rad_fn(-xr, r_R[sp_sel])
+
+                # wdelta[sp_sel] += blockage
+                self._superp.add_wake(
+                    algo,
+                    mdata,
+                    fdata,
+                    tdata,
+                    downwind_index,
+                    sp_sel,
+                    FV.WS,
+                    wake_deltas[FV.WS],
+                    blockage,
                 )
-                wake_deltas[FV.WS][sp_sel] += 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]
+        )