- class foxes.models.turbine_models.Calculator(foxes.core.TurbineModel)[source]
Calculates variables based on given functions.
Attributes¶
- in_vars: list of str
The input farm vairables
- out_vars: list of str
The output variables
- func: Function
The function: f(in0, in1, …, stsel) -> (out0, ou1, …) where inX and outY are numpy.ndarrays and st_sel is the state-turbine selection slice or array. All arrays have shape (n_states, n_turbines).
Public members¶
- Calculator(in_vars, out_vars, func, **kwargs)[source]
Constructor.
- output_farm_vars(algo)[source]
The variables which are being modified by the model.
- ensure_variables(algo, mdata, fdata)[source]
Add variables to fdata, initialized with NaN
- run_calculation(algo, *data, out_vars, **calc_pars)[source]
Starts the model calculation in parallel, via xarray’s apply_ufunc.
- property model_id
Unique id based on the model type.
- property initialized
Initialization flag.
- sub_models()[source]
List of all sub-models
-
initialize(algo, verbosity=
0
, force=False
)[source] Initializes the model.
-
get_data(variable, target, lookup=
'smfp'
, mdata=None
, ...)[source] Getter for a data entry in the model object or provided data sources
- data_to_store(name, algo, data)[source]
Adds data from mdata to the local store, intended for iterative runs.
-
from_data_or_store(name, algo, data, ret_dims=
False
, safe=False
)[source] Get data from mdata or local store