Source code for foxes.models.point_models.ustar2ti

import numpy as np
from foxes.core import PointDataModel
import foxes.variables as FV
import foxes.constants as FC



[docs]
class Ustar2TI(PointDataModel):
    """
    Calculates TI from Ustar, using TI = Ustar / (kappa*WS)

    Attributes
    ----------
    max_ti: float
        Upper limit of the computed TI values

    :group: models.point_models

    """


[docs]
    def __init__(self, max_ti=None, **kwargs):
        """
        Constructor

        Parameters
        ----------
        max_ti: float, optional
            Upper limit of the computed TI values
        kwargs: dict, optional
            Additional parameters for the base class

        """
        super().__init__(**kwargs)
        self.max_ti = max_ti



[docs]
    def output_point_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.TI]



[docs]
    def calculate(self, algo, mdata, fdata, pdata):
        """
        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
        tdata: foxes.core.TData
            The target point data

        Returns
        -------
        results: dict
            The resulting data, keys: output variable str.
            Values: numpy.ndarray with shape (n_states, n_points)

        """
        ustar = pdata[FV.USTAR]
        ws = pdata[FV.WS]

        ti = (ustar / FC.KAPPA) / ws
        if self.max_ti is not None:
            ti = np.maximum(ti, self.max_ti)

        return {FV.TI: ti}