Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2024, 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 <iostream>
50 : #include <sstream>
51 :
52 : // ObjexxFCL Headers
53 : #include <ObjexxFCL/Fmath.hh>
54 :
55 : // EnergyPlus Headers
56 : #include <EnergyPlus/Data/EnergyPlusData.hh>
57 : #include <EnergyPlus/DataGlobals.hh>
58 : #include <EnergyPlus/DataSystemVariables.hh>
59 : #include <EnergyPlus/DisplayRoutines.hh>
60 :
61 : namespace EnergyPlus {
62 :
63 20238 : void DisplayString(EnergyPlusData &state, std::string const &String) // String to be displayed
64 : {
65 :
66 : // SUBROUTINE INFORMATION:
67 : // AUTHOR Linda Lawrie
68 : // DATE WRITTEN Version 1.0
69 : // MODIFIED na
70 : // RE-ENGINEERED na
71 :
72 : // PURPOSE OF THIS SUBROUTINE:
73 : // This subroutine provides a call to display strings during program execution.
74 :
75 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
76 : // na
77 20238 : if (state.dataGlobal->fMessagePtr) state.dataGlobal->fMessagePtr(String);
78 20238 : if (state.dataGlobal->messageCallback) state.dataGlobal->messageCallback(String.c_str());
79 :
80 20238 : if (state.dataGlobal->KickOffSimulation && !state.dataSysVars->DeveloperFlag) return;
81 18794 : if (!state.dataGlobal->printConsoleOutput) return;
82 18794 : std::cout << String << std::endl;
83 : }
84 :
85 36040 : void DisplayString(EnergyPlusData &state, char const *String) // String to be displayed
86 : {
87 :
88 : // SUBROUTINE INFORMATION:
89 : // AUTHOR Linda Lawrie
90 : // DATE WRITTEN Version 1.0
91 : // MODIFIED na
92 : // RE-ENGINEERED Overload to avoid std::string creation overhead
93 :
94 : // PURPOSE OF THIS SUBROUTINE:
95 : // This subroutine provides a call to display strings during program execution.
96 :
97 36040 : if (state.dataGlobal->fMessagePtr) state.dataGlobal->fMessagePtr(String);
98 36040 : if (state.dataGlobal->messageCallback) state.dataGlobal->messageCallback(String);
99 :
100 36040 : if (state.dataGlobal->KickOffSimulation && !state.dataSysVars->DeveloperFlag) return;
101 26116 : if (!state.dataGlobal->printConsoleOutput) return;
102 26116 : std::cout << String << std::endl;
103 : }
104 :
105 0 : void DisplayNumberAndString(EnergyPlusData &state,
106 : int const Number, // number to be displayed
107 : std::string const &String // String to be displayed
108 : )
109 : {
110 :
111 : // SUBROUTINE INFORMATION:
112 : // AUTHOR Linda Lawrie
113 : // DATE WRITTEN Version 1.0
114 : // MODIFIED na
115 : // RE-ENGINEERED na
116 :
117 : // PURPOSE OF THIS SUBROUTINE:
118 : // This subroutine provides a call to display (at set point on screen for screen positioning models) card images
119 : // during program parsing.
120 :
121 : // METHODOLOGY EMPLOYED:
122 : // usage:= call DisplayNumberAndString(numbr,string)
123 :
124 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
125 0 : std::stringstream sstm;
126 0 : sstm << String << ' ' << Number;
127 0 : if (state.dataGlobal->fMessagePtr) state.dataGlobal->fMessagePtr(sstm.str());
128 0 : if (state.dataGlobal->messageCallback) state.dataGlobal->messageCallback(sstm.str().c_str());
129 :
130 0 : if (state.dataGlobal->KickOffSimulation && !state.dataSysVars->DeveloperFlag) return;
131 0 : if (!state.dataGlobal->printConsoleOutput) return;
132 0 : std::cout << String << ' ' << Number << std::endl;
133 0 : }
134 :
135 4710 : void DisplaySimDaysProgress(EnergyPlusData &state,
136 : int const CurrentSimDay, // Current Simulation Day
137 : int const TotalSimDays // Total number of Simulation Days
138 : )
139 : {
140 :
141 : // SUBROUTINE INFORMATION:
142 : // AUTHOR Linda Lawrie
143 : // DATE WRITTEN Version 1.0
144 : // MODIFIED na
145 : // RE-ENGINEERED na
146 :
147 : // PURPOSE OF THIS SUBROUTINE:
148 : // This subroutine provides a call for "progress" during simulation.
149 : // Progress is percent of current days vs total days.
150 :
151 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
152 4710 : int percent(0); // Current percent progress
153 :
154 4710 : if (state.dataGlobal->KickOffSimulation && !state.dataSysVars->DeveloperFlag) return;
155 4336 : if (TotalSimDays > 0) {
156 4336 : percent = nint(((float)CurrentSimDay / (float)TotalSimDays) * 100.0);
157 4336 : percent = min(percent, 100);
158 : } else {
159 0 : percent = 0;
160 : }
161 :
162 4336 : if (state.dataGlobal->fProgressPtr) state.dataGlobal->fProgressPtr(percent);
163 4336 : if (state.dataGlobal->progressCallback) state.dataGlobal->progressCallback(percent);
164 : }
165 :
166 : } // namespace EnergyPlus
|
