LCOV - code coverage report
Current view: top level - EnergyPlus - WaterManager.hh (source / functions) Hit Total Coverage
Test: lcov.output.filtered Lines: 3 11 27.3 %
Date: 2023-01-17 19:17:23 Functions: 1 2 50.0 %

          Line data    Source code
       1             : // EnergyPlus, Copyright (c) 1996-2023, 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 WaterManager_hh_INCLUDED
      49             : #define WaterManager_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <string>
      53             : 
      54             : // EnergyPlus Headers
      55             : #include <EnergyPlus/Data/BaseData.hh>
      56             : #include <EnergyPlus/EnergyPlus.hh>
      57             : 
      58             : namespace EnergyPlus {
      59             : 
      60             : // Forward declarations
      61             : struct EnergyPlusData;
      62             : 
      63             : namespace WaterManager {
      64             : 
      65             :     void ManageWater(EnergyPlusData &state);
      66             : 
      67             :     void ManageWaterInits(EnergyPlusData &state);
      68             : 
      69             :     void GetWaterManagerInput(EnergyPlusData &state);
      70             : 
      71             :     void UpdatePrecipitation(EnergyPlusData &state);
      72             : 
      73             :     void UpdateIrrigation(EnergyPlusData &state);
      74             : 
      75             :     void CalcWaterStorageTank(EnergyPlusData &state, int const TankNum); // Index of storage tank
      76             : 
      77             :     void SetupTankSupplyComponent(EnergyPlusData &state,
      78             :                                   std::string_view CompName,
      79             :                                   std::string_view CompType,
      80             :                                   std::string_view TankName,
      81             :                                   bool &ErrorsFound,
      82             :                                   int &TankIndex,
      83             :                                   int &WaterSupplyIndex);
      84             : 
      85             :     void InternalSetupTankSupplyComponent(EnergyPlusData &state,
      86             :                                           std::string_view CompName,
      87             :                                           std::string_view CompType,
      88             :                                           std::string_view TankName,
      89             :                                           bool &ErrorsFound,
      90             :                                           int &TankIndex,
      91             :                                           int &WaterSupplyIndex);
      92             : 
      93             :     void SetupTankDemandComponent(EnergyPlusData &state,
      94             :                                   std::string_view CompName,
      95             :                                   std::string_view const CompType,
      96             :                                   std::string_view TankName,
      97             :                                   bool &ErrorsFound,
      98             :                                   int &TankIndex,
      99             :                                   int &WaterDemandIndex);
     100             : 
     101             :     void InternalSetupTankDemandComponent(EnergyPlusData &state,
     102             :                                           std::string_view CompName,
     103             :                                           std::string_view const CompType,
     104             :                                           std::string_view TankName,
     105             :                                           bool &ErrorsFound,
     106             :                                           int &TankIndex,
     107             :                                           int &WaterDemandIndex);
     108             : 
     109             :     void CalcRainCollector(EnergyPlusData &state, int const RainColNum); // Index of rain collector
     110             : 
     111             :     void CalcGroundwaterWell(EnergyPlusData &state, int const WellNum); // Index of well
     112             : 
     113             :     void UpdateWaterManager(EnergyPlusData &state);
     114             : 
     115             :     void ReportRainfall(EnergyPlusData &state);
     116             : 
     117             : } // namespace WaterManager
     118             : 
     119             : struct WaterManagerData : BaseGlobalStruct
     120             : {
     121             : 
     122             :     bool MyOneTimeFlag;
     123             :     bool GetInputFlag; // First time, input is "gotten"
     124             :     bool MyEnvrnFlag;  // flag for init once at start of environment
     125             :     bool MyWarmupFlag; // flag for init after warmup complete
     126             :     bool MyTankDemandCheckFlag;
     127             :     Real64 overflowTwater = 0.0;
     128             : 
     129           0 :     void clear_state() override
     130             :     {
     131           0 :         this->MyOneTimeFlag = true;
     132           0 :         this->GetInputFlag = true;
     133           0 :         this->MyEnvrnFlag = true;
     134           0 :         this->MyWarmupFlag = false;
     135           0 :         this->MyTankDemandCheckFlag = true;
     136           0 :         this->overflowTwater = 0.0;
     137           0 :     }
     138             : 
     139             :     // Default Constructor
     140         771 :     WaterManagerData()
     141         771 :         : MyOneTimeFlag(true), GetInputFlag(true), MyEnvrnFlag(true), MyWarmupFlag(false), MyTankDemandCheckFlag(true), overflowTwater(0.0)
     142             :     {
     143         771 :     }
     144             : };
     145             : 
     146             : } // namespace EnergyPlus
     147             : 
     148             : #endif

Generated by: LCOV version 1.13