Skip to content

Issue2060 actuator travel tagging boptest #2061

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

Open
terrancelu92 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Issue2060 actuator travel tagging boptest #2061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a415e4e
Add the actuator type to the read block
terrancelu92 Sep 30, 2025
5c68288
Update Read.mo
terrancelu92 Sep 30, 2025
0d22adb
Change the documentation
terrancelu92 Sep 30, 2025
5b029b1
Update Read.mo
terrancelu92 Sep 30, 2025
9de5374
Update SignalsForActuatorTravel.mo
terrancelu92 Sep 30, 2025
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
16 changes: 15 additions & 1 deletion IBPSA/Utilities/IO/SignalExchange/Read.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ model Read "Block that allows a signal to be read as an FMU output"
KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.RelativeHumidity or
KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.CO2Concentration)));

parameter SignalTypes.SignalsForActuatorTravel actuatorType = SignalTypes.SignalsForActuatorTravel.None if (
KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)
"Actuator type designation, required if KPIs is ActuatorTravel"
annotation(Dialog(enable=(
KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)));

final parameter Boolean boptestRead = true
"Parameter that is used by tools to search for read block in models";

Expand Down Expand Up @@ -53,12 +59,20 @@ variable <code>y</code>, assign a type if needed for KPI
calculation using the <code>KPIs</code> parameter, and assign a zone
designation using the <code>zone</code> parameter if the KPI calculation is
specific to a particular zone (for multi-zone models). See documentation for
the parameter <code>zone</code> for more details.
the parameter <code>zone</code> for more details.
If the KPI type is for actuator travel,
assign an actuator type designation using the <code>actuatorType</code> parameter.
See documentation for the parameter <code>actuatorType</code> for more details.
</p>
</html>",
revisions="<html>
<ul>
<li>
September 30, 2025 by Xing Lu:<br/>
Added actuator type designation for KPI calculation by parameter <code>actuatorType</code>.
See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2060\">#2060</a>.
</li>
<li>
February 17, 2022 by David Blum:<br/>
Made parameter <code>boptestRead</code> unprotected.
This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1585\">#1585</a>.
Expand Down
61 changes: 61 additions & 0 deletions IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
within IBPSA.Utilities.IO.SignalExchange.SignalTypes;
type SignalsForActuatorTravel = enumeration(
None
"Not used for control actuators",
Damper
"Damper",
Valve
"Valve",
Fan
"Fan",
Pump
"Pump",
HVACEquipment
"HVAC Equipment",
Other
"Other")
"Signals used for the calculation of the actuator travel"
annotation (Documentation(info="<html>
<p>This enumeration defines the actuator signal types that are used by BOPTEST to compute the actuator travel. </p>
<p>The following signal types are supported. </p>
<table cellspacing=\"0\" cellpadding=\"2\" border=\"1\"><tr>
<td><p align=\"center\"><h4>Value</h4></p></td>
<td><p align=\"center\"><h4>Description</h4></p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">None</span></p></td>
<td><p>Not used for actuator travel</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">Damper</span></p></td>
<td><p>Damper signal (e.g., damper openess signal)</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">Valve</span></p></td>
<td><p>Valve signal (e.g., valve openess signal)</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">Fan</span></p></td>
<td><p>Fan signal (e.g., fan speed signal)</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">Pump</span></p></td>
<td><p>Pump signal (e.g., pump speed signal)</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">HVACEquipment</span></p></td>
<td><p>HVAC equipment signal (e.g., heat pump signal)</p></td>
</tr>
<tr>
<td><p><span style=\"font-family: Courier New;\">Other</span></p></td>
<td><p>Other actuator signal</p></td>
</tr>
</table>
</html>", revisions="<html>
<ul>
<li>
September 30, 2025, by Xing Lu:<br/>
First implementation.
</li>
</ul>
</html>"));
4 changes: 3 additions & 1 deletion IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForKPIs.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ type SignalsForKPIs = enumeration(
SolarThermalPower
"Thermal power from solar thermal",
FreshWaterFlowRate
"FreshWaterFlowRate") "Signals used for the calculation of key performance indicators"
"FreshWaterFlowRate",
ActuatorTravel
"Actuator travel") "Signals used for the calculation of key performance indicators"
annotation (Documentation(info="<html>
<p>
This enumeration defines the signal types that are used by BOPTEST
Expand Down
1 change: 1 addition & 0 deletions IBPSA/Utilities/IO/SignalExchange/SignalTypes/package.order
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
SignalsForKPIs
SignalsForActuatorTravel
Loading