LCOV - code coverage report
Current view: top level - EnergyPlus - WindowManagerExteriorData.hh (source / functions) Coverage Total Hit
Test: lcov.output.filtered Lines: 100.0 % 7 7
Test Date: 2025-05-22 16:09:37 Functions: 100.0 % 3 3

            Line data    Source code
       1              : // EnergyPlus, Copyright (c) 1996-2025, 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 WindowManagerExteriorData_hh_INCLUDED
      49              : #define WindowManagerExteriorData_hh_INCLUDED
      50              : 
      51              : // C++ Headers
      52              : #include <map>
      53              : #include <memory>
      54              : #include <vector>
      55              : 
      56              : // EnergyPlus Headers
      57              : #include <EnergyPlus/Data/BaseData.hh>
      58              : #include <EnergyPlus/EnergyPlus.hh>
      59              : #include <EnergyPlus/Material.hh>
      60              : #include <EnergyPlus/Vectors.hh>
      61              : #include <WCEMultiLayerOptics.hpp>
      62              : 
      63              : namespace EnergyPlus {
      64              : 
      65              : // Forward declarations
      66              : struct EnergyPlusData;
      67              : 
      68              : namespace DataHeatBalance {
      69              :     struct MaterialBase;
      70              :     struct MaterialChild;
      71              : } // namespace DataHeatBalance
      72              : 
      73              : } // namespace EnergyPlus
      74              : 
      75              : namespace FenestrationCommon {
      76              : 
      77              : enum class WavelengthRange;
      78              : class CSeries;
      79              : 
      80              : } // namespace FenestrationCommon
      81              : 
      82              : namespace SpectralAveraging {
      83              : 
      84              : class CSpectralSampleData;
      85              : }
      86              : 
      87              : namespace SingleLayerOptics {
      88              : 
      89              : class CBSDFLayer;
      90              : class CScatteringLayer;
      91              : enum class BSDFDirection;
      92              : 
      93              : } // namespace SingleLayerOptics
      94              : 
      95              : namespace MultiLayerOptics {
      96              : 
      97              : class CMultiPaneBSDF;
      98              : class CMultiLayerScattered;
      99              : 
     100              : } // namespace MultiLayerOptics
     101              : 
     102              : namespace EnergyPlus {
     103              : 
     104              : namespace Window {
     105              : 
     106              :     // using IGU_BSDFLayers = std::vector< std::shared_ptr< SingleLayerOptics::CBSDFLayer > >;
     107              :     using IGU_Layers = std::vector<SingleLayerOptics::CScatteringLayer>;
     108              :     // Construction numbers in EnergyPlus are not stored in orders and it can contain wall numbers
     109              :     // in between. So we will just use map to store layers so that we get optimized search.
     110              :     // using LayersBSDF_Map = std::map< int, std::shared_ptr< IGU_BSDFLayers > >;
     111              :     using Layers_Map = std::map<int, IGU_Layers>;
     112              : 
     113              :     // Test if surface is hit by beam defined with vector
     114              :     bool isSurfaceHit(EnergyPlusData &state, const int t_SurfNum, const DataVectorTypes::Vector &t_Ray);
     115              : 
     116              :     // Converts world coordinates (E+) into local surface coordinates that suites better for
     117              :     // WCE operations. Return values are angles Theta and Phi that are used to define WCE direction
     118              :     std::pair<Real64, Real64> getWCECoordinates(EnergyPlusData &state,
     119              :                                                 const int t_SurfNum,
     120              :                                                 const DataVectorTypes::Vector &t_Ray,
     121              :                                                 const SingleLayerOptics::BSDFDirection t_Direction);
     122              : 
     123              :     // Returns Theta and Phi coordinates of surface BSDF for current Sun position
     124              :     std::pair<Real64, Real64> getSunWCEAngles(EnergyPlusData &state, const int t_SurfNum, const SingleLayerOptics::BSDFDirection t_Direction);
     125              : 
     126              :     ///////////////////////////////////////////////////////////////////////////////
     127              :     //   CWCESpecturmProperties
     128              :     ///////////////////////////////////////////////////////////////////////////////
     129              :     class CWCESpecturmProperties
     130              :     {
     131              :     public:
     132              :         static std::shared_ptr<SpectralAveraging::CSpectralSampleData> getSpectralSample(EnergyPlusData &state, int const t_SampleDataPtr);
     133              :         static std::shared_ptr<SpectralAveraging::CSpectralSampleData> getSpectralSample(Material::MaterialGlass const &t_MaterialProperties);
     134              :         static FenestrationCommon::CSeries getDefaultSolarRadiationSpectrum(EnergyPlusData &state);
     135              :         static FenestrationCommon::CSeries getDefaultVisiblePhotopicResponse(EnergyPlusData &state);
     136              :     };
     137              : 
     138              :     ///////////////////////////////////////////////////////////////////////////////
     139              :     //   CWindowConstructionsSimplified
     140              :     ///////////////////////////////////////////////////////////////////////////////
     141              :     // Singleton to keep window constructions in simplified (scattering) format.
     142              :     class CWindowConstructionsSimplified
     143              :     {
     144              :     public:
     145              :         static CWindowConstructionsSimplified &instance(EnergyPlusData &state);
     146              : 
     147              :         void pushLayer(FenestrationCommon::WavelengthRange const t_Range, int t_ConstrNum, const SingleLayerOptics::CScatteringLayer &t_Layer);
     148              : 
     149              :         std::shared_ptr<MultiLayerOptics::CMultiLayerScattered>
     150              :         getEquivalentLayer(EnergyPlusData &state, FenestrationCommon::WavelengthRange t_Range, int t_ConstrNum);
     151              : 
     152              :         static void clearState();
     153              :         CWindowConstructionsSimplified();
     154              : 
     155              :     private:
     156              :         IGU_Layers getLayers(EnergyPlusData &state, FenestrationCommon::WavelengthRange t_Range, int t_ConstrNum) const;
     157              : 
     158              :         // Need separate layer properties for Solar and Visible range
     159              :         std::map<FenestrationCommon::WavelengthRange, Layers_Map> m_Layers;
     160              :         std::map<std::pair<FenestrationCommon::WavelengthRange, int>, std::shared_ptr<MultiLayerOptics::CMultiLayerScattered>> m_Equivalent;
     161              :     };
     162              : 
     163              : } // namespace Window
     164              : 
     165              : struct WindowManagerExteriorData : BaseGlobalStruct
     166              : {
     167              :     std::unique_ptr<Window::CWindowConstructionsSimplified> p_inst;
     168              : 
     169         2126 :     void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
     170              :     {
     171         2126 :     }
     172              : 
     173         1152 :     void init_state([[maybe_unused]] EnergyPlusData &state) override
     174              :     {
     175         1152 :     }
     176              : 
     177         2100 :     void clear_state() override
     178              :     {
     179         2100 :         new (this) WindowManagerExteriorData();
     180         2100 :     }
     181              : };
     182              : 
     183              : } // namespace EnergyPlus
     184              : 
     185              : #endif
        

Generated by: LCOV version 2.0-1