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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2019 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 initialize model dynamics variables and model scalars
This module contents the following classes:
- SourceTermsModel
- SourceTermsTestCase
"""
#-------------------------------------------------------------------------------
# Library modules import
#-------------------------------------------------------------------------------
import sys, unittest
from math import pow
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from code_saturne.model.Common import *
from code_saturne.model.XMLmodel import XMLmodel, ModelTest
from code_saturne.model.XMLvariables import Model, Variables
from code_saturne.model.DefineUserScalarsModel import DefineUserScalarsModel
from code_saturne.model.LocalizationModel import LocalizationModel
from code_saturne.model.ThermalScalarModel import ThermalScalarModel
from code_saturne.model.DefineUserScalarsModel import DefineUserScalarsModel
from code_saturne.model.NotebookModel import NotebookModel
#-------------------------------------------------------------------------------
# Variables and Scalar model initialization modelling class
#-------------------------------------------------------------------------------
class SourceTermsModel(Model):
"""
Class for Variables and Scalar model initialization.
"""
def __init__(self, case):
"""
Constructor.
"""
self.case = case
self.models = self.case.xmlGetNode('thermophysical_models')
self.node_userscalar = self.case.xmlGetNode('additional_scalars')
self.node_veloce = self.models.xmlGetNode('velocity_pressure')
self.node_turb = self.models.xmlGetNode('turbulence', 'model')
self.node_therm = self.models.xmlGetNode('thermal_scalar', 'model')
self.node_sterm = self.models.xmlInitNode('source_terms')
self.therm = ThermalScalarModel(self.case)
self.th_sca = DefineUserScalarsModel(self.case)
self.notebook = NotebookModel(self.case)
def __verifyZone(self, zone):
"""Private method.
Verify if zone exists and raise ValueError if not.
"""
self.isInt(int(zone))
self.isInList(zone, LocalizationModel('VolumicZone', self.case).getCodeNumbersList())
def getMomentumFormulaComponents(self, zone):
exp = self.getMomentumFormula(zone)
if not exp:
exp = """Su = 0;\nSv = 0;\nSw = 0;\n
dSudu = 0;\ndSudv = 0;\ndSudw = 0;\n
dSvdu = 0;\ndSvdv = 0;\ndSvdw = 0;\n
dSwdu = 0;\ndSwdv = 0;\ndSwdw = 0;\n"""
req = [('Su', "x component of the momentum source term"),
('Sv', "y component of the momentum source term"),
('Sw', "z component of the momentum source term"),
('dSudu', "x component x velocity derivative"),
('dSudv', "x component y velocity derivative"),
('dSudw', "x component z velocity derivative"),
('dSvdu', "y component x velocity derivative"),
('dSvdv', "y component y velocity derivative"),
('dSvdw', "y component z velocity derivative"),
('dSwdu', "z component x velocity derivative"),
('dSwdv', "z component y velocity derivative"),
('dSwdw', "z component z velocity derivative")]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time'),
('volume', 'Source terms zone volume')]
sym.append( ("velocity[0]", 'x velocity component'))
sym.append( ("velocity[1]", 'y velocity component'))
sym.append( ("velocity[2]", 'z velocity component'))
sym.append( ("rho", 'local density (kg/m^3)'))
for (nme, val) in self.notebook.getNotebookList():
sym.append((nme, 'value (notebook) = ' + str(val)))
return exp, req, sym
@Variables.undoLocal
def setMomentumFormula(self, zone, formula):
"""
Public method.
Set the formula for the velocity.
"""
self.__verifyZone(zone)
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
n = node.xmlInitChildNode('momentum_formula', zone_id=zone)
n.xmlSetTextNode(formula)
@Variables.noUndo
def getMomentumFormula(self, zone):
"""
Public method.
Return the formula for the velocity.
"""
self.__verifyZone(zone)
node = self.node_sterm
formula = node.xmlGetString('momentum_formula', zone_id=zone)
return formula
def getSpeciesFormulaComponents(self, zone, species):
exp = self.getSpeciesFormula(zone, species)
if not exp:
exp = """S = 0;\ndS = 0;\n"""
req = [('S', 'species source term'),
('dS', 'species source term derivative')]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time'),
('volume', 'Source terms zone volume')]
name = self.th_sca.getScalarName(species)
sym.append((name, 'current species'))
for (nme, val) in self.notebook.getNotebookList():
sym.append((nme, 'value (notebook) = ' + str(val)))
return exp, req, sym
@Variables.undoGlobal
def setSpeciesFormula(self, zone, species, formula):
"""
Public method.
Set the formula for a turbulent variable.
"""
self.__verifyZone(zone)
self.isInList(species, DefineUserScalarsModel(self.case).getUserScalarNameList())
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
name_species = DefineUserScalarsModel(self.case).getScalarName(species)
n = node.xmlInitChildNode('scalar_formula', name = name_species, label = species, zone_id=zone)
n.xmlSetTextNode(formula)
@Variables.noUndo
def getSpeciesFormula(self, zone, species):
"""
Public method.
Return the formula for a turbulent variable.
"""
self.__verifyZone(zone)
self.isInList(species, DefineUserScalarsModel(self.case).getUserScalarNameList())
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
name_species = DefineUserScalarsModel(self.case).getScalarName(species)
formula = node.xmlGetString('scalar_formula', name = name_species, label = species, zone_id=zone)
return formula
def getGroundWaterSpeciesFormulaComponents(self, zone, species):
exp = self.getGroundWaterSpeciesFormula(zone, species)
if not exp:
exp = """Q = 0;\nlambda = 0;"""
req = [('Q', 'species source term'),
('lambda', 'radioactive decay')]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time'),
('volume', 'Source terms zone volume')]
name = self.th_sca.getScalarName(species)
sym.append((name, 'current species'))
for (nme, val) in self.notebook.getNotebookList():
sym.append((nme, 'value (notebook) = ' + str(val)))
return exp, req, sym
@Variables.undoGlobal
def setGroundWaterSpeciesFormula(self, zone, species, formula):
"""
Public method.
Set the formula for a turbulent variable.
"""
self.__verifyZone(zone)
self.isInList(species, DefineUserScalarsModel(self.case).getUserScalarNameList())
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
name_species = DefineUserScalarsModel(self.case).getScalarName(species)
n = node.xmlInitChildNode('scalar_formula', name = name_species, label = species, zone_id=zone)
n.xmlSetTextNode(formula)
@Variables.noUndo
def getGroundWaterSpeciesFormula(self, zone, species):
"""
Public method.
Return the formula for a turbulent variable.
"""
self.__verifyZone(zone)
self.isInList(species, DefineUserScalarsModel(self.case).getUserScalarNameList())
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
name_species = DefineUserScalarsModel(self.case).getScalarName(species)
formula = node.xmlGetString('scalar_formula', name = name_species, label = species, zone_id=zone)
return formula
def getRichardsFormulaComponents(self, zone):
exp = self.getRichardsFormula(zone)
if not exp:
exp = """Qs = 0;\n"""
req = [('Qs', 'volumetric source term')]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time'),
('volume', 'Source terms zone volume')]
for (nme, val) in self.notebook.getNotebookList():
sym.append((nme, 'value (notebook) = ' + str(val)))
return exp, req, sym
@Variables.undoGlobal
def setRichardsFormula(self, zone, formula):
"""
Public method.
Set the formula for a turbulent variable.
"""
self.__verifyZone(zone)
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
n = node.xmlInitChildNode('volumetric_source_term', zone_id=zone)
n.xmlSetTextNode(formula)
@Variables.noUndo
def getRichardsFormula(self, zone):
"""
Public method.
Return the formula for a turbulent variable.
"""
self.__verifyZone(zone)
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
formula = node.xmlGetString('volumetric_source_term', zone_id=zone)
return formula
def getThermalFormulaComponents(self, zone, scalar):
exp = self.getThermalFormula(zone, scalar)
if not exp:
exp = self.getDefaultThermalFormula(scalar)
req = [('S', 'thermal source term'),
('dS', 'thermal source term derivative')]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time'),
('volume', 'Source terms zone volume')]
if self.case.module_name() == 'code_saturne':
if self.therm.getThermalScalarModel() == 'enthalpy':
sym.append(('enthalpy', 'thermal scalar'))
if self.therm.getThermalScalarModel() == 'total_energy':
sym.append(('total_energy', 'thermal scalar'))
else:
sym.append(('temperature', 'thermal scalar'))
elif self.case.module_name() == 'neptune_cfd':
sym.append(('enthalpy', 'Enthalpy'))
for (nme, val) in self.notebook.getNotebookList():
sym.append((nme, 'value (notebook) = ' + str(val)))
return exp, req, sym
@Variables.undoGlobal
def setThermalFormula(self, zone, scalar, formula):
"""
Public method.
Set the formula for tharmal scalars.
"""
self.__verifyZone(zone)
self.isInList(scalar, ['enthalpy', 'total_energy', 'temperature'])
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
n = node.xmlInitChildNode('thermal_formula', name = scalar, zone_id=zone)
n.xmlSetTextNode(formula)
@Variables.noUndo
def getThermalFormula(self, zone, scalar):
"""
Public method.
Return the formula for thermal scalars.
"""
self.__verifyZone(zone)
self.isInList(scalar, ['enthalpy', 'total_energy', 'temperature'])
node = self.node_sterm
if not node:
msg = "There is an error: this node " + str(node) + "should exist"
raise ValueError(msg)
formula = node.xmlGetString('thermal_formula', name = scalar, zone_id=zone)
return formula
def getDefaultThermalFormula(self, scalar):
"""
Public method.
Return the default formula for thermal scalars.
"""
formula = """S = 0;\ndS = 0;"""
return formula
#-------------------------------------------------------------------------------
# InitializationModel test case
#-------------------------------------------------------------------------------
class SourceTermsTestCase(ModelTest):
"""
Unittest.
"""
def checkSourceTermsInstantiation(self):
"""Check whether the SourceTerms class could be instantiated."""
model = None
model = SourceTermsModel(self.case)
assert model != None, 'Could not instantiate SourceTerms'
def suite():
testSuite = unittest.makeSuite(SourceTermsTestCase, "check")
return testSuite
def runTest():
print("SourceTermsTestCase - OK !!!!")
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|
