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 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
|
# -*- 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 differents possible outputs : listings, for ensights
chronologic and historic files .... probes .... used variables ...
This module defines the following classes:
- NumericalParamGlobalModel
- NumericalParamGlobalModelTestCase
"""
#-------------------------------------------------------------------------------
# Library modules import
#-------------------------------------------------------------------------------
import 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.OutputVolumicVariablesModel import OutputVolumicVariablesModel
#-------------------------------------------------------------------------------
# NumericalParamGlobal model class
#-------------------------------------------------------------------------------
class NumericalParamGlobalModel(Model):
"""
Manage the input/output markups in the xml doc about Turbulence
"""
def __init__(self, case):
"""
Xml node declaration and supplementary default value settings.
"""
self.case = case
self.node_np = self.case.xmlInitNode('numerical_parameters')
def _defaultValues(self):
"""
default values
"""
self.default = {}
self.default['gradient_transposed'] = 'on'
self.default['pressure_relaxation'] = 1.
self.default['density_relaxation'] = 0.95
self.default['velocity_pressure_coupling'] ='off'
self.default['hydrostatic_pressure'] ='off'
self.default['hydrostatic_equilibrium'] ='on'
self.default['wall_pressure_extrapolation'] = 'neumann'
self.default['time_scheme_order'] = 1
from code_saturne.Pages.GroundwaterModel import GroundwaterModel
if GroundwaterModel(self.case).getGroundwaterModel() != 'off':
self.default['gradient_reconstruction'] = 1
else:
self.default['gradient_reconstruction'] = 0
del GroundwaterModel
return self.default
@Variables.noUndo
def getTransposedGradient(self):
"""
Return status of transposed gradient
"""
node = self.node_np.xmlInitNode('gradient_transposed', 'status')
status = node['status']
if not status:
status = self._defaultValues()['gradient_transposed']
self.setTransposedGradient(status)
return status
@Variables.noUndo
def getVelocityPressureCoupling(self):
"""
Return status of IPUCOU value is activated or not
"""
node = self.node_np.xmlInitNode('velocity_pressure_coupling', 'status')
status = node['status']
if not status:
status = self._defaultValues()['velocity_pressure_coupling']
self.setVelocityPressureCoupling(status)
return status
@Variables.noUndo
def getHydrostaticEquilibrium(self):
"""
Return status of ICFGRP value (for hydrostatic equilibrium) is activated or not
"""
node = self.node_np.xmlInitNode('hydrostatic_equilibrium', 'status')
status = node['status']
if not status:
status = self._defaultValues()['hydrostatic_equilibrium']
self.setHydrostaticEquilibrium(status)
return status
@Variables.noUndo
def getHydrostaticPressure(self):
"""
Return status of hydrostatic pressure :
'off' if standard, 'on' if improved
"""
node = self.node_np.xmlInitNode('hydrostatic_pressure', 'status')
status = node['status']
if not status:
status = self._defaultValues()['hydrostatic_pressure']
self.setHydrostaticPressure(status)
return status
@Variables.noUndo
def getWallPressureExtrapolation(self):
"""
Return EXTRAG value
"""
value = self.node_np.xmlGetString('wall_pressure_extrapolation')
if not value:
value = self._defaultValues()['wall_pressure_extrapolation']
self.setWallPressureExtrapolation(value)
else:
if value == '0':
value = 'neumann'
else:
value = 'extrapolation'
return value
@Variables.noUndo
def getPressureRelaxation(self):
"""
Return RELAXP value
"""
value = self.node_np.xmlGetDouble('pressure_relaxation')
if value == None:
value = self._defaultValues()['pressure_relaxation']
self.setPressureRelaxation(value)
return value
@Variables.noUndo
def getDensityRelaxation(self):
"""
Return SRROM value
"""
value = self.node_np.xmlGetDouble('density_relaxation')
if value == None:
value = self._defaultValues()['density_relaxation']
self.setDensityRelaxation(value)
return value
@Variables.noUndo
def getGradientReconstruction(self):
"""
Return IMRGRA value : 0, 1, 2, 3, 4 or 5
"""
node = self.node_np.xmlInitNode('gradient_reconstruction', 'choice')
choice = node['choice']
if not choice:
choice = self._defaultValues()['gradient_reconstruction']
self.setGradientReconstruction(choice)
return choice
@Variables.undoLocal
def setTransposedGradient(self, status):
"""
Put status of gradient transposed
"""
self.isOnOff(status)
node = self.node_np.xmlInitNode('gradient_transposed', 'status')
node['status'] = status
@Variables.undoLocal
def setVelocityPressureCoupling(self, status):
"""
Put status of velocity_pressure_coupling
"""
self.isOnOff(status)
node_ipucou = self.node_np.xmlInitNode('velocity_pressure_coupling', 'status')
node_ipucou['status'] = status
if status == 'on':
node_Tx = node_ipucou.xmlInitNode('property', name='weight_matrix_X')
node_Ty = node_ipucou.xmlInitNode('property', name='weight_matrix_Y')
node_Tz = node_ipucou.xmlInitNode('property', name='weight_matrix_Z')
for (node, val) in [(node_Tx, 'weight_matrix_X'),
(node_Ty, 'weight_matrix_Y'),
(node_Tz, 'weight_matrix_Z')]:
if not node['label']: node['label'] = Tool.dicoLabel(val)
node.xmlInitChildNode('listing_printing', status="off")
node.xmlInitChildNode('postprocessing_recording', status="off")
else:
for node in node_ipucou.xmlGetNodeList('property'):
node.xmlRemoveNode()
@Variables.undoLocal
def setHydrostaticEquilibrium(self, var):
"""
Put status of hydrostatic equilibrium
"""
self.isOnOff(var)
node = self.node_np.xmlInitNode('hydrostatic_equilibrium', 'status')
node['status'] = var
@Variables.undoLocal
def setHydrostaticPressure(self, var):
"""
Put status of hydrostatic pressure
"""
self.isOnOff(var)
node = self.node_np.xmlInitNode('hydrostatic_pressure', 'status')
node['status'] = var
@Variables.undoLocal
def setPressureRelaxation(self, value):
"""
Put value of pressure_relaxation
"""
self.isPositiveFloat(value)
self.node_np.xmlSetData('pressure_relaxation', value)
@Variables.undoLocal
def setDensityRelaxation(self, value):
"""
Put value of density_relaxation
"""
self.isGreaterOrEqual(value, 0.0)
self.isLower(value, 1.0)
self.node_np.xmlSetData('density_relaxation', value)
@Variables.undoLocal
def setWallPressureExtrapolation(self, value):
"""
Put value of wall pressure extrapolation
"""
self.isInList(value, ('neumann', 'extrapolation'))
if value == 'neumann':
value = '0'
else:
value = '1'
self.node_np.xmlSetData('wall_pressure_extrapolation', value)
@Variables.undoLocal
def setGradientReconstruction(self, value):
"""
Put value of gradient_reconstruction
"""
self.isInt(value)
self.isInList(value, (0, 1, 2, 3, 4, 5))
node = self.node_np.xmlInitNode('gradient_reconstruction', 'choice')
node['choice'] = value
@Variables.undoLocal
def getTimeSchemeOrder(self):
"""
Return time scheme order for NumericalParamEquationModel
"""
# getTimeSchemeOrder: used only by NumericalParamEquationModel
node = self.node_np.xmlGetNode('time_scheme_order')
if node:
order = self.node_np.xmlGetInt('time_scheme_order')
else:
order = self._defaultValues()['time_scheme_order']
return order
@Variables.undoLocal
def setTimeSchemeOrder(self, order):
"""
Set or remove markup of time scheme order for turbulence (LES)
"""
# setTimeSchemeOrder : used only by Turbulence Model
self.isInt(order)
if order == 2:
self.node_np.xmlSetData('time_scheme_order', 2)
else:
self.node_np.xmlRemoveChild('time_scheme_order')
#-------------------------------------------------------------------------------
# NumericalParamEquat test case
#-------------------------------------------------------------------------------
class NumericalParamGlobalTestCase(ModelTest):
"""
"""
def checkNumericalParamGlobalInstantiation(self):
"""
Check whether the NumericalParamEquatModel class could be instantiated
"""
model = None
model = NumericalParamGlobalModel(self.case)
assert model != None, 'Could not instantiate NumericalParamGlobalModel'
def checkSetandGetGradTransp(self):
"""
Check whether the NumericalParamEquatModel class
could be set and get gradient transposed
"""
model = NumericalParamGlobalModel(self.case)
model.setTransposedGradient('on')
doc = """<numerical_parameters>
<gradient_transposed status="on"/>
</numerical_parameters>"""
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set gradient transposed in NumericalParamGlobalModel'
assert model.getTransposedGradient() == 'on',\
'Could not get gradient transposed in NumericalParamGlobalModel'
def checkSetandGetVelPesCoupl(self):
"""
Check whether the NumericalParamEquatModel class
could be set and get velocity pressure coupling
"""
model = NumericalParamGlobalModel(self.case)
model.setVelocityPressureCoupling('on')
doc = '''<numerical_parameters>
<velocity_pressure_coupling status="on">
<property label="VPsolve1" name="weight_matrix_X">
<listing_printing status="off"/>
<postprocessing_recording status="off"/>
</property>
<property label="VPsolve2" name="weight_matrix_Y">
<listing_printing status="off"/>
<postprocessing_recording status="off"/>
</property>
<property label="VPsolve3" name="weight_matrix_Z">
<listing_printing status="off"/>
<postprocessing_recording status="off"/>
</property>
</velocity_pressure_coupling>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set velocity_pressure_coupling in NumericalParamGlobalModel'
assert model.getVelocityPressureCoupling() == 'on',\
'Could not get velocity_pressure_coupling in NumericalParamGlobalModel'
def checkSetandGetWallPressureExtrapolation(self):
"""
Check whether the NumericalParamEquatModel class could be set
and get wall pressure extrapolation
"""
model = None
model = NumericalParamGlobalModel(self.case)
model.setWallPressureExtrapolation('extrapolation')
doc = '''<numerical_parameters>
<wall_pressure_extrapolation>1</wall_pressure_extrapolation>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set wall pressure extrapolation in NumericalParamGlobalModel'
assert model.getWallPressureExtrapolation() == 'extrapolation',\
'Could not get wall pressure extrapolation in NumericalParamGlobalModel'
def checkGetandSetHydrostaticPressure(self):
"""
Check whether the hydrostatic pressure could be set and get
"""
model = NumericalParamGlobalModel(self.case)
model.setHydrostaticPressure('on')
doc = '''<numerical_parameters>
<hydrostatic_pressure status="on"/>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc), \
'Could not set hydrostatic pressure'
assert model.getHydrostaticPressure() == 'on',\
'Could not get hydrostatic pressure'
def checkSetandGetPressureRelaxation(self):
"""
Check whether the NumericalParamEquatModel class could be set
and get pressure relaxation
"""
model = None
model = NumericalParamGlobalModel(self.case)
model.setPressureRelaxation(0.88)
doc = '''<numerical_parameters>
<pressure_relaxation>0.88</pressure_relaxation>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set pressure relaxation in NumericalParamGlobalModel'
assert model.getPressureRelaxation() == 0.88,\
'Could not get pressure relaxation in NumericalParamGlobalModel'
def checkSetandGetDensityRelaxation(self):
"""
Check whether the NumericalParamEquatModel class could be set
and get density relaxation
"""
model = None
model = NumericalParamGlobalModel(self.case)
model.setDensityRelaxation(0.91)
doc = '''<numerical_parameters>
<density_relaxation>0.91</density_relaxation>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set density relaxation in NumericalParamGlobalModel'
assert model.getDensityRelaxation() == 0.91,\
'Could not get density relaxation in NumericalParamGlobalModel'
def checkSetandGetGradientReconstructionruction(self):
"""
Check whether the NumericalParamEquatModel class could be set
and get gradient_reconstruction
"""
model = None
model = NumericalParamGlobalModel(self.case)
model.setGradientReconstruction(3)
doc = '''<numerical_parameters>
<gradient_reconstruction choice="3"/>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set gradient_reconstruction in NumericalParamGlobalModel'
assert model.getGradientReconstruction() == "3",\
'Could not get gradient_reconstruction in NumericalParamGlobalModel'
def checkSetandGetsetTimeSchemeOrder(self):
"""
Check whether the NumericalParamEquatModel class could be set
and get time scheme order
"""
model = None
model = NumericalParamGlobalModel(self.case)
model.setTimeSchemeOrder(2)
doc = '''<numerical_parameters>
<time_scheme_order>2</time_scheme_order>
</numerical_parameters>'''
assert model.node_np == self.xmlNodeFromString(doc),\
'Could not set time scheme order in NumericalParamGlobalModel'
assert model.getTimeSchemeOrder() == 2,\
'Could not get time scheme order in NumericalParamGlobalModel'
def suite():
testSuite = unittest.makeSuite(NumericalParamGlobalTestCase, "check")
return testSuite
def runTest():
print("NumericalParamGlobalModelTestCase")
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|