foxes 0.8.2__py3-none-any.whl → 1.1.0.2__py3-none-any.whl

foxes/models/turbine_types/PCt_from_two.py

@@ -26,7 +26,7 @@ class PCtFromTwo(TurbineType):
     col_ct: str
         The ct column
     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
     WSCT: str
         The wind speed variable for ct lookup
@@ -76,7 +76,7 @@ class PCtFromTwo(TurbineType):
         col_ct: str
             The ct column
         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
@@ -126,6 +126,30 @@ class PCtFromTwo(TurbineType):
         a += f", var_ws_ct={self.WSCT}, var_ws_P={self.WSP}"
         return f"{type(self).__name__}({a})"
 
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self.WSCT == FV.REWS2 or self.WSP == FV.REWS2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self.WSCT == FV.REWS3 or self.WSP == FV.REWS3
+
     def output_farm_vars(self, algo):
         """
         The variables which are being modified by the model.
@@ -289,7 +313,7 @@ class PCtFromTwo(TurbineType):
             super().modify_cutin(modify_ct, modify_P)
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/TBL_file.py

@@ -0,0 +1,80 @@
+import numpy as np
+import pandas as pd
+from pathlib import Path
+
+from .PCt_file import PCtFile
+from foxes.data import parse_Pct_file_name
+import foxes.constants as FC
+
+
+class TBLFile(PCtFile):
+    """
+    Reads turbine data from a TBL file.
+
+    Examples
+    --------
+    A TBL file is a csv file with space as separator
+    and two header lines. The followind lines denote
+    wind speed, ct, P.
+
+    - first row will be ignored
+    - second row: H D ct-stand-still rated-power-in-MW
+    - further rows: ws ct P-in-kW
+
+    For example:
+
+    45
+    175.0 290.0 0.03 22.0
+    3.0 0.820 102.9
+    3.5 0.800 444.0
+    4.0 0.810 874.7
+    4.5 0.820 1418.7
+    5.0 0.820 2100.9
+    5.5 0.830 3021.2
+    6.0 0.830 3904.7
+    6.5 0.830 5061.7
+    7.0 0.810 6379.0
+
+    :group: models.turbine_types
+
+    """
+
+    def __init__(
+        self,
+        tbl_file,
+        rho=1.225,
+        **parameters,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        tbl_file: str
+            Path to the tbl file
+        rho: float
+            The air density for the curves
+        paramerers: dict, optional
+            Additional parameters for PCtFile class
+
+        """
+        fpath = Path(tbl_file)
+        assert fpath.suffix == ".tbl", f"Expecting *.tbl file, got '{tbl_file}'"
+
+        meta = np.genfromtxt(fpath, skip_header=1, max_rows=1)
+        sdata = pd.read_csv(
+            fpath, sep=" ", skiprows=2, header=None, names=["ws", "ct", "P"]
+        )
+
+        super().__init__(
+            sdata,
+            col_ws="ws",
+            col_P="P",
+            col_ct="ct",
+            H=meta[0],
+            D=meta[1],
+            P_nominal=meta[3] * 1e3,
+            P_unit="kW",
+            rho=rho,
+            **parameters,
+        )

foxes/models/turbine_types/__init__.py

@@ -9,3 +9,5 @@ from .CpCt_from_two import CpCtFromTwo
 from .null_type import NullType
 from .wsrho2PCt_from_two import WsRho2PCtFromTwo
 from .wsti2PCt_from_two import WsTI2PCtFromTwo
+from .lookup import FromLookupTable
+from .TBL_file import TBLFile

foxes/models/turbine_types/lookup.py

@@ -0,0 +1,316 @@
+import numpy as np
+import pandas as pd
+
+from foxes.core import TurbineType, FData
+from foxes.data import parse_Pct_file_name
+from foxes.models.turbine_models import LookupTable
+import foxes.variables as FV
+
+
+class FromLookupTable(TurbineType):
+    """
+    Calculate power and ct by interpolating
+    by using a lookup-table
+
+    Attributes
+    ----------
+    source: str or pandas.DataFrame
+        The file path, static name, or data
+    rho: float
+        The air density for which the data is valid
+        or None for no correction
+    WSCT: str
+        The wind speed variable for ct lookup
+    WSP: str
+        The wind speed variable for power lookup
+    rpars: dict, optional
+        Parameters for pandas file reading
+
+    :group: models.turbine_types
+
+    """
+
+    def __init__(
+        self,
+        data_source,
+        input_vars,
+        varmap={},
+        lookup_pars={},
+        rho=None,
+        p_ct=1.0,
+        p_P=1.88,
+        var_ws_ct=FV.REWS2,
+        var_ws_P=FV.REWS3,
+        pd_file_read_pars={},
+        interpn_args={},
+        **parameters,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        data_source: str or pandas.DataFrame
+            The file path, static name, or data
+        input_vars: list of str
+            The foxes input variables
+        varmap: dict
+            Mapping from foxes variable names
+            to column names in the data_source
+        lookup_pars: dict
+            Additional parameters for the LookupTable model
+        rho: float, optional
+            The air density for which the data is valid
+            or None for no correction
+        p_ct: float
+            The exponent for yaw dependency of ct
+        p_P: float
+            The exponent for yaw dependency of P
+        var_ws_ct: str
+            The wind speed variable for ct lookup
+        var_ws_P: str
+            The wind speed variable for power lookup
+        pd_file_read_pars: dict
+            Parameters for pandas file reading
+        interpn_args: dict
+            Parameters for scipy intern or interp1d
+        parameters: dict, optional
+            Additional parameters for TurbineType class
+
+        """
+        if not isinstance(data_source, pd.DataFrame):
+            pars = parse_Pct_file_name(data_source)
+            pars.update(parameters)
+        else:
+            pars = parameters
+
+        super().__init__(**pars)
+
+        self.source = data_source
+        self.rho = rho
+        self.p_ct = p_ct
+        self.p_P = p_P
+        self.WSCT = var_ws_ct
+        self.WSP = var_ws_P
+        self.rpars = pd_file_read_pars
+
+        if FV.REWS not in input_vars or len(
+            set(input_vars).intersection([FV.WS, FV.REWS2, FV.REWS3])
+        ):
+            raise KeyError(
+                f"Turbine type '{self.name}': Expecting '{FV.REWS}' as wind speed variable in inputv_vars, got {input_vars}"
+            )
+
+        iargs = dict(bounds_error=False, fill_value=0)
+        iargs.update(interpn_args)
+        self._lookup = LookupTable(
+            data_source=data_source,
+            input_vars=input_vars,
+            output_vars=[FV.P, FV.CT],
+            varmap=varmap,
+            interpn_args=iargs,
+            **lookup_pars,
+        )
+
+    def __repr__(self):
+        a = f"D={self.D}, H={self.H}, P_nominal={self.P_nominal}, P_unit={self.P_unit}, rho={self.rho}"
+        a += f", var_ws_ct={self.WSCT}, var_ws_P={self.WSP}"
+        return f"{type(self).__name__}({a})"
+
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self.WSCT == FV.REWS2 or self.WSP == FV.REWS2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self.WSCT == FV.REWS3 or self.WSP == FV.REWS3
+
+    def sub_models(self):
+        """
+        List of all sub-models
+
+        Returns
+        -------
+        smdls: list of foxes.core.Model
+            All sub models
+
+        """
+        return [self._lookup]
+
+    def output_farm_vars(self, algo):
+        """
+        The variables which are being modified by the model.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+
+        Returns
+        -------
+        output_vars: list of str
+            The output variable names
+
+        """
+        return [FV.P, FV.CT]
+
+    def initialize(self, algo, verbosity=0, force=False):
+        """
+        Initializes the model.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        verbosity: int
+            The verbosity level, 0 = silent
+        force: bool
+            Overwrite existing data
+
+        """
+        super().initialize(algo, verbosity, force)
+        if self.P_nominal is None:
+            col_P = self._lookup.varmap.get(FV.P, FV.P)
+            self.P_nominal = np.max(self._lookup._data[col_P].to_numpy())
+
+    def modify_cutin(
+        self,
+        modify_ct,
+        modify_P,
+        steps=20,
+        iterations=100,
+        a=0.55,
+        b=0.55,
+    ):
+        """
+        Modify the data such that a discontinuity
+        at cutin wind speed is avoided
+
+        Parameters
+        ----------
+        variable: str
+            The target variable
+        modify_ct: bool
+            Flag for modification of the ct curve
+        modify_P: bool
+            Flag for modification of the power curve
+        steps: int
+            The number of wind speed steps between 0 and
+            the cutin wind speed
+        iterations: int
+            The number of iterations
+        a: float
+            Coefficient for iterative mixing
+        b: float
+            Coefficient for iterative mixing
+
+        """
+        if modify_ct or modify_P:
+            raise NotImplementedError
+
+        else:
+            super().modify_cutin(modify_ct, modify_P)
+
+    def calculate(self, algo, mdata, fdata, st_sel):
+        """
+        The main model calculation.
+
+        This function is executed on a single chunk of data,
+        all computations should be based on numpy arrays.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        mdata: foxes.core.MData
+            The model data
+        fdata: foxes.core.FData
+            The farm data
+        st_sel: numpy.ndarray of bool
+            The state-turbine selection,
+            shape: (n_states, n_turbines)
+
+        Returns
+        -------
+        results: dict
+            The resulting data, keys: output variable str.
+            Values: numpy.ndarray with shape (n_states, n_turbines)
+
+        """
+        # prepare data for lookup:
+        input_vars = self._lookup.input_vars
+        fdata_lookup = FData(
+            data={v: fdata[v] for v in input_vars},
+            dims={v: fdata.dims[v] for v in input_vars},
+            loop_dims=fdata.loop_dims,
+        )
+        for v in self.output_farm_vars(algo):
+            fdata_lookup.add(v, fdata[v], fdata.dims[v])
+
+        rews2 = None
+        rews3 = None
+        if self.WSP != FV.REWS or self.WSCT != FV.REWS:
+            rews2 = fdata[self.WSCT].copy()
+            rews3 = fdata[self.WSP].copy()
+
+        # apply air density correction:
+        if self.rho is not None:
+            if rews2 is None:
+                rews2 = fdata[self.WSCT].copy()
+                rews3 = fdata[self.WSP].copy()
+
+            # correct wind speed by air density, such
+            # that in the partial load region the
+            # correct value is reconstructed:
+            rho = fdata[FV.RHO][st_sel]
+            rews3[st_sel] *= (self.rho / rho) ** (1.0 / 3.0)
+            del rho
+
+        # in yawed case, calc yaw corrected wind speed:
+        if FV.YAWM in fdata and (self.p_P is not None or self.p_ct is not None):
+            if rews2 is None:
+                rews2 = fdata[self.WSCT].copy()
+                rews3 = fdata[self.WSP].copy()
+
+            # calculate corrected wind speed wsc,
+            # gives ws**3 * cos**p_P in partial load region
+            # and smoothly deals with full load region:
+            yawm = fdata[FV.YAWM][st_sel]
+            if np.any(np.isnan(yawm)):
+                raise ValueError(
+                    f"{self.name}: Found NaN values for variable '{FV.YAWM}'. Maybe change order in turbine_models?"
+                )
+            cosm = np.cos(yawm / 180 * np.pi)
+            if self.p_ct is not None:
+                rews2[st_sel] *= (cosm**self.p_ct) ** 0.5
+            if self.p_P is not None:
+                rews3[st_sel] *= (cosm**self.p_P) ** (1.0 / 3.0)
+            del yawm, cosm
+
+        # run lookup:
+        if rews2 is None:
+            out = self._lookup.calculate(algo, mdata, fdata_lookup, st_sel)
+        else:
+            fdata_lookup[FV.REWS] = rews2
+            ct = self._lookup.calculate(algo, mdata, fdata_lookup, st_sel)[FV.CT]
+            fdata_lookup[FV.REWS] = rews3
+            out = self._lookup.calculate(algo, mdata, fdata_lookup, st_sel)
+            out[FV.CT] = ct
+
+        return out

foxes/models/turbine_types/null_type.py

@@ -9,6 +9,56 @@ class NullType(TurbineType):
 
     """
 
+    def __init__(
+        self,
+        *args,
+        needs_rews2=False,
+        needs_rews3=False,
+        **kwargs,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        args: tuple, optional
+            Additional parameters for TurbineType class
+        needs_rews2: bool
+            Flag for runs that require the REWS2 variable
+        needs_rews3: bool
+            Flag for runs that require the REWS3 variable
+        kwargs: dict, optional
+            Additional parameters for TurbineType class
+
+        """
+        super().__init__(*args, **kwargs)
+        self._rews2 = needs_rews2
+        self._rews3 = needs_rews3
+
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self._rews2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self._rews3
+
     def output_farm_vars(self, algo):
         """
         The variables which are being modified by the model.
@@ -27,7 +77,7 @@ class NullType(TurbineType):
         return []
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/wsrho2PCt_from_two.py

@@ -37,9 +37,9 @@ class WsRho2PCtFromTwo(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
 
     :group: models.turbine_types
 
@@ -81,9 +81,9 @@ class WsRho2PCtFromTwo(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
 
@@ -115,6 +115,30 @@ class WsRho2PCtFromTwo(TurbineType):
         self._P = None
         self._ct = None
 
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self.WSCT == FV.REWS2 or self.WSP == FV.REWS2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self.WSCT == FV.REWS3 or self.WSP == FV.REWS3
+
     def output_farm_vars(self, algo):
         """
         The variables which are being modified by the model.
@@ -205,7 +229,7 @@ class WsRho2PCtFromTwo(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/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
 
@@ -127,6 +127,30 @@ class WsTI2PCtFromTwo(TurbineType):
         a = f"D={self.D}, H={self.H}, P_nominal={self.P_nominal}, P_unit={self.P_unit}, rho={self.rho}"
         return f"{type(self).__name__}({a})"
 
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self.WSCT == FV.REWS2 or self.WSP == FV.REWS2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self.WSCT == FV.REWS3 or self.WSP == FV.REWS3
+
     def output_farm_vars(self, algo):
         """
         The variables which are being modified by the model.
@@ -217,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/vertical_profiles/data_profile.py

@@ -31,7 +31,7 @@ class DataProfile(VerticalProfile):
         col_z=None,
         col_var=None,
         pd_read_pars={},
-        **interp_pars
+        **interp_pars,
     ):
         """
         Constructor

foxes/models/wake_frames/__init__.py

@@ -8,3 +8,4 @@ from .timelines import Timelines
 from .yawed_wakes import YawedWakes
 from .farm_order import FarmOrder
 from .seq_dynamic_wakes import SeqDynamicWakes
+from .dynamic_wakes import DynamicWakes