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
|
# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2015 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 Groundwater Law model data management.
This module contains the following classes and function:
- GroundwaterLawModel
- GroundwaterLawTestCase
"""
#-------------------------------------------------------------------------------
# Library modules
#-------------------------------------------------------------------------------
import sys, unittest
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from code_saturne.Base.Common import *
import code_saturne.Base.Toolbox as Tool
from code_saturne.Base.XMLvariables import Variables, Model
from code_saturne.Base.XMLmodel import ModelTest
from code_saturne.Pages.LocalizationModel import LocalizationModel, VolumicLocalizationModel, Zone
from code_saturne.Pages.GroundwaterModel import GroundwaterModel
from code_saturne.Pages.DefineUserScalarsModel import DefineUserScalarsModel
#-------------------------------------------------------------------------------
# GroundwaterLaw model class
#-------------------------------------------------------------------------------
class GroundwaterLawModel(Variables, Model):
"""
Manage the input/output markups in the xml doc about Groundwater Law
"""
def __init__(self, case):
"""
Constructor.
"""
self.case = case
self.node_models = self.case.xmlGetNode('thermophysical_models')
self.node_domain = self.case.xmlGetNode('solution_domain')
self.node_volzone = self.node_domain.xmlGetNode('volumic_conditions')
self.node_darcy = self.node_models.xmlInitNode('groundwater')
self.sca_mo = DefineUserScalarsModel(self.case)
self.choicevalue = ('choice')
self.getNameAndLocalizationZone()
def __defaultValues(self):
"""
Return in a dictionnary which contains default values
"""
default = {}
default['choice'] = 'VanGenuchten'
default['ks'] = 0.3
default['ks_xx'] = 0.3
default['ks_yy'] = 0.3
default['ks_zz'] = 0.3
default['ks_xy'] = 0.
default['ks_xz'] = 0.
default['ks_yz'] = 0.
default['thetas'] = 0.3
default['thetar'] = 0.078
default['n'] = 1.56
default['l'] = 0.5
default['alpha'] = 0.036
default['longitudinal'] = 1.0
default['transverse'] = 0.0
default['isotropic'] = 0.0
default['diffusion_choice'] = 'variable'
default['soil_density'] = 1.0
default['diffusivity'] = 0.0
default['kd'] = 0.0
default['kplus'] = 0.0
default['kminus'] = 0.0
return default
@Variables.noUndo
def getNameAndLocalizationZone(self):
"""
Return name and localization zone from volume regions definitions.
"""
zoneDico = {}
zonesList = LocalizationModel('VolumicZone', self.case).getZones()
for zone in zonesList:
if zone.getNature()['groundwater_law'] == 'on':
label = zone.getLabel()
zoneid = zone.getCodeNumber()
localization = zone.getLocalization()
zoneDico[label] = (zoneid, localization)
self.setNameAndLabelZone(zoneid)
return zoneDico
@Variables.undoGlobal
def setNameAndLabelZone(self, zoneid):
"""
Set name and label zone for porosity markups.
"""
self.node_darcy.xmlInitChildNode('groundwater_law', zone_id=zoneid)
self.getGroundwaterLawModel(zoneid)
@Variables.noUndo
def getGroundwaterLawModel(self, zoneid):
"""
Get the darcy law choice
"""
self.isInt(int(zoneid))
node = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
mdl = node['model']
if mdl == None:
mdl = self.__defaultValues()['choice']
self.setGroundwaterLawModel(zoneid, mdl)
return mdl
@Variables.undoLocal
def setGroundwaterLawModel(self, zoneid, choice):
"""
Get the darcy law choice
"""
self.isInt(int(zoneid))
self.isInList(choice, ['user', 'VanGenuchten'])
node = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
oldchoice = node['model']
node['model'] = choice
# TODO
if oldchoice != None and oldchoice != choice:
if choice == "user":
node.xmlRemoveChild('VanGenuchten_parameters')
else:
node.xmlRemoveChild('formula')
@Variables.undoLocal
def setValue(self, zoneid, variable, value):
"""
Input value for variable
"""
self.isInt(int(zoneid))
self.isFloat(value)
self.isInList(variable, ['ks', 'ks_xx', 'ks_yy', 'ks_zz',
'ks_xy', 'ks_xz', 'ks_yz',
'thetas', 'thetar','n','l','alpha'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
node = nodeZone.xmlInitChildNode('VanGenuchten_parameters')
node.xmlSetData(variable, value)
@Variables.noUndo
def getValue(self, zoneid, variable):
"""
Return value for variable
"""
self.isInt(int(zoneid))
self.isInList(variable, ['ks', 'ks_xx', 'ks_yy', 'ks_zz',
'ks_xy', 'ks_xz', 'ks_yz',
'thetas', 'thetar','n','l','alpha'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
node = nodeZone.xmlInitChildNode('VanGenuchten_parameters')
value = node.xmlGetDouble(variable)
if value == None:
value = self.__defaultValues()[variable]
self.setValue(zoneid, variable, value)
return value
@Variables.undoLocal
def setDispersionCoefficient(self, zoneid, variable, value):
"""
Input value for variable
"""
self.isInt(int(zoneid))
self.isFloat(value)
self.isInList(variable, ['longitudinal', 'transverse', 'isotropic'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
node = nodeZone.xmlInitChildNode('diffusion_coefficient')
node.xmlSetData(variable, value)
@Variables.noUndo
def getDispersionCoefficient(self, zoneid, variable):
"""
Return value for variable
"""
self.isInt(int(zoneid))
self.isInList(variable, ['longitudinal', 'transverse', 'isotropic'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
node = nodeZone.xmlInitChildNode('diffusion_coefficient')
value = node.xmlGetDouble(variable)
if value == None:
value = self.__defaultValues()[variable]
self.setDispersionCoefficient(zoneid, variable, value)
return value
@Variables.undoLocal
def setSoilDensity(self, zoneid, value):
"""
Input value for variable
"""
self.isInt(int(zoneid))
self.isFloat(value)
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
nodeZone.xmlSetData('soil_density', value)
@Variables.noUndo
def getSoilDensity(self, zoneid):
"""
Return value for variable
"""
self.isInt(int(zoneid))
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
value = nodeZone.xmlGetDouble('soil_density')
if value == None:
value = self.__defaultValues()['soil_density']
self.setSoilDensity(zoneid, value)
return value
@Variables.undoLocal
def setGroundwaterLawFormula(self, zoneid, formula):
"""
Public method.
Set the formula for Groundwater
"""
self.isInt(int(zoneid))
node = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
n = node.xmlInitChildNode('formula')
n.xmlSetTextNode(formula)
@Variables.noUndo
def getGroundwaterLawFormula(self, zoneid):
"""
Public method.
Return the formula for Groundwater
"""
self.isInt(int(zoneid))
node = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
formula = node.xmlGetString('formula')
return formula
@Variables.noUndo
def getDefaultGroundwaterLawFormula(self):
"""
Public method.
Return the default formula for Groundwater.
"""
if GroundwaterModel(self.case).getPermeabilityType() == 'anisotropic':
formula = """capacity = 0.;
saturation = 1.;
permeability[XX]=1.;
permeability[YY]=1.;
permeability[ZZ]=1.;
permeability[XY]=0.;
permeability[XZ]=0.;
permeability[YZ]=0.;"""
else:
formula = """capacity = 0.;
saturation = 1.;
permeability=1.;"""
return formula
@Variables.noUndo
def getGroundWaterScalarPropertyByZone(self, scalar_name, zoneid, prop):
"""
Get value for the diffusivity of one scalar on one zone
"""
self.isInt(int(zoneid))
self.isNotInList(scalar_name, self.sca_mo.getScalarsVarianceList())
self.isInList(scalar_name, self.sca_mo.getUserScalarNameList())
self.isInList(prop, ['diffusivity','kd', 'kplus', 'kminus'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
nodeScalar = nodeZone.xmlInitChildNode('scalar', name=scalar_name)
value = nodeScalar.xmlGetDouble(prop)
if value == None:
value = self.__defaultValues()[prop]
self.setGroundWaterScalarPropertyByZone(scalar_name, zoneid, prop, value)
return value
@Variables.undoLocal
def setGroundWaterScalarPropertyByZone(self, scalar_name, zoneid, prop, value):
"""
Set value for the diffusivity of one scalar on one zone
"""
self.isInt(int(zoneid))
self.isNotInList(scalar_name, self.sca_mo.getScalarsVarianceList())
self.isInList(scalar_name, self.sca_mo.getUserScalarNameList())
self.isInList(prop, ['diffusivity','kd', 'kplus', 'kminus'])
nodeZone = self.node_darcy.xmlGetNode('groundwater_law', zone_id=zoneid)
nodeScalar = nodeZone.xmlInitChildNode('scalar', name=scalar_name)
nodeScalar.xmlSetData(prop, value)
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|
