From 171dcddfda0fdaaee256801193f47cdd698be4cb Mon Sep 17 00:00:00 2001
From: Ben White <61331010+BenTWhite@users.noreply.github.com>
Date: Fri, 17 Jan 2025 06:09:52 -0500
Subject: [PATCH] Adding new KOQs for unitless coefficient (#419)

* new formatters

* had some backwards units

* needed add custom attribute to allow for persistence unit update
---
 .../RoadRailUnits/RoadRailUnits.ecschema.xml  |  6 +++++-
 .../PipeNetworkHydraulicAnalysis.ecschema.xml |  8 ++++----
 .../SewerHydraulicAnalysis.ecschema.xml       | 20 +++++++++++++------
 3 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/Domains/2-DisciplinePhysical/Civil/RoadRailUnits/RoadRailUnits.ecschema.xml b/Domains/2-DisciplinePhysical/Civil/RoadRailUnits/RoadRailUnits.ecschema.xml
index ccd523fad..49c38cd5f 100644
--- a/Domains/2-DisciplinePhysical/Civil/RoadRailUnits/RoadRailUnits.ecschema.xml
+++ b/Domains/2-DisciplinePhysical/Civil/RoadRailUnits/RoadRailUnits.ecschema.xml
@@ -32,4 +32,8 @@
     <KindOfQuantity typeName="PERCENTAGE" displayLabel="Road &amp; Rail Percentage" persistenceUnit="u:DECIMAL_PERCENT" presentationUnits="f:DefaultRealU(2)[u:PERCENT];f:DefaultRealU(4)[u:DECIMAL_PERCENT]" relativeError="0.0001"/>
     <KindOfQuantity typeName="SIDE_SLOPE" displayLabel="Road &amp; Rail Side Slope" persistenceUnit="u:M_HORIZONTAL_PER_M_VERTICAL" presentationUnits="f:DefaultRealU(1)[u:HORIZONTAL_PER_VERTICAL]" relativeError="0.0001"/>
     <KindOfQuantity typeName="INTENSITY_INFILTRATION" displayLabel="Road &amp; Rail Intensity/Infiltration" persistenceUnit="u:M_PER_SEC" presentationUnits="f:DefaultRealU(2)[u:MM_PER_HR];f:DefaultRealU(2)[u:IN_PER_HR]" relativeError="0.0001"/>
-</ECSchema>
+    <KindOfQuantity typeName="RATIONAL_COEFFICIENT" displayLabel="Road &amp; Rail Rational Coefficient" persistenceUnit="u:COEFFICIENT" presentationUnits="f:DefaultRealU(2)[u:COEFFICIENT]" relativeError="0.0001"/>
+    <KindOfQuantity typeName="MANNINGS_N" displayLabel="Road &amp; Rail Manning's n" persistenceUnit="u:COEFFICIENT" presentationUnits="f:DefaultRealU(3)[u:COEFFICIENT]" relativeError="0.0001"/>
+    <KindOfQuantity typeName="HAZEN_WILLIAMS_C" displayLabel="Road &amp; Rail Hazen-William's C" persistenceUnit="u:COEFFICIENT" presentationUnits="f:DefaultRealU(0)[u:COEFFICIENT]" relativeError="0.0001"/>
+    
+    </ECSchema>
diff --git a/Domains/3-DisciplineOther/Hydraulics/PipeNetworkHydraulicAnalysis/PipeNetworkHydraulicAnalysis.ecschema.xml b/Domains/3-DisciplineOther/Hydraulics/PipeNetworkHydraulicAnalysis/PipeNetworkHydraulicAnalysis.ecschema.xml
index de36546ec..b8b7d399d 100644
--- a/Domains/3-DisciplineOther/Hydraulics/PipeNetworkHydraulicAnalysis/PipeNetworkHydraulicAnalysis.ecschema.xml
+++ b/Domains/3-DisciplineOther/Hydraulics/PipeNetworkHydraulicAnalysis/PipeNetworkHydraulicAnalysis.ecschema.xml
@@ -10,7 +10,7 @@
     <ECSchemaReference name="BisCore" version="01.00.10" alias="bis" />
     <ECSchemaReference name="Analytical" version="01.00.01" alias="anlyt" />
     <ECSchemaReference name="AecUnits" version="01.00.03" alias="AECU"/>
-    <ECSchemaReference name="RoadRailUnits" version="01.00.02" alias="rru"/>
+    <ECSchemaReference name="RoadRailUnits" version="01.00.03" alias="rru"/>
     <ECSchemaReference name="PipeworkPhysical" version="01.00.01" alias="pipphys"/>
 
     <ECCustomAttributes>
@@ -39,9 +39,9 @@
 
     <ECEntityClass typeName="HydraulicMaterialAspect" modifier="Sealed" displayLabel="Hydraulic Material Aspect">
         <BaseClass >bis:ElementUniqueAspect</BaseClass>
-        <ECProperty propertyName="ManningsN" typeName="double" displayLabel="Manning's n"/>
-        <ECProperty propertyName="KuttersN" typeName="double" displayLabel="Kutter's n"/>
-        <ECProperty propertyName="HazenWilliamsC" typeName="double" displayLabel="Hazen-William's C"/>
+        <ECProperty propertyName="ManningsN" typeName="double" kindOfQuantity="rru:MANNINGS_N" displayLabel="Manning's n"/>
+        <ECProperty propertyName="KuttersN" typeName="double" kindOfQuantity="rru:MANNINGS_N" displayLabel="Kutter's n"/>
+        <ECProperty propertyName="HazenWilliamsC" typeName="double" kindOfQuantity="rru:HAZEN_WILLIAMS_C" displayLabel="Hazen-William's C"/>
         <ECProperty propertyName="DarcyWeisbachRoughnessHeight" typeName="double" kindOfQuantity="rru:LENGTH_SHORT" displayLabel="Darcy-Weisbach Roughness Height"/>
     </ECEntityClass>
 
diff --git a/Domains/3-DisciplineOther/Hydraulics/SewerHydraulicAnalysis.ecschema.xml b/Domains/3-DisciplineOther/Hydraulics/SewerHydraulicAnalysis.ecschema.xml
index 2675a56e1..3c8d56ff3 100644
--- a/Domains/3-DisciplineOther/Hydraulics/SewerHydraulicAnalysis.ecschema.xml
+++ b/Domains/3-DisciplineOther/Hydraulics/SewerHydraulicAnalysis.ecschema.xml
@@ -13,6 +13,7 @@
     <ECSchemaReference name="RoadRailUnits" version="01.00.03" alias="rru"/>
     <ECSchemaReference name="NetworkTopology" version="01.00.01" alias="net"/>
     <ECSchemaReference name="StormSewerPhysical" version="01.00.01" alias="stmswrphys"/>
+    <ECSchemaReference name="SchemaUpgradeCustomAttributes" version="01.00.00" alias="SchemaUpgradeCA"/>
 
     <ECCustomAttributes>
         <ProductionStatus xmlns="CoreCustomAttributes.01.00.03">
@@ -845,7 +846,7 @@
         <BaseClass>net:IEdge</BaseClass>
         <ECProperty propertyName="StartInvert" typeName="double" displayLabel="Invert (Start)" category="HydraulicData" kindOfQuantity="rru:ELEVATION" description="Set the invert of pipe adjacent to the start node."/>
         <ECProperty propertyName="StopInvert" typeName="double" displayLabel="Invert (Stop)" category="HydraulicData" kindOfQuantity="rru:ELEVATION" description="Set the invert of the pipe adjacent to the stop node."/>
-        <ECProperty propertyName="ManningsN" typeName="double" displayLabel="Manning's n" category="HydraulicData" description="The roughness value for the pipe."/>
+        <ECProperty propertyName="ManningsN" typeName="double" displayLabel="Manning's n" kindOfQuantity="rru:MANNINGS_N" category="HydraulicData" description="The roughness value for the pipe."/>
         <ECProperty propertyName="PlanLength" typeName="double" displayLabel="Length" category="HydraulicData" kindOfQuantity="rru:LENGTH" description="The horizontal length of the pipe."/>
     </ECEntityClass>  
     
@@ -1019,7 +1020,14 @@
 
     <ECEntityClass typeName="CatchmentRationalSimpleAreaAspect" modifier="Sealed" displayLabel="CatchmentRationalSimpleAreaAspect">
         <BaseClass >CatchmentSimpleAreaDefinitionAspect</BaseClass>
-        <ECProperty propertyName="RationalC" typeName="double" displayLabel="Rational C" category="HydraulicData" kindOfQuantity="rru:PERCENTAGE" description="The runoff coefficient used with the Rational Method. C in Q=CiA."/>
+        <ECProperty propertyName="RationalC" typeName="double" displayLabel="Rational C" category="HydraulicData" kindOfQuantity="rru:RATIONAL_COEFFICIENT" description="The runoff coefficient used with the Rational Method. C in Q=CiA.">
+            <ECCustomAttributes>
+                <AllowUnitChange xmlns="SchemaUpgradeCustomAttributes.01.00.00">
+                    <From>u:DECIMAL_PERCENT</From>
+                    <To>u:COEFFICIENT</To>
+                </AllowUnitChange>
+            </ECCustomAttributes>
+            </ECProperty>
     </ECEntityClass>
 
     <ECEntityClass typeName="CatchmentRationalComplexAreaDefinitionAspect" modifier="Sealed" displayLabel="CatchmentRationalComplexAreaAspect">
@@ -1029,16 +1037,16 @@
 
     <ECStructClass typeName="RationalSubarea" modifier="Sealed" description="The list of subareas that comprise the total area of the catchment. The weighted average of the rational c value will be used to compute the runoff.">
         <ECProperty propertyName="RationalSubareaArea" typeName="double" displayLabel="Area" category="HydraulicData" kindOfQuantity="rru:AREA" description="The size of the subarea."/>
-        <ECProperty propertyName="RationalSubareaC" typeName="double" displayLabel="Rational C" category="HydraulicData" description="The Rational C coefficient to be applied to the current subarea."/>
+        <ECProperty propertyName="RationalSubareaC" typeName="double" displayLabel="Rational C" category="HydraulicData" kindOfQuantity="rru:RATIONAL_COEFFICIENT" description="The Rational C coefficient to be applied to the current subarea."/>
     </ECStructClass>
 
     <ECEntityClass typeName="EpaSWMMRunoffMethodAreaAspect" modifier="Sealed" displayLabel="EPA SWMM Runoff Method">
         <BaseClass >CatchmentSimpleAreaDefinitionAspect</BaseClass>
         <ECProperty propertyName="CharacteristicWidth" typeName="double" displayLabel="Characteristic Width" category="HydraulicData" description="The width of the overland flow path for sheet flow runoff (note: the catchment area occupied by Low Impact Development Controls (if any) should not be considered when determining characteristic width)." kindOfQuantity="rru:LENGTH" />
         <ECProperty propertyName="CatchmentSlope" typeName="double" displayLabel="Slope (Catchment)" category="HydraulicData" kindOfQuantity="rru:SLOPE" description="Average slope of the catchment."/>
-        <ECProperty propertyName="ManningsNImpervious" typeName="double" displayLabel="Manning's n (Impervious)" category="HydraulicData" description="Manning's n for overland flow over the impervious portion of the catchment."/>
-        <ECProperty propertyName="ManningsNPervious" typeName="double" displayLabel="Manning's n (Pervious)" category="HydraulicData" description="Manning's n for overland flow over the pervious portion of the catchment."/>
-        <ECProperty propertyName="DepressionStorageImpervious" typeName="double" displayLabel="Storage (Impervious Depression)" category="HydraulicData" kindOfQuantity="rru:LENGTH_SHORT" description="Manning's n for overland flow over the pervious portion of the catchment."/>
+        <ECProperty propertyName="ManningsNImpervious" typeName="double" displayLabel="Manning's n (Impervious)" category="HydraulicData" kindOfQuantity="rru:MANNINGS_N" description="Manning's n for overland flow over the impervious portion of the catchment."/>
+        <ECProperty propertyName="ManningsNPervious" typeName="double" displayLabel="Manning's n (Pervious)" category="HydraulicData" kindOfQuantity="rru:MANNINGS_N" description="Manning's n for overland flow over the pervious portion of the catchment."/>
+        <ECProperty propertyName="DepressionStorageImpervious" typeName="double" displayLabel="Storage (Impervious Depression)" category="HydraulicData" kindOfQuantity="rru:LENGTH_SHORT" description="Depth of depression storage on the impervious portion of the catchment."/>
         <ECProperty propertyName="DepressionStoragePervious" typeName="double" displayLabel="Storage (Pervious Depression)" category="HydraulicData" kindOfQuantity="rru:LENGTH_SHORT" description="Depth of depression storage on the pervious portion of the catchment."/>
         <ECProperty propertyName="PercentImpervious" typeName="double" displayLabel="Percent Impervious" category="HydraulicData" kindOfQuantity="rru:PERCENTAGE" description="Percent of land area (not including any land in this catchment associated with a Low Impact Development Control) that is impervious."/>
         <ECProperty propertyName="PercentZeroStorageImpervious" typeName="double" displayLabel="Percent Zero Storage on Impervious" category="HydraulicData" kindOfQuantity="rru:PERCENTAGE" description="Percent of the impervious area with no depression storage."/>