Port in first check of distribution

Author: jasondegraw

src/EnergyPlus/AirflowNetwork/include/AirflowNetwork/Elements.hpp

@@ -847,11 +847,11 @@ namespace AirflowNetwork {
         std::string node_name; // EnergyPlus node name
         std::string EPlusType; // EnergyPlus node type
         Real64 Height;         // Nodal height
-        int EPlusNodeNum;      // EPlus node number
+        int node_number;      // EPlus node number
         int AirLoopNum;        // AirLoop number
 
         // Default Constructor
-        DisSysNodeProp() : Height(0.0), EPlusNodeNum(0), AirLoopNum(0)
+        DisSysNodeProp() : Height(0.0), node_number(0), AirLoopNum(0)
         {
         }
     };
@@ -1285,10 +1285,10 @@ namespace AirflowNetwork {
     {
         // Members
         std::string Name;      // Provide a unique node name
-        //std::string node_type_string;  // Provide node type "External", "Thermal Zone" or "Other"
-        //std::string node_name; // EnergyPlus node name
+        // std::string node_type_string; // Provide node type "External", "Thermal Zone" or "Other"
+        // std::string node_name;        // EnergyPlus node name
         Real64 NodeHeight;     // Node height [m]
-        int NodeNum;           // Node number
+        // int node_number;       // Node number
         int NodeTypeNum;       // Node type with integer number,  0: Calculated, 1: Given pressure;
         // std::string zone_name; // EnergyPlus node name
         int EPlusZoneNum;          // E+ zone number
@@ -1302,7 +1302,7 @@ namespace AirflowNetwork {
 
         // Default Constructor
         AirflowNetworkNodeProp()
-            : NodeHeight(0.0), NodeNum(0), NodeTypeNum(0), EPlusZoneNum(0), EPlusNodeNum(0), ExtNodeNum(0), OutAirNodeNum(0),
+            : NodeHeight(0.0), /*node_number(0),*/ NodeTypeNum(0), EPlusZoneNum(0), EPlusNodeNum(0), ExtNodeNum(0), OutAirNodeNum(0),
               EPlusTypeNum(NodeType::Unknown), RAFNNodeNum(0), NumOfLinks(0), AirLoopNum(0)
         {
         }

src/EnergyPlus/AirflowNetwork/include/AirflowNetwork/Solver.hpp

@@ -307,7 +307,8 @@ namespace AirflowNetwork {
                              Real64 &OpenFactor                             // Window or door opening factor (used to calculate airflow)
         );
         void assign_fan_airloop();
-        void validate_distribution();
+        bool validate_network();
+        void finalize_distribution();
         void validate_fan_flowrate(); // Catch a fan flow rate from EPlus input file and add a flag for VAV terminal damper
         void validate_exhaust_fan_input();
         void hybrid_ventilation_control();
@@ -371,6 +372,7 @@ namespace AirflowNetwork {
         Array1D<Real64> LoopOnOffFanRunTimeFraction;
         Array1D<bool> LoopOnOffFlag;
 
+        bool distribution_is_final = false;
         bool ValidateExhaustFanInputOneTimeFlag = true;
         bool initializeOneTimeFlag = true;
         bool initializeMyEnvrnFlag = true;
@@ -595,6 +597,7 @@ namespace AirflowNetwork {
             LoopOnOffFanRunTimeFraction.deallocate();
             LoopOnOffFlag.deallocate();
             UniqueAirflowNetworkSurfaceName.clear();
+            distribution_is_final = false;
             ValidateExhaustFanInputOneTimeFlag = true;
             initializeOneTimeFlag = true;
             initializeMyEnvrnFlag = true;

src/EnergyPlus/AirflowNetwork/src/Solver.cpp

@@ -287,7 +287,7 @@ namespace AirflowNetwork {
 
         if (AirflowNetworkFanActivated && distribution_simulated) {
             if (ValidateDistributionSystemFlag) {
-                validate_distribution();
+                finalize_distribution();
                 validate_fan_flowrate();
                 ValidateDistributionSystemFlag = false;
                 if (simulation_control.autosize_ducts) {
@@ -3923,7 +3923,7 @@ namespace AirflowNetwork {
                 DisSysNodeData(i).node_name = Alphas(2); // Name of associated EnergyPlus node
                 DisSysNodeData(i).EPlusType = Alphas(3); // Name of associated EnergyPlus type
                 DisSysNodeData(i).Height = Numbers(1);   // Nodal height
-                DisSysNodeData(i).EPlusNodeNum = 0;      // EPlus node number
+                DisSysNodeData(i).node_number = 0;      // EPlus node number
                 // verify EnergyPlus object type
                 if (Util::SameString(Alphas(3), "AirLoopHVAC:ZoneMixer") || Util::SameString(Alphas(3), "AirLoopHVAC:ZoneSplitter") ||
                     Util::SameString(Alphas(3), "AirLoopHVAC:OutdoorAirSystem") || Util::SameString(Alphas(3), "OAMixerOutdoorAirStreamNode") ||
@@ -4261,7 +4261,7 @@ namespace AirflowNetwork {
                 AirflowNetworkNodeData(i).NodeTypeNum = 0;
                 AirflowNetworkNodeData(i).EPlusZoneNum = 0;
                 AirflowNetworkNodeData(i).NodeHeight = DisSysNodeData(i - NumOfNodesMultiZone).Height;
-                AirflowNetworkNodeData(i).EPlusNodeNum = DisSysNodeData(i - NumOfNodesMultiZone).EPlusNodeNum;
+                AirflowNetworkNodeData(i).EPlusNodeNum = DisSysNodeData(i - NumOfNodesMultiZone).node_number;
                 // Get mixer information
                 if (Util::SameString(DisSysNodeData(i - NumOfNodesMultiZone).EPlusType, "AirLoopHVAC:ZoneMixer")) {
                     AirflowNetworkNodeData(i).EPlusTypeNum = NodeType::MIX;
@@ -9992,17 +9992,19 @@ namespace AirflowNetwork {
                         OpenFactorMult = 1.0;
                     } else if (DelEnthal >= UpperValInOutEnthalDiff) {
                         OpenFactorMult = LimValVentOpenFacMult;
-                    } else {
-                        OpenFactorMult =
-                            LimValVentOpenFacMult + ((UpperValInOutEnthalDiff - DelEnthal) / (UpperValInOutEnthalDiff - LowerValInOutEnthalDiff)) *
-                                                        (1 - LimValVentOpenFacMult);
+                    }
+ else {
+     OpenFactorMult =
+         LimValVentOpenFacMult + ((UpperValInOutEnthalDiff - DelEnthal) / (UpperValInOutEnthalDiff - LowerValInOutEnthalDiff)) *
+         (1 - LimValVentOpenFacMult);
                     }
                     OpenFactor *= OpenFactorMult;
                     m_state.dataSurface->SurfWinVentingOpenFactorMultRep(SurfNum) = OpenFactorMult;
                 }
-            } else {
-                OpenFactor = 0.0;
-                m_state.dataSurface->SurfWinVentingOpenFactorMultRep(SurfNum) = -1.0;
+            }
+ else {
+     OpenFactor = 0.0;
+     m_state.dataSurface->SurfWinVentingOpenFactorMultRep(SurfNum) = -1.0;
             }
         }
 
@@ -10022,13 +10024,16 @@ namespace AirflowNetwork {
                         m_state.dataThermalComforts->ThermalComfortData(PeopleInd).TComfASH55) {
                         OpenFactor = MultizoneSurfaceData(i).Factor;
                         m_state.dataSurface->SurfWinVentingOpenFactorMultRep(SurfNum) = 1.0;
-                    } else {
+                    }
+                    else {
                         OpenFactor = 0.0;
                     }
-                } else {
+                }
+                else {
                     OpenFactor = 0.0;
                 }
-            } else {
+            }
+            else {
                 OpenFactor = 0.0;
             }
         }
@@ -10041,13 +10046,16 @@ namespace AirflowNetwork {
                         m_state.dataThermalComforts->ThermalComfortData(PeopleInd).TComfCEN15251) {
                         OpenFactor = MultizoneSurfaceData(i).Factor;
                         m_state.dataSurface->SurfWinVentingOpenFactorMultRep(SurfNum) = 1.0;
-                    } else {
+                    }
+                    else {
                         OpenFactor = 0.0;
                     }
-                } else {
+                }
+                else {
                     OpenFactor = 0.0;
                 }
-            } else {
+            }
+            else {
                 OpenFactor = 0.0;
             }
         }
@@ -10078,7 +10086,26 @@ namespace AirflowNetwork {
         }
     }
 
-    void Solver::validate_distribution()
+    bool Solver::validate_network()
+    {
+        bool result = true;
+        // Technically, the nodes could be verified at input time with a bunch of string comparisons on the names,
+        // but this will likely be faster and should get the same result
+        std::vector<int> nodes_already_in_use;
+        for (auto& node : DisSysNodeData) {
+            if (node.node_number)
+            if (std::find(nodes_already_in_use.begin(), nodes_already_in_use.end(), node.node_number) == nodes_already_in_use.end()) {
+                // Node number already in use
+                ShowWarningError(m_state, format("validate_network: Node \"{}\" (node number {}) is used more than once as an AirflowNetwork distribution node, verify that this matches the modeling intent", node.node_name, node.node_number));
+                result = false;
+            } else {
+                nodes_already_in_use.push_back(node.node_number);
+            }
+        }
+        return result;
+    }
+
+    void Solver::finalize_distribution()
     {
 
         // SUBROUTINE INFORMATION:
@@ -10088,9 +10115,14 @@ namespace AirflowNetwork {
         //       RE-ENGINEERED  na
 
         // PURPOSE OF THIS SUBROUTINE:
-        // This subroutine validates the inputs of distribution system, since node data from a primary airloop
-        // are not available in the first call during reading input data of airflownetwork objects.
-        // Note: this routine shouldn't be called more than once
+        // This subroutine finalizes the inputs of distribution system, since node data from a primary airloop
+        // are not available in the first call during reading input data of AirflowNetwork objects.
+        // Note: this routine shouldn't be called more than once, which is enforced with the distribution_is_final
+        // flag. Some of the validation may be moved to the validate_network function.
+
+        if (distribution_is_final) {
+            return;
+        }
 
         // Using/Aliasing
         using BranchNodeConnections::GetNodeConnectionType;
@@ -10148,7 +10180,7 @@ namespace AirflowNetwork {
                                           "The entered name is " + DisSysNodeData(i).node_name + " in an AirflowNetwork:Distribution:Node object.");
                         ErrorsFound = true;
                     }
-                    DisSysNodeData(i).EPlusNodeNum = j;
+                    DisSysNodeData(i).node_number = j;
                     AirflowNetworkNodeData(NumOfNodesMultiZone + i).EPlusNodeNum = j;
                     AirflowNetworkNodeData(NumOfNodesMultiZone + i).AirLoopNum = DisSysNodeData(i).AirLoopNum;
                     NodeFound(j) = true;
@@ -10168,7 +10200,7 @@ namespace AirflowNetwork {
                     ErrorsFound = true;
                 }
             }
-            if (DisSysNodeData(i).EPlusNodeNum == 0) {
+            if (DisSysNodeData(i).node_number == 0) {
                 ShowSevereError(m_state,
                                 format(RoutineName) +
                                     "Primary Air Loop Node is not found in AIRFLOWNETWORK:DISTRIBUTION:NODE = " + DisSysNodeData(i).Name);
@@ -11007,6 +11039,9 @@ namespace AirflowNetwork {
             }
             if (NumOfFans > 1) break;
         }
+
+        distribution_is_final = true;
+
         if (NumOfFans > 1) {
             ShowSevereError(m_state,
                             format(RoutineName) + "An AirLoop branch, " + m_state.dataAirSystemsData->PrimaryAirSystems(1).Branch(BranchNum).Name +

tst/EnergyPlus/unit/AirflowNetworkHVAC.unit.cc

@@ -6081,7 +6081,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_CheckNumOfFansInAirLoopTest)
     state->dataAirSystemsData->PrimaryAirSystems(1).Branch(1).Comp(1).Name = "CVF";
     state->dataAirSystemsData->PrimaryAirSystems(1).Branch(1).Comp(2).Name = "VAV";
 
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
 
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: An AirLoop branch, , has two or more fans: CVF,VAV",
@@ -6156,7 +6156,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_CheckMultiZoneNodes_NoZoneNode)
     state->dataZoneEquip->ZoneEquipConfig(1).NumReturnNodes = 0;
     state->dataZoneEquip->ZoneEquipConfig(1).IsControlled = true;
 
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
 
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: 'ATTIC ZONE AIR NODE' is not defined as an AirflowNetwork:Distribution:Node "
@@ -6251,7 +6251,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_CheckMultiZoneNodes_NoInletNode)
     state->afn->SplitterNodeNumbers(2) = 0;
 
     // MixedAir::NumOAMixers.allocate(1);
-    state->afn->validate_distribution();
+    state->afn->finalize_distribution();
 
     EXPECT_TRUE(compare_err_stream("", true));
 }
@@ -10503,7 +10503,7 @@ TEST_F(EnergyPlusFixture, DISABLED_AirLoopNumTest)
     state->dataZoneEquip->ZoneEquipConfig(1).ReturnNodeAirLoopNum(1) = 1;
     state->dataZoneEquip->ZoneEquipConfig(2).InletNodeAirLoopNum(1) = 1;
     state->dataZoneEquip->ZoneEquipConfig(2).ReturnNodeAirLoopNum(1) = 1;
-    state->afn->DisSysNodeData(9).EPlusNodeNum = 50;
+    state->afn->DisSysNodeData(9).node_number = 50;
     // AirflowNetwork::AirflowNetworkExchangeData.allocate(5);
     state->afn->manage_balance(true);
     EXPECT_EQ(state->afn->DisSysCompCVFData(1).AirLoopNum, 1);
@@ -10797,7 +10797,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestNoZoneEqpSupportZoneERV)
     state->dataHVACStandAloneERV->StandAloneERV(1).HeatExchangerName = "ERV Heat Exchanger";
 
     // Check validation and expected errors
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: 'SupplyFanInletNode' is not defined as an AirflowNetwork:Distribution:Node "
         "object.",
@@ -10978,7 +10978,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestZoneEqpSupportZoneERV)
     state->dataHVACStandAloneERV->StandAloneERV(1).HeatExchangerName = "ERV Heat Exchanger";
 
     // Check validation and expected warning
-    state->afn->validate_distribution();
+    state->afn->finalize_distribution();
 
     EXPECT_TRUE(compare_err_stream(
         "   ** Warning ** AirflowNetwork::Solver::validate_distribution: A ZoneHVAC:EnergyRecoveryVentilator is simulated along with an "
@@ -11146,7 +11146,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestZoneEqpSupportUnbalancedZoneERV)
     state->dataHVACStandAloneERV->StandAloneERV(1).HeatExchangerName = "ERV Heat Exchanger";
 
     // Check validation and expected errors
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: 'SupplyFanInletNode' is not defined as an AirflowNetwork:Distribution:Node "
         "object.",
@@ -11289,7 +11289,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestNoZoneEqpSupportHPWH)
     state->dataWaterThermalTanks->HPWaterHeater(1).FanOutletNode = 3;
 
     // Check validation and expected errors
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: 'SupplyFanInletNode' is not defined as an AirflowNetwork:Distribution:Node "
         "object.",
@@ -11427,7 +11427,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestZoneEqpSupportHPWH)
     state->dataWaterThermalTanks->HPWaterHeater(1).FanOutletNode = 3;
 
     // Check validation and expected warning
-    state->afn->validate_distribution();
+    state->afn->finalize_distribution();
     EXPECT_TRUE(compare_err_stream(
         "   ** Warning ** AirflowNetwork::Solver::validate_distribution: Heat pump water heater is simulated along with an AirflowNetwork "
         "but is not included in the AirflowNetwork.\n",
@@ -11555,7 +11555,7 @@ TEST_F(EnergyPlusFixture, AirflowNetwork_TestZoneEqpSupportHPWHZoneAndOA)
     state->dataWaterThermalTanks->HPWaterHeater(1).FanOutletNode = 3;
 
     // Check validation and expected errors
-    ASSERT_THROW(state->afn->validate_distribution(), std::runtime_error);
+    ASSERT_THROW(state->afn->finalize_distribution(), std::runtime_error);
     std::string const error_string = delimited_string({
         "   ** Severe  ** AirflowNetwork::Solver::validate_distribution: 'SupplyFanInletNode' is not defined as an AirflowNetwork:Distribution:Node "
         "object.",