LCOV - code coverage report
Current view: top level - EnergyPlus - PondGroundHeatExchanger.hh (source / functions) Hit Total Coverage
Test: lcov.output.filtered Lines: 6 11 54.5 %
Date: 2023-01-17 19:17:23 Functions: 5 7 71.4 %

          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 PondGroundHeatExchanger_hh_INCLUDED
      49             : #define PondGroundHeatExchanger_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             : #include <EnergyPlus/Plant/PlantLocation.hh>
      59             : #include <EnergyPlus/PlantComponent.hh>
      60             : 
      61             : namespace EnergyPlus {
      62             : 
      63             : // Forward declarations
      64             : struct EnergyPlusData;
      65             : 
      66             : namespace PondGroundHeatExchanger {
      67             : 
      68           9 :     struct PondGroundHeatExchangerData : PlantComponent
      69             :     {
      70             :         // Members
      71             :         std::string Name;           // name of pond GHE
      72             :         std::string InletNode;      // pond inlet fluid node
      73             :         std::string OutletNode;     // pond outlet fluid node
      74             :         Real64 DesignMassFlowRate;  // design flow rate of circulating fluid
      75             :         Real64 DesignCapacity;      // design cooling capacity of pond at
      76             :         Real64 Depth;               // depth of pond
      77             :         Real64 Area;                // area of pond
      78             :         Real64 TubeInDiameter;      // hydronic tube inside diameter
      79             :         Real64 TubeOutDiameter;     // hydronic tube outside diameter
      80             :         Real64 TubeConductivity;    // hydronic tube thermal conductivity
      81             :         Real64 GrndConductivity;    // ground thermal conductivity
      82             :         Real64 CircuitLength;       // length of each circuit
      83             :         Real64 BulkTemperature;     // current pond bulk temperature
      84             :         Real64 PastBulkTemperature; // past pond bulk temperature
      85             :         int NumCircuits;            // number of circuits in total
      86             :         int InletNodeNum;           // inlet node number
      87             :         int OutletNodeNum;          // oulet node number
      88             :         int FrozenErrIndex;         // for recurring warnings
      89             :         int ConsecutiveFrozen;      // count of time steps consecutive frozen
      90             :                                     // loop topology variables
      91             :         PlantLocation plantLoc;
      92             : 
      93             :         // Report data
      94             :         Real64 InletTemp;        // fluid inlet temperature
      95             :         Real64 OutletTemp;       // fluid outlet temperature
      96             :         Real64 MassFlowRate;     // fluid mass flow rate
      97             :         Real64 PondTemp;         // pond bulk temperature
      98             :         Real64 HeatTransferRate; // total fluid heat transfer rate, Watts
      99             :         Real64 Energy;           // cumulative energy, Joules
     100             : 
     101             :         bool OneTimeFlag;
     102             :         bool MyFlag;
     103             :         bool setupOutputVarsFlag;
     104             : 
     105             :         int WaterIndex;
     106             : 
     107             :         bool firstTimeThrough;
     108             : 
     109             :         // Default Constructor
     110           3 :         PondGroundHeatExchangerData()
     111           3 :             : DesignMassFlowRate(0.0), DesignCapacity(0.0), Depth(0.0), Area(0.0), TubeInDiameter(0.0), TubeOutDiameter(0.0), TubeConductivity(0.0),
     112             :               GrndConductivity(0.0), CircuitLength(0.0), BulkTemperature(0.0), PastBulkTemperature(0.0), NumCircuits(0), InletNodeNum(0),
     113             :               OutletNodeNum(0), FrozenErrIndex(0), ConsecutiveFrozen(0), plantLoc{}, InletTemp(0.0), OutletTemp(0.0), MassFlowRate(0.0),
     114             :               PondTemp(0.0), HeatTransferRate(0.0), Energy(0.0), OneTimeFlag(true), MyFlag(true), setupOutputVarsFlag(true), WaterIndex(0),
     115           3 :               firstTimeThrough(true)
     116             :         {
     117           3 :         }
     118             : 
     119             :         void
     120             :         simulate(EnergyPlusData &state, const PlantLocation &calledFromLocation, bool FirstHVACIteration, Real64 &CurLoad, bool RunFlag) override;
     121             : 
     122             :         static PlantComponent *factory(EnergyPlusData &state, std::string const &objectName);
     123             : 
     124             :         void getDesignCapacities(
     125             :             EnergyPlusData &state, const PlantLocation &calledFromLocation, Real64 &MaxLoad, Real64 &MinLoad, Real64 &OptLoad) override;
     126             : 
     127             :         void InitPondGroundHeatExchanger(EnergyPlusData &state, bool FirstHVACIteration);
     128             : 
     129             :         void setupOutputVars(EnergyPlusData &state);
     130             : 
     131             :         void CalcPondGroundHeatExchanger(EnergyPlusData &state);
     132             : 
     133             :         Real64 CalcTotalFLux(EnergyPlusData &state, Real64 PondBulkTemp // pond temp for this flux calculation
     134             :         );
     135             : 
     136             :         Real64 CalcEffectiveness(EnergyPlusData &state,
     137             :                                  Real64 InsideTemperature, // Temperature of fluid in pipe circuit, in C
     138             :                                  Real64 PondTemperature,   // Temperature of pond water (i.e. outside the pipe), in C
     139             :                                  Real64 massFlowRate       // Mass flow rate, in kg/s
     140             :         );
     141             : 
     142             :         Real64 CalcSolarFlux(EnergyPlusData &state) const;
     143             : 
     144             :         void UpdatePondGroundHeatExchanger(EnergyPlusData &state);
     145             : 
     146             :         void onInitLoopEquip([[maybe_unused]] EnergyPlusData &state, [[maybe_unused]] const PlantLocation &calledFromLocation) override;
     147             : 
     148             :         void oneTimeInit(EnergyPlusData &state) override;
     149             :     };
     150             : 
     151             :     void GetPondGroundHeatExchanger(EnergyPlusData &state);
     152             : 
     153             : } // namespace PondGroundHeatExchanger
     154             : 
     155        1542 : struct PondGroundHeatExchangerData : BaseGlobalStruct
     156             : {
     157             : 
     158             :     bool GetInputFlag = true;
     159             :     int NumOfPondGHEs = 0;
     160             :     Array1D<PondGroundHeatExchanger::PondGroundHeatExchangerData> PondGHE;
     161             : 
     162           0 :     void clear_state() override
     163             :     {
     164           0 :         this->GetInputFlag = true;
     165           0 :         this->NumOfPondGHEs = 0;
     166           0 :         this->PondGHE.deallocate();
     167           0 :     }
     168             : };
     169             : 
     170             : } // namespace EnergyPlus
     171             : 
     172             : #endif

Generated by: LCOV version 1.13