Gerard/4372 intersection issue found using create bar

[ggartside]

Pull request overview

• Fixes Intersection issue found when using create bar #4372

Fixes an issue revealed by surface matching when small surfaces created in intersection were reduced to 0 area surfaces and discarded. The tolerance used in removeSpikesEx should have been the same value as the amount used to shrink and expand surfaces to remove spikes

PR includes the fix (one line change) a test model and a unit test in Model_Gtest to verify the surfaces are paired correctly

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• Model API methods are tested (in src/model/test)
• EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
• If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
• If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
• Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
• All new and existing tests passes
• If methods have been deprecated, update rest of code to use the new methods

Labels:

• If change to an IDD file, add the label IDDChange
• If breaking existing API, add the label APIChange
• If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• Code Style, strip trailing whitespace, etc.
• All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
• Labeling is ok
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified

[ggartside]

The issue was a fault in removeSpikesEx. In this method a polygon is expanded by amount and then shrunk by amount to remove small spikes, the resulting vertices were compared to the original vertices and adjusted accordingly so that the original coordinates could be returned wherever possible. The tolerance used to compare vertices was too large and resulted in the polygon being reduced to a 0 area polygon and rejected. By changing the tolerance to the amount expanded and shrunk the issue was fixed.

Polygons are rejected based on area tolerance in intersection - they have to be greater than tol * tol which is 100mm2, surface matching uses a linear tolerance of 0.01, 10mm. If a polygon is rejected because it is less than 100mm2 it is possible that vertices in that polygon could be > 10mm apart and hence surface matching could fail under certain circumstances.

Currently, if two identical surfaces are intersected their vertices are not changed by the intersection method, which makes perfect sense. However if two almost identical surfaces are intersected and the resulting difference between them is too small to be considered then the original surface vertices are not changed either even though they are slightly different.

These two surfaces are therefore considered to be identical after intersection is performed but may not be considered identical as far as surface matching is concerned (because they are not identical)

To eliminate this error intersection should always return two identical surfaces that will be determined to be equal when passed to circularEqual

[ggartside]

I resolved the two test fails. One of them was caused by adding the circularEqual test in Surface intersect. The circulaEqual is removing inline points and so the count of vertices dropped from 6 to 4. This may be an unwanted artifact so to be prudent it was removed

[jmarrec]

Some minor changes, otherwise everything looks good!

[ci-commercialbuildings]

CI Results for 3867acb:

• Ubuntu 18.04:

  • OpenStudio-3.3.1-alpha+3867acbc0c-Ubuntu-18.04.deb
  • OpenStudio-3.3.1-alpha+3867acbc0c-Ubuntu-18.04.tar.gz

• Ubuntu 20.04:

  • OpenStudio-3.3.1-alpha+3867acbc0c-Ubuntu-20.04.deb
  • OpenStudio-3.3.1-alpha+3867acbc0c-Ubuntu-20.04.tar.gz
  • perf_all.csv
  • perf_comparison.png
  • perf_means.csv

• Darwin:

  • OpenStudio-3.3.1-alpha+3867acbc0c-Darwin.dmg
  • OpenStudio-3.3.1-alpha+3867acbc0c-Darwin.tar.gz

• Windows:

  • OpenStudio-3.3.1-alpha+3867acbc0c-Windows.exe
  • OpenStudio-3.3.1-alpha+3867acbc0c-Windows.tar.gz

• Code Coverage:

  • OpenStudio-3867acbc0c047ceca0ebf415642a2779c9521a94.gcov.html

[tijcolem]

@jmarrec Thanks for reviewing. Just running the windows CI again and if that passed I'll merge.