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 DataSurfaceLists_hh_INCLUDED
      49             : #define DataSurfaceLists_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/EnergyPlus.hh>
      58             : 
      59             : namespace EnergyPlus {
      60             : 
      61             : // Forward declarations
      62             : struct EnergyPlusData;
      63             : 
      64             : namespace DataSurfaceLists {
      65             : 
      66             :     // Types
      67             : 
      68             :     struct SurfaceListData
      69             :     {
      70             :         // Members
      71             :         std::string Name;             // Name of the surface list
      72             :         int NumOfSurfaces;            // Number of surfaces in the list
      73             :         Array1D_string SurfName;      // Surfaces named in the list
      74             :         Array1D_int SurfPtr;          // Location of surfaces in Surface derived type
      75             :         Array1D<Real64> SurfFlowFrac; // Fraction of mass flow/length for a surface
      76             : 
      77             :         // Default Constructor
      78          31 :         SurfaceListData() : NumOfSurfaces(0)
      79             :         {
      80          31 :         }
      81             :     };
      82             : 
      83             :     struct SlabListData
      84             :     {
      85             :         // Members
      86             :         std::string Name;               // Name of the surface list
      87             :         int NumOfSurfaces;              // Number of surfaces in the list
      88             :         Array1D_string SurfName;        // Surfaces named in the list
      89             :         Array1D_int SurfPtr;            // Location of surfaces in Surface derived type
      90             :         Array1D_string ZoneName;        // Zone named in the list
      91             :         Array1D_int ZonePtr;            // Location of Zone in Surface derived type
      92             :         Array1D<Real64> CoreDiameter;   // Fraction of mass flow/length for a surface
      93             :         Array1D<Real64> CoreLength;     // Fraction of mass flow/length for a surface
      94             :         Array1D<Real64> CoreNumbers;    // Fraction of mass flow/length for a surface
      95             :         Array1D_string SlabInNodeName;  // Zone named in the list
      96             :         Array1D_string SlabOutNodeName; // Zone named in the list
      97             : 
      98             :         // Default Constructor
      99          31 :         SlabListData() : NumOfSurfaces(0)
     100             :         {
     101          31 :         }
     102             :     };
     103             : 
     104             :     void GetSurfaceListsInputs(EnergyPlusData &state);
     105             : 
     106             :     int GetNumberOfSurfaceLists(EnergyPlusData &state);
     107             : 
     108             :     int GetNumberOfSurfListVentSlab(EnergyPlusData &state);
     109             : 
     110             : } // namespace DataSurfaceLists
     111             : 
     112             : struct SurfaceListsData : BaseGlobalStruct
     113             : {
     114             :     int NumOfSurfaceLists = 0;            // Number of surface lists in the user input file
     115             :     int NumOfSurfListVentSlab = 0;        // Number of surface lists in the user input file
     116             :     bool SurfaceListInputsFilled = false; // Set to TRUE after first pass through air loop
     117             :     Array1D<DataSurfaceLists::SurfaceListData> SurfList;
     118             :     Array1D<DataSurfaceLists::SlabListData> SlabList;
     119             : 
     120         796 :     void init_state([[maybe_unused]] EnergyPlusData &state) override
     121             :     {
     122         796 :     }
     123             : 
     124           0 :     void clear_state() override
     125             :     {
     126           0 :         this->NumOfSurfaceLists = 0;
     127           0 :         this->NumOfSurfListVentSlab = 0;
     128           0 :         this->SurfaceListInputsFilled = false;
     129           0 :         this->SurfList.deallocate();
     130           0 :         this->SlabList.deallocate();
     131           0 :     }
     132             : };
     133             : 
     134             : } // namespace EnergyPlus
     135             : 
     136             : #endif