foxes.core.turbine.Turbine¶
- class foxes.core.turbine.Turbine[source]¶
Bases:
object
An individual wind turbine.
The turbine is merely a defined by basic data entries and a choice of turbine models.
- Parameters:
xy (array_like) – The turbine ground position, shape: (2,)
turbine_models (list of str) – The turbine model names, as they appear in the model book
index (int, optional) – The index in the wind farm
name (str, optional) – The turbine name/label
models_state_sel (list of numpy.ndarray, optional) – For each turbine model, the state selection boolean array with shape (n_states,)
D (float, optional) – The rotor diameter. Overwrites turbine type settings if given
H (float, optional) – The hub height. Overwrites turbine type settings if given
- xy¶
The turbine ground position, shape: (2,)
- Type:
array_like
- mstates_sel¶
For each turbine model, the state selection boolean array with shape (n_states,)
- Type:
list of numpy.ndarray, optional
- __init__(xy, turbine_models=[], index=None, name=None, models_state_sel=None, D=None, H=None)[source]¶
Methods
__init__
(xy[, turbine_models, index, name, ...])add_model
(model[, states_sel])Add a turbine model to the list.
insert_model
(index, model[, states_sel])Insert a turbine model into the list of models.
- __init__(xy, turbine_models=[], index=None, name=None, models_state_sel=None, D=None, H=None)[source]¶
- add_model(model, states_sel=None)[source]¶
Add a turbine model to the list.
- Parameters:
model (foxes.core.TurbineModel) – The model
states_sel (numpy.ndarray of bool, optional) – The states selection for the model, shape: (n_states,)
- insert_model(index, model, states_sel=None)[source]¶
Insert a turbine model into the list of models.
- Parameters:
index (int) – The position in the model list
model (foxes.core.TurbineModel) – The model
states_sel (numpy.ndarray of bool, optional) – The states selection for the model, shape: (n_states,)