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              : // C++ Headers
      49              : #include <vector>
      50              : 
      51              : // EnergyPlus Headers
      52              : #include <EnergyPlus/Data/EnergyPlusData.hh>
      53              : #include <EnergyPlus/EnergyPlus.hh>
      54              : #include <EnergyPlus/GroundTemperatureModeling/BaseGroundTemperatureModel.hh>
      55              : #include <EnergyPlus/GroundTemperatureModeling/FiniteDifferenceGroundTemperatureModel.hh>
      56              : #include <EnergyPlus/GroundTemperatureModeling/GroundTemperatureModelManager.hh>
      57              : #include <EnergyPlus/GroundTemperatureModeling/KusudaAchenbachGroundTemperatureModel.hh>
      58              : #include <EnergyPlus/GroundTemperatureModeling/SiteBuildingSurfaceGroundTemperatures.hh>
      59              : #include <EnergyPlus/GroundTemperatureModeling/SiteDeepGroundTemperatures.hh>
      60              : #include <EnergyPlus/GroundTemperatureModeling/SiteFCFactorMethodGroundTemperatures.hh>
      61              : #include <EnergyPlus/GroundTemperatureModeling/SiteShallowGroundTemperatures.hh>
      62              : #include <EnergyPlus/GroundTemperatureModeling/XingGroundTemperatureModel.hh>
      63              : #include <EnergyPlus/UtilityRoutines.hh>
      64              : 
      65              : namespace EnergyPlus::GroundTemp {
      66              : 
      67          501 : BaseGroundTempsModel *GetGroundTempModelAndInit(EnergyPlusData &state, ModelType modelType, std::string const &name)
      68              : {
      69              :     // SUBROUTINE INFORMATION:
      70              :     //       AUTHOR         Matt Mitchell
      71              :     //       DATE WRITTEN   Summer 2015
      72              : 
      73              :     // PURPOSE OF THIS SUBROUTINE:
      74              :     // Called by objects requiring ground temperature models. Determines type and calls appropriate factory method.
      75              : 
      76              :     // Check if this instance of this model has already been retrieved
      77         1184 :     for (auto *gtm : state.dataGrndTempModelMgr->groundTempModels) {
      78              :         // Check if the type and name match
      79          684 :         if (modelType == gtm->modelType && name == gtm->Name) {
      80            1 :             return gtm;
      81              :         }
      82              :     }
      83              : 
      84              :     // If not found, create new instance of the model
      85          500 :     switch (modelType) {
      86           50 :     case ModelType::Kusuda:
      87           50 :         return KusudaGroundTempsModel::KusudaGTMFactory(state, name);
      88            1 :     case ModelType::FiniteDiff:
      89            1 :         return FiniteDiffGroundTempsModel::FiniteDiffGTMFactory(state, name);
      90          112 :     case ModelType::SiteBuildingSurface:
      91          112 :         return SiteBuildingSurfaceGroundTemps::BuildingSurfaceGTMFactory(state, name);
      92          112 :     case ModelType::SiteShallow:
      93          112 :         return SiteShallowGroundTemps::ShallowGTMFactory(state, name);
      94          112 :     case ModelType::SiteDeep:
      95          112 :         return SiteDeepGroundTemps::DeepGTMFactory(state, name);
      96          112 :     case ModelType::SiteFCFactorMethod:
      97          112 :         return SiteFCFactorMethodGroundTemps::FCFactorGTMFactory(state, name);
      98            1 :     case ModelType::Xing:
      99            1 :         return XingGroundTempsModel::XingGTMFactory(state, name);
     100            0 :     default:
     101            0 :         assert(false);
     102              :         return nullptr;
     103              :     }
     104              : }
     105              : 
     106              : } // namespace EnergyPlus::GroundTemp