Add FluidLoop #514

JieXiong9119 · 2025-03-14T22:41:25Z

Any background context you want to provide?

This is an effort of introducing new element in alignment with the task of mapping with ASHRAE 229p for BEM tools.

What does this PR do?

See proposal.

How should this be manually tested?

What are the relevant tickets?

Screenshots (if appropriate)

JieXiong9119 · 2025-03-14T22:43:25Z

Please review the proposal and make comment on the proposal file.
@ThibaultMarzullo could you please add Craig and whoever are interested in reviewing this? I could not find them in the repo's team group.

Sashadf1 · 2025-03-18T19:03:40Z

BuildingSync.xsd

-            </xs:element>
-            <xs:element name="MinimumFlowFraction">
-              <xs:annotation>
-                <xs:documentation>Minimum fraction of full flow allowed. (0-1)</xs:documentation>


Does "full flow" refer to the loop design flow referenced in line 15899? i.e. "Total design pump power divided by the loop design flow rate."? If so, could consider renaming description in 15955 to "Minimum fraction of full (i.e. loop design) flow allowed."

Sashadf1 · 2025-03-18T20:28:58Z

BuildingSync.xsd

-                      <xs:sequence>
-                        <xs:element name="OutdoorHighForLoopSupplyTemperatureReset" minOccurs="0">
-                          <xs:annotation>
-                            <xs:documentation>Outdoor high for loop supply temp reset. (°C)</xs:documentation>


Is this referring to the outdoor air drybulb temp? Maybe worth clarifying in xs:documentation.

If yes, suggest renaming to:
"Outdoor air drybulb temperature high for loop supply temp reset. (°C)"

Sashadf1 · 2025-03-18T20:30:37Z

BuildingSync.xsd

-                        </xs:element>
-                        <xs:element name="OutdoorLowForLoopSupplyTemperatureReset" minOccurs="0">
-                          <xs:annotation>
-                            <xs:documentation>Outdoor low for loop supply temp reset. (°C)</xs:documentation>


see comment above re outdoor high.

Realized I was annotating removed lines. Not sure if the comments above could apply to the additions (in green), but if so, they could still be considered.

Sashadf1 · 2025-03-18T20:31:51Z

BuildingSync.xsd

-                        </xs:element>
-                        <xs:element name="LoopSupplyTemperatureAtOutdoorHigh" minOccurs="0">
-                          <xs:annotation>
-                            <xs:documentation>Loop supply temperature at outdoor high temperature. (°C)</xs:documentation>


Don't think we need to clarify that the outdoor high is OADBT here if we are clarifying it above.

Sashadf1 · 2025-03-18T20:36:11Z

BuildingSync.xsd

+      </xs:element>
+      <xs:element name="PumpPowerPerFlowRate" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation>Total design pump power divided by the loop design flow rate. (W-s/L)</xs:documentation>


correct units

Sashadf1 · 2025-03-18T20:42:25Z

BuildingSync.xsd

+            </xs:element>
+            <xs:element name="MinimumFlowFraction" minOccurs="0">
+              <xs:annotation>
+                <xs:documentation>Minimum fraction of full flow allowed. (0-1)</xs:documentation>


see comment in red removed lines re documentation for min. fraction of full flow allowed. Would it be useful to clarify?

Sashadf1 · 2025-03-18T20:45:28Z

BuildingSync.xsd

+                      <xs:sequence>
+                        <xs:element name="OutdoorHighForLoopSupplyTemperatureReset" minOccurs="0">
+                          <xs:annotation>
+                            <xs:documentation>Outdoor high for loop supply temp reset. (°C)</xs:documentation>


could clarify outdoor high as outdoor air drybulb temp

Sashadf1 · 2025-03-18T20:45:50Z

BuildingSync.xsd

+                        </xs:element>
+                        <xs:element name="OutdoorLowForLoopSupplyTemperatureReset" minOccurs="0">
+                          <xs:annotation>
+                            <xs:documentation>Outdoor low for loop supply temp reset. (°C)</xs:documentation>


see comment above re outdoor high

Sashadf1 · 2025-03-18T20:51:49Z

BuildingSync.xsd

+    </xs:annotation>
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="FluidLoop" type="auc:FluidLoopType">


type="auc:FluidLoopType" is definitely better than type="auc:FluidLoopTypeType".

It's hard to tell what has changed from the diffs in the xsd, b.c. they aren't side by side. Is this what the proposal is for?

Sashadf1 · 2025-03-18T20:55:34Z

proposals/2025/Add Loop.md

        <xs:annotation>
            <xs:documentation>An list of properties of a general fluid loop.</xs:documentation>
        </xs:annotation>
        <xs:sequence>
            <xs:element name="FluidLoopType" minOccurs="0">
+            <!-- Note that element FluidLoopType is different from complexType FluidLoopType although they have the same name. -->


https://www.geeksforgeeks.org/what-is-the-difference-between-a-simple-element-and-a-complex-element-in-xml/ helpful reference

Sashadf1 · 2025-03-18T21:01:30Z

proposals/2025/Add Loop.md

@@ -103,20 +103,21 @@ Global definition
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
-                <xs:element name="FluidLoop" type="auc:FluidLoopTypes" maxOccurs="unbounded">
+                <xs:element name="FluidLoop" type="auc:FluidLoopType" maxOccurs="unbounded">
                    <xs:annotation>
                        <xs:documentation>fluid loop for HeatingSource.</xs:documentation>


e.g. hydronic loop served by a boiler (HeatingSource)?

Sashadf1 · 2025-03-18T21:05:39Z

proposals/2025/Add Loop.md

@@ -187,7 +188,7 @@ Global definition
                                </xs:simpleContent>
                            </xs:complexType>
                        </xs:element>
-                        <xs:element name="MinimumFlowFraction">
+                        <xs:element name="MinimumFlowFraction" minOccurs="0">


Is there a reason we are making DesignSupplyTemperature, DesignReturnTemperature, MinimumFlowFraction optional (minOccurs=0?)

Sashadf1

Waiting for Thibault to give explicit merge approval. It looks fine to me and I didn't notice very many significant changes. I had a few comments about the documentation elements in the xsd that maybe could help users w/ clarity.

ThibaultMarzullo · 2025-03-19T16:40:48Z

Thanks Jie and Sasha! I'll add my review. I added @markborkum to the reviewers to keep him in the fluid loop, Craig will follow soon.

markborkum · 2025-03-19T16:47:40Z

proposals/2025/Add Loop.md

+
+## Overview
+This proposal is to add new elements related to Loop components used in BEM tools such as EnergyPlus/OpenStudio, and to map with the standardized usage of Loop or `FluidLoop` elements in ASHRAE Standard 229P - Protocols for Evaluating Ruleset Application in Building Performance Models. In 229P, `FluidLoop` element is defined and used in [schema](https://github.com/open229/ruleset-model-description-schema/blob/6509fdcc546053e13f06eb78b3fba99328fda58d/docs229/ASHRAE229.schema.json#L3316) for elements as follow:
+* `FluidLoop` -> `fuild_loop`: list of all loops and sources to link from


Typo: fuild_loop

markborkum · 2025-03-19T16:51:24Z

proposals/2025/Add Loop.md

+                            </xs:simpleType>
+                        </xs:element>
+                        <xs:element ref="auc:LinkedScheduleIDs" minOccurs="0"/>
+                        <xs:element name="FluidLoopFlowControlTypes" minOccurs="0">


These should match the capitalization of preexisting enumerations (e.g., "Fixed Flow" and "Variable Flow").

Also, consider adding a "Two Position Flow" enumeration (c.f., https://github.com/BuildingSync/schema/blob/develop-v2/BuildingSync.xsd#L13908-L13921).

markborkum · 2025-03-19T16:54:20Z

proposals/2025/Add Loop.md

+                    <xs:restriction base="xs:string">
+                        <xs:enumeration value="Heating"/>
+                        <xs:enumeration value="Cooling"/>
+                        <xs:enumeration value="Heating and cooling"/>


Consider renaming this enumeration to "Closed".

markborkum · 2025-03-19T16:55:47Z

proposals/2025/Add Loop.md

+                                    <xs:enumeration value="Continuous"/>
+                                    <xs:enumeration value="Intermittent"/>
+                                    <xs:enumeration value="Demand"/>
+                                    <xs:enumeration value="Scheduled"/>


Consider renaming this enumeration to "Timer" to match preexisting enumerations (e.g., https://github.com/BuildingSync/schema/blob/develop-v2/BuildingSync.xsd#L8075-L8089).

markborkum · 2025-03-19T16:57:38Z

proposals/2025/Add Loop.md

+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:complexType name="FluidLoopType">


Should this type have child elements for year installed, year of manufacture, primary fuel, manufacturer, model number, location, linked premises, quantity, equipment ID, etc.?

JieXiong9119 added 4 commits March 5, 2025 13:03

add proposal

ab2cff7

Update Add Loop.md

185757e

Update Add Loop.md

559edb8

Update Add Loop.md

f93428a

JieXiong9119 added DO NOT MERGE Schema: Systems Update to systems Non-breaking Change labels Mar 14, 2025

JieXiong9119 requested review from ThibaultMarzullo and Sashadf1 March 14, 2025 22:41

JieXiong9119 self-assigned this Mar 14, 2025

JieXiong9119 added 9 commits March 14, 2025 17:05

implementation

05aa5da

update implementation

9ad0a79

Update BuildingSync.xsd

bb1adcc

Update BuildingSync.xsd

b2c1d6f

Update BuildingSync.xsd

78a7daf

Update BuildingSync.xsd

17b086f

Update BuildingSync.xsd

39cc2ea

Update BuildingSync.xsd

c92ac8f

Update Add Loop.md

90245fd

Sashadf1 reviewed Mar 18, 2025

View reviewed changes

ThibaultMarzullo requested a review from markborkum March 19, 2025 16:37

markborkum reviewed Mar 19, 2025

View reviewed changes

JieXiong9119 requested a review from craig-simmons March 20, 2025 16:32

JieXiong9119 mentioned this pull request Apr 17, 2025

Add Files (attachment feature) #516

Open

Add FluidLoop #514

Are you sure you want to change the base?

Add FluidLoop #514

Uh oh!

Conversation

JieXiong9119 commented Mar 14, 2025

Any background context you want to provide?

What does this PR do?

How should this be manually tested?

What are the relevant tickets?

Screenshots (if appropriate)

Uh oh!

JieXiong9119 commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sashadf1 Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sashadf1 Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sashadf1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThibaultMarzullo commented Mar 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JieXiong9119 commented Mar 14, 2025 •

edited

Loading

Sashadf1 Mar 18, 2025 •

edited

Loading

Sashadf1 Mar 18, 2025 •

edited

Loading

Sashadf1 left a comment •

edited

Loading