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

foxes/models/wake_models/induction/rankine_half_body.py

@@ -1,7 +1,7 @@
 import numpy as np
 
 from foxes.core import TurbineInductionModel
-from foxes.utils import uv2wd, wd2uv
+from foxes.utils import uv2wd, wd2uv, delta_wd
 import foxes.variables as FV
 import foxes.constants as FC
 
@@ -198,7 +198,7 @@ class RankineHalfBody(TurbineInductionModel):
         xs = -np.sqrt(m / (4 * ws + 1e-15))
 
         # set values out of body shape
-        st_sel = (ct > 0) & ((RHB_shape < -1) | (x < xs))
+        st_sel = (ct > 1e-8) & ((RHB_shape < -1) | (x < xs))
         if np.any(st_sel):
             # apply selection
             xyz = wake_coos[st_sel]
@@ -209,7 +209,7 @@ class RankineHalfBody(TurbineInductionModel):
             wake_deltas["V"][st_sel] += vel_factor * xyz[:, 1]
 
         # set values inside body shape
-        st_sel = (ct > 0) & (RHB_shape >= -1) & (x >= xs) & (x <= 0)
+        st_sel = (ct > 1e-8) & (RHB_shape >= -1) & (x >= xs) & (x <= 0)
         if np.any(st_sel):
             # apply selection
             xyz = np.zeros_like(wake_coos[st_sel])
@@ -270,4 +270,4 @@ class RankineHalfBody(TurbineInductionModel):
         new_wd = uv2wd(wind_vec)
         new_ws = np.linalg.norm(wind_vec, axis=-1)
         wake_deltas[FV.WS] += new_ws - amb_results[FV.WS]
-        wake_deltas[FV.WD] += new_wd - amb_results[FV.WD]
+        wake_deltas[FV.WD] += delta_wd(amb_results[FV.WD], new_wd)

foxes/models/wake_models/induction/rathmann.py

@@ -199,7 +199,7 @@ class Rathmann(TurbineInductionModel):
             return sin_alpha * sin_beta * (1 + x_R**2)
 
         # ws delta in front of rotor
-        sp_sel = (ct > 0) & (x_R <= 0)
+        sp_sel = (ct > 1e-8) & (x_R <= 0)
         if np.any(sp_sel):
             xr = x_R[sp_sel]
             a = self.induction.ct2a(ct[sp_sel])
@@ -209,7 +209,7 @@ class Rathmann(TurbineInductionModel):
         # ws delta behind rotor
         if not self.pre_rotor_only:
             # mirror -blockage in rotor plane
-            sp_sel = (ct > 0) & (x_R > 0) & (r_R > 1)
+            sp_sel = (ct > 1e-8) & (x_R > 0) & (r_R > 1)
             if np.any(sp_sel):
                 xr = x_R[sp_sel]
                 a = self.induction.ct2a(ct[sp_sel])

foxes/models/wake_models/induction/self_similar.py

@@ -214,7 +214,7 @@ class SelfSimilar(TurbineInductionModel):
         r_R = np.linalg.norm(wake_coos[..., 1:3], axis=-1) / R
 
         # select values
-        sp_sel = (ct > 0) & (x_R <= 0)  # upstream
+        sp_sel = (ct > 1e-8) & (x_R <= 0)  # upstream
         if np.any(sp_sel):
             # velocity eqn 10 from [1]
             xr = x_R[sp_sel]
@@ -225,7 +225,7 @@ class SelfSimilar(TurbineInductionModel):
 
         # set area behind to mirrored value EXCEPT for area behind turbine
         if not self.pre_rotor_only:
-            sp_sel = (ct > 0) & (x_R > 0) & (r_R > 1)
+            sp_sel = (ct > 1e-8) & (x_R > 0) & (r_R > 1)
             if np.any(sp_sel):
                 # velocity eqn 10 from [1]
                 xr = x_R[sp_sel]

foxes/models/wake_models/induction/vortex_sheet.py

@@ -183,7 +183,7 @@ class VortexSheet(TurbineInductionModel):
             downwind_index=downwind_index,
         )
 
-        sp_sel = (ct > 0) & (x <= 0)
+        sp_sel = (ct > 1e-8) & (x <= 0)
         ws_sel = ws[sp_sel]
         ct_sel = ct[sp_sel]
         r_sph_sel = r_sph[sp_sel]
@@ -203,7 +203,7 @@ class VortexSheet(TurbineInductionModel):
 
         if not self.pre_rotor_only:
             sp_sel = (
-                (ct > 0) & (x > 0) & (r > D / 2)
+                (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]

foxes/models/wake_models/ti/iec_ti.py

@@ -54,24 +54,27 @@ class IECTIWake(TopHatWakeModel):
 
         """
         super().__init__(superpositions={FV.TI: superposition}, induction=induction)
+        self.iec_type = iec_type
+        self.wake_k = None
 
-        if opening_angle is not None:
+        if opening_angle is None:
+            self.wake_k = WakeK(**wake_k)
+        else:
             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.wake_k = WakeK(**wake_k)
+            self._k = float(np.tan(np.deg2rad(opening_angle / 2.0)))
 
     def __repr__(self):
         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}, "
-        s += self.wake_k.repr() + ")"
+        s += f"({self.superpositions[FV.TI]}, induction={iname}"
+        if self.wake_k is not None:
+            s += ", " + self.wake_k.repr()
+        s += ")"
         return s
 
     def sub_models(self):
@@ -84,7 +87,7 @@ class IECTIWake(TopHatWakeModel):
             All sub models
 
         """
-        return [self.wake_k]
+        return [self.wake_k] if self.wake_k is not None else []
 
     def new_wake_deltas(self, algo, mdata, fdata, tdata):
         """
@@ -147,15 +150,29 @@ class IECTIWake(TopHatWakeModel):
             The wake radii, shape: (n_states, n_targets)
 
         """
-        k = self.wake_k(
-            FC.STATE_TARGET,
-            algo=algo,
-            fdata=fdata,
-            tdata=tdata,
-            upcast=False,
-            downwind_index=downwind_index,
-        )
-        return k * x
+        if self.wake_k is None:
+            return self._k * x
+        else:
+            D = self.get_data(
+                FV.D,
+                FC.STATE_TARGET,
+                lookup="w",
+                algo=algo,
+                fdata=fdata,
+                tdata=tdata,
+                downwind_index=downwind_index,
+                upcast=True,
+            )
+
+            k = self.wake_k(
+                FC.STATE_TARGET,
+                algo=algo,
+                fdata=fdata,
+                tdata=tdata,
+                upcast=True,
+                downwind_index=downwind_index,
+            )
+            return D / 2 + k * x
 
     def calc_centreline(
         self,

foxes/models/wake_models/top_hat.py

@@ -209,7 +209,7 @@ class TopHatWakeModel(AxisymmetricWakeModel):
         wake_r = self.calc_wake_radius(algo, mdata, fdata, tdata, downwind_index, x, ct)
 
         wdeltas = {}
-        st_sel = (ct > 0) & (x > 0) & np.any(r < wake_r[:, :, None], axis=2)
+        st_sel = (x > 1e-8) & (ct > 1e-8) & np.any(r < wake_r[:, :, None], axis=2)
         if np.any(st_sel):
             x = x[st_sel]
             r = r[st_sel]

foxes/models/wake_models/wind/bastankhah14.py

@@ -140,9 +140,9 @@ class Bastankhah2014(GaussianWakeModel):
             downwind_index=downwind_index,
             upcast=True,
         )
-        
+
         # select targets:
-        st_sel = (x > 0) & (ct > 0)
+        st_sel = (x > 1e-8) & (ct > 1e-8)
         if np.any(st_sel):
             # apply selection:
             x = x[st_sel]

foxes/models/wake_models/wind/bastankhah16.py

@@ -146,13 +146,13 @@ class Bastankhah2016Model(Model):
             The k parameter values, shape: (n_states, n_targets)
 
         """
-
         # store parameters:
         out = {self.PARS: self.pars}
         out[self.CHECK] = (
-            mdata[FC.STATE][0],
+            mdata.states_i0(counter=True),
+            mdata.n_states,
             downwind_index,
-            x.shape,
+            hash(x.tobytes()),
         )
 
         # get D:
@@ -180,7 +180,7 @@ class Bastankhah2016Model(Model):
         )
 
         # select targets:
-        st_sel = (x > 0) & (ct > 0.0)
+        st_sel = (x > 1e-8) & (ct > 1e-8)
         if np.any(st_sel):
             # get ws:
             ws = super().get_data(
@@ -329,7 +329,7 @@ class Bastankhah2016Model(Model):
 
         # update mdata:
         out[self.ST_SEL] = st_sel
-        mdata[self.MDATA_KEY] = out
+        mdata.add(self.MDATA_KEY, out, None)
 
     def has_data(self, mdata, downwind_index, x):
         """
@@ -352,9 +352,10 @@ class Bastankhah2016Model(Model):
 
         """
         check = (
-            mdata[FC.STATE][0],
+            mdata.states_i0(counter=True),
+            mdata.n_states,
             downwind_index,
-            x.shape,
+            hash(x.tobytes()),
         )
         return self.MDATA_KEY in mdata and mdata[self.MDATA_KEY][self.CHECK] == check
 

foxes/models/wake_models/wind/jensen.py

@@ -88,7 +88,7 @@ class JensenWake(TopHatWakeModel):
             fdata=fdata,
             tdata=tdata,
             downwind_index=downwind_index,
-            upcast=False,
+            upcast=True,
         )
 
         k = self.wake_k(

foxes/models/wake_models/wind/turbopark.py

@@ -160,7 +160,7 @@ class TurbOParkWake(GaussianWakeModel):
         )
 
         # select targets:
-        st_sel = (x > 1e-5) & (ct > 0.0)
+        st_sel = (x > 1e-8) & (ct > 1e-8)
         if np.any(st_sel):
             # apply selection:
             x = x[st_sel]
@@ -443,7 +443,7 @@ class TurbOParkWakeIX(GaussianWakeModel):
         )
 
         # select targets:
-        st_sel = (x > 1e-5) & (ct > 0.0)
+        st_sel = (x > 1e-8) & (ct > 1e-8)
         if np.any(st_sel):
             # apply selection:
             # x = x[st_sel]

foxes/output/__init__.py

@@ -16,5 +16,8 @@ from .slice_data import SliceData
 from .rotor_point_plots import RotorPointPlot
 from .state_turbine_table import StateTurbineTable
 
-from .flow_plots_2d import FlowPlots2D, SeqFlowAnimationPlugin
+from .flow_plots_2d import FlowPlots2D
+from .seq_plugins import SeqFlowAnimationPlugin, SeqWakeDebugPlugin
+
 from . import grids
+from . import seq_plugins

foxes/output/farm_layout.py

@@ -288,8 +288,6 @@ class FarmLayoutOutput(Output):
         """
         Writes the layout plot to file.
 
-        The kwargs are forwarded to self.get_figure
-
         Parameters
         ----------
         file_path: str
@@ -297,6 +295,8 @@ class FarmLayoutOutput(Output):
             for default
         fontsize: int
             Size of the turbine numbers
+        kwargs: dict, optional
+            Additional arguments for get_figure()
 
         """
 

foxes/output/flow_plots_2d/__init__.py

@@ -1,3 +1,2 @@
 from .flow_plots import FlowPlots2D
-from .seq_flow_ani_plugin import SeqFlowAnimationPlugin
 from .get_fig import get_fig

foxes/output/flow_plots_2d/flow_plots.py

@@ -482,6 +482,7 @@ class FlowPlots2D(SliceData):
         ret_im=False,
         animated=False,
         rotor_color=None,
+        precalc=False,
         **kwargs,
     ):
         """
@@ -527,6 +528,11 @@ class FlowPlots2D(SliceData):
             Switch for usage for an animation
         rotor_color: str, optional
             Indicate the rotor orientation by a colored line
+        precalc: bool or tuple
+            Flag for pre-calculation run, adding an additional
+            generator call before the actual plot generations,
+            yields data, states, gdata. The same tuple can be given
+            for avoiding its calculation and picking up from there.
         kwargs: dict, optional
             Additional parameters for SliceData.get_states_data_xy
 
@@ -546,15 +552,21 @@ class FlowPlots2D(SliceData):
         wdi = variables.index(FV.WD)
         wsi = variables.index(FV.WS)
 
-        data, states, gdata = self.get_states_data_xy(
-            variables=variables,
-            vmin={var: vmin} if vmin is not None else {},
-            vmax={var: vmax} if vmax is not None else {},
-            data_format="numpy",
-            ret_states=True,
-            ret_grid=True,
-            **kwargs,
-        )
+        if isinstance(precalc, (tuple, list)):
+            data, states, gdata = precalc
+        else:
+            data, states, gdata = self.get_states_data_xy(
+                variables=variables,
+                vmin={var: vmin} if vmin is not None else {},
+                vmax={var: vmax} if vmax is not None else {},
+                data_format="numpy",
+                ret_states=True,
+                ret_grid=True,
+                **kwargs,
+            )
+            if precalc:
+                yield data, states, gdata
+
         x_pos, y_pos, z_pos, __ = gdata
 
         # define wind vector arrows:
@@ -573,8 +585,12 @@ class FlowPlots2D(SliceData):
 
         # loop over states:
         for si, s in enumerate(states):
-            if animated and si > 0 and vmin is not None and vmax is not None:
+            if animated and si == 0:
+                vmin = vmin if vmin is not None else np.min(data[..., vi])
+                vmax = vmax if vmax is not None else np.max(data[..., vi])
+            elif animated and si > 0:
                 add_bar = False
+
             if not animated and title is None:
                 ttl = f"State {s}"
                 ttl += f", z =  {int(np.round(z_pos))} m"
@@ -652,6 +668,7 @@ class FlowPlots2D(SliceData):
         ret_im=False,
         animated=False,
         rotor_color=None,
+        precalc=False,
         **kwargs,
     ):
         """
@@ -699,6 +716,11 @@ class FlowPlots2D(SliceData):
             Switch for usage for an animation
         rotor_color: str, optional
             Indicate the rotor orientation by a colored line
+        precalc: bool or tuple
+            Flag for pre-calculation run, adding an additional
+            generator call before the actual plot generations,
+            yields data, states, gdata. The same tuple can be given
+            for avoiding its calculation and picking up from there.
         kwargs: dict, optional
             Additional parameters for SliceData.get_states_data_xz
 
@@ -718,16 +740,22 @@ class FlowPlots2D(SliceData):
         wdi = variables.index(FV.WD)
         wsi = variables.index(FV.WS)
 
-        data, states, gdata = self.get_states_data_xz(
-            variables=variables,
-            vmin={var: vmin} if vmin is not None else {},
-            vmax={var: vmax} if vmax is not None else {},
-            data_format="numpy",
-            ret_states=True,
-            ret_grid=True,
-            x_direction=x_direction,
-            **kwargs,
-        )
+        if isinstance(precalc, (tuple, list)):
+            data, states, gdata = precalc
+        else:
+            data, states, gdata = self.get_states_data_xz(
+                variables=variables,
+                vmin={var: vmin} if vmin is not None else {},
+                vmax={var: vmax} if vmax is not None else {},
+                data_format="numpy",
+                ret_states=True,
+                ret_grid=True,
+                x_direction=x_direction,
+                **kwargs,
+            )
+            if precalc:
+                yield data, states, gdata
+
         x_pos, y_pos, z_pos, __ = gdata
 
         # define wind vector arrows:
@@ -826,6 +854,7 @@ class FlowPlots2D(SliceData):
         ret_im=False,
         animated=False,
         rotor_color=None,
+        precalc=False,
         **kwargs,
     ):
         """
@@ -873,6 +902,11 @@ class FlowPlots2D(SliceData):
             Switch for usage for an animation
         rotor_color: str, optional
             Indicate the rotor orientation by a colored line
+        precalc: bool or tuple
+            Flag for pre-calculation run, adding an additional
+            generator call before the actual plot generations,
+            yields data, states, gdata. The same tuple can be given
+            for avoiding its calculation and picking up from there.
         kwargs: dict, optional
             Additional parameters for SliceData.get_states_data_yz
 
@@ -892,16 +926,22 @@ class FlowPlots2D(SliceData):
         wdi = variables.index(FV.WD)
         wsi = variables.index(FV.WS)
 
-        data, states, gdata = self.get_states_data_yz(
-            variables=variables,
-            vmin={var: vmin} if vmin is not None else {},
-            vmax={var: vmax} if vmax is not None else {},
-            data_format="numpy",
-            ret_states=True,
-            ret_grid=True,
-            x_direction=x_direction,
-            **kwargs,
-        )
+        if isinstance(precalc, (tuple, list)):
+            data, states, gdata = precalc
+        else:
+            data, states, gdata = self.get_states_data_yz(
+                variables=variables,
+                vmin={var: vmin} if vmin is not None else {},
+                vmax={var: vmax} if vmax is not None else {},
+                data_format="numpy",
+                ret_states=True,
+                ret_grid=True,
+                x_direction=x_direction,
+                **kwargs,
+            )
+            if precalc:
+                yield data, states, gdata
+
         x_pos, y_pos, z_pos, __ = gdata
 
         # define wind vector arrows: