# -*- 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 1D profile management page.
This module defines the following classes:
- ProfilesModel
- ProfilesTestCase
"""
#-------------------------------------------------------------------------------
# Library modules import
#-------------------------------------------------------------------------------
import os, sys, types, unittest
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from code_saturne.Base.Common import *
import code_saturne.Base.Toolbox as Tool
from code_saturne.Base.XMLmodel import XMLmodel, ModelTest
from code_saturne.Base.XMLvariables import Model, Variables
from code_saturne.Pages.OutputVolumicVariablesModel import OutputVolumicVariablesModel
#-------------------------------------------------------------------------------
# Model class
#-------------------------------------------------------------------------------
class ProfilesModel(Model):
"""
1D profile management.
"""
def __init__(self, case):
"""
Constructor.
"""
self.case = case
self.node_anal = self.case.xmlInitNode('analysis_control')
self.node_prof = self.node_anal.xmlInitNode('profiles')
self.node_model = self.case.xmlInitNode('thermophysical_models')
self.node_model_vp = self.node_model.xmlInitNode('velocity_pressure')
self.node_var_vp = self.node_model_vp.xmlGetNodeList('variable')
self.node_pro_vp = self.node_model_vp.xmlGetNodeList('property')
self.__var_prop_list = self.getVariablesAndVolumeProperties()
def __defaultValues(self):
"""
Private method.
Returns a dictionnary with default values.
"""
value = {}
value['nfreq'] = -1
value['formula'] = "x = 0;\ny = s;\nz = 0;\n"
value['points'] = 200
value['label'] = "profile"
value['choice'] = "frequency"
value['frequency'] = 1
value['format'] = "CSV"
return value
@Variables.noUndo
def getVariablesAndVolumeProperties(self):
"""
Creates a dictionnary to connect name and label from
variables and properties.
"""
# FIXME: merge this method with the same one in TimeAveragesView
self.dicoLabel2Name = {}
model = XMLmodel(self.case)
output = OutputVolumicVariablesModel(self.case)
for nodeList in [self.node_var_vp,
self.node_pro_vp,
model.getTurbNodeList(),
output.getFluidProperty(),
output.getAdditionalScalarProperty(),
output.getTimeProperty(),
output.getListOfTimeAverage(),
output.getPuCoalScalProper(),
output.getGasCombScalProper(),
output.getMeteoScalProper(),
output.getElecScalProper(),
output.getThermalScalar(),
output.getAdditionalScalar()]:
for node in nodeList:
name = node['name']
label = node['label']
if not label:
raise ValueError("Node has no label")
dim = node['dimension']
if dim and int(dim) > 1:
# If we consider the Rij tensor, the user will see
# R11, R22, ... in the GUI instead of Rij[0], Rij[1], ...
# This choice was considered as the clearest.
# CK
if name == 'rij':
rij_lbls = ['R11', 'R22', 'R33', 'R12', 'R23', 'R13']
for ii in range(int(dim)):
label1 = rij_lbls[ii]
if not (node['support'] and node['support'] == "boundary"):
self.dicoLabel2Name[label1] = (name, str(ii))
else:
for ii in range(int(dim)):
label1 = label + "[" + str(ii) + "]"
if not (node['support'] and node['support'] == "boundary"):
self.dicoLabel2Name[label1] = (name, str(ii))
else:
if not (node['support'] and node['support'] == "boundary"):
if name != 'local_time_step':
self.dicoLabel2Name[label] = (name, str(0))
return list(self.dicoLabel2Name.keys())
@Variables.undoGlobal
def addProfile(self):
"""
Public method.
Add a new profile and return a default label
"""
label = self.__defaultValues()['label']
def_label = label + str(len(self.getProfilesLabelsList()) + 1)
# define default label
if def_label in self.getProfilesLabelsList():
i = 2
while def_label in self.getProfilesLabelsList():
def_label = label + str(len(self.getProfilesLabelsList()) + i)
i = i + 1
node = self.node_prof.xmlInitNode('profile', label = def_label)
return def_label
@Variables.undoLocal
def setFormula(self, label, str):
"""
Public method.
Get coordinates for profile named I{label}
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlSetData('formula', str)
def getFormula(self, label):
"""
Private method.
Gets coordinates for profile named I{label}.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
return node.xmlGetString('formula')
@Variables.undoLocal
def setNbPoint(self, label, NbPoint):
"""
Public method.
Get coordinates for profile named I{label}
"""
self.isInt(NbPoint)
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlSetData('points', NbPoint)
def __getNbPoint(self, label):
"""
Private method.
Gets coordinates for profile named I{label}.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
return node.xmlGetInt('points')
@Variables.noUndo
def getProfilesLabelsList(self):
"""
Public method.
Returns the profiles labels list.
"""
lst = []
for node in self.node_prof.xmlGetNodeList('profile'):
label = node['label']
lst.append(label)
return lst
@Variables.undoLocal
def setOutputType(self, label, choice):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
self.isInList(choice, ["end", "frequency", "time_value"])
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlSetData('output_type', choice)
@Variables.undoLocal
def setOutputFrequency(self, label, freq):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlSetData('output_frequency', freq)
@Variables.noUndo
def getOutputFrequency(self, label):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
return node.xmlGetDouble('output_frequency')
@Variables.undoLocal
def setLabel(self, old_label, label):
"""
Public method.
"""
self.isInList(old_label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = old_label)
node['label'] = label
@Variables.undoLocal
def setFormat(self, label, fmt):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlRemoveChild('format')
node.xmlAddChild('format', name=fmt)
@Variables.undoLocal
def setVariable(self, label, lst):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
node.xmlRemoveChild('var_prop')
for var in lst:
self.isInList(var, self.__var_prop_list)
(name, comp) = self.dicoLabel2Name[var]
node.xmlAddChild('var_prop', name=name, component=comp)
@Variables.noUndo
def getVariable(self, label):
"""
Public method.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label = label)
lst = []
for var in node.xmlGetChildNodeList('var_prop'):
for name in self.__var_prop_list:
if self.dicoLabel2Name[name] == (var['name'], var['component']) :
lst.append(name)
return lst
@Variables.undoLocal
def deleteProfile(self, label):
"""
Public method.
Deletes profile named I{label}.
"""
self.isInList(label, self.getProfilesLabelsList())
node = self.node_prof.xmlGetNode('profile', label=label)
if node:
node.xmlRemoveNode()
@Variables.noUndo
def getProfileData(self, label):
"""
Public method. Only for the GUI.
Get profile named label and return list of variables or properties,
frequency and coordinates.
"""
self.isInList(label, self.getProfilesLabelsList())
lst = []
node = self.node_prof.xmlGetNode('profile', label = label)
choice = node.xmlGetString('output_type')
if not choice:
choice = self.__defaultValues()['choice']
self.setOutputType(label, choice)
if choice == "time_value":
freq = node.xmlGetDouble('output_frequency')
else:
freq = node.xmlGetInt('output_frequency')
if not freq:
freq = self.__defaultValues()['frequency']
self.setOutputFrequency(label, freq)
f_node = node.xmlGetChildNode('format')
if not f_node:
fmt = self.__defaultValues()['format']
self.setFormat(label, fmt)
else:
fmt = f_node['name']
formula = self.getFormula(label)
if not formula:
formula = self.__defaultValues()['formula']
self.setFormula(label, formula)
NbPoint = self.__getNbPoint(label)
if not NbPoint:
NbPoint = self.__defaultValues()['points']
self.setNbPoint(label, NbPoint)
for var in node.xmlGetChildNodeList('var_prop'):
for name in self.__var_prop_list:
if self.dicoLabel2Name[name] == (var['name'], var['component']) :
lst.append(name)
return label, fmt, lst, choice, freq, formula, NbPoint
#-------------------------------------------------------------------------------
# TimeAveragesModel test case
#-------------------------------------------------------------------------------
class ProfilesTestCase(ModelTest):
"""
Unittest.
"""
def checkProfilesModelInstantiation(self):
"""Check whether the ProfilesModel class could be instantiated"""
model = None
model = ProfilesModel(self.case)
assert model != None, 'Could not instantiate ProfilesModel'
def checkSetProfile(self):
"""Check whether the ProfilesModel class could set one profile"""
mdl = ProfilesModel(self.case)
mdl.setProfile('prof1.dat', ['VelocitU', 'VelocitV', 'VelocitW'], 20, 0.1, 0.2, 0.3, 2.1, 2.2, 2.3)
doc = '''
20
0.1
0.2
0.3
2.1
2.2
2.3
'''
assert mdl.node_prof == self.xmlNodeFromString(doc),\
'Could not set profiles in ProfilesModel'
def checkReplaceProfile(self):
"""Check whether the ProfilesModel class could replace profiles"""
mdl = ProfilesModel(self.case)
mdl.setProfile('prof1', ['VelocitU', 'VelocitV', 'VelocitW'], 20, 0.1, 0.2, 0.3, 2.1, 2.2, 2.3)
mdl.replaceProfile('prof1', 'premier', ['VelocitU'], 30, 0.1, 0.2, 0.3, 2.0, 2.0, 2.0)
doc = '''
30
0.1
0.2
0.3
2.0
2.0
2.0
'''
assert mdl.node_prof == self.xmlNodeFromString(doc),\
'Could not replace profiles in ProfilesModel'
def checkDeleteProfile(self):
"""Check whether the ProfilesModel class could delete profiles"""
mdl = ProfilesModel(self.case)
mdl.setProfile('prof1.dat', ['VelocitU', 'VelocitV', 'VelocitW'], 20, 0.1, 0.2, 0.3, 2.1, 2.2, 2.3)
mdl.setProfile('prof2.dat', ['VelocitU'], 20, 0.9, 0.8, 0.7, 9.1, 9.2, 9.3)
mdl.deleteProfile('prof1')
doc = '''
20
0.9
0.8
0.7
9.1
9.2
9.3
'''
assert mdl.node_prof == self.xmlNodeFromString(doc),\
'Could not delete profiles in ProfilesModel'
def checkGetVarProfile(self):
"""Check whether the ProfilesModel class could get one profile"""
mdl = ProfilesModel(self.case)
mdl.setProfile('prof1.dat', ['VelocitU', 'VelocitV', 'VelocitW'], 20, 0.1, 0.2, 0.3, 2.1, 2.2, 2.3)
mdl.setProfile('prof2.dat', ['VelocitU'], 20, 0.9, 0.8, 0.7, 9.1, 9.2, 9.3)
prof = ('prof2.dat', ['VelocitU'], 20, 0.9, 0.8, 0.7, 9.1, 9.2, 9.3)
assert mdl.getProfileData('prof2') == prof,\
'Could not get values for profile named label in ProfilesModel'
def suite():
testSuite = unittest.makeSuite(ProfilesTestCase, "check")
return testSuite
def runTest():
print(__file__)
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------