Eval funcs docs

[gawng]

Purpose

Address #206

Also, all the time spectral aircraft stability derivatives are allegedly broken so the documentation of cost functions says so Issue #295 .
Fixes some typos in source code as well.

Do not merge until these are checked

• Document the computeCavitation flag behavior and extra evaluations that result (and how it affects cpmin vs cavitation sensor). See PR Several features on tecplot io, slices, MG PC, cavitation constraints, and overset hole cutting. #231

Expected time until merged

Would really appreciate reviews before all the senior students graduate so within the next semester.
EDIT: Before September 2023

Type of change

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (non-backwards-compatible fix or feature)
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Documentation update
• Maintenance update
• Other (please describe)

Testing

Checklist

• I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
• I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
• I have run unit and regression tests which pass locally with my changes
• I have added new tests that prove my fix is effective or that my feature works
• I have added necessary documentation

[codecov]

Codecov Report

Merging #240 (1d12ad7) into main (eea5686) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #240   +/-   ##
=======================================
  Coverage   42.01%   42.01%           
=======================================
  Files          13       13           
  Lines        3999     3999           
=======================================
  Hits         1680     1680           
  Misses       2319     2319           

Impacted Files	Coverage Δ
adflow/pyADflow.py	68.94% <ø> (ø)

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

[gawng]

@ArshSaja Please document the remaining functions. That would be every function after area. Also the separation sensor funcs are your domain too.

To others, feel free to check the changes I have made so far so we can iterate. I would appreciate some help with all the aircraft stability derivatives. @lamkina feel free to add your stuff to this too. Thanks!

[anilyil]

In #231, we ran into an issue with the computeCavitation option. This option controls of the cpmin and cavitation cost functions are computed or not. Is this documented in this PR? Is this the right place to document these? If not, I will create an issue.

[gawng]

Yep, this is exactly the place to put that documentation. It is not currently in this PR so I will add it to my TODO to specify that the compute cavitation flag results in extra computations in the cost function description.

[ArshSaja]

I will work on this during the break.

[lamkina]

Thanks for fixing all the formatting stuff @gang525! I think this is ready to go.

[anilyil]

I am hitting request changes; I want to review the explanations. Will try to do it later this week. Please finish reviewing other discussions in the meanwhile.

[ArshSaja]

Thanks @gang525 for all changes! I will try to fix it if anything new comes up

[gawng]

The index TOC depth is now changed from 2 to 1. I corrected some of the other items, but @ArshSaja do you know what the flowpower cost functional is? This PR is getting close to ready.

EDIT: this is ready for review

[anilyil]

I have pushed my changes to the descriptions. Someone else should review. @sseraj can you add brief descriptions to the time spectral functions and remove the "TODO"s ?

[sseraj]

@sseraj can you add brief descriptions to the time spectral functions and remove the "TODO"s ?

Yes, I can do that.

[anilyil]

I'll wait for the tests just to be sure and merge this.