Environment_Engine: Compute Openings from a list of panels and a glazing ratio

[Felix-Mallinder]

NOTE: Depends on

Issues addressed by this PR

Closes #3226

Added compute method, as described in the linked issue, the method calculates window sizes based on glazing ratio, for externally facing panels and creates openings.

Test files

OpeningsByGlazingByRatioTestScript.zip
Unzip, open in Rhino and check actual area is equal to expected area

Changelog

Additional comments

[FraserGreenroyd]

Plus any compliance fixes the bot may find please @FelixMallinder-BH 😄
Additionally the PR title needs improving to meet our change log guidelines please

[FraserGreenroyd]

@BHoMBot check compliance

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

There are 1 requests in the queue ahead of you.

[Felix-Mallinder]

@BHoMBot check for copyright-compliance

[bhombot-ci]

@FelixMallinder-BH sorry, I didn't understand.
Was that comment an instruction for me? If so, could you state again what check you would like me to do?
For a list of available instructions, please see this wiki page.

[Felix-Mallinder]

@BHoMBot check copyright-compliance

[bhombot-ci]

@FelixMallinder-BH to confirm, the following actions are now queued:

• check copyright-compliance

[bhombot-ci]

@FelixMallinder-BH fix requested for copyright headers.

The errors with the copyright headers on the CS (.cs) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

Each CS (.cs) file that does not have the current copyright header will have it applied. The current copyright header can be examined here.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix copyright headers ref. 20780543059

[Felix-Mallinder]

@BHoMBot fix copyright headers ref. 20780543059

[bhombot-ci]

@FelixMallinder-BH I'm sorry, but I cannot understand which check reference you are trying to provide. Please can you try again?

[Tom-Kingstone]

@BHoMBot check compliance

[Tom-Kingstone]

@BHoMBot check compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[bhombot-ci]

@Tom-Kingstone fix requested for copyright headers.

The errors with the copyright headers on the CS (.cs) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

Each CS (.cs) file that does not have the current copyright header will have it applied. The current copyright header can be examined here.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix copyright headers ref. 20780849163

[Tom-Kingstone]

@BHoMBot fix copyright headers ref. 20780849163

[bhombot-ci]

@Tom-Kingstone sorry, but the check you're asking me to make automatic fixes for has not failed, so I cannot make any changes at this point.

[Tom-Kingstone]

@BHoMBot check copyright-compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check copyright-compliance

[Tom-Kingstone]

@BHoMBot check core
@BHoMBot check compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check core
• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[bhombot-ci]

The check copyright-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[Tom-Kingstone]

@BHoMBot check core
@BHoMBot check compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check core
• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[Tom-Kingstone]

I tested after changes using the test file provided, and the area returned is the same. Also the opening produced looks correct given the inputs, and ignoring panels is working.

[albinber]

Going by the test script everything works as intended. Good work @FelixMallinder-BH & @Tom-Kingstone! Happy to approve :)

[Felix-Mallinder]

Reviewed and re-tested @Tom-Kingstone 's changes, happy that they solved the previous issues and functionality follows.

[FraserGreenroyd]

I've reviewed the code and the tests done by the team and all looks good.

However, as noted in #3279, we do have issues with openings being created larger than their host panels but that comes from the Create method rather than necessarily this method for now, so let's merge this PR for further testing, and then revisit this as necessary when handling #3279

[FraserGreenroyd]

@BHoMBot check required

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[FraserGreenroyd]

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: unit-tests

[FraserGreenroyd]

@BHoMBot check ready-to-merge

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check ready-to-merge

There are 19 requests in the queue ahead of you.

[bhombot-ci]

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.