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 HVACSizingSimulationManager_hh_INCLUDED
      49              : #define HVACSizingSimulationManager_hh_INCLUDED
      50              : 
      51              : // C++ Headers
      52              : #include <vector>
      53              : 
      54              : // EnergyPlus Headers
      55              : #include <EnergyPlus/Data/BaseData.hh>
      56              : #include <EnergyPlus/DataEnvironment.hh>
      57              : #include <EnergyPlus/DataErrorTracking.hh>
      58              : #include <EnergyPlus/DataGlobals.hh>
      59              : #include <EnergyPlus/DataReportingFlags.hh>
      60              : #include <EnergyPlus/DataSizing.hh>
      61              : #include <EnergyPlus/DataSystemVariables.hh>
      62              : #include <EnergyPlus/DisplayRoutines.hh>
      63              : #include <EnergyPlus/EMSManager.hh>
      64              : #include <EnergyPlus/ExteriorEnergyUse.hh>
      65              : #include <EnergyPlus/FluidProperties.hh>
      66              : #include <EnergyPlus/General.hh>
      67              : #include <EnergyPlus/HeatBalanceManager.hh>
      68              : #include <EnergyPlus/Plant/DataPlant.hh>
      69              : #include <EnergyPlus/Plant/PlantManager.hh>
      70              : #include <EnergyPlus/PlantPipingSystemsManager.hh>
      71              : #include <EnergyPlus/SQLiteProcedures.hh>
      72              : #include <EnergyPlus/SimulationManager.hh>
      73              : #include <EnergyPlus/SizingAnalysisObjects.hh>
      74              : #include <EnergyPlus/UtilityRoutines.hh>
      75              : #include <EnergyPlus/WeatherManager.hh>
      76              : 
      77              : namespace EnergyPlus {
      78              : 
      79              : // Forward declarations
      80              : struct EnergyPlusData;
      81              : 
      82              : class HVACSizingSimulationManager
      83              : {
      84              : public:
      85              :     std::vector<PlantCoinicidentAnalysis> plantCoincAnalyObjs;
      86              :     bool plantCoinAnalyRequestsAnotherIteration;
      87              : 
      88              :     SizingLoggerFramework sizingLogger;
      89              : 
      90              :     void DetermineSizingAnalysesNeeded(EnergyPlusData &state);
      91              :     void SetupSizingAnalyses(EnergyPlusData &state);
      92              : 
      93              :     void RedoKickOffAndResize(EnergyPlusData &state);
      94              :     void PostProcessLogs();
      95              :     void ProcessCoincidentPlantSizeAdjustments(EnergyPlusData &state, int const HVACSizingIterCount);
      96              : 
      97              :     void UpdateSizingLogsZoneStep(EnergyPlusData &state);
      98              :     void UpdateSizingLogsSystemStep(EnergyPlusData &state);
      99              : 
     100              : private:
     101              :     void CreateNewCoincidentPlantAnalysisObject(EnergyPlusData &state, std::string const &PlantLoopName, int const PlantSizingIndex);
     102              : };
     103              : 
     104              : void ManageHVACSizingSimulation(EnergyPlusData &state, bool &ErrorsFound);
     105              : 
     106              : struct HVACSizingSimMgrData : BaseGlobalStruct
     107              : {
     108              :     std::unique_ptr<HVACSizingSimulationManager> hvacSizingSimulationManager;
     109         2126 :     void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
     110              :     {
     111         2126 :     }
     112              : 
     113         1152 :     void init_state([[maybe_unused]] EnergyPlusData &state) override
     114              :     {
     115         1152 :     }
     116              : 
     117         2100 :     void clear_state() override
     118              :     {
     119              :         this->hvacSizingSimulationManager
     120         2100 :             .reset(); // not sure if this is necessary, but it should be fine to destroy it here, it is recreated in ManageHVACSizingSimulation
     121         2100 :     }
     122              : };
     123              : 
     124              : } // namespace EnergyPlus
     125              : 
     126              : #endif