off
- class off.off.OFF(wind_farm: WindFarm, settings_sim: dict, settings_wke: dict, settings_sol: dict, settings_cor: dict, vis: dict)
Bases:
objectOFF is the central object which initializes the wind farm and runs the simulation
- get_wind_farm() WindFarm
Get the current wind farm object which equals the simulation state
- Returns:
Wind farm object with turbines and states
- Return type:
- init_sim(start_ambient: ndarray, start_turbine: ndarray)
Function which initializes the states within the
self.wind_farmobject. Assigns turbine & ambient states and distributes the OPs downstream. OP locations are not necessarily correct but the wakes are “unrolled” and do not have to first develop.- Parameters:
start_ambient (np.ndarray) – 1 x n vector with initial ambient state
start_turbine (np.ndarray) – 1 x n vector with initial turbine state
- run_sim() DataFrame
Central function which executes the simulation and manipulates the
self.wind_farm object- Returns:
Measurements from the entire simulation
- Return type:
pandas.Dataframe
- set_wind_farm(new_wf: WindFarm)
Overwrite wind farm object with a new wind farm object. Can be used to restart the simulation from a given state
- Parameters:
new_wf (windfarm.WindFarm) – Wind farm object with turbines and states
------- –
- settings_sim = {}
- settings_vis = {}