Added dict key validation & updated documentation

[kanekosh]

Purpose

Key validation

With this PR, OAS will check a user-defined dicts (mesh dict or surface dict) and warn if the user provides a key that is not implemented or used in OAS.

For example, some examples and tests provide the chord key when creating a mesh, but the key chord does not exist and therefore never used. I fixed them to root_chord, the one actually used.
I also removed unused keys from other tests.

Documentation update

The current documentation and docstrings say the chord_cp variable is the actual chord value in meters, but what the code (ScaleX component) actually does is that it applies the chord scaler to the initial mesh. Therefore chord_cp is actually a dimensionless chord scaler.
This PR fixes the documentation and docstrings.

Also, I updated the surface dict documentation.

(It's a little too late but I probably should've opened two separate PRs for this...)

Expected time until merged

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

I added a new test to check the chord values before and after ScaleX is applied.

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 #417 (76c8f30) into main (f2f974f) will increase coverage by 0.00%.
The diff coverage is 96.15%.

@@           Coverage Diff           @@
##             main     #417   +/-   ##
=======================================
  Coverage   94.50%   94.51%           
=======================================
  Files         103      104    +1     
  Lines        6448     6469   +21     
=======================================
+ Hits         6094     6114   +20     
- Misses        354      355    +1     

Files	Coverage Δ
openaerostruct/geometry/geometry_group.py	100.00% <100.00%> (ø)
openaerostruct/geometry/geometry_mesh.py	98.63% <ø> (ø)
...rostruct/geometry/geometry_mesh_transformations.py	99.67% <100.00%> (ø)
openaerostruct/integration/aerostruct_groups.py	97.54% <100.00%> (+0.03%)	⬆️
openaerostruct/utils/check_surface_dict.py	100.00% <100.00%> (ø)
openaerostruct/geometry/utils.py	62.59% <92.30%> (+0.81%)	⬆️

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

[eytanadler]

Thanks for fixing these!

[ewu63]

In addition, I found that some examples and tests provide the chord key when creating a mesh, but the key chord does not exist and therefore never used. I fixed them to root_chord, the one actually used.

Should there be some sort of key validation then? To ensure we aren't passing in dict entries that are silently inactive?

[kanekosh]

In addition, I found that some examples and tests provide the chord key when creating a mesh, but the key chord does not exist and therefore never used. I fixed them to root_chord, the one actually used.

Should there be some sort of key validation then? To ensure we aren't passing in dict entries that are silently inactive?

That's true, I'll add it.

[kanekosh]

Added key validation as @nwu63 suggested, ready for the 2nd review

[eytanadler]

Thanks for doing this tedious work. Only one very minor spelling correction, and otherwise looks good!

[eytanadler]

Consistend -> consistent

[kanekosh]

Thanks for the quick review!