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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
|
# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2021 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 Immersed boundaries model data management.
This module contains the following classes and function:
- ImmersedBoundariesModel
"""
#-------------------------------------------------------------------------------
# Library modules
#-------------------------------------------------------------------------------
import sys, unittest
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from code_saturne.model.Common import *
from code_saturne.model.XMLvariables import Variables, Model
from code_saturne.model.XMLmodel import ModelTest
from code_saturne.model.NotebookModel import NotebookModel
#-------------------------------------------------------------------------------
# Cathare coupling model class
#-------------------------------------------------------------------------------
class ImmersedBoundariesModel(Variables, Model):
"""
Manage the input/output markups in the xml doc
"""
# ----------------------------------
def __init__(self, case):
"""
Constructor.
"""
self.case = case
self.__node_models = self.case.xmlGetNode('thermophysical_models')
self.__node_ibm = self.__node_models.xmlInitNode('immersed_boundaries')
self.notebook = NotebookModel(self.case)
# ----------------------------------
# ----------------------------------
def defaultValues(self):
"""
Return in a dictionnary which contains default values.
"""
default = {}
default['OnOff'] = 'off'
default['fsi_object_name'] = "fsi_object"
default['fsi_interaction'] = "imposed"
default['method'] = "explicit"
default['object_density'] = 0.0
default['object_stiffness'] = 0.0
default['object_damping'] = 0.0
default['object_init'] = "0.0"
return default
# ----------------------------------
# ----------------------------------
def getNumberOfFSIObjects(self):
return len(self.__node_ibm.xmlGetNodeList('ibm_object'))
# ----------------------------------
# ----------------------------------
def getObjectsNodeList(self):
return self.__node_ibm.xmlGetNodeList('ibm_object')
# ----------------------------------
# ----------------------------------
def getObjectsNameList(self):
"""
return list of objects' names
"""
objectsList = []
for node in self.__node_ibm.xmlGetNodeList('ibm_object'):
objectsList.append(node['object_name'])
return objectsList
# ----------------------------------
# ----------------------------------
def setOnOff(self, state):
self.__node_ibm.xmlSetData('ibm_state', state)
def getOnOff(self):
state = self.__node_ibm.xmlGetString('ibm_state')
if state == None or state == '':
state = self.defaultValues()['OnOff']
return state
# ----------------------------------
# ----------------------------------
def setMethod(self, method):
self.__node_ibm.xmlSetData('ibm_method', method)
def getMethod(self):
method = self.__node_ibm.xmlGetString('ibm_method')
if method == None or method == '':
method = self.defaultValues()['method']
return method
# ----------------------------------
#------------------------------------------------------------------
# Helper function
#------------------------------------------------------------------
def __getStringData(self, index, name, setFunction):
"""
Get string value from xml file.
"""
self.isLowerOrEqual(index+1, self.getNumberOfFSIObjects())
node = self.__node_ibm.xmlGetNodeList('ibm_object')[index]
value = node.xmlGetString(name)
return self.__getDefaultDataIfNone(index, value, name, setFunction)
def __getIntData(self, index, name, setFunction):
"""
Get int value from xml file.
"""
self.isLowerOrEqual(index+1, self.getNumberOfFSIObjects())
node = self.__node_ibm.xmlGetNodeList('ibm_object')[index]
value = node.xmlGetInt(name)
return self.__getDefaultDataIfNone(index, value, name, setFunction)
def __getDefaultDataIfNone(self, index, value, name, setFunction):
"""
Get default value if value is none.
"""
if value == None or value == "":
value = self.defaultValues()[name]
setFunction(index+1, value)
return value
# ----------------------------------
@Variables.undoGlobal
def addFSIObject(self, name, interaction):
num = self.getNumberOfFSIObjects()
node_new = self.__node_ibm.xmlAddChild('ibm_object')
num += 1
self.setObjectName(num, name)
self.setObjectInteraction(num, interaction)
return num
@Variables.undoLocal
def deleteFSIObject(self, num):
self.isLowerOrEqual(num, self.getNumberOfFSIObjects())
node_list = self.__node_ibm.xmlGetNodeList('ibm_object')
node = node_list[num-1]
node.xmlRemoveNode()
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectName(self, num, name):
self.isLowerOrEqual(num, self.getNumberOfFSIObjects())
self.isStr(name)
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node.xmlSetData('object_name', name)
@Variables.noUndo
def getObjectName(self, num):
return self.__getStringData(num-1, 'object_name',
self.setObjectName)
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectInteraction(self, num, interaction):
self.isLowerOrEqual(num, self.getNumberOfFSIObjects())
self.isStr(interaction)
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node.xmlSetData('object_interaction', interaction)
@Variables.noUndo
def getObjectInteraction(self, num):
return self.__getStringData(num-1, 'object_interaction',
self.setObjectInteraction)
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectDensity(self, num, density):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node.xmlSetData('object_density', density)
@Variables.noUndo
def getObjectDensity(self, num):
return self.__getStringData(num-1, 'object_density',
self.setObjectDensity)
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectStiffness(self, num, stiffness):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node.xmlSetData('object_stiffness', stiffness)
@Variables.noUndo
def getObjectStiffness(self, num):
return self.__getStringData(num-1, 'object_density',
self.setObjectStiffness)
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectDamping(self, num, damping):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node.xmlSetData('object_damping', damping)
@Variables.noUndo
def getObjectDamping(self, num):
return self.__getStringData(num-1, 'object_damping',
self.setObjectDamping)
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectEqPosition(self, num, xeq=None, yeq=None, zeq=None):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_eq = node.xmlInitNode('equilibrium_position')
if xeq:
node_eq.xmlSetData('xeq',xeq)
if yeq:
node_eq.xmlSetData('yeq',yeq)
if zeq:
node_eq.xmlSetData('zeq',zeq)
@Variables.noUndo
def getObjectEqPosition(self, num):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_eq = node.xmlGetChildNode('equilibrium_position')
if node_eq == None:
self.setObjectEqPosition(num,
self.defaultValues()['object_init'],
self.defaultValues()['object_init'],
self.defaultValues()['object_init'])
return self.defaultValues()['object_init'], \
self.defaultValues()['object_init'], \
self.defaultValues()['object_init']
else:
return node_eq.xmlGetString('xeq'), \
node_eq.xmlGetString('yeq'), \
node_eq.xmlGetString('zeq')
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectInitPosition(self, num, xini=None, yini=None, zini=None):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_ini = node.xmlInitNode('initial_position')
if xini:
node_ini.xmlSetData('xini', xini)
if yini:
node_ini.xmlSetData('yini', yini)
if zini:
node_ini.xmlSetData('zini', zini)
@Variables.noUndo
def getObjectInitPosition(self, num):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_ini = node.xmlGetChildNode('initial_position')
if node_ini == None:
self.setObjectInitPosition(num,
self.defaultValues()['object_init'],
self.defaultValues()['object_init'],
self.defaultValues()['object_init'])
return self.defaultValues()['object_init'], \
self.defaultValues()['object_init'], \
self.defaultValues()['object_init']
else:
return node_ini.xmlGetString('xini'), \
node_ini.xmlGetString('yini'), \
node_ini.xmlGetString('zini')
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectInitVel(self, num, vx=None, vy=None, vz=None):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_vel = node.xmlInitNode('initial_velocity')
if vx:
node_vel.xmlSetData('vx', vx)
if vy:
node_vel.xmlSetData('vy', vy)
if vz:
node_vel.xmlSetData('vz', vz)
@Variables.noUndo
def getObjectInitVel(self, num):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_vel = node.xmlGetChildNode('initial_velocity')
if node_vel == None:
self.setObjectInitVel(num,
self.defaultValues()['object_init'],
self.defaultValues()['object_init'],
self.defaultValues()['object_init'])
return self.defaultValues()['object_init'], \
self.defaultValues()['object_init'], \
self.defaultValues()['object_init']
else:
return node_vel.xmlGetString('vx'), \
node_vel.xmlGetString('vy'), \
node_vel.xmlGetString('vz')
# ----------------------------------
# ----------------------------------
@Variables.undoLocal
def setObjectInitAcc(self, num, ax=None, ay=None, az=None):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_acc = node.xmlInitNode('initial_acceleration')
if ax:
node_acc.xmlSetData('ax', ax)
if ay:
node_acc.xmlSetData('ay', ay)
if az:
node_acc.xmlSetData('az', az)
@Variables.noUndo
def getObjectInitAcc(self, num):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[num-1]
node_vel = node.xmlGetChildNode('initial_acceleration')
if node_vel == None:
self.setObjectInitAcc(num,
self.defaultValues()['object_init'],
self.defaultValues()['object_init'],
self.defaultValues()['object_init'])
return self.defaultValues()['object_init'], \
self.defaultValues()['object_init'], \
self.defaultValues()['object_init']
else:
return node_vel.xmlGetString('ax'), \
node_vel.xmlGetString('ay'), \
node_vel.xmlGetString('az')
# ----------------------------------
# ----------------------------------
def deleteObjectFormula(self, objId):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[objId]
node.xmlRemoveChild('explicit_formula')
def setObjectFormula(self, objId, formula):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[objId]
n = node.xmlInitChildNode('explicit_formula')
n.xmlSetTextNode(formula)
def getObjectFormula(self, objId):
node = self.__node_ibm.xmlGetNodeList('ibm_object')[objId]
formula = node.xmlGetString('explicit_formula')
return formula
def getIBMFormulaComponents(self, objId):
exp = self.getObjectFormula(objId)
if not exp:
exp = """indicator = 1;\n"""
req = [('indicator', 'Solid object indicator (1 is fluid, 0 is solid)')]
sym = [('x', 'cell center coordinate'),
('y', 'cell center coordinate'),
('z', 'cell center coordinate'),
('t', 'current time')]
for (name, val) in self.notebook.getNotebookList():
sym.append((name, 'value (notebook) = ' + str(val)))
return exp, req, sym
# ----------------------------------
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|
