NatLabRockies / NatLabRockies/OpenStudio
Shading surface translation to IDF
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Translation to IDF https://github.com/NREL/OpenStudio/blob/develop/openstudiocore/src/energyplus/ForwardTranslator/ForwardTranslateShadingSurface.cpp#L88 should respect the shaded surface or shaded surface specified on the shading group https://github.com/NREL/OpenStudio/blob/develop/openstudiocore/src/model/ShadingSurfaceGroup.hpp#L86
If that is not specified, we should use a distance to plane metric for distance rather than distance to vertex we currently use. The current solution was just meant to make runnable IDF
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in openstudiocore/src/energyplus/ForwardTranslator/ForwardTranslateShadingSurface.cpp around line 88 and inspect the shaded-surface access described in openstudiocore/src/model/ShadingSurfaceGroup.hpp around line 86. Trace how the translator currently computes distance and verify the intended behavior for both explicitly specified surfaces and the fallback case. Done means the generated IDF respects the specified surface and uses distance to plane when none is specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100