ImperialCollegeLondon / sharpy

Simulation of High Aspect Ratio aeroplanes and wind turbines in Python: a nonlinear aeroelastic code
https://imperial.ac.uk/aeroelastics/sharpy
BSD 3-Clause "New" or "Revised" License
119 stars 58 forks source link

Updates to plotutils.py and the cantilever_wing demo #242

Closed boltyboi closed 9 months ago

boltyboi commented 1 year ago

Edit: Wind turbine demo has also been changed, but I can't change the title.

Plotutils: Added code for custom_scaling and z_compression. These are used in the cantilever wing demo to make the simulated wings appear more realistic. They are disabled by default and therefore shouldn't interfere with other demos that use plotutils. Also added a little more detail describing what certain functions actually mean, and cleaned up the formatting a little bit in those areas.

Cantilever wing demo: Fixed various typos and added extra clarifications on what parts of the code do. Mainly, I've added the custom_scaling and z_compression as toggleable features under the simulations, alongside a short explanation of what they do. This should hopefully make the simulations less confusing to newcomers if they decide to enable it. Both of these features are disabled by default and must be manually turned on.

Wind turbine demo Fixed some typos and changed up the grammar in some areas, the results I obtained are inaccurate, however, as when "Steady Simulation" is set to true the results seem to break. I'm not sure how to remove these from the commit though. Sorry about that.

codecov-commenter commented 1 year ago

Codecov Report

Merging #242 (f4b5472) into main (328558b) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #242   +/-   ##
=======================================
  Coverage   67.20%   67.20%           
=======================================
  Files         156      156           
  Lines       25923    25923           
=======================================
  Hits        17422    17422           
  Misses       8501     8501           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

kccwing commented 9 months ago

Merging this - thanks Ozan @boltyboi!