initial implementation of BoilerGeneric and Example #1443

DaJansenGit · 2023-06-06T13:57:36Z

This includes the first model of the new ModularEnergySystems models (see #1147)

Before merge we want to solve all todos listed in #1439

…sue1147_GenericBoiler

FelixStege · 2023-06-06T16:10:15Z

I looked roughly over the code and saw some issues regarding the naming convention. I am mentioning them here so that you can consider them in your further development.

You use "Nom" as an abbreviation in some models (e.g., in NominalFuelConsumption). In a lot of other models, we use "nominal" (also mentioned at the bottom of the wiki). Additionally, in NominalFuelConsumption the naming for dTNom is confusing when you also have dTNominal.
Another thing is the order of the variable names (use m_flow_rel instead of rel_m_flow).

ebc-aixlib-bot · 2024-07-29T12:17:25Z

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/issue1147_GenericBoiler/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!

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

…/AixLib into issue1147_GenericBoiler

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

DaJansenGit · 2024-07-30T11:28:30Z

Let's check the naming violations listed here against the guidelines and correct if needed

…/AixLib into issue1147_GenericBoiler

FWuellhorst

Find my comments below based on the git diff, I will look into the models itself once these points are addressed 👍

FWuellhorst · 2024-08-07T11:29:19Z

AixLib/DataBase/Boiler/General/Boiler_Generic_Performance_Map.sdf

Resource files should be under Resources

FWuellhorst · 2024-08-07T11:29:52Z

AixLib/Fluid/BoilerCHP/BaseClasses/DesignOperation.mo

+
+
+
+  Modelica.Blocks.Sources.RealExpression ReturnTemp(y=TRet_nominal)


I wont check further naming convention, please adhere to the errors in the .txt

FWuellhorst · 2024-08-07T11:31:00Z

AixLib/Fluid/BoilerCHP/BaseClasses/DesignOperation.mo

@@ -0,0 +1,163 @@
+within AixLib.Fluid.BoilerCHP.BaseClasses;
+model DesignOperation "Operating for design conditions"


I don't get the doc

FWuellhorst · 2024-08-07T11:32:09Z

AixLib/Fluid/BoilerCHP/BaseClasses/DesignOperation.mo

+<p><span style=\"font-family: Arial;\">The nominal adiabatic efficiency (reference is the higher heating value (includes vaporization enthalpy)) comes from the SDF and depends on:</span></p>
+<ul>
+<li><span style=\"font-family: Arial;\">Nominal return temperature (TColdNom)</span></li>
+<li><span style=\"font-family: Arial;\">Nominale temperature difference (TColdNom-THotNom)</span></li>


Why not use a parameter if it is only the nominal value?
Also, check Arial font

FWuellhorst · 2024-08-07T11:32:28Z

AixLib/Fluid/BoilerCHP/BaseClasses/OffDesignOperation.mo

+    "Design return temperature" annotation (Dialog(group="Design"),Evaluate=false);
+
+
+package Medium=AixLib.Media.Water;


replaceable as usual?

FWuellhorst · 2024-08-07T11:41:14Z

AixLib/Resources/ReferenceResults/Dymola/AixLib_Fluid_BoilerCHP_Examples_CHPSystem.txt

@@ -12,4 +12,4 @@ statistics-simulation=
 }
 time=[0e+00, 1.2e+03]
 TSet.y=[3.531499938964844e+02, 3.531499938964844e+02]
-combinedHeatPower.senTHot.T=[2.931499938964844e+02, 3.247222900390625e+02, 3.337673950195312e+02, 3.406928405761719e+02, 3.459860534667969e+02, 3.500254211425781e+02, 3.531043701171875e+02, 3.554481506347656e+02, 3.57231201171875e+02, 3.585867309570312e+02, 3.596168518066406e+02, 3.60399169921875e+02, 3.609931030273438e+02, 3.614440002441406e+02, 3.617863464355469e+02, 3.62046142578125e+02, 3.622433166503906e+02, 3.623928833007812e+02, 3.625064086914062e+02, 3.625924987792969e+02, 3.626578369140625e+02, 3.627074279785156e+02, 3.627449951171875e+02, 3.627735290527344e+02, 3.62795166015625e+02, 3.628115844726562e+02, 3.628240661621094e+02, 3.6283349609375e+02, 3.628406677246094e+02, 3.628460998535156e+02, 3.628502197265625e+02, 3.51466796875e+02, 3.426469116210938e+02, 3.359141540527344e+02, 3.307493286132812e+02, 3.267692260742188e+02, 3.236861572265625e+02, 3.212864990234375e+02, 3.194056701660156e+02, 3.179310913085938e+02, 3.168027648925781e+02, 3.159405212402344e+02, 3.152824096679688e+02, 3.147796630859375e+02, 3.143954162597656e+02, 3.141017456054688e+02, 3.138772583007812e+02, 3.137058410644531e+02, 3.135748596191406e+02, 3.134747009277344e+02, 3.133981323242188e+02, 3.133395385742188e+02, 3.132947082519531e+02, 3.132605895996094e+02, 3.132345886230469e+02, 3.132146911621094e+02, 3.131994323730469e+02, 3.25228790283203e+02, 3.348995056152344e+02, 3.422317810058594e+02, 3.477757568359375e+02, 3.519564208984375e+02, 3.551002197265625e+02, 3.574575805664062e+02, 3.592198791503906e+02, 3.605324401855469e+02, 3.615051879882812e+02, 3.622214660644531e+02, 3.62744873046875e+02, 3.631228637695312e+02, 3.633914489746094e+02, 3.63577880859375e+02, 3.637023010253906e+02, 3.637803039550781e+02, 3.63823486328125e+02, 3.638405151367188e+02, 3.638379516601562e+02, 3.638207397460938e+02, 3.637925109863281e+02, 3.637561950683594e+02, 3.637138366699219e+02, 3.636670532226562e+02, 3.636170349121094e+02, 3.635645751953125e+02, 3.635104064941406e+02, 3.63455078125e+02, 3.517401123046875e+02, 3.426918029785156e+02, 3.358100280761719e+02, 3.305563659667969e+02, 3.265324096679688e+02, 3.234400024414062e+02, 3.210558166503906e+02, 3.192101135253906e+02, 3.17780517578125e+02, 3.166877746582031e+02, 3.158526306152344e+02, 3.152152404785156e+02, 3.147283630371094e+02, 3.143562622070312e+02, 3.140718078613281e+02]


Why do these change?

FWuellhorst · 2024-08-07T11:43:13Z

AixLib/Systems/ModularEnergySystems/ModularBoiler/Controls/heatingCurve.mo

+model heatingCurve
+  "Flow temperature control (power control) with heating curve"


Why not use the existing one?

FWuellhorst · 2024-08-07T11:43:38Z

AixLib/Systems/ModularEnergySystems/ModularBoiler/Examples/ModularBoilerFeedback.mo

+  parameter Integer k=2 "number of consumers";
+  package MediumWater = AixLib.Media.Water;
+
+  ModularBoiler modularBoiler(


FWuellhorst · 2024-08-07T11:44:01Z

AixLib/Systems/ModularEnergySystems/ModularBoiler/ModularBoiler.mo

+  parameter Boolean hasPump=true "Model includes a pump"
+    annotation (choices(checkBox=true), Dialog(descriptionLabel=true, group="System setup"));
+  parameter Modelica.Units.SI.HeatFlowRate Q_flow_nominal=50000
+    "Thermal dimension power"


Nominal heat flow rate?

FWuellhorst · 2024-08-07T11:45:15Z

AixLib/Systems/package.order

@@ -1,4 +1,5 @@
 HeatPumpSystems
 HydraulicModules
 ModularAHU
+ModularEnergySystems


This only contains the Boiler, and AHU, Hydraulics, and HeatPump are also energy systems and modular.

initial implementation of BoilerGeneric and Example (by Moritz Zuschlag)

02a7843

DaJansenGit requested a review from FelixStege June 6, 2023 13:57

DaJansenGit assigned DaJansenGit and MZuschlag Jun 6, 2023

DaJansenGit and others added 3 commits June 6, 2023 17:14

add first implementation of ModularBoiler and ModularConsumer

0fee6f0

Update description of BoilerGeneric

27ca717

Merge remote-tracking branch 'origin/issue1147_GenericBoiler' into is…

94b43d9

…sue1147_GenericBoiler

mz2101 and others added 11 commits June 9, 2023 12:04

Update with new SDF

3012e81

Merge branch 'development' into issue1147_GenericBoiler

c5ad040

update genericBoiler model

19cf460

update generic boiler and examples

703662b

update controls for boilder module

7c9d7f2

remove obsolete models

d9683ef

model -> sub dirs for modules package

9e50313

cleanup modular models

418a62c

update modular energy systems package and examples, add some docs

f7828da

merge main into branch

d7b9b00

update package order and add mos script for ref results

9fec9b4

DaJansenGit added 10 commits July 29, 2024 14:18

update simulate_and_plot script

2b15b8e

add tolerance for boilerGeneric

7d58a88

CI message from ebc-aixlib-bot. Automatic push of CI with new regress…

eddc6a7

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

update sensor names, add conversion script and bump aixlib version

8fa1284

add simulate and plot scripts for modularenergysystem examples

3a5e0b5

add tolerances

16d0600

CI message from ebc-aixlib-bot. Automatic push of CI with new regress…

937f8f4

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

reset GenericAHU to main branch status

b727361

Merge branch 'issue1147_GenericBoiler' of https://github.com/RWTH-EBC…

fc1728a

…/AixLib into issue1147_GenericBoiler

reset GenericAHU to main branch status

4684156

DaJansenGit added 4 commits July 29, 2024 15:19

reset CTRAHUBasic to main branch status

476dace

rm old package structure

bc101de

rm dymolalic file and obsolete Interfaces package

a653aa5

rm obsolete example package

4b4224e

DaJansenGit marked this pull request as ready for review July 29, 2024 13:24

DaJansenGit requested review from FWuellhorst and removed request for FelixStege and FWuellhorst July 29, 2024 13:24

DaJansenGit added 5 commits July 29, 2024 19:22

fix initial conditions and update sensor name in regression scripts

f1b82a3

delete outdated ref results and update sensor names in existing

0e8cd19

CI message from ebc-aixlib-bot. Automatic push of CI with new regress…

516b3f6

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

delete outdated ref results and update sensor names in existing

43d000b

CI message from ebc-aixlib-bot. Automatic push of CI with new regress…

a93e9d4

…ion reference files. Please pull the new files before push again. Plottet Results /issue1147_GenericBoiler/charts/

DaJansenGit requested review from FWuellhorst and removed request for FWuellhorst July 30, 2024 11:24

DaJansenGit added 3 commits July 30, 2024 14:28

update docs and naming

81531f9

update docs and naming

7e60a40

Merge branch 'issue1147_GenericBoiler' of https://github.com/RWTH-EBC…

21d1785

…/AixLib into issue1147_GenericBoiler

FWuellhorst requested changes Aug 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

initial implementation of BoilerGeneric and Example #1443

initial implementation of BoilerGeneric and Example #1443

DaJansenGit commented Jun 6, 2023

FelixStege commented Jun 6, 2023

ebc-aixlib-bot commented Jul 29, 2024

DaJansenGit commented Jul 30, 2024 •

edited

Loading

FWuellhorst left a comment

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024

FWuellhorst Aug 7, 2024




		Modelica.Blocks.Sources.RealExpression ReturnTemp(y=TRet_nominal)

		@@ -0,0 +1,163 @@
		within AixLib.Fluid.BoilerCHP.BaseClasses;
		model DesignOperation "Operating for design conditions"

		"Design return temperature" annotation (Dialog(group="Design"),Evaluate=false);


		package Medium=AixLib.Media.Water;

		model heatingCurve
		"Flow temperature control (power control) with heating curve"

initial implementation of BoilerGeneric and Example #1443

Are you sure you want to change the base?

initial implementation of BoilerGeneric and Example #1443

Conversation

DaJansenGit commented Jun 6, 2023

FelixStege commented Jun 6, 2023

ebc-aixlib-bot commented Jul 29, 2024

DaJansenGit commented Jul 30, 2024 • edited Loading

FWuellhorst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaJansenGit commented Jul 30, 2024 •

edited

Loading