Line data    Source code

       1             : // EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois,
       2             : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
       3             : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
       4             : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
       5             : // contributors. All rights reserved.
       6             : //
       7             : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
       8             : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
       9             : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
      10             : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
      11             : // derivative works, and perform publicly and display publicly, and to permit others to do so.
      12             : //
      13             : // Redistribution and use in source and binary forms, with or without modification, are permitted
      14             : // provided that the following conditions are met:
      15             : //
      16             : // (1) Redistributions of source code must retain the above copyright notice, this list of
      17             : //     conditions and the following disclaimer.
      18             : //
      19             : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
      20             : //     conditions and the following disclaimer in the documentation and/or other materials
      21             : //     provided with the distribution.
      22             : //
      23             : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
      24             : //     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
      25             : //     used to endorse or promote products derived from this software without specific prior
      26             : //     written permission.
      27             : //
      28             : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
      29             : //     without changes from the version obtained under this License, or (ii) Licensee makes a
      30             : //     reference solely to the software portion of its product, Licensee must refer to the
      31             : //     software as "EnergyPlus version X" software, where "X" is the version number Licensee
      32             : //     obtained under this License and may not use a different name for the software. Except as
      33             : //     specifically required in this Section (4), Licensee shall not use in a company name, a
      34             : //     product name, in advertising, publicity, or other promotional activities any name, trade
      35             : //     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
      36             : //     similar designation, without the U.S. Department of Energy's prior written consent.
      37             : //
      38             : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
      39             : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
      40             : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
      41             : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      42             : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      43             : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      44             : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
      45             : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      46             : // POSSIBILITY OF SUCH DAMAGE.
      47             : 
      48             : #ifndef DataBranchNodeConnections_hh_INCLUDED
      49             : #define DataBranchNodeConnections_hh_INCLUDED
      50             : 
      51             : // ObjexxFCL Headers
      52             : #include <ObjexxFCL/Array1D.hh>
      53             : 
      54             : // EnergyPlus Headers
      55             : #include <EnergyPlus/Data/BaseData.hh>
      56             : #include <EnergyPlus/DataGlobals.hh>
      57             : #include <EnergyPlus/EPVector.hh>
      58             : #include <EnergyPlus/EnergyPlus.hh>
      59             : #include <EnergyPlus/NodeInputManager.hh>
      60             : 
      61             : namespace EnergyPlus {
      62             : 
      63             : namespace DataBranchNodeConnections {
      64             : 
      65             :     struct ComponentListData
      66             :     {
      67             :         // Members
      68             :         // std::string ParentCType; // Parent Object Type (Cannot be SPLITTER or MIXER)
      69             :         DataLoopNode::ConnectionObjectType ParentObjectType = DataLoopNode::ConnectionObjectType::Invalid;
      70             :         std::string ParentCName; // Parent Object Name
      71             :         // std::string CType;       // Component Type (Cannot be SPLITTER or MIXER)
      72             :         DataLoopNode::ConnectionObjectType ComponentObjectType = DataLoopNode::ConnectionObjectType::Invalid;
      73             :         std::string CName;          // Component Name
      74             :         std::string InletNodeName;  // Inlet Node ID
      75             :         std::string OutletNodeName; // Outlet Node ID
      76             :         std::string Description;    // Description of Component List Type
      77             :     };
      78             : 
      79             :     struct NodeConnectionDef
      80             :     {
      81             :         // Members
      82             :         int NodeNumber = 0;                                                                          // Node number of this node connection
      83             :         std::string NodeName;                                                                        // Node Name of this node connection
      84             :         DataLoopNode::ConnectionObjectType ObjectType = DataLoopNode::ConnectionObjectType::Invalid; // Object/Component Type of this node connection
      85             :         std::string ObjectName; // Name of the Object/Component Type of this node connection
      86             :         DataLoopNode::ConnectionType ConnectionType =
      87             :             DataLoopNode::ConnectionType::Invalid; // Connection Type (must be valid) for this node connection
      88             :         NodeInputManager::CompFluidStream FluidStream = NodeInputManager::CompFluidStream::Invalid; // Fluid Stream for this node connection
      89             :         bool ObjectIsParent = false;                                                                // Indicator whether the object is a parent or not
      90             :     };
      91             : 
      92             :     struct ParentListData
      93             :     {
      94             :         // Members
      95             :         DataLoopNode::ConnectionObjectType ComponentType =
      96             :             DataLoopNode::ConnectionObjectType::Invalid; // Component Type (Cannot be SPLITTER or MIXER)
      97             :         std::string ComponentName;                       // Component Name
      98             :         std::string InletNodeName;                       // Inlet Node ID
      99             :         std::string OutletNodeName;                      // Outlet Node ID
     100             :         std::string Description;                         // Description of Component List Type
     101             :     };
     102             : 
     103             :     struct EqNodeConnectionDef
     104             :     {
     105             :         // Members
     106             :         std::string NodeName;                                                                        // Node Name of this node connection
     107             :         DataLoopNode::ConnectionObjectType ObjectType = DataLoopNode::ConnectionObjectType::Invalid; // Object/Component Type of this node connection
     108             :         std::string ObjectName;     // Name of the Object/Component Type of this node connection
     109             :         std::string InputFieldName; // Input Field Name for this connection
     110             :         DataLoopNode::ConnectionType ConnectionType =
     111             :             DataLoopNode::ConnectionType::Invalid; // Connection Type (must be valid) for this node connection
     112             :     };
     113             : 
     114             : } // namespace DataBranchNodeConnections
     115             : 
     116             : struct BranchNodeConnectionsData : BaseGlobalStruct
     117             : {
     118             : 
     119             :     int NumCompSets = 0;             // Number of Component Sets found in branches
     120             :     int NumNodeConnectionErrors = 0; // Count of node connection errors
     121             :     int NumOfNodeConnections = 0;
     122             :     int MaxNumOfNodeConnections = 0;
     123             :     int NumOfActualParents = 0;
     124             :     int NumOfAirTerminalNodes = 0;
     125             :     int MaxNumOfAirTerminalNodes = 0;
     126             : 
     127             :     EPVector<DataBranchNodeConnections::ComponentListData> CompSets;
     128             :     EPVector<DataBranchNodeConnections::ParentListData> ParentNodeList;
     129             :     EPVector<DataBranchNodeConnections::NodeConnectionDef> NodeConnections;
     130             :     EPVector<DataBranchNodeConnections::EqNodeConnectionDef> AirTerminalNodeConnections;
     131             :     Array1D_bool NonConnectedNodes;
     132             : 
     133         796 :     void init_state([[maybe_unused]] EnergyPlusData &state) override
     134             :     {
     135         796 :     }
     136             : 
     137           0 :     void clear_state() override
     138             :     {
     139           0 :         new (this) BranchNodeConnectionsData();
     140           0 :     }
     141             : };
     142             : 
     143             : } // namespace EnergyPlus
     144             : 
     145             : #endif