Skip to content

1525 wrong description of the incidence angle #1583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 16, 2025

Conversation

Jun-Jiang-92
Copy link
Contributor

Changes in this PR:

  • Renaming solar radiation from I to H according to new naming space rules, including I_dir to HDir, I_diff to HDif, I_gr to HGrd
  • Renaming solar incidence angle from AOI to incAng

One exception is the model AixLib/ThermalZones/HighOrder/Components/WindowsDoors/BaseClasses/CorrectionSolarGain/CorG_ASHRAE140.mo, in which internal variables AOI and AOI_help remain unchanged, to keep these internal vars similar to other vars, such as AOR (angle of refraction).

@Jun-Jiang-92 Jun-Jiang-92 self-assigned this Mar 13, 2025
@Jun-Jiang-92 Jun-Jiang-92 linked an issue Mar 13, 2025 that may be closed by this pull request
@ebc-aixlib-bot
Copy link
Contributor

Thank you for making a Pull Request to AixLib!

Our CI pipeline will help you finalize your contribution.
Here's what is typically checked:

  • HTML syntax of your models, primarily in your documentation.
  • Adherence to the naming convention in all changed files.
  • Ability to check all models.
  • Ability to simulate all models, if they are examples.
  • If your contribution changes existing reference results.

If HTML errors occur, I will fix the issues using a separate pull request.
For the other checks, I will post the results here: https://rwth-ebc.github.io/AixLib/1525-wrong-description-of-the-incidence-angle/index.html

Tips to fix possible naming violations:

  • Stick to the naming guidelines, e.g. Namespace Requirements
  • Do all paramaters, variables, models, etc. have a description?
  • Use absolute paths to classes! -> AixLib.Fluid.HeatExchangers.Radiator - Avoid: HeatExchangers.Radiator

If all CI stages pass and you have addressed possible naming violations, please consider the following:

  • Use "group" and "tab" annotations to achieve a good visualization window.
  • Use units consistently.
  • Instantiate the replaceable medium package as:
    replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium model";
    instead of using a full media model like AixLib.Media.Water directly.
  • Never using absolute paths to files (e.g., C: or D:). Replace them with modelica://AixLib/....
  • Ensure your documentation is helpful and concise.
  • Make sure icons are clear. Please avoid using images!
  • Stick to 80 characters per line, as long as it makes sense.
  • Add or modify examples for new or revised models.
  • Include a simulate-and-plot script as a regression test for new models.
    How? Follow the documentation here: https://github.com/ibpsa/modelica-ibpsa/wiki/Unit-Tests#how-to-include-models-as-part-of-the-unit-tests
    Tip: To create the initial script, you can use Dymolas script generator, explained here: https://www.claytex.com/tech-blog/how-to-use-a-plot-script/)

Once you have addressed these points, you can assign a reviewer.
Although this process may seem tedious, ensuring CI passes allows the reviewer to focus
their time on the actual modeling rather than syntax and unintended breakages caused by your changes.

If you have any questions or issues, please tag a library developer.
Once again, thank you for your valuable contribution!

Copy link
Contributor

@TobiasSpratte TobiasSpratte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, thank you!

@Jun-Jiang-92
Copy link
Contributor Author

@TobiasSpratte Hi, Tobi. Thanks for your review. I have updated the block Sunblind.mo. Now, the CI is already passed. Could you please review the code again and approve the change if everything is OK?

Copy link
Contributor

@TobiasSpratte TobiasSpratte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice, thank you!

@Jun-Jiang-92 Jun-Jiang-92 requested a review from larissakuehn May 14, 2025 10:23
@Jun-Jiang-92
Copy link
Contributor Author

@larissakuehn Hi, Larissa. This PR seems to request a second reviewer (with write access) for the approvement. Could you please give a review for the changing?

@Jun-Jiang-92 Jun-Jiang-92 merged commit 51ae3fe into main May 16, 2025
1 check passed
@Jun-Jiang-92 Jun-Jiang-92 deleted the 1525-wrong-description-of-the-incidence-angle branch May 16, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong description of the incidence angle
3 participants