LCOV - code coverage report
Current view: top level - EnergyPlus/GroundTemperatureModeling - FiniteDifferenceGroundTemperatureModel.hh (source / functions) Hit Total Coverage
Test: lcov.output.filtered Lines: 4 4 100.0 %
Date: 2023-01-17 19:17:23 Functions: 4 4 100.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 FiniteDifferenceGroundTemperatureModel_hh_INCLUDED
      49             : #define FiniteDifferenceGroundTemperatureModel_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <memory>
      53             : 
      54             : // ObjexxFCL Headers
      55             : #include <ObjexxFCL/Array1D.hh>
      56             : #include <ObjexxFCL/Array2D.hh>
      57             : #include <ObjexxFCL/Optional.hh>
      58             : 
      59             : // EnergyPlus Headers
      60             : #include <EnergyPlus/EnergyPlus.hh>
      61             : #include <EnergyPlus/GroundTemperatureModeling/BaseGroundTemperatureModel.hh>
      62             : 
      63             : namespace EnergyPlus {
      64             : 
      65             : // Forward declarations
      66             : struct EnergyPlusData;
      67             : 
      68             : // Derived class for Finite-Difference Model
      69           2 : class FiniteDiffGroundTempsModel : public BaseGroundTempsModel
      70             : {
      71             : 
      72             :     static int constexpr maxYearsToIterate = 10;
      73             : 
      74             :     Real64 rhoCp_soil_liq_1;
      75             :     Real64 rhoCP_soil_liq;
      76             :     Real64 rhoCP_soil_transient;
      77             :     Real64 rhoCP_soil_ice;
      78             : 
      79             : public:
      80             :     Real64 baseConductivity;
      81             :     Real64 baseDensity;
      82             :     Real64 baseSpecificHeat;
      83             :     int totalNumCells;
      84             :     Real64 timeStepInSeconds;
      85             :     Real64 evapotransCoeff;
      86             :     Real64 saturatedWaterContent;
      87             :     Real64 waterContent;
      88             :     Real64 annualAveAirTemp;
      89             :     Real64 minDailyAirTemp; // Set hi. Will be reset later
      90             :     Real64 maxDailyAirTemp; // Set low. Will be reset later
      91             :     Real64 dayOfMinDailyAirTemp;
      92             :     Real64 depth;
      93             :     Real64 simTimeInDays;
      94             : 
      95             :     // Default constructor
      96           1 :     FiniteDiffGroundTempsModel() : minDailyAirTemp(100.0), maxDailyAirTemp(-100.0), dayOfMinDailyAirTemp(1)
      97             :     {
      98           1 :     }
      99             : 
     100           1 :     struct instanceOfCellData
     101             :     {
     102             : 
     103             :         struct properties
     104             :         {
     105             :             Real64 conductivity;
     106             :             Real64 density;
     107             :             Real64 specificHeat;
     108             :             Real64 diffusivity;
     109             :             Real64 rhoCp;
     110             :         };
     111             : 
     112             :         properties props;
     113             : 
     114             :         int index;
     115             :         Real64 thickness;
     116             :         Real64 minZValue;
     117             :         Real64 maxZValue;
     118             :         Real64 temperature;
     119             :         Real64 temperature_prevIteration;
     120             :         Real64 temperature_prevTimeStep;
     121             :         Real64 temperature_finalConvergence;
     122             :         Real64 beta;
     123             :         Real64 volume;
     124             :         Real64 conductionArea = 1.0; // Assumes 1 m2
     125             :     };
     126             : 
     127             :     Array1D<instanceOfCellData> cellArray;
     128             : 
     129             :     struct instanceOfWeatherData
     130             :     {
     131             :         Real64 dryBulbTemp;
     132             :         Real64 relativeHumidity;
     133             :         Real64 windSpeed;
     134             :         Real64 horizontalRadiation;
     135             :         Real64 airDensity;
     136             :     };
     137             : 
     138             :     Array1D<instanceOfWeatherData> weatherDataArray;
     139             : 
     140             :     static std::shared_ptr<FiniteDiffGroundTempsModel> FiniteDiffGTMFactory(EnergyPlusData &state, std::string objectName);
     141             : 
     142             :     void getWeatherData(EnergyPlusData &state);
     143             : 
     144             :     void initAndSim(EnergyPlusData &state);
     145             : 
     146             :     void developMesh();
     147             : 
     148             :     void performSimulation(EnergyPlusData &state);
     149             : 
     150             :     void updateSurfaceCellTemperature(EnergyPlusData &state);
     151             : 
     152             :     void updateGeneralDomainCellTemperature(int const cell);
     153             : 
     154             :     void updateBottomCellTemperature();
     155             : 
     156             :     void initDomain(EnergyPlusData &state);
     157             : 
     158             :     bool checkFinalTemperatureConvergence(EnergyPlusData &state);
     159             : 
     160             :     bool checkIterationTemperatureConvergence();
     161             : 
     162             :     void updateIterationTemperatures();
     163             : 
     164             :     void updateTimeStepTemperatures(EnergyPlusData &state);
     165             : 
     166             :     void doStartOfTimeStepInits();
     167             : 
     168             :     Real64 getGroundTemp(EnergyPlusData &state) override;
     169             : 
     170             :     Real64 getGroundTempAtTimeInSeconds(EnergyPlusData &state, Real64 const depth, Real64 const timeInSecondsOfSim) override;
     171             : 
     172             :     Real64 getGroundTempAtTimeInMonths(EnergyPlusData &state, Real64 const depth, int const monthOfSim) override;
     173             : 
     174             :     void evaluateSoilRhoCp(Optional<int const> cell = _, Optional_bool_const InitOnly = _);
     175             : 
     176             :     Real64 interpolate(Real64 const x, Real64 const x_hi, Real64 const x_low, Real64 const y_hi, Real64 const y_low);
     177             : 
     178             :     Array2D<Real64> groundTemps;
     179             : 
     180             :     Array1D<Real64> cellDepths;
     181             : 
     182             :     enum surfaceTypes
     183             :     {
     184             :         surfaceCoverType_bareSoil = 1,
     185             :         surfaceCoverType_shortGrass = 2,
     186             :         surfaceCoverType_longGrass = 3
     187             :     };
     188             : };
     189             : 
     190             : } // namespace EnergyPlus
     191             : 
     192             : #endif

Generated by: LCOV version 1.13