foxes 0.5.0.2__py3-none-any.whl → 0.5.2__py3-none-any.whl

foxes/models/vertical_profiles/abl_log_ws.py

@@ -13,10 +13,32 @@ class ABLLogWsProfile(VerticalProfile):
     This profile picks the profile according to the mol value
     (neutral: mol = None or mol = 0)
 
+    Attributes
+    ----------
+    ustar_input: bool
+        Flag for using ustar as an input
+
     :group: models.vertical_profiles
 
     """
 
+    def __init__(self, *args, ustar_input=False, **kwargs):
+        """
+        Constructor.
+        
+        Parameters
+        ----------
+        args: tuple, optional
+            Additional arguments for VerticalProfile
+        ustar_input: bool
+            Flag for using ustar as an input
+        kwargs: dict, optional
+            Additional arguments for VerticalProfile
+
+        """
+        super().__init__(*args, **kwargs)
+        self.ustar_input = ustar_input
+
     def input_vars(self):
         """
         The input variables needed for the profile
@@ -28,7 +50,10 @@ class ABLLogWsProfile(VerticalProfile):
             The variable names
 
         """
-        return [FV.WS, FV.H, FV.Z0, FV.MOL]
+        if self.ustar_input:
+            return [FV.USTAR, FV.Z0, FV.MOL]
+        else:
+            return [FV.WS, FV.H, FV.Z0, FV.MOL]
 
     def calculate(self, data, heights):
         """
@@ -48,52 +73,59 @@ class ABLLogWsProfile(VerticalProfile):
             shape as heights
 
         """
-        ws = np.zeros_like(heights)
-        ws[:] = data[FV.WS]
-
-        h0 = np.zeros_like(heights)
-        h0[:] = data[FV.H]
 
         z0 = np.zeros_like(heights)
         z0[:] = data[FV.Z0]
 
         mol = np.zeros_like(heights)
         mol[:] = data[FV.MOL]
+        
+        if self.ustar_input:
+            ustar = data[FV.USTAR]
+        else:
+            ws = np.zeros_like(heights)
+            ws[:] = data[FV.WS]
+
+            h0 = np.zeros_like(heights)
+            h0[:] = data[FV.H]
 
         out = np.zeros_like(heights)
 
         # neutral profiles:
         sel = np.isnan(mol) | (mol == 0.0)
         if np.any(sel):
-            sws = ws[sel]
-            sh0 = h0[sel]
             sz0 = z0[sel]
             sh = heights[sel]
-            ustar = abl.neutral.ustar(sws, sh0, sz0, kappa=FC.KAPPA)
-            out[sel] = abl.neutral.calc_ws(sh, sz0, ustar, kappa=FC.KAPPA)
+            if self.ustar_input:
+                sus = ustar[sel]
+            else:
+                sus = abl.neutral.ustar(ws[sel], h0[sel], sz0, kappa=FC.KAPPA)
+            out[sel] = abl.neutral.calc_ws(sh, sz0, sus, kappa=FC.KAPPA)
 
         # stable profiles:
         sel = mol > 0.0
         if np.any(sel):
-            sws = ws[sel]
-            sh0 = h0[sel]
             sz0 = z0[sel]
             smo = mol[sel]
             sh = heights[sel]
-            ustar = abl.stable.ustar(sws, sh0, sz0, smo, kappa=FC.KAPPA)
+            if self.ustar_input:
+                sus = ustar[sel]
+            else:
+                sus = abl.stable.ustar(ws[sel], h0[sel], sz0, smo, kappa=FC.KAPPA)
             psi = abl.stable.psi(sh, smo)
-            out[sel] = abl.stable.calc_ws(sh, sz0, ustar, psi, kappa=FC.KAPPA)
+            out[sel] = abl.stable.calc_ws(sh, sz0, sus, psi, kappa=FC.KAPPA)
 
         # unstable profiles:
         sel = mol < 0.0
         if np.any(sel):
-            sws = ws[sel]
-            sh0 = h0[sel]
             sz0 = z0[sel]
             smo = mol[sel]
             sh = heights[sel]
-            ustar = abl.unstable.ustar(sws, sh0, sz0, smo, kappa=FC.KAPPA)
+            if self.ustar_input:
+                sus = ustar[sel]
+            else:
+                sus = abl.unstable.ustar(ws[sel], h0[sel], sz0, smo, kappa=FC.KAPPA)
             psi = abl.unstable.psi(sh, smo)
-            out[sel] = abl.unstable.calc_ws(sh, sz0, ustar, psi, kappa=FC.KAPPA)
+            out[sel] = abl.unstable.calc_ws(sh, sz0, sus, psi, kappa=FC.KAPPA)
 
         return out

foxes/models/wake_frames/yawed_wakes.py

@@ -1,7 +1,7 @@
 import numpy as np
 
 from foxes.core import WakeFrame
-from foxes.models.wake_models.wind.porte_agel import PorteAgelModel
+from foxes.models.wake_models.wind.bastankhah16 import Bastankhah2016Model
 import foxes.variables as FV
 import foxes.constants as FC
 from .rotor_wd import RotorWD
@@ -9,13 +9,19 @@ from .rotor_wd import RotorWD
 
 class YawedWakes(WakeFrame):
     """
-    Bend the wakes for yawed turbines.
+    Bend the wakes for yawed turbines, based on the
+    Bastankhah 2016 wake model
 
-    Based on Bastankhah & Porte-Agel, 2016, https://doi.org/10.1017/jfm.2016.595
+    Notes
+    -----
+    Reference: 
+    "Experimental and theoretical study of wind turbine wakes in yawed conditions"
+    Majid Bastankhah, Fernando Porté-Agel
+    https://doi.org/10.1017/jfm.2016.595
 
     Attributes
     ----------
-    model: PorteAgelModel
+    model: Bastankhah2016Model
         The model for computing common data
     K: float
         The wake growth parameter k. If not given here
@@ -65,7 +71,7 @@ class YawedWakes(WakeFrame):
         super().__init__()
 
         self.base_frame = base_frame
-        self.model = PorteAgelModel(ct_max, alpha, beta)
+        self.model = Bastankhah2016Model(ct_max, alpha, beta)
         self.k_var = k_var
 
         setattr(self, k_var, k)
@@ -143,20 +149,20 @@ class YawedWakes(WakeFrame):
         )
 
         # select targets:
-        sp_sel = self.model.get_data(PorteAgelModel.SP_SEL, mdata)
+        sp_sel = self.model.get_data(Bastankhah2016Model.SP_SEL, mdata)
         if np.any(sp_sel):
             # prepare:
             n_sp_sel = np.sum(sp_sel)
             ydef = np.zeros((n_sp_sel,), dtype=FC.DTYPE)
 
             # collect data:
-            near = self.model.get_data(PorteAgelModel.NEAR, mdata)
+            near = self.model.get_data(Bastankhah2016Model.NEAR, mdata)
             far = ~near
 
             # near wake:
             if np.any(near):
                 # collect data:
-                delta = self.model.get_data(PorteAgelModel.DELTA_NEAR, mdata)
+                delta = self.model.get_data(Bastankhah2016Model.DELTA_NEAR, mdata)
 
                 # set deflection:
                 ydef[near] = delta
@@ -164,7 +170,7 @@ class YawedWakes(WakeFrame):
             # far wake:
             if np.any(far):
                 # collect data:
-                delta = self.model.get_data(PorteAgelModel.DELTA_FAR, mdata)
+                delta = self.model.get_data(Bastankhah2016Model.DELTA_FAR, mdata)
 
                 # set deflection:
                 ydef[far] = delta

foxes/models/wake_models/induction/__init__.py

@@ -2,4 +2,4 @@
 Induction wake models
 """
 
-from .rankine_half_body import RHB
+from .rankine_half_body import RankineHalfBody

foxes/models/wake_models/induction/rankine_half_body.py

@@ -6,7 +6,7 @@ import foxes.variables as FV
 import foxes.constants as FC
 
 
-class RHB(WakeModel):
+class RankineHalfBody(WakeModel):
     """
     The Rankine half body induction wake model
 
@@ -18,11 +18,27 @@ class RHB(WakeModel):
 
     https://www.fnc.co.uk/media/o5eosxas/a-potential-flow-model-for-wind-turbine-induction-and-wind-farm-blockage.pdf
 
+    Attributes
+    ----------
+    ct_max: float
+        The maximal value for ct, values beyond will be limited
+        to this number
+
     :group: models.wake_models.induction
 
     """
 
     def __init__(self, ct_max=0.9999):
+        """
+        Constructor.
+        
+        Parameters
+        ----------
+        ct_max: float
+            The maximal value for ct, values beyond will be limited
+            to this number
+
+        """
         super().__init__()
         self.ct_max = ct_max
 
@@ -157,17 +173,28 @@ class RHB(WakeModel):
         # stagnation point condition
         xs = -np.sqrt(m / (4 * ws))
 
-        # select targets
-        sp_sel = (ct > 0) & ((RHB_shape <= -1) | (x < xs))
+        # set values out of body shape
+        sp_sel = (ct > 0) & ((RHB_shape < -1) | (x < xs))
         if np.any(sp_sel):
             # apply selection
-            xyz = wake_coos[sp_sel]
+            xyz = wake_coos[sp_sel]                
 
             # calc velocity components
             vel_factor = m[sp_sel] / (4 * np.linalg.norm(xyz, axis=-1) ** 3)
             wake_deltas["U"][sp_sel] += vel_factor * xyz[:, 0]
             wake_deltas["V"][sp_sel] += vel_factor * xyz[:, 1]
 
+        # set values inside body shape
+        sp_sel = (ct > 0) & (RHB_shape >= -1) & (x >= xs) & (x < 0)
+        if np.any(sp_sel):
+            # apply selection
+            xyz = np.zeros_like(wake_coos[sp_sel])
+            xyz[:, 0] = xs[sp_sel]                
+
+            # calc velocity components
+            vel_factor = m[sp_sel] / (4 * np.linalg.norm(xyz, axis=-1) ** 3)
+            wake_deltas["U"][sp_sel] += vel_factor * xyz[:, 0]
+
         return wake_deltas
 
     def finalize_wake_deltas(
@@ -212,9 +239,8 @@ class RHB(WakeModel):
 
         # add ambient result to wake deltas
         delta_uv = np.stack((wake_deltas["U"], wake_deltas["V"]), axis=2)
-        sel = np.linalg.norm(delta_uv, axis=-1) < ws0
-        wind_vec[sel] += delta_uv[sel]
-        del delta_uv, sel, ws0
+        wind_vec += delta_uv
+        del delta_uv, ws0
 
         # deduce WS and WD deltas:
         new_wd = uv2wd(wind_vec)

foxes/models/wake_models/ti/crespo_hernandez.py

@@ -9,7 +9,12 @@ class CrespoHernandezTIWake(TopHatWakeModel):
     """
     The Crespo and Hernandez TI empirical correlation
 
-    Source: https://doi.org/10.1016/0167-6105(95)00033-X
+    Notes
+    -----
+    Reference: 
+    "Turbulence characteristics in wind-turbine wakes"
+    A. Crespo, J. Hernandez
+    https://doi.org/10.1016/0167-6105(95)00033-X
 
     For the wake diameter we use Eqns. (17), (15), (4), (5) from
             doi:10.1088/1742-6596/625/1/012039

foxes/models/wake_models/ti/iec_ti.py

@@ -9,13 +9,15 @@ class IECTIWake(TopHatWakeModel):
     """
     The TI wake model from IEC-64100-1-2005-8 (2005):
 
-    source: http://orbit.dtu.dk/files/3750291/2009_31.pdf
+    Notes
+    -----
+    Reference: 
+    http://orbit.dtu.dk/files/3750291/2009_31.pdf
     v2: VolLuk: corrected implementation following: IEC-64100-1-2005-8
     (Appearently an error in the document by DTU)
 
     and the Frandsen wake TI model, from IEC-64100 (2019):
-
-    Source: http://orbit.dtu.dk/files/3750291/2009_31.pdf
+    http://orbit.dtu.dk/files/3750291/2009_31.pdf
 
     Attributes
     ----------

foxes/models/wake_models/wind/__init__.py

@@ -2,6 +2,6 @@
 Wind deficit wake models.
 """
 from .jensen import JensenWake
-from .bastankhah import BastankhahWake
+from .bastankhah14 import Bastankhah2014
+from .bastankhah16 import Bastankhah2016Model, Bastankhah2016
 from .turbopark import TurbOParkWake, TurbOParkWakeIX
-from .porte_agel import PorteAgelModel, PorteAgelWake

foxes/models/wake_models/wind/{bastankhah.py → bastankhah14.py}

@@ -5,14 +5,16 @@ import foxes.variables as FV
 import foxes.constants as FC
 
 
-class BastankhahWake(GaussianWakeModel):
+class Bastankhah2014(GaussianWakeModel):
     """
-    The Bastankhah wake model
+    The Bastankhah 2014 wake model
 
-    (https://doi.org/10.1016/j.renene.2014.01.002)
-    Modifications: In the calculation of the initial wake radius
-    a constant of 0.25 instead of 0.2 is used as it fits better
-    to the validation data
+    Notes
+    -----
+    Reference: 
+    "A new analytical model for wind-turbine wakes"
+    Majid Bastankhah, Fernando Porté-Agel
+    https://doi.org/10.1016/j.renene.2014.01.002
 
     Attributes
     ----------
@@ -32,7 +34,7 @@ class BastankhahWake(GaussianWakeModel):
     """
 
     def __init__(
-        self, superposition, k=None, sbeta_factor=0.25, ct_max=0.9999, k_var=FV.K
+        self, superposition, k=None, sbeta_factor=0.2, ct_max=0.9999, k_var=FV.K
     ):
         """
         Constructor.
@@ -188,13 +190,8 @@ class BastankhahWake(GaussianWakeModel):
             del x, k, sbeta, sblim
 
             # calculate amplitude:
-            if self.sbeta_factor < 0.25:
-                radicant = 1.0 - ct / (8 * (sigma / D) ** 2)
-                reals = radicant >= 0
-                ampld = -np.ones_like(radicant)
-                ampld[reals] = np.sqrt(radicant[reals]) - 1.0
-            else:
-                ampld = np.sqrt(1.0 - ct / (8 * (sigma / D) ** 2)) - 1.0
+            term = 1.0 - ct / (8 * (sigma / D) ** 2)
+            ampld = np.sqrt(np.where(term > 0, term, 0)) - 1
 
         # case no targets:
         else:

foxes/models/wake_models/wind/{porte_agel.py → bastankhah16.py}

@@ -6,12 +6,16 @@ import foxes.variables as FV
 import foxes.constants as FC
 
 
-class PorteAgelModel(Model):
+class Bastankhah2016Model(Model):
     """
     Common calculations for the wake model and the wake
     frame, such that code repetitions can be avoided.
 
-    Based on Bastankhah & Porte-Agel, 2016,
+    Notes
+    -----
+    Reference: 
+    "Experimental and theoretical study of wind turbine wakes in yawed conditions"
+    Majid Bastankhah, Fernando Porté-Agel
     https://doi.org/10.1017/jfm.2016.595
 
     Attributes
@@ -28,7 +32,7 @@ class PorteAgelModel(Model):
 
     """
 
-    MDATA_KEY = "PorteAgelModel"
+    MDATA_KEY = "Bastankhah2016Model"
     PARS = "pars"
     CHECK = "check"
     SP_SEL = "sp_sel"
@@ -355,16 +359,20 @@ class PorteAgelModel(Model):
         del mdata[self.MDATA_KEY]
 
 
-class PorteAgelWake(DistSlicedWakeModel):
+class Bastankhah2016(DistSlicedWakeModel):
     """
-    The Bastankhah PorteAgel wake model
+    The Bastankhah 2016 wake model
 
-    Based on Bastankhah & Porte-Agel, 2016,
+    Notes
+    -----
+    Reference: 
+    "Experimental and theoretical study of wind turbine wakes in yawed conditions"
+    Majid Bastankhah, Fernando Porté-Agel
     https://doi.org/10.1017/jfm.2016.595
 
     Attributes
     ----------
-    model: PorteAgelModel
+    model: Bastankhah2016Model
         The model for computing common data
     K: float
         The wake growth parameter k. If not given here
@@ -413,7 +421,7 @@ class PorteAgelWake(DistSlicedWakeModel):
         """
         super().__init__(superpositions={FV.WS: superposition})
 
-        self.model = PorteAgelModel(ct_max, alpha, beta)
+        self.model = Bastankhah2016Model(ct_max, alpha, beta)
         self.k_var = k_var
 
         setattr(self, k_var, k)
@@ -533,7 +541,7 @@ class PorteAgelWake(DistSlicedWakeModel):
             )
 
         # select targets:
-        sp_sel = self.model.get_data(PorteAgelModel.SP_SEL, mdata)
+        sp_sel = self.model.get_data(Bastankhah2016Model.SP_SEL, mdata)
         n_sp_sel = np.sum(sp_sel)
         wdeltas = {FV.WS: np.zeros((n_sp_sel, n_y_per_z), dtype=FC.DTYPE)}
         if np.any(sp_sel):
@@ -541,15 +549,15 @@ class PorteAgelWake(DistSlicedWakeModel):
             yz = yz[sp_sel]
 
             # collect data:
-            near = self.model.get_data(PorteAgelModel.NEAR, mdata)
+            near = self.model.get_data(Bastankhah2016Model.NEAR, mdata)
             far = ~near
 
             # near wake:
             if np.any(near):
                 # collect data:
-                ampl = self.model.get_data(PorteAgelModel.AMPL_NEAR, mdata)
-                r_pc = self.model.get_data(PorteAgelModel.R_PC, mdata)
-                s = self.model.get_data(PorteAgelModel.R_PC_S, mdata)
+                ampl = self.model.get_data(Bastankhah2016Model.AMPL_NEAR, mdata)
+                r_pc = self.model.get_data(Bastankhah2016Model.R_PC, mdata)
+                s = self.model.get_data(Bastankhah2016Model.R_PC_S, mdata)
 
                 # radial dependency:
                 r = np.linalg.norm(yz[near], axis=-1)
@@ -569,11 +577,11 @@ class PorteAgelWake(DistSlicedWakeModel):
                 yz = yz[far]
 
                 # collect data:
-                ampl = self.model.get_data(PorteAgelModel.AMPL_FAR, mdata)[:, None]
-                sigma_y = self.model.get_data(PorteAgelModel.SIGMA_Y_FAR, mdata)[
+                ampl = self.model.get_data(Bastankhah2016Model.AMPL_FAR, mdata)[:, None]
+                sigma_y = self.model.get_data(Bastankhah2016Model.SIGMA_Y_FAR, mdata)[
                     :, None
                 ]
-                sigma_z = self.model.get_data(PorteAgelModel.SIGMA_Z_FAR, mdata)[
+                sigma_z = self.model.get_data(Bastankhah2016Model.SIGMA_Z_FAR, mdata)[
                     :, None
                 ]
 

foxes/models/wake_models/wind/turbopark.py

@@ -9,6 +9,11 @@ class TurbOParkWake(GaussianWakeModel):
     """
     The TurbOPark wake model
 
+    Notes
+    -----
+    Reference: 
+    "Turbulence Optimized Park model with Gaussian wake profile"
+    J G Pedersen, E Svensson, L Poulsen and N G Nygaard
     https://iopscience.iop.org/article/10.1088/1742-6596/2265/2/022063/pdf
 
     Attributes
@@ -181,8 +186,6 @@ class TurbOParkWake(GaussianWakeModel):
 
             # calculate sigma:
             sbeta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))
-            # sblim = 1 / (np.sqrt(8) * self.sbeta_factor)
-            # sbeta[sbeta > sblim] = sblim
             epsilon = self.sbeta_factor * sbeta
 
             alpha = self.c1 * ati
@@ -208,20 +211,14 @@ class TurbOParkWake(GaussianWakeModel):
             del (
                 x,
                 sbeta,
-                # sblim,
                 alpha,
                 beta,
                 epsilon,
             )
 
-            # calculate amplitude, same as in Bastankha model (eqn 7)
-            if self.sbeta_factor < 0.25:
-                radicant = 1.0 - ct / (8 * (sigma / D) ** 2)
-                reals = radicant >= 0
-                ampld = -np.ones_like(radicant)
-                ampld[reals] = np.sqrt(radicant[reals]) - 1.0
-            else:
-                ampld = np.sqrt(1.0 - ct / (8 * (sigma / D) ** 2)) - 1.0
+            # calculate amplitude, same as in Bastankhah model (eqn 7)
+            term = 1.0 - ct / (8 * (sigma / D) ** 2)
+            ampld = np.sqrt(np.where(term > 0, term, 0)) - 1
 
         # case no targets:
         else:
@@ -428,8 +425,6 @@ class TurbOParkWakeIX(GaussianWakeModel):
 
             # calculate sigma:
             sbeta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))
-            # sblim = 1 / (np.sqrt(8) * self.sbeta_factor)
-            # sbeta[sbeta > sblim] = sblim
             epsilon = self.sbeta_factor * sbeta
 
             # get TI by integration along centre line:
@@ -452,18 +447,12 @@ class TurbOParkWakeIX(GaussianWakeModel):
             del (
                 x,
                 sbeta,
-                # sblim,
                 epsilon,
             )
 
-            # calculate amplitude, same as in Bastankha model (eqn 7)
-            if self.sbeta_factor < 0.25:
-                radicant = 1.0 - ct / (8 * (sigma / D) ** 2)
-                reals = radicant >= 0
-                ampld = -np.ones_like(radicant)
-                ampld[reals] = np.sqrt(radicant[reals]) - 1.0
-            else:
-                ampld = np.sqrt(1.0 - ct / (8 * (sigma / D) ** 2)) - 1.0
+            # calculate amplitude, same as in Bastankhah model (eqn 7)
+            term = 1.0 - ct / (8 * (sigma / D) ** 2)
+            ampld = np.sqrt(np.where(term > 0, term, 0)) - 1
 
         # case no targets:
         else:

foxes/models/wake_superpositions/__init__.py

@@ -1,8 +1,12 @@
 """
 Wake superposition models.
 """
-from .linear import LinearSuperposition
-from .quadratic import QuadraticSuperposition
-from .max import MaxSuperposition
-from .product import ProductSuperposition
-from .ti_superp import TISuperposition
+from .ws_linear import WSLinear
+from .ws_quadratic import WSQuadratic
+from .ws_pow import WSPow
+from .ws_max import WSMax
+from .ws_product import WSProduct
+from .ti_linear import TILinear
+from .ti_quadratic import TIQuadratic
+from .ti_pow import TIPow
+from .ti_max import TIMax