Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add virtual turbine plotting method #418

Merged
merged 28 commits into from
Feb 7, 2023

Conversation

paulf81
Copy link
Collaborator

@paulf81 paulf81 commented Apr 12, 2022

Feature or improvement description
Some wake models (cc, turbopark) are not yet set up to enable visualization of the horizontal flowfield. However this visualization can be useful in understanding, sanity checking etc. This pull request provides a function to calculate the flowfield, through a slower process, of sweeping an extra turbine around the domain in a nested for loop and extracting the u-velocity at hub height. As the turbine is moved throughout the domain, the calculated velocities at the turbine are stored in a local variable and the turbine's wake is not applied to the flow field. For the same resolution, this produces the same results as the FlorisInterface.calculate_xx_plane methods. However, this method is significantly slower since it does a full flow field calculation including iterating over each turbine for each visualization grid point.

Pull request comes with demo example to show the new method:
calculate_horizontal_plane_with_turbines

Which at at upper most level behaves much like calculate_horizontal_plane except height can not be freely specified. Results in plot:
image

Related issue, if one exists
Issue #355

@paulf81 paulf81 added the enhancement An improvement of an existing feature label Apr 12, 2022
@paulf81 paulf81 added this to the v3.2.0 milestone Apr 12, 2022
@Bartdoekemeijer
Copy link
Collaborator

Hi @paulf81. I like this idea of having an artificial turbine in FLORIS function as a probe. I ran the example and saw it run very slowly on my machine. I think this is because of the overhead coming from reinitializing the FLORIS object for every measurement (in the example, we reinitialize FLORIS 600 times). Simply reinitializing floris 600 times on my laptop took 222.75 s.

Here's an idea based on yours, but circumventing the reinitialize issue. What if we add one turbine for every probe measurement? So if we want to calculate a grid of 40 x 15 wind speeds, we add 600 turbines to the farm. We make these turbines of the turbine_type=probe, give them a rotor diameter of -1, and a thrust curve of zeros. We can change that probe's location and hub height to specify the (x, y, z) coordinate of every measurement. Then, in solver.py, at the very start of the loop:

for i in range(grid.n_turbines):

we can add

if farm.rotor_diameters[i] < 0.001:
    continue

so that these probes have zero effect on the flow field. This would also enable users to handpick measurement locations, rather than always being forced to a grid. It would also resolve the issue with requiring a separate flowfield solver function, like full_flow_cc_solver.

@bayc @rafmudaf Feel free to let me know if this is a horrible idea. I understand it would go against some principles in how you designed the FLORIS model.

@paulf81
Copy link
Collaborator Author

paulf81 commented Apr 14, 2022

I think that's really brilliant @Bartdoekemeijer , I really like it!

@Bartdoekemeijer
Copy link
Collaborator

Okay I just opened a pull request here: paulf81#12

It's a very primitive version of what the turbines-as-probes method that I was trying to explain. It's a little iffy but it mostly works. Try running the example code that I added and see what you think.

@bayc bayc self-assigned this Jul 18, 2022
@rafmudaf rafmudaf modified the milestones: v3.2.0, v3.3 Sep 16, 2022
@rafmudaf
Copy link
Collaborator

rafmudaf commented Feb 1, 2023

TODO:

  • Remove example
  • Move plotting function to floris.tools.visualization

@paulf81 paulf81 marked this pull request as ready for review February 6, 2023 17:15
Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line.
Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow.
@rafmudaf
Copy link
Collaborator

rafmudaf commented Feb 7, 2023

This PR depends on #569

@rafmudaf rafmudaf changed the title Feature/vis by turbine Add virtual turbine plotting method Feb 7, 2023
@rafmudaf rafmudaf merged commit b8437e9 into NREL:develop Feb 7, 2023
rafmudaf added a commit to dhcho347/floris that referenced this pull request Feb 7, 2023
* Add func calculate_horizontal_plane_with_turbines

* Add demo example

* Correct sort order

* Improve resolution and force matching range

* fix append

* Remove calculate with turbine from floris interfa

* Delete turbine scan example

* Add calc with turbines to visualizations.py

* Add vis with turbine to visualization example

* Support for yaw angles

* Fix handling of yaw angles

* fix outdated layout keyword

* ruff linting

* test pre-commit

* test pre-commit

* Pre-commit fixes

* Fixed doc errors

* Clean out commented code

* Preserve isort formatting - run it last

Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line.

* Use token for codecov upload

* Reduce computational load in an example

Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow.

* Restrict PyPI deploy workflow to NREL/floris

* Add info on plotting method

* Use coarse mesh for turbine plotting

---------

Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>
rafmudaf added a commit that referenced this pull request Mar 7, 2023
* Speed up angle wrap functions and improve API (#505)

* replace wrap functions with faster implementations

* slight change to unit test as 180 -> -180

* Update doc string to reflect accurate return type

* Use executable book project for documentation

* Add a gh-pages deploy action

* Add more content

* Add a logo

* Add a brief description of each example

List examples in numeric order

Small cleanup to Examples listing

* Add initial API documentation

* Add input file reference

* Use autodoc and autosummary instead of autoapi

Remove TOC from intro page

* Locally install the current repo

* Configure autodocs better

Include undocumented objects as well as all members of an object

Add all default autodoc options to config

* Link to API docs in references to Python objects

* Git-ignore docs build

* Add instructions for building documentation

And other minor changes

* Add Google Analytics tracker

* Update README with documentation links

* List floris packages in API docs

* Enforce building docs from the develop branch

* Add a method to show mpl plots

This means users don’t have to also import matplotlib.pyplot as plt only to run plt.show()

* Update documentation references list (#519)

* initial entry for cumulative curl

* copy in v2 references

* add cc references

* add cc refs

* replace references to zrefs with references.bib

* API improvements

* Add a subtract overload to CutPlane

Also replaces another method CutPlane.subtract to do something similar. That one made assumptions about the order and expected operations. The new subtract method expects all preprocessing to be down outside of the class.

* Fix incorrect yaw angles in fi.calculate_wake

In subsequent function calls, the yaw angles are not reset when they are all zeros. This means that if initially the yaw angles are non-zero and then they’re all-zero, the non-zero yaw settings are retained.

* Remove requirement to use codecov token to upload reports (#532)

* remove potentially error causing line

* Update codecov upload action to v3

Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>

* Update API in examples

And clean up examples imports

* Use standard conventions in argument case

minSpeed, maxSpeed => min_speed, max_speed

* Add function to label turbines on CutPlane plots

* Rotate turbine lines and ID annotations with wind

* Configure isort and apply rules (#535)

* Configure isort and apply to floris.simulation

* Apply isort to floris.tools

* Apply isort to shared modules

* Apple isort to examples and tests

* Increase line length to 100

* Add isort description in docs

* Add weights to AEP wind rose function (#541)

* Add weights to get_farm_AEP_wind_rose_class

* updating layout passed to floris_interface in example

* Remove typecast to int for turbine weighting

---------

Co-authored-by: bayc <christopher.j.bay@gmail.com>
Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>

* Add parallel computing interface for farm simulation and yaw optimization (#555)

* Add parallel computing class

* Simplify and lighten the way floris information is passed to single-core functions

* Remove unc_options and only pass unc_pmfs internally: all information already contained in that variable.

* Update how wind directions are split up

* Add example for parallel computing

* Introduce separate variable for number of workers

* Expand PCI capabilities with reinitialize, copy. This is needed for some FLASC functionalities like precalculating table of floris solutions

* Allow user to reinitialize atmospheric conditions but then also reload how atmospheric conditions are divided by cores

* Add toggle to silence print statements from Serial Refine and set default in parallel computing. Namely, with 16 workers, you will see 16 times these print statements. This only becomes more with more workers and quickly clutters up the log file.

* Add the option to propagate flow field information from workers to main florisinterface object

* Add parallel processing example

* Remove duplicate example listing

---------

Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>

* Feature/update layout vis (#496)

* Update layout visualization functions

* Provide an example of layout visualization

* list 23_visaluze_layout in examples.md

---------

Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* Add ruff configuration

* Fix all E and F codes

F are pyflakes
E are pycodestyle
https://github.com/charliermarsh/ruff#pyflakes-f

Note: line length errors are not excluded here

* Line length corrections - floris.simulation

Max line length setting is 100

* Line length corrections - floris.tools

* Line length corrections - floris/

* Line length corrections - tests

* Line length corrections - examples

* Line length corrections - profiling

* Fix W codes

Here, it’s only adding a blank line at the end

* Fix C4-comprehensions codes

* Fix I codes

Import formatting. Ruff is not yet at parity with isort, but it is pretty close.

* Include Ruff in CI

Use pre-commit with Actions

Also update the developer dependencies

* Add Ruff usage documentation in developer guide

* Enable and fix pre-commit formatting hooks (#567)

* Enable and fix pre-commit formatting hooks

* Add pre-commit instructions to developer documentation

* Support heterogeneous wind direction definition via FlorisInterface.reinitialize (#453)

* Provide ability to pass het_map to reinitialize

* re-order reinitialize inputs

* Add a new example

* Add an error if het map doesnt match on dimensions to wd

* Add error example to example

* updating format of example

* Add indication final error is on purpose

* line length check

* Comment out forced error

* Add example 16b to docs

* use n directions instead of x

* Add comment

---------

Co-authored-by: Paul <paul.fleming@nrel.gov>
Co-authored-by: bayc <christopher.j.bay@gmail.com>

* Infrastructure improvements (#569)

* Preserve isort formatting - run it last

Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line.

* Use token for codecov upload

* Reduce computational load in an example

Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow.

* Restrict PyPI deploy workflow to NREL/floris

* Run tests regardless of linting results

* Fail the linter

* Revert "Fail the linter"

This reverts commit d7bfa62.

* Add virtual turbine plotting method (#418)

* Add func calculate_horizontal_plane_with_turbines

* Add demo example

* Correct sort order

* Improve resolution and force matching range

* fix append

* Remove calculate with turbine from floris interfa

* Delete turbine scan example

* Add calc with turbines to visualizations.py

* Add vis with turbine to visualization example

* Support for yaw angles

* Fix handling of yaw angles

* fix outdated layout keyword

* ruff linting

* test pre-commit

* test pre-commit

* Pre-commit fixes

* Fixed doc errors

* Clean out commented code

* Preserve isort formatting - run it last

Also enables splitting imports on trailing comma. If a multi-line import statement is short and includes a trailing comma, it will not be refactored into a single line.

* Use token for codecov upload

* Reduce computational load in an example

Initially, this example slowed the Actions workflow by 2x. This commit reduces the amount of work in the example to speed up the Actions workflow.

* Restrict PyPI deploy workflow to NREL/floris

* Add info on plotting method

* Use coarse mesh for turbine plotting

---------

Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* Add linear wind condition upsampling method to WindRose (#544)

* Add LinearNDInterpolant to wind_rose

* Change from returning interpolant to immediately interpolating to values

* Add example to docstring

---------

Co-authored-by: Paul <paul.fleming@nrel.gov>
Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* Improve the documentation navigation menu and organization (#570)

* minor formatting updates

* start overhaul of docuemntation structure

* convert input reference to markdown for consistency

* add a serious placeholder for theory and update the example input file

* remove my notes

* add top-level workflow description for getting started

* add missing period

* Add intro notebook

* Add developer section to menu

* Bug fix: fix toc reference to placeholder page

* Warning fix: use alternate cross reference form

---------

Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* Feature: External Turbine Library (#568)

* add the external library functionality

* update tests for new functionality

* enable future typing

* fix extra white space

* remove extra parameters

* add missing test file

* fix name bug and address #513

* get tests passing and ensure dictionary entries still work

* address Raf's comment

* add _path to turbine library references

* update typo, FI, and tests for _path

* fix error on case of using turbine dictionary and missing air density

* add additional test for the unique turbine check

* Specify coverage file in Codecov upload action

* Add a link to Discussions from Issues

* Add helpful info to GitHub Issue and PR templates (#597)

---------

Co-authored-by: paulf81 <paul.fleming@nrel.gov>
Co-authored-by: Rob Hammond <13874373+RHammond2@users.noreply.github.com>
Co-authored-by: bayc <christopher.j.bay@gmail.com>
Co-authored-by: Bart Doekemeijer <bart.doekemeijer@shell.com>
Co-authored-by: pjireland <pireland@windesco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement of an existing feature floris.tools
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants