Source code for foxes.core.turbine_model

from abc import abstractmethod

from foxes.utils import all_subclasses

from .farm_data_model import FarmDataModel


[docs] class TurbineModel(FarmDataModel): """ Abstract base class for turbine models. Turbine models are FarmDataModels that run on a selection of turbines. :group: core """
[docs] @abstractmethod 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: slice or numpy.ndarray of bool The state-turbine selection, for shape: (n_states, n_turbines) Returns ------- results: dict The resulting data, keys: output variable str. Values: numpy.ndarray with shape (n_states, n_turbines) """ pass
[docs] @classmethod def new(cls, tmodel_type, *args, **kwargs): """ Run-time turbine model factory. Parameters ---------- tmodel_type: str The selected derived class name args: tuple, optional Additional parameters for constructor kwargs: dict, optional Additional parameters for constructor """ if tmodel_type is None: return None allc = all_subclasses(cls) found = tmodel_type in [scls.__name__ for scls in allc] if found: for scls in allc: if scls.__name__ == tmodel_type: return scls(*args, **kwargs) else: estr = "Turbine model type '{}' is not defined, available types are \n {}".format( tmodel_type, sorted([i.__name__ for i in allc]) ) raise KeyError(estr)