Draft: Utilities module

[dtgaebe]

Description

With this PR a utilities.py module is added to the code. In utilities.py there are several functions commonly used in WEC analysis, but that are not required for the optimization problem itself.

Type of PR

• Bug fix
• New feature
• Documentation
• Other: (specify)

Checklist for PR

• Authors read the contribution guidelines
• The pull request is from an issue branch (not main) on your fork, to the main branch in WecOptTool.
• The authors have given the admins edit access
• All changes adhere to the style guide including PEP8, Docstrings, and Type Hints.
• Modified the documentation if applicable
• Modified or added a new test
• All tests pass
• Reference or close any relevant issues

Additional details

Utility functions so far include:

• Calculating the natural frequency for DoFs with natural restoring force based on the hydrodynamic_impedance (intrinsic impedance
• Plotting the BEM results based on all available DoFs in bem_data
• Plotting the Bode graph of all the DoFs in the hydrodynamic_impedance

[dtgaebe]

TODO:
Update the tutorials and use the new utility functions where appropriate

[coveralls]

Pull Request Test Coverage Report for Build 8861591992

Details

• 230 of 232 (99.14%) changed or added relevant lines in 4 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.5%) to 94.527%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tests/test_utilities.py	103	105	98.1%

Totals
Change from base Build 8529707928:	0.5%
Covered Lines:	2729
Relevant Lines:	2887

---

💛 - Coveralls

[dtgaebe]

Other utils funcitons

• function for reading or running bem - read if freqs and mesh is identical, else run bem

[cmichelenstrofer]

Other functions to consider for the utilities module in future PR:

• Thévenin equivalent system:
  • linear solution
  • natural frequency of full Thévenin equivalent system
• Plots: Smith plots?

[cmichelenstrofer]

The code used to have several other functions that were eliminated, but that makes sense to bring back into this utilities submodule. E.g. #89: power limit, optimal velocity (linear theory),

[ryancoe]

@dtgaebe - Per discussion today,

• Leave additional functionality beyond what you have now suggested by @cmichelenstrofer for later PRs
• Add test_utilities.py

[dtgaebe]

The current version of this PR has 4 new utility functions and tests for them

1. plot_hydrodynamic_coefficients
2. plot_bode_impedance
3. calculate_power_flows
4. plot_power_flow

[michaelcdevin]

@dtgaebe: just to confirm, can we close this PR without merging since #343 has now been merged in its place?

[dtgaebe]

@michaelcdevin , Yes. I'll close it