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 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 : #include <EnergyPlus/Material.hh>
57 :
58 : namespace EnergyPlus {
59 :
60 : // Forward declarations
61 : struct EnergyPlusData;
62 :
63 : namespace Material {
64 :
65 : enum class Phase
66 : {
67 : Invalid = -1,
68 : Liquid,
69 : Melting,
70 : Transition,
71 : Freezing,
72 : Crystallized,
73 : Num
74 : };
75 :
76 : static constexpr std::array<int, (int)Phase::Num> phaseInts = {-2, -1, 0, 1, 2};
77 :
78 : struct MaterialPhaseChange : public MaterialBase
79 : {
80 : // members are pretty much all accessed outside of the class in one way or another (by the static factory, etc.)
81 : Real64 enthalpyM = 0.0;
82 : Real64 enthalpyF = 0.0;
83 :
84 : // input parameters
85 : Real64 totalLatentHeat = 0.0;
86 : Real64 specificHeatLiquid = 0.0;
87 : Real64 deltaTempMeltingHigh = 0.0;
88 : Real64 peakTempMelting = 0.0;
89 : Real64 deltaTempMeltingLow = 0.0;
90 : Real64 specificHeatSolid = 0.0;
91 : Real64 deltaTempFreezingHigh = 0.0;
92 : Real64 peakTempFreezing = 0.0;
93 : Real64 deltaTempFreezingLow = 0.0;
94 :
95 : // additional thermal propreties
96 : Real64 fullySolidThermalConductivity = 0.0;
97 : Real64 fullyLiquidThermalConductivity = 0.0;
98 : Real64 fullySolidDensity = 0.0;
99 : Real64 fullyLiquidDensity = 0.0;
100 :
101 : // history and state terms // Why are these here and not in surface?
102 : bool phaseChangeTransition = false;
103 : Real64 enthOld = 0.0;
104 : Real64 enthNew = 0.0;
105 : Real64 enthRev = 0.0;
106 : Real64 CpOld = 0.0;
107 : Real64 specHeatTransition = 0.0;
108 :
109 : Real64 getEnthalpy(Real64 T, Real64 Tc, Real64 tau1, Real64 tau2) const;
110 :
111 : Real64 specHeat(Real64 temperaturePrev,
112 : Real64 temperatureCurrent,
113 : Real64 criticalTemperature,
114 : Real64 tau1,
115 : Real64 tau2,
116 : Real64 EnthalpyOld,
117 : Real64 EnthalpyNew) const;
118 :
119 : // This function modifies some state variables that look like they should belong to surface rather than material
120 : // the Cp calculation function for this class
121 : Real64 getCurrentSpecificHeat(
122 : Real64 prevTempTD, Real64 updatedTempTDT, Real64 phaseChangeTempReverse, Phase prevPhaseChangeState, Phase &phaseChangeState);
123 :
124 : // the conductivity calculation function for this class
125 : Real64 getConductivity(Real64 T) const;
126 :
127 : // the density calculation function for this class
128 : Real64 getDensity(Real64 T) const;
129 :
130 7 : MaterialPhaseChange() : MaterialBase()
131 : {
132 7 : group = Material::Group::Regular;
133 7 : }
134 8 : ~MaterialPhaseChange() = default;
135 : };
136 :
137 : void GetHysteresisData(EnergyPlusData &state, bool &ErrorsFound);
138 :
139 : } // namespace Material
140 :
141 : struct HysteresisPhaseChangeData : BaseGlobalStruct
142 : {
143 :
144 : bool getHysteresisModels = true;
145 :
146 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
147 : {
148 2126 : }
149 :
150 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
151 : {
152 1152 : }
153 :
154 2100 : void clear_state() override
155 : {
156 2100 : getHysteresisModels = true;
157 2100 : }
158 : };
159 :
160 : } // namespace EnergyPlus
161 :
162 : #endif
|
