Source code for foxes.algorithms.downwind.models.set_amb_farm_results

import foxes.variables as FV
from foxes.core import FarmDataModel



[docs]
class SetAmbFarmResults(FarmDataModel):
    """
    This model copies farm data results to ambient results.

    Attributes
    ----------
    vars: list of str
        The variables to be copied, or `None` for all

    :group: algorithms.downwind.models

    """


[docs]
    def __init__(self):
        """
        Constructor.
        """
        super().__init__()
        self.vars = None



[docs]
    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

        """
        if self.vars is None:
            self.vars = set([v for v in algo.farm_vars if v in FV.var2amb])
        return [FV.var2amb[v] for v in self.vars]



[docs]
    def calculate(self, algo, mdata, fdata):
        """
        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.Data
            The model data
        fdata: foxes.core.Data
            The farm data

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

        """
        for v in self.vars:
            fdata[FV.var2amb[v]] = fdata[v].copy()
        return {v: fdata[v] for v in self.output_farm_vars(algo)}