Index
- -A
-| - | - |
C
-| - | - |
D
-| - | - |
F
-| - | - |
G
-H
-| - |
I
-| - | - |
L
-
|
-
M
-
|
-
N
-| - | - |
O
-
|
-
|
-
P
-| - |
R
-| - | - |
S
-T
-| - | - |
U
-| - |
W
-| - | - |
' + - '' + - _("Hide Search Matches") + - "
" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); diff --git a/01_Docs/build/html/genindex.html b/01_Docs/build/html/genindex.html deleted file mode 100644 index ca36875..0000000 --- a/01_Docs/build/html/genindex.html +++ /dev/null @@ -1,635 +0,0 @@ - - - - - -| - | - |
| - | - |
| - | - |
| - | - |
| - |
| - | - |
|
-
|
-
| - | - |
|
-
|
-
| - |
| - | - |
| - | - |
| - |
| - | - |
-a dynamic parametric wake toolbox which combines and connects OnWaRDS [1], FLORIDyn [2] and FLORIS [3]
-Run the main.py in the 03_Code folder.
-To change the simulation, you have to change the .yaml file OFF calls. This is defined by one of the first limes of code in the main function. The .yaml structure is showed in run_example.yaml . This is where you can change the wind farm layout, the flow conditions, the wake model etc.
-
-
-The documentation is handled automatically using Sphinx and available here.
-The documentation for this program is under a creative commons attribution share-alike 4.0 license. http://creativecommons.org/licenses/by-sa/4.0/
-Bases: object
updates the corrector buffer
-t (float) – current time in s
-Bases: States, ABC
Creates an AmbientStates object of its own kind with only one state entry, based on two weighted states. -The returned object then still has access to functions such as get_turbine_wind_dir()
-index1 (int) – Index of the first state
index2 (int) – Index of the second state
w1 (float) – Weight for first index (has to be w1 = 1 - w2, and [0,1])
w2 (float) – Weight for second index (has to be w2 = 1 - w1, and [0,1])
ambient state object with single entry
-Returns wind direction at the turbine location
-wind direction (deg)
-float
-Returns u,v component wind speed at the turbine location
-1 x 2 vector of [u,v] wind speeds in m/s
-np.ndarray
-Returns the absolute wind speed at the turbine location (first entry)
-absolute wind speed
-float
-Returns the u component of the wind speed (x direction) at the turbine location
-u wind speed
-float
-Returns the v component of the wind speed (y direction) at the turbine location
-v wind speed
-float
-Returns all wind directions
-m x 1 vector of wind direction states in deg
-np.ndarray
-Returns wind directions at an index
-ind (int) – Index
-m x 1 vector of wind direction states in deg
-np.ndarray
-Returns u,v component of all wind speeds
-m x 2 matrix of [u,v] wind speeds in m/s
-np.ndarray
-Returns the absolute wind speed
-m x 1 vector of the absolute wind speed in m/s
-np.ndarray
-Returns the u component of the wind speed (x direction)
-m x 1 vector of the u wind speed in m/s
-np.ndarray
-Returns the v component of the wind speed (y direction)
-m x 1 vector of the v wind speed in m/s
-np.ndarray
-Bases: AmbientStates
Creates an AmbientStates object of its own kind with only one state entry, based on two weighted states. -The returned object then still has access to functions such as get_turbine_wind_dir()
-index1 (int) – Index of the first state
index2 (int) – Index of the second state
w1 (float) – Weight for first index (has to be w1 = 1 - w2, and [0,1])
w2 (float) – Weight for second index (has to be w2 = 1 - w1, and [0,1])
ambient state object with single entry
-Returns all wind directions
-float of wind direction state at the turbine location in deg
-Returns u,v component of u & v wind speed at the turbine location
-1 x 2 matrix of [u,v] wind speeds in m/s
-np.ndarray
-Returns the absolute wind speed at the turbine location (first entry)
-absolute wind speed
-float
-Returns the u component of the wind speed (x direction) at the turbine location
-u wind speed
-float
-Returns the v component of the wind speed (y direction) at the turbine location
-v wind speed
-float
-Returns all stored wind directions
-m x 1 vector of wind direction states in deg
-Returns wind directions at an index
-ind (int) – Index
-m x 1 vector of wind direction states in deg
-np.ndarray
-Returns the wind direction at a requested location
-location (np.ndarray) – m x 3 matrix where the columns are [x,y,z] locations in m
op_coord (np.ndarray) – n x 3 matrix of the OP world coordinate states in m
m x 1 vector with absolute wind speeds in deg
-np.ndarray
-Returns u,v component of all wind speeds
-m x 2 matrix of [u,v] wind speeds in m/s
-np.ndarray
-Returns the absolute wind speed
-m x 1 vector of the absolute wind speed in m/s
-np.ndarray
-Returns the absolute wind speed at a requested location
-location (np.ndarray) – m x 3 matrix where the columns are [x,y,z] locations in m
op_coord (np.ndarray) – n x 3 matrix of the OP world coordinate states in m
m x 1 vector with absolute wind speeds in m/s
-np.ndarray
-Returns the u component of the wind speed (x direction)
-m x 1 vector of the u wind speed in m/s
-np.ndarray
-Returns the v component of the wind speed (y direction)
-m x 1 vector of the v wind speed in m/s
-np.ndarray
-Bases: ObservationPoints
Returns a x, y, z vector pointing from the OP to the turbine location in the OP coordinate system. -OP coordinate system is usually the wake coordinate system based on the OP data.
-1 x 3 matrix where the columns are the x,y,z coordinates
-np.ndarray
-Returns the world coordinates of the OPs
-[x, y, z] coordinates in world coordinate system
-np.ndarray
-Creates a downstream chain of OPs -Overwrites the base method of the States class
-wind_speed_u (float) – wind speed in x direction in m/s
wind_speed_v (float) – wind speed in y direction in m/s
rotor_pos (np.ndarray) – 1 x 3 vector with x,y,z location of the rotor in the world coordinate system
time_step (float) – simulation time step in s
Propagates the OPs based on the u and v velocity component
-uv_op (np.ndarray) – m x 2 matrix with wind speeds of all OPs in x and y direction in m/s
time_step (float) – Time step of the simulation in s
Bases: ObservationPoints
Returns the world coordinates of the OPs
-[x, y, z] coordinates in world coordinate system
-np.ndarray
-Creates a downstream chain of OPs -Overwrites the base method of the States class
-wind_speed_u (float) – wind speed in x direction in m/s
wind_speed_v (float) – wind speed in y direction in m/s
rotor_pos (np.ndarray) – 1 x 3 vector with x,y,z location of the rotor in the world coordinate system
time_step (float) – simulation time step in s
Propagates the OPs based on the u and v velocity component
-uv_op (np.ndarray) – m x 2 matrix with wind speeds of all OPs in x and y direction in m/s
time_step (float) – Time step of the simulation in s
Bases: States, ABC
ObservationPoints is the abstract base class for a list of wake tracers / particles -The class inherits get, set & iterate methods from the abstract States class, init is overwritten
-Returns a x, y, z vector pointing from the OP to the turbine location in the OP coordinate system. -OP coordinate system is usually the wake coordinate system based on the OP data.
-1 x 3 matrix where the columns are the x,y,z coordinates
-np.ndarray
-Returns the x, y, z coordinates of all OPs
-m x 3 matrix where the columns are the x,y,z coordinates
-np.ndarray
-Creates a downstream chain of OPs -Overwrites the base method of the States class
-wind_speed_u (float) – Wind speed in x direction in m/s
wind_speed_v (float) – Wind speed in y direction in m/s
rotor_pos (np.ndarray) – 1 x 3 vector with x,y,z location of the rotor in the world coordinate system
time_step (float) – simulation time step in s
Propagates the OPs based on the u and v velocity component
-uv_op (np.ndarray) – m x 2 matrix with wind speeds of all OPs in x and y direction in m/s
time_step (float) – Time step of the simulation in s
Sets the propagation speed of the OPs, meant as a temporay storage, which ensures that different lengths of OP -chains can be used in the simulation
-op_propagation_speed (np.ndarray) – m x 2 matrix with [u,v] velocity component for all OPs
-Bases: object
OFF is the central object which initializes the wind farm and runs the simulation
-Get the current wind farm object which equals the simulation state
-Wind farm object with turbines and states
-Function which initializes the states within the self.wind_farm object.
-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.
start_ambient (np.ndarray) – 1 x n vector with initial ambient state
start_turbine (np.ndarray) – 1 x n vector with initial turbine state
Central function which executes the simulation and manipulates the self.wind_farm object
Measurements from the entire simulation
-pandas.Dataframe
-Overwrite wind farm object with a new wind farm object. Can be used to restart the simulation from a given state
-new_wf (windfarm.WindFarm) – Wind farm object with turbines and states
------- –
Bases: ABC
Abstract state class -Provides basic functions for state lists, such as get, set, initialize and iterate
-Returns state matrix
-m x n matrix, columns mark different states, rows time steps
-Returns the state at a given index
-index (int) – index of the state to return
-state – 1 x n state vector
-np.ndarray
-List with names of the stored states
-List with the names of the stored states in the corresponding order
-list
-Copies a given state across all state entries as initialisation. -For more advanced initialisation, use set_all_states()
-init_state (np.ndarray) – 1 x n vector of init state
-shift_states shifts all states and adds a new entry in first place
-new_state – 1 x n vector
-none
-shift_states shifts all states and but keeps the first entry the same
-none
-Overwrites the states with the given matrix.
-new_states – m x n matrix with new states, columns mark different states, rows time steps
-none
-Overwrites a state at the given index
-index (int) – index of state to overwrite
new_state (np.ndarray) – 1 x n vector which overwrites the state
Bases: Turbine
Calculate the power based on turbine, ambient and OP states
-wind_speed (float) – Wind speed (m/s)
air_den (float) – air density
Power generated (W)
-float
-Bases: ABC
Calculate the power based on turbine, ambient and OP states
-wind_speed (float) – Wind speed (m/s)
air_den (float) – air density
Power generated (W)
-float
-Get the tilt of the turbine
-tilt (deg)
-float
-Get the yaw misalignment of the turbine
-wind_direction (number) – Wind direction (deg)
-yaw misalignment (deg)
-float
-Calculates the rotor position based on the current yaw and tilt
-1 x 3 vector with x,y,z location of the rotor in the world coordinate system
-np.ndarray
-Sets the base location, based on a rotor location and the nacelle position -:param pos_rot:
-Sets the orientation based on the given wind direction and yaw angle
-wind_direction (float) – Wind direction in degrees
yaw (float) – Turbine yaw misalignment angle in degrees
Bases: States, ABC
Creates a TurbineStates object of its own kind with only one state entry, based on two weighted states. -The returned object then still has access to functions such as get_current_yaw()
-index1 (int) – Index of the first state
index2 (int) – Index of the second state
w1 (float) – Weight for first index (has to be w1 = 1 - w2, and [0,1])
w2 (float) – Weight for second index (has to be w2 = 1 - w1, and [0,1])
turbine state object with single entry
-get_all_axInd returns the all axial induction factors of the saved turbine states
-Axial induction factor (-)
-np.ndarray
-get_all_ct(index) returns the Ct coefficients for all turbine states.
-Thrust coefficient at all turbine states (-)
-np.ndarray
-get_all_ct(index) returns the yaw misalignment for all turbine states.
-Yaw misalignment at all turbine states (deg)
-np.ndarray
-get_ax_ind(index) returns the axial induction coefficient at a requested index of the turbine state chain
-index (int) – Turbine state list index at which a should be calculated
-Axial induction factor
-float
-get_ct(index) returns the Ct coefficient at a requested index of the turbine state chain
-index (int) – Turbine state list index at which Ct should be calculated
-Thrust coefficient
-float
-get_current_axInd returns the current axial induction factor of the turbine
-Axial induction factor (-)
-float
-get_current_cp returns the current power coefficient of the turbine
-Power coefficient (-)
-float
-get_current_ct returns the current thrust coefficient of the turbine
-Thrust coefficient (-)
-float
-get_current_yaw returns the current yaw misalignment at the turbine location
-yaw misalignment at the turbine location (deg)
-float
-get_yaw(index) returns the yaw misalignment at a requested index
-index (int) –
-yaw misalignment in deg
-float
-Bases: TurbineStates
Creates a TurbineStates object of its own kind with only one state entry, based on two weighted states. -The returned object then still has access to functions such as get_current_yaw()
-index1 (int) – Index of the first state
index2 (int) – Index of the second state
w1 (float) – Weight for first index (has to be w1 = 1 - w2, and [0,1])
w2 (float) – Weight for second index (has to be w2 = 1 - w1, and [0,1])
turbine state object with single entry
-get_all_axInd returns the all axial induction factors of the saved turbine states
-Axial induction factor (-)
-np.ndarray
-get_all_ct(index) returns the Ct coefficients for all turbine states.
-Thrust coefficient at all turbine states (-)
-np.ndarray
-returns the yaw misalignment for all turbine states.
-n x 1 vector with all yaw angles
-np.ndarray
-get_all_axInd returns the all axial induction factors of the saved turbine states
-Axial induction factor (-)
-np.ndarray
-get_ct(index) returns the Ct coefficient at a requested index of the turbine state chain
-index (int) – Turbine state list index at which Ct should be calculated
-Thrust coefficient
-float
-get_all_axInd returns the all axial induction factors of the saved turbine states
-Axial induction factor (-)
-np.ndarray
-get_current_cp returns the current power coefficient of the turbine
-Power coefficient (-)
-float
-get_current_ct returns the current thrust coefficient of the turbine
-Thrust coefficient (-)
-float
-get_current_yaw returns the current yaw misalignment at the turbine location
-yaw misalignment at the turbine location (deg)
-float
-get_yaw(index) returns the yaw misalignment at a requested index
-index (int) –
-yaw misalignment in deg
-float
-Utilities for the OFF toolbox -functions which are handy in multiple places but do not have a true parent object they could belong to.
-Function to find the index of the closest 2 points to a reference location in 3D. -The function can expect the list of points to be sorted / trailing each other.
-ref_loc – [1 x 3] np.ndarray Reference location
points – [n x 3] np.ndarray Points
[1 x 2] int array
-Function to find the index of the closes point to a reference location in 3D. -The function can expect the list of points to be sorted / trailing each other.
-ref_loc – [1 x 3] np.ndarray Reference location
points – [n x 3] np.ndarray Points
index
-int
-Return the turbine orientation based on the wind direction and the yaw angle
-wind_dir (float) – Wind direction in LES degree (270 deg pointing along the x-axis, 190 deg along the y axis)
yaw (float) – Yaw angle in degree
Orientation in LES degree
-float
-Return the turbine yaw angle based on the wind direction and turbine orientation
-wind_dir (float) – Wind direction in LES degree (270 deg pointing along the x-axis, 190 deg along the y axis)
orientation (float) – Turbine orientation in LES degree (270 deg pointing along the x-axis, 190 deg along the y axis)
yaw angle in LES degree (clockwise)
-float
-Isocell algorithm to discretize the rotor plane (or any circle) -Masset et al.
-https://orbi.uliege.be/bitstream/2268/91953/1/masset_isocell_orbi.pdf
-We choose N = 3 here, 4 or 5 are also viable options, 3 is close to optimal
-n_rp (int) – desired number of Rotor points (algorithm can not work with all numbers, takes the closest one)
-[yRP, zRP] : np.ndarray location of the rotor points with values between -0.5 and 0.5 -w : float weight of the RPs (1/number)
-tuple
-Bases: object
Wind Farm Attributes
-List of turbine objects which form the wind farm
-Row i describes which turbines influence turbine i. The main diagonal should always be ‘True’.
-Number of turbines in the wind farm
-Adds another turbine to the list
-turb (Turbine) – Turbine class object which describes the new turbine
-index of the newly added turbine object
-int
-Collects and returns the current turbine states of the turbines
-[n_t x m] matrix with current turbine states at the turbine locations
-np.ndarray
-Gets the current wind farm layout and diameters
-[n_t x 4] matrix with wind farm layout in the world coordinate system and turbine diameter
-np.ndarray
-Collects and returns all OP world locations
-x,y,z coordiates of the OPs (in m)
-np.ndarray
-Creates a subset of the wind farm with the turbines at the given indices
-indices (int[]) –
-turbines array
-Removes a turbine from the wind farm
-ind (int) – Index of the turbine to remove
-removed turbine object
-dependencies (np.ndarray) – boolean array with dependencies - true if there is a dependency, false if not
-| - o | ||
| - |
- off | - |
| - |
- off.ambient | - |
| - |
- off.observation_points | - |
| - |
- off.off | - |
| - |
- off.states | - |
| - |
- off.turbine | - |
| - |
- off.utils | - |
| - |
- off.windfarm | - |