Skip to content
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

81 sup ctrl interfaces #82

Merged
merged 20 commits into from
Sep 23, 2024
Merged

81 sup ctrl interfaces #82

merged 20 commits into from
Sep 23, 2024

Conversation

FWuellhorst
Copy link
Contributor

This PR closes #81.
I explicitly did not add "Modelica internal" supervisory control as we do not have a use-case for this yet and a simple extends of the control subsystem enables the addition of a then naming independent Modelica internal supervisory control.

@FWuellhorst
Copy link
Contributor Author

@PatrickHenkel1 I want to keep the changes in the valve control models as the current main has some wrong annotations which are removed automatically by Dymola. Can you do the review?

@ebc-aixlib-bot
Copy link

Thank you for making a Pull Request to BESMod!

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/BESMod/81_supCtrlInterfaces/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! -> BESMod.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 BESMod.Media.Water directly.
  • Never using absolute paths to files (e.g., C: or D:). Replace them with modelica://BESMod/....
  • 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!

@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/81_supCtrlInterfaces/charts

@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/81_supCtrlInterfaces/charts

Copy link
Contributor Author

@FWuellhorst FWuellhorst left a comment

Choose a reason for hiding this comment

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

@MaxBerktoldRWTH : I used the standard supervisory control block to possibly allow for Modelica-internal supervisory control. Thus, the names slightly change, you have to override the defaults the same way the other signals are overridden.

@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/81_supCtrlInterfaces/charts

Copy link
Contributor Author

@FWuellhorst FWuellhorst left a comment

Choose a reason for hiding this comment

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

Changes look good and work, going to merge this now.

@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/81_supCtrlInterfaces/charts

Copy link
Contributor

@MaxBerktoldRWTH MaxBerktoldRWTH left a comment

Choose a reason for hiding this comment

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

Looks good. Although to be honest I'm not 100% sure what all the changes do.

@ebc-aixlib-bot
Copy link

Reference results have been displayed graphically and are created under the following page https://rwth-ebc.github.io/BESMod/81_supCtrlInterfaces/charts

…ion reference files. Please pull the new files before push again. Plottet Results /81_supCtrlInterfaces/charts/
@FWuellhorst FWuellhorst merged commit d1ba432 into main Sep 23, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the 81_supCtrlInterfaces branch September 23, 2024 13:06
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.

Add direct control interfaces for valve and compressor speed
3 participants