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 : #ifndef HYSTERESISPHASECHANGE_HH_INCLUDED
49 : #define HYSTERESISPHASECHANGE_HH_INCLUDED
50 :
51 : #include <string>
52 : #include <vector>
53 :
54 : #include <EnergyPlus/Data/BaseData.hh>
55 : #include <EnergyPlus/EnergyPlus.hh>
56 :
57 : namespace EnergyPlus {
58 :
59 : // Forward declarations
60 : struct EnergyPlusData;
61 :
62 : namespace HysteresisPhaseChange {
63 :
64 : struct PhaseChangeStates
65 : {
66 : // keeping these as ints to allow output variable reporting; could refine later into enum class
67 : static const int LIQUID = -2;
68 : static const int MELTING = -1;
69 : static const int TRANSITION = 0;
70 : static const int FREEZING = 1;
71 : static const int CRYSTALLIZED = 2;
72 : };
73 :
74 : class HysteresisPhaseChange
75 : {
76 :
77 : Real64 getEnthalpy(Real64 T, Real64 Tc, Real64 tau1, Real64 tau2);
78 :
79 : Real64 specHeat(Real64 temperaturePrev,
80 : Real64 temperatureCurrent,
81 : Real64 criticalTemperature,
82 : Real64 tau1,
83 : Real64 tau2,
84 : Real64 EnthalpyOld,
85 : Real64 EnthalpyNew);
86 :
87 : public:
88 : // members are pretty much all accessed outside of the class in one way or another (by the static factory, etc.)
89 : std::string name;
90 : Real64 enthalpyM;
91 : Real64 enthalpyF;
92 :
93 : // input parameters
94 : Real64 totalLatentHeat;
95 : Real64 specificHeatLiquid;
96 : Real64 deltaTempMeltingHigh;
97 : Real64 peakTempMelting;
98 : Real64 deltaTempMeltingLow;
99 : Real64 specificHeatSolid;
100 : Real64 deltaTempFreezingHigh;
101 : Real64 peakTempFreezing;
102 : Real64 deltaTempFreezingLow;
103 :
104 : // additional thermal propreties
105 : Real64 fullySolidThermalConductivity;
106 : Real64 fullyLiquidThermalConductivity;
107 : Real64 fullySolidDensity;
108 : Real64 fullyLiquidDensity;
109 :
110 : // history and state terms
111 : bool phaseChangeTransition;
112 : Real64 enthOld;
113 : Real64 enthNew;
114 : Real64 enthRev;
115 : Real64 CpOld;
116 : Real64 specHeatTransition;
117 :
118 : // the factory for this class
119 : static HysteresisPhaseChange *factory(EnergyPlusData &state, const std::string &objectName);
120 :
121 : // the Cp calculation function for this class
122 : Real64 getCurrentSpecificHeat(
123 : Real64 prevTempTD, Real64 updatedTempTDT, Real64 phaseChangeTempReverse, int prevPhaseChangeState, int &phaseChangeState);
124 :
125 : // the conductivity calculation function for this class
126 : Real64 getConductivity(Real64 T);
127 :
128 : // the density calculation function for this class
129 : Real64 getDensity(Real64 T);
130 :
131 : // and the destructor
132 2 : virtual ~HysteresisPhaseChange()
133 2 : {
134 2 : }
135 : };
136 :
137 : void readAllHysteresisModels(EnergyPlusData &state);
138 :
139 : } // namespace HysteresisPhaseChange
140 :
141 : struct HysteresisPhaseChangeData : BaseGlobalStruct
142 : {
143 :
144 : bool getHysteresisModels = true;
145 : int numHysteresisModels = 0;
146 : std::vector<HysteresisPhaseChange::HysteresisPhaseChange> hysteresisPhaseChangeModels;
147 :
148 796 : void init_state([[maybe_unused]] EnergyPlusData &state) override
149 : {
150 796 : }
151 :
152 0 : void clear_state() override
153 : {
154 0 : numHysteresisModels = 0;
155 0 : getHysteresisModels = true;
156 0 : hysteresisPhaseChangeModels.clear();
157 0 : }
158 : };
159 :
160 : } // namespace EnergyPlus
161 :
162 : #endif
|
