/usr/lib/python2.7/dist-packages/code_saturne/Pages/HeadLossesModel.py is in code-saturne-data 4.3.3+repack-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2016 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 HeadLosses model data management.
This module contains the following classes and function:
- HeadLossesModel
- HeadLossesTestCase
"""
#-------------------------------------------------------------------------------
# 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
#-------------------------------------------------------------------------------
# HeadLosses model class
#-------------------------------------------------------------------------------
class HeadLossesModel(Variables, Model):
"""
Manage the input/output markups in the xml doc about HeadLosses
"""
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_hloss = self.node_models.xmlInitNode('heads_losses')
self.coeffNames = ('kxx', 'kyy', 'kzz')
self.matrix = ('a11', 'a12', 'a13',
'a21', 'a22', 'a23',
'a31', 'a32', 'a33')
self.choicevalue = ('choice')
self.getNameAndLocalizationZone()
def __defaultValues(self):
"""
Return in a dictionnary which contains default values
"""
default = {}
default['kxx'] = 0.0
default['kyy'] = 0.0
default['kzz'] = 0.0
default['a11'] = 1.0
default['a12'] = 0.0
default['a13'] = 0.0
default['a21'] = 0.0
default['a22'] = 1.0
default['a23'] = 0.0
default['a31'] = 0.0
default['a32'] = 0.0
default['a33'] = 1.0
default['choice'] = 'off'
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()['head_losses'] == '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 head losses markups.
"""
self.node_hloss.xmlInitChildNode('head_loss', zone_id=zoneid)
self.getKCoefficients(zoneid)
self.getMatrix(zoneid)
self.getMatrixChoice(zoneid,'choice')
@Variables.noUndo
def getMatrixChoice(self,zoneid,choice):
"""
Get the Transfo Matrix choice
"""
self.isInList(choice, self.choicevalue)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
value = node.xmlGetString(choice)
if value == None:
value = self.__defaultValues()[choice]
self.setMatrixChoice(zoneid, choice, value)
return value
@Variables.undoLocal
def setMatrixChoice(self, zoneid, choice, value):
"""
Set the Transfo Matrix Choice
"""
self.isInt(int(zoneid))
self.isInList(choice, self.choicevalue)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
node.xmlSetData(choice, value)
@Variables.noUndo
def getCoefficient(self, zoneid, k):
"""
Return value of coefficient k for the head loss with zone's id.
"""
self.isInt(int(zoneid))
self.isInList(k, self.coeffNames)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
value = node.xmlGetDouble(k)
if value == None:
value = self.__defaultValues()[k]
self.setCoefficient(zoneid, k, value)
return value
@Variables.noUndo
def getKCoefficients(self, zoneid):
"""
Get value of kxx, kyy and kzz from xml file, for the head loss with zone's id.
"""
self.isInt(int(zoneid))
kxx = self.getCoefficient(zoneid, 'kxx')
kyy = self.getCoefficient(zoneid, 'kyy')
kzz = self.getCoefficient(zoneid, 'kzz')
return kxx, kyy, kzz
@Variables.undoLocal
def setCoefficient(self, zoneid, k, value):
"""
Set value of coefficient k for the head loss with zone's id.
"""
self.isInt(int(zoneid))
self.isInList(k, self.coeffNames)
self.isFloat(value)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
node.xmlSetData(k, value)
@Variables.undoGlobal
def setKCoefficients(self, zoneid, kxx, kyy, kzz):
"""
Set value of kxx, kyy and kzz into xml file, for the head loss with zone's id.
"""
self.isInt(int(zoneid))
self.isFloat(kxx)
self.isFloat(kyy)
self.isFloat(kzz)
self.setCoefficient(zoneid, 'kxx', kxx)
self.setCoefficient(zoneid, 'kyy', kyy)
self.setCoefficient(zoneid, 'kzz', kzz)
@Variables.noUndo
def getMatrixComposant(self, zoneid, a):
"""
Get values of one composant of the matrix of the change reference frame,
for the head loss with zone's id.
"""
self.isInt(int(zoneid))
self.isInList(a, self.matrix)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
value = node.xmlGetDouble(a)
if value == None:
value = self.__defaultValues()[a]
self.setMatrixComposant(zoneid, a, value)
return value
@Variables.noUndo
def getMatrix(self, zoneid):
"""
Get values of matrix of the change reference frame from xml file,
for the head loss with zone's id.
"""
self.isInt(int(zoneid))
a11 = self.getMatrixComposant(zoneid, 'a11')
a12 = self.getMatrixComposant(zoneid, 'a12')
a13 = self.getMatrixComposant(zoneid, 'a13')
a21 = self.getMatrixComposant(zoneid, 'a21')
a22 = self.getMatrixComposant(zoneid, 'a22')
a23 = self.getMatrixComposant(zoneid, 'a23')
a31 = self.getMatrixComposant(zoneid, 'a31')
a32 = self.getMatrixComposant(zoneid, 'a32')
a33 = self.getMatrixComposant(zoneid, 'a33')
return a11, a12, a13, a21, a22, a23, a31, a32, a33
@Variables.undoLocal
def setMatrixComposant(self, zoneid, a, value):
"""
Set value of composant of matrix of the change reference frame,
for the head loss with zone's id.
"""
self.isInt(int(zoneid))
self.isInList(a, self.matrix)
self.isFloat(value)
node = self.node_hloss.xmlGetNode('head_loss', zone_id=zoneid)
node.xmlSetData(a, value)
@Variables.undoGlobal
def setMatrix(self, zoneid, a11, a12, a13, a21, a22, a23, a31, a32, a33):
"""
Set values of the matrix of the change reference frame,
for the head loss with zone's id.
"""
self.isInt(int(zoneid))
for a in (a11, a12, a13, a21, a22, a23, a31, a32, a33):
self.isFloat(a)
self.setMatrixComposant(zoneid, 'a11', a11)
self.setMatrixComposant(zoneid, 'a12', a12)
self.setMatrixComposant(zoneid, 'a13', a13)
self.setMatrixComposant(zoneid, 'a21', a21)
self.setMatrixComposant(zoneid, 'a22', a22)
self.setMatrixComposant(zoneid, 'a23', a23)
self.setMatrixComposant(zoneid, 'a31', a31)
self.setMatrixComposant(zoneid, 'a32', a32)
self.setMatrixComposant(zoneid, 'a33', a33)
#-------------------------------------------------------------------------------
# HeadLossesModel test case
#-------------------------------------------------------------------------------
class HeadLossesModelTestCase(ModelTest):
"""
"""
def checkHeadLossesInstantiation(self):
"""Check whether the HeadLossesModel class could be instantiated"""
model = None
model = HeadLossesModel(self.case)
assert model != None, 'Could not instantiate HeadLossesModel'
def checkSetandGetNameLabelandCoefficients(self):
"""Check whether the head_losses markups could be set and get"""
# we create a new zone for head losses
loc = LocalizationModel("VolumicZone", self.case)
zone = Zone("VolumicZone", label='toto', localization="1 or door", nature="head_losses")
loc.addZone(zone)
#we can test
mdl = HeadLossesModel(self.case)
mdl.getNameAndLocalizationZone()
doc = '''<heads_losses>
<head_loss zone_id="2">
<kxx>0</kxx>
<kyy>0</kyy>
<kzz>0</kzz>
<a11>0</a11>
<a12>0</a12>
<a13>0</a13>
<a21>0</a21>
<a22>0</a22>
<a23>0</a23>
<a31>0</a31>
<a32>0</a32>
<a33>0</a33>
</head_loss>
</heads_losses>'''
assert mdl.node_hloss == self.xmlNodeFromString(doc),\
'Could not set zone_id and label for head losses'
assert mdl.getNameAndLocalizationZone() == {'toto': (2, '1 or door')},\
'Could not get zone_id, label and localization for head losses'
def checkSetandGetKCoefficients(self):
"""Check whether the head_losses could be set and get kxx, kyy, kzz"""
# we create a new zone for head losses
loc = LocalizationModel("VolumicZone", self.case)
zone = Zone("VolumicZone", label='toto', localization="1 or door", nature="head_losses")
loc.addZone(zone)
mdl = HeadLossesModel(self.case)
mdl.setKCoefficients('2', 10., 100., 1000.)
doc = '''<heads_losses>
<head_loss zone_id="2">
<kxx>10</kxx>
<kyy>100</kyy>
<kzz>1000</kzz>
<a11>0</a11>
<a12>0</a12>
<a13>0</a13>
<a21>0</a21>
<a22>0</a22>
<a23>0</a23>
<a31>0</a31>
<a32>0</a32>
<a33>0</a33>
</head_loss>
</heads_losses>'''
assert mdl.node_hloss == self.xmlNodeFromString(doc),\
'Could not set kxx, kyy, kzz coefficients for head losses'
assert mdl.getKCoefficients('2') == (10., 100., 1000.),\
'Could not get kxx, kyy, kzz coefficients for head losses'
mdl.setCoefficient('2', 'kyy', 555.)
doc2 = '''<heads_losses>
<head_loss zone_id="2">
<kxx>10</kxx>
<kyy>555</kyy>
<kzz>1000</kzz>
<a11>0</a11>
<a12>0</a12>
<a13>0</a13>
<a21>0</a21>
<a22>0</a22>
<a23>0</a23>
<a31>0</a31>
<a32>0</a32>
<a33>0</a33>
</head_loss>
</heads_losses>'''
assert mdl.node_hloss == self.xmlNodeFromString(doc2),\
'Could not set one coefficient for head losses'
assert mdl.getCoefficient('2', 'kyy') == 555.,\
'Could not get one coefficient for head losses'
def checkSetandGetMatrix(self):
"""Check whether the head_losses could be set and get composantes of matrix"""
# we create a new zone for head losses
loc = LocalizationModel("VolumicZone", self.case)
zone = Zone("VolumicZone", label='toto', localization="1 or door", nature="head_losses")
loc.addZone(zone)
mdl = HeadLossesModel(self.case)
mdl.setMatrix('2', 1., 1.2, 1.5, 2., 2.2, 2.5, 3., 3.2, 3.5)
doc = '''<heads_losses>
<head_loss zone_id="2">
<kxx>0</kxx>
<kyy>0</kyy>
<kzz>0</kzz>
<a11>1</a11>
<a12>1.2</a12>
<a13>1.5</a13>
<a21>2</a21>
<a22>2.2</a22>
<a23>2.5</a23>
<a31>3</a31>
<a32>3.2</a32>
<a33>3.5</a33>
</head_loss>
</heads_losses>'''
assert mdl.node_hloss == self.xmlNodeFromString(doc),\
'Could not set matrix for head losses'
assert mdl.getMatrix('2') == (1., 1.2, 1.5, 2., 2.2, 2.5, 3., 3.2, 3.5),\
'Could not get matrix for head losses'
mdl.setMatrixComposant('2', 'a23', 2300.55)
doc2='''<heads_losses>
<head_loss zone_id="2">
<kxx>0</kxx>
<kyy>0</kyy>
<kzz>0</kzz>
<a11>1</a11>
<a12>1.2</a12>
<a13>1.5</a13>
<a21>2</a21>
<a22>2.2</a22>
<a23>2300.55</a23>
<a31>3</a31>
<a32>3.2</a32>
<a33>3.5</a33>
</head_loss>
</heads_losses>'''
assert mdl.node_hloss == self.xmlNodeFromString(doc2),\
'Could not set one composant of the matrix for head losses'
assert mdl.getMatrixComposant('2', 'a23') == 2300.55,\
'Could not get one composant of the matrix for head losses'
def suite():
testSuite = unittest.makeSuite(HeadLossesModelTestCase, "check")
return testSuite
def runTest():
print("HeadLossesModelTestCase")
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|