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 SimulationManager_hh_INCLUDED
49 : #define SimulationManager_hh_INCLUDED
50 :
51 : // EnergyPlus Headers
52 : #include <EnergyPlus/Data/BaseData.hh>
53 : #include <EnergyPlus/EnergyPlus.hh>
54 : #include <EnergyPlus/FileSystem.hh>
55 :
56 : namespace EnergyPlus {
57 :
58 : // Forward declarations
59 : struct EnergyPlusData;
60 :
61 : namespace SimulationManager {
62 :
63 : void ManageSimulation(EnergyPlusData &state);
64 :
65 : void GetProjectData(EnergyPlusData &state);
66 :
67 : void writeInitialPerfLogValues(EnergyPlusData &state, std::string const ¤tOverrideModeValue);
68 :
69 : std::string bool_to_string(bool logical);
70 :
71 : void CheckForMisMatchedEnvironmentSpecifications(EnergyPlusData &state);
72 :
73 : void CheckForRequestedReporting(EnergyPlusData &state);
74 :
75 : std::unique_ptr<std::ostream>
76 : OpenStreamFile(EnergyPlusData &state, const fs::path &fileName, std::ios_base::openmode mode = (std::ios_base::out | std::ios_base::trunc));
77 :
78 : std::unique_ptr<fmt::ostream> OpenFmtStreamFile(EnergyPlusData &state, const fs::path &filePath);
79 :
80 : void OpenOutputFiles(EnergyPlusData &state);
81 :
82 : void CloseOutputFiles(EnergyPlusData &state);
83 :
84 : void SetupSimulation(EnergyPlusData &state, bool &ErrorsFound);
85 :
86 : void ReportNodeConnections(EnergyPlusData &state);
87 :
88 : void ReportLoopConnections(EnergyPlusData &state);
89 :
90 : void PostIPProcessing(EnergyPlusData &state);
91 :
92 : void isInputObjectUsed(EnergyPlusData &state);
93 :
94 : } // namespace SimulationManager
95 :
96 : struct SimulationManagerData : BaseGlobalStruct
97 : {
98 : bool RunPeriodsInInput = false;
99 : bool RunControlInInput = false;
100 : bool PreP_Fatal = false;
101 : bool WarningOut = true;
102 :
103 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
104 : {
105 2126 : }
106 :
107 1153 : void init_state(EnergyPlusData &state) override
108 : {
109 1153 : SimulationManager::OpenOutputFiles(state);
110 1153 : SimulationManager::GetProjectData(state);
111 1153 : }
112 :
113 2100 : void clear_state() override
114 : {
115 2100 : this->RunPeriodsInInput = false;
116 2100 : this->RunControlInInput = false;
117 2100 : this->PreP_Fatal = false;
118 2100 : this->WarningOut = true;
119 2100 : }
120 : };
121 :
122 : void Resimulate(EnergyPlusData &state,
123 : bool const ResimExt, // Flag to resimulate the exterior energy use simulation
124 : bool const ResimHB, // Flag to resimulate the heat balance simulation (including HVAC)
125 : bool &ResimHVAC // Flag to resimulate the HVAC simulation
126 : );
127 :
128 : } // namespace EnergyPlus
129 :
130 : #endif
|
