geometry caching

[ivanmaione]

Linked Issues

related to Issue #1196
Closes #682
Closes #1090

Description

This PR implements the shape caching in BluemiraGeo objects. Geometry functions are modified in such a way that shape and boundary are always consistent.

Interface Changes

BluemiraGeo.shape and BluemiraGeo.boundary are readonly now.

Checklist

I confirm that I have completed the following checks:

• Tests run locally and pass pytest tests --reactor
• Code quality checks run locally and pass flake8 and black .
• Documentation built locally and checked sphinx-build -W documentation/source documentation/build

Check tests

tests/geometry

• test_coordinates.py
• test_deprecated_base.py
• test_deprecated_loop.py
• test_deprecated_offset.py
• test_deprecated_tools.py
• test_face.py
• test_geometry.py
• test_inscribed_rect.py
• test_offset.py -> necessary to change test_data/offset_wire2022-04-08_10-19-27.json to be compliant with the new serialization structure.
• test_optimisation.py
• test_parameterisations.py
• test_orientation.py -> since the FreeCAD shape is directly cached, the only orientation test that could have meaning is that in which two wires are joined -> maybe it would be worth discussing this point.
• test_placement.py
• test_plane.py
• test_sweep.py
• test_tools.py
• test_wire.py

[github-actions]

⚠️ Warning Report

Found 0 new warnings, 0 fixed warnings. 🎉

[CoronelBuendia]

Looking really good! I fixed the last remaining test failure and made a couple of minor aesthetic changes. A couple of comments / queries beyond what we had discussed.

I'd really like to get rid of the orientation stuff in general, but without the EU-DEMO build stuff running in full with the caching, I'm too scared to take it out. I will create a separate issue to remove the orientation tracking, now that we no longer handle reconstruction.

[je-cook]

I'm happy just a few minors

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[codecov-commenter]

Codecov Report

Merging #1650 (45533ab) into develop (ebec2de) will decrease coverage by 0.07%.
The diff coverage is 80.32%.

@@             Coverage Diff             @@
##           develop    #1650      +/-   ##
===========================================
- Coverage    74.65%   74.57%   -0.08%     
===========================================
  Files          162      162              
  Lines        19213    19382     +169     
===========================================
+ Hits         14343    14455     +112     
- Misses        4870     4927      +57     

Impacted Files	Coverage Δ
bluemira/codes/_freecadapi.py	81.91% <54.76%> (-1.83%)	⬇️
bluemira/geometry/solid.py	76.19% <74.19%> (-13.56%)	⬇️
bluemira/geometry/compound.py	82.35% <77.77%> (-8.56%)	⬇️
bluemira/geometry/shell.py	82.69% <77.77%> (-14.09%)	⬇️
bluemira/geometry/face.py	75.23% <78.94%> (+3.64%)	⬆️
bluemira/geometry/wire.py	87.82% <84.21%> (-2.94%)	⬇️
bluemira/geometry/base.py	83.79% <91.46%> (+0.98%)	⬆️
bluemira/geometry/tools.py	81.34% <94.44%> (ø)
bluemira/builders/cryostat.py	100.00% <100.00%> (ø)
bluemira/display/displayer.py	96.84% <100.00%> (ø)
... and 8 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.