Skip to content

Update UsersGuide.mo #2105

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.

Sign up for GitHub

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
mwetter merged 1 commit into from
Apr 8, 2026
Merged

Update UsersGuide.mo #2105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions IBPSA/Fluid/HeatPumps/ModularReversible/UsersGuide.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ package UsersGuide
They may be on/off and inverter driven;
</li>
<li>
They are able to reverse the operation between heating and cooling,
They are able to reverse the operation between heating and cooling,
and some systems even provide simultaneous heating and cooling capabilities;
</li>
<li>
Expand Down Expand Up @@ -118,8 +118,8 @@ to the section <b>Refrigerant cycle models</b>.
<!-- @include_Buildings
<li>
<a href=\"modelica://IBPSA.Fluid.HeatPumps.ModularReversible.TableData2DLoadDep\">
IBPSA.Fluid.HeatPumps.ModularReversible.TableData2DLoadDep</a>:
This is the recommended model for energy simulation and any use case where detailed
IBPSA.Fluid.HeatPumps.ModularReversible.TableData2DLoadDep</a>:
This is the recommended model for energy simulation and any use case where detailed
modeling of the heat pump onboard controls is not required.
</li>
-->
Expand Down Expand Up @@ -171,8 +171,8 @@ to the section <b>Refrigerant cycle models</b>.
<!-- @include_Buildings
<li>
<a href=\"modelica://IBPSA.Fluid.Chillers.ModularReversible.TableData2DLoadDep\">
IBPSA.Fluid.Chillers.ModularReversible.TableData2DLoadDep</a>:
This is the recommended model for energy simulation and any use case where detailed
IBPSA.Fluid.Chillers.ModularReversible.TableData2DLoadDep</a>:
This is the recommended model for energy simulation and any use case where detailed
modeling of the chiller onboard controls is not required.
</li>
-->
Expand Down Expand Up @@ -305,12 +305,13 @@ The following table summarizes the possible options.
<!-- @include_Buildings
<p>
Prefatory note: This section only applies to the models that do not include
onboard controls. The models that include onboard controls, such as
onboard controls. The models that include onboard controls, such as
<a href=\"modelica://IBPSA.Fluid.HeatPumps.ModularReversible.TableData2DLoadDep\">
IBPSA.Fluid.HeatPumps.ModularReversible.TableData2DLoadDep</a>,
rather expose a connector <code>TSet</code> representing the temperature setpoint.
rather expose a connector <code>THwSet</code> or <code>TChwSet</code> representing
the HW or CHW temperature setpoint.
</p>
-->
-->

<p>
The input <code>ySet</code> represents the relative compressor speed.
Expand Down Expand Up @@ -387,11 +388,11 @@ rather expose a connector <code>TSet</code> representing the temperature setpoin
the third dimension of the performance sensitivity is captured using
the part load ratio as a proxy variable for the actual capacity modulation observable.
This allows a unified modeling of various technologies such as
modulating the compressor speed, throttling the inlet guide vanes
modulating the compressor speed, throttling the inlet guide vanes
or staging a varying number of compressors.
This approach does not rely on any third-party dependency and is fully
supported by the existing classes from the Modelica Standard Library.
It is implemented in the modular heat pump and chiller models named
It is implemented in the modular heat pump and chiller models named
<code>TableData2DLoadDep</code>.
</p>

Expand Down
Loading