1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2018 EDF S.A.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
# Street, Fifth Floor, Boston, MA 02110-1301, USA.
#-------------------------------------------------------------------------------
"""
This module defines the thermal scalar management.
This module contains the following classes and function:
- ThermalScalarModel
- ThermalScalarTestCase
"""
#-------------------------------------------------------------------------------
# Library modules import
#-------------------------------------------------------------------------------
import unittest
import sys
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from code_saturne.Base.Common import *
import code_saturne.Base.Toolbox as Tool
from code_saturne.Base.XMLmodel import ModelTest
from code_saturne.Base.XMLvariables import Variables, Model
from code_saturne.Pages.DefineUserScalarsModel import DefineUserScalarsModel
from code_saturne.Pages.ThermalRadiationModel import ThermalRadiationModel
from code_saturne.Pages.ConjugateHeatTransferModel import ConjugateHeatTransferModel
#-------------------------------------------------------------------------------
# Thermal scalar model class
#-------------------------------------------------------------------------------
class ThermalScalarModel(DefineUserScalarsModel, Variables, Model):
"""
The thermal scalar could be temperature
(Celsius degrees or Kelvin) either enthalpy.
"""
def __init__(self, case):
"""
Constuctor.
"""
DefineUserScalarsModel.__init__(self, case)
self.node_models = self.case.xmlGetNode('thermophysical_models')
self.node_therm = self.node_models.xmlInitChildNode('thermal_scalar', 'model')
self.node_coal = self.node_models.xmlGetChildNode('solid_fuels', 'model')
self.node_joule = self.node_models.xmlGetChildNode('joule_effect', 'model')
self.node_gas = self.node_models.xmlGetChildNode('gas_combustion', 'model')
self.node_ray = self.node_models.xmlGetChildNode('radiative_transfer', 'model')
self.node_atmo = self.node_models.xmlGetChildNode('atmospheric_flows', 'model')
self.node_comp = self.node_models.xmlGetChildNode('compressible_model', 'model')
self.old_scaTh = "off"
self.thermalModel = ('off',
'temperature_celsius',
'temperature_kelvin',
'enthalpy',
'potential_temperature',
'liquid_potential_temperature',
'total_energy')
def _defaultThermalScalarValues(self):
"""
Return in a dictionnary which contains default values
"""
default = {}
default['thermal_scalar'] = "off"
return default
def _setNewThermalScalar(self, thermal_scalar):
"""
Put a new thermal scalar name on to the XML document and its dependances
"""
self.isInList(thermal_scalar, self.thermalModel)
if thermal_scalar == 'enthalpy':
name = 'enthalpy'
elif thermal_scalar == 'total_energy':
name = 'total_energy'
else:
name = 'temperature'
node = self.node_therm.xmlInitNode('variable', name=name, type='thermal')
if not node['label']:
lab_def = Tool.dicoLabel(thermal_scalar)
node['label'] = lab_def
else:
lab_def = node['label']
node_prop = self.case.xmlGetNode('physical_properties').xmlGetNode('fluid_properties')
self.setNewFluidProperty(node_prop, 'thermal_conductivity')
self.setScalarBoundaries()
def _removeThermalTimeStep(self):
"""
Private method : remove node 'thermal_time_step' in time_parameters
we call function from TimeStepModel
"""
from code_saturne.Pages.TimeStepModel import TimeStepModel
TimeStepModel(self.case).RemoveThermalTimeStepNode()
del TimeStepModel
def thermalScalarModelsList(self):
"""
Create a tuple with the thermal scalar allowed by the calculation
features (multi-phases model, and reactive flow models).
"""
thermalScalarList = self.thermalModel
for node in (self.node_gas, self.node_coal, self.node_joule, self.node_atmo, self.node_comp):
if node['model'] == "":
node['model'] = 'off'
if node['model'] != 'off':
thermalScalarList = ('off',)
return thermalScalarList
def isSpecificPhysicActiv(self):
"""
"""
spec = False
for node in (self.node_gas, self.node_coal, self.node_joule, self.node_atmo, self.node_comp):
if node != None:
if node['model'] != 'off':
spec = True
return spec
def setThermalModelOutputs(self, thermal_scalar):
"""
Update the thermal model outputs in the XML document.
"""
self.isInList(thermal_scalar, self.thermalModel)
self.node_therm['model'] = thermal_scalar
t_outputs = (("tplus", "Tplus", False),
("thermal_flux", "Thermal flux", True),
("boundary_temperature", "Boundary temperature", True),
("boundary_layer_nusselt", "Dimensionless Thermal flux", False))
if thermal_scalar != 'off' or self.isSpecificPhysicActiv():
for v in t_outputs:
n = self.node_therm.xmlGetChildNode('property',
name=v[0],
support="boundary")
if not n:
n = self.node_therm.xmlInitChildNode('property',
name=v[0],
support="boundary")
if not n['label']:
n['label'] = v[1]
if not v[2]:
n.xmlInitNode('postprocessing_recording')['status']= "off"
else:
for v in t_outputs:
self.node_therm.xmlRemoveChild('property',
name=v[0],
support="boundary")
@Variables.undoGlobal
def setThermalModel(self, thermal_scalar):
"""
Update the thermal model and create the thermal scalar markup from the XML document.
"""
self.isInList(thermal_scalar, self.thermalModel)
self.node_therm['model'] = thermal_scalar
if thermal_scalar != 'off':
node = self.node_therm.xmlGetNode('variable', type='thermal')
if node:
if thermal_scalar == 'enthalpy':
name = 'enthalpy'
elif thermal_scalar == 'total_energy':
name = 'total_energy'
else:
name = 'temperature'
if node['name'] != name or name == 'temperature':
self.deleteThermalScalar(node['name'])
self._setNewThermalScalar(thermal_scalar)
else:
node = self.node_therm.xmlGetNode('variable', type='thermal')
if node:
self.deleteThermalScalar(node['name'])
self._removeThermalTimeStep()
ThermalRadiationModel(self.case).setRadiativeModel('off')
ConjugateHeatTransferModel(self.case).deleteConjugateHeatTransfer()
self.setThermalModelOutputs(thermal_scalar)
@Variables.noUndo
def getThermalScalarModel(self):
"""
Get name of thermal scalar (not label)
"""
model = self.node_therm['model']
if not model:
model = self._defaultThermalScalarValues()['thermal_scalar']
self.setThermalModel(model)
return model
@Variables.noUndo
def getThermalScalarName(self):
"""
Get name for thermal scalar
"""
label = ""
node = self.node_therm.xmlGetNode('variable', type='thermal')
if node:
label = node['name']
return label
#-------------------------------------------------------------------------------
# ThermalScalar Model test case
#-------------------------------------------------------------------------------
class ThermalScalarTestCase(ModelTest):
"""
"""
def checkThermalInstantiation(self):
"""
Check whether the ThermalScalarModel class could be instantiated
"""
model = None
model = ThermalScalarModel(self.case)
assert model != None, 'Could not instantiate ThermalScalarModel'
def checkThermalScalarModelsList(self):
"""
Check whether the ThermalScalarModelsList could be get
"""
mdl = ThermalScalarModel(self.case)
mdl.node_gas['model'] = 'on'
assert mdl.getThermalScalarModel() == ('off'),\
'Could not use the thermalScalarModelsList method'
def checkUpdateandGetThermalScalarModel(self):
"""
Check whether a new thermal scalar could be set and get
"""
mdl = ThermalScalarModel(self.case)
mdl.setThermalModel('temperature_kelvin')
doc = '''<thermal_scalar>
<variable label="TempK" name="temperature" type="thermal">
<initial_value zone_id="1">293.15</initial_value>
<min_value>-1e+12</min_value>
<max_value>1e+12</max_value>
</variable>
</thermal_scalar>'''
assert mdl.scalar_node == self.xmlNodeFromString(doc), \
'Could not update thermal scalar in ThermalScalarModel'
assert mdl.getThermalScalarModel() == 'temperature_kelvin', \
'Could not get the thermal scalar'
def suite():
testSuite = unittest.makeSuite(ThermalScalarTestCase, "check")
return testSuite
def runTest():
print("ThermalScalarTestCase")
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|
