Base class for DVGeos

[hajdik]

Purpose

This is pretty much ready for review now, the biggest lingering questions are what the new classes should be named and if there are more functions that can be brought up a level after some refactoring.

Addresses #125. There is repeated code and similar structures between the different DVGeo classes, resulting in issues when there are changes in the API. There is now an abstract base class, BaseDVGeo, that all DVGeo classes will inherit from, as well as an intermediate class, DVGeoSketch, for DVGeoESP and DVGeoVSP to inherit from due to the large amount of shared code.

There is also a base class for design variables now to unify the different implementations better.

Expected time until merged

Maybe a week now that it's closer to complete, there's no rush

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 do not believe any additional tests will be needed, the functionality should be the same so if the original tests pass this should be good.

Checklist

• I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
• 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 #130 (43808ec) into main (7484ec5) will increase coverage by 0.01%.
The diff coverage is 81.65%.

@@            Coverage Diff             @@
##             main     #130      +/-   ##
==========================================
+ Coverage   62.60%   62.61%   +0.01%     
==========================================
  Files          43       45       +2     
  Lines       11207    11217      +10     
==========================================
+ Hits         7016     7024       +8     
- Misses       4191     4193       +2     

Impacted Files	Coverage Δ
pygeo/parameterization/DVGeoSketch.py	69.76% <69.76%> (ø)
pygeo/parameterization/BaseDVGeo.py	70.00% <70.00%> (ø)
pygeo/parameterization/DVGeoESP.py	64.83% <75.00%> (-0.66%)	⬇️
pygeo/parameterization/designVars.py	76.71% <97.77%> (+1.84%)	⬆️
pygeo/parameterization/DVGeo.py	64.37% <100.00%> (+0.06%)	⬆️
pygeo/parameterization/DVGeoVSP.py	81.40% <100.00%> (+0.15%)	⬆️
pygeo/geo_utils/misc.py	38.46% <0.00%> (+7.69%)	⬆️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

[sseraj]

I think this is a good start. Some comments below

[marcomangano]

I am not really familiar with abstract methods and how to exploit them, but I think a couple of fixes might be needed here.
Also, pls check for more leftover comments over the PR

[ewu63]

Overall I think there should be more things that we can pull out, but maybe that needs a bigger refactoring. See specific comments below

[sseraj]

The tests are hanging. I tried cancelling the build, but Azure is slow to respond. Testing locally first would be ideal

[hajdik]

They were passing locally, I'll look into it later today.

[joanibal]

I'm confused by some of the abstract class and methods stuff.

[ewu63]

This looks good to me, but I'd appreciate other diligent reviews