# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2014 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 Time averages page.
This module defines the following classes:
- TimeAveragesModel
- TimeAveragesTestCase
"""
#-------------------------------------------------------------------------------
# Library modules import
#-------------------------------------------------------------------------------
import os, sys, string, types, unittest
#-------------------------------------------------------------------------------
# Application modules import
#-------------------------------------------------------------------------------
from Base.Common import *
import Base.Toolbox as Tool
from Base.XMLmodel import XMLmodel, ModelTest
from Base.XMLvariables import Model, Variables
from Pages.OutputVolumicVariablesModel import OutputVolumicVariablesModel
from Pages.StartRestartModel import StartRestartModel
#-------------------------------------------------------------------------------
# Model class
#-------------------------------------------------------------------------------
class TimeAveragesModel(Model):
"""
Class to open TimeAverages Page.
"""
def __init__(self, case):
"""
Simple constructor.
"""
self.case = case
self.node_anal = self.case.xmlInitNode('analysis_control')
self.node_mean = self.node_anal.xmlInitNode('time_averages')
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.__updateDicoLabel2Name()
def defaultValues(self):
"""
Public method.
@return: dictionary with default values.
@rtype: C{Dict}
"""
value = {}
value['start'] = 1
value['restart'] = -2
return value
def __updateDicoLabel2Name(self):
"""
Private method.
Gets a dictionnary to connect name and label from
variables and properties.
"""
# FIXME: merge this method with the same one in ProfilesView
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.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:
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())
def __updateTimeAverage(self, nb, label, start, restart, lst):
"""
Private method.
Update data for average I{label}.
@type nb: C{Int}
@param nb: time average I{label} number.
@type start: C{Int}
@param start: start iteration for the time average I{label}.
@type restart: C{Int}
@param restart: restart parameter value for the new time average I{label}.
@type list: C{List}
@param list: list of variables and properties for the new time average I{label}.
@type label: C{String}
@param label: label for the time average I{label}.
@type start: C{Int}
@param start: start iteration for time average I{label}.
@type restart: C{Int}
@param restart: restart parameter value for the time average I{label}.
@type list: C{List}
@param lst: list of variables and properties for the time average I{label}.
"""
node = self.node_mean.xmlInitNode('time_average', label=label)
node['id'] = str(nb)
for var in lst:
self.isInList(var, list(self.dicoLabel2Name.keys()))
(name, comp) = self.dicoLabel2Name[var]
node.xmlAddChild('var_prop', name=name, component=comp)
node.xmlSetData('time_step_start', start)
if StartRestartModel(self.case).getRestartPath():
if restart != -2:
node.xmlSetData('restart_from_time_average', restart)
else:
node.xmlRemoveChild('restart_from_time_average')
@Variables.undoGlobal
def setTimeAverage(self, label, start, restart, lst):
"""
Public method.
Add a new time average I{label}.
@type label: C{String}
@param label: label for the new time average I{label}.
@type start: C{Int}
@param start: start iteration for the time average I{label}.
@type restart: C{Int}
@param restart: restart parameter value for the new time average I{label}.
@type list: C{List}
@param lst: list of variables and properties for the new time average I{label}.
"""
self.isGreater(start, 0)
self.isNotInList(restart, [0])
self.isNotInList(label, self.getTimeAverageLabels())
nb = self.getNumberOfTimeAverage()
self.__updateTimeAverage(nb+1, label, start, restart, lst)
@Variables.undoGlobal
def replaceTimeAverage(self, old_label, new_label, start, restart, lst):
"""
Public method.
Replaces data for time average I{old_label}.
@type old_label: C{String}
@param old_label: label of the time average to change.
@type new_label: C{String}
@param new_label: new label for the time average I{old_label}.
@type start: C{Int}
@param start: new start iteration for the time average I{old_label}.
@type restart: C{Int}
@param restart: new restart parameter value for the time average I{old_label}.
@type list: C{List}
@param list: new list of variables and properties for the time average I{old_label}.
"""
self.isGreater(start, 0)
self.isNotInList(restart, [0])
node = self.node_mean.xmlGetNode('time_average', label=old_label)
if node:
node['label'] = new_label
node.xmlRemoveChild('var_prop')
node.xmlRemoveChild('time_step_start')
node.xmlRemoveChild('restart_from_time_average')
self.__updateTimeAverage(node['id'], new_label, start, restart, lst)
@Variables.undoGlobal
def deleteTimeAverage(self, label):
"""
Public method.
@type label: C{String}
@param label: label of the time average to delete.
"""
node = self.node_mean.xmlGetNode('time_average', label=label)
if node:
nb = node['id']
node.xmlRemoveNode()
# renumerotation of all time average
for p in range(int(nb)+1, self.getNumberOfTimeAverage()+2):
t = self.node_mean.xmlGetNode('time_average', id=p)
t['id'] = p - 1
@Variables.noUndo
def getTimeAverageData(self, imom):
"""
Public method.
@return: data for time average number I{imom}.
@rtype: C{Tuple}
"""
self.isInt(imom)
lst = []
restart = self.defaultValues()['restart']
node = self.node_mean.xmlGetNode('time_average', id=imom)
start = node.xmlGetInt('time_step_start')
if StartRestartModel(self.case).getRestartPath():
restart = node.xmlGetInt('restart_from_time_average')
for var in node.xmlGetChildNodeList('var_prop'):
for label in list(self.dicoLabel2Name.keys()):
if self.dicoLabel2Name[label] == (var['name'], var['component']):
lst.append(label)
return node['label'], start, restart, lst
@Variables.noUndo
def getTimeAverageLabels(self):
"""
Public method.
@return: list of time averages labels.
@rtype: C{List} of C{String}
"""
lst = []
for node in self.node_mean.xmlGetNodeList('time_average'):
label = node['label']
lst.append(label)
return lst
@Variables.noUndo
def getNumberOfTimeAverage(self):
"""
Public method.
@return: number of time averages already defined.
@rtype: C{Int}
"""
return len(self.node_mean.xmlGetNodeList('time_average'))
#-------------------------------------------------------------------------------
# TimeAveragesModel test case
#-------------------------------------------------------------------------------
class TimeAveragesTestCase(ModelTest):
"""
unittest
"""
def checkTimeAveragesInstantiation(self):
"""Check whether the TimeAveragesModel class could be instantiated"""
model = None
model = TimeAveragesModel(self.case)
assert model != None, 'Could not instantiate TimeAveragesModel'
def checksetTimeAverage(self):
"""Check whether the TimeAveragesModel class could be set a average"""
mdl = TimeAveragesModel(self.case)
mdl.setTimeAverage(1, 'moyenne', 10, 1, ['VelocitU', 'VelocitV'])
mdl.setTimeAverage(2, 'deux', 20, 1, ['Pressure'])
doc = '''
10
20
'''
assert mdl.node_mean == self.xmlNodeFromString(doc),\
'Could not set some averages in TimeAveragesModel'
def checkreplaceTimeAverage(self):
"""Check whether the TimeAveragesModel class could be replaced one average"""
mdl = TimeAveragesModel(self.case)
mdl.setTimeAverage(1, 'moyenne', 10, 1, ['VelocitU', 'VelocitV'])
mdl.setTimeAverage(2, 'deux', 20, 1, ['Pressure'])
mdl.setTimeAverage(3, 'trois', 33, 1, ['Pressure', 'VelocitU'])
mdl.replaceTimeAverage(2, 'SECOND', 12, 1, ['VelocitW', 'VelocitV'])
mdl.replaceTimeAverage(3, 'trois', 33, 1, ['Pressure', 'VelocitW'])
doc = '''
10
12
33
'''
assert mdl.node_mean == self.xmlNodeFromString(doc),\
'Could not replace one average in TimeAveragesModel'
def checkdeleteTimeAverage(self):
"""Check whether the TimeAveragesModel class could be deleted one average"""
mdl = TimeAveragesModel(self.case)
mdl.setTimeAverage(1, 'moyenne', 10, 1, ['VelocitU', 'VelocitV'])
mdl.setTimeAverage(2, 'deux', 20, 1, ['VelocitU'])
mdl.setTimeAverage(3, 'trois', 33, 1, ['VelocitW', 'VelocitU'])
mdl.deleteTimeAverage(2)
doc = '''
10
33
'''
assert mdl.node_mean == self.xmlNodeFromString(doc),\
'Could not delete one average in TimeAveragesModel'
def suite():
testSuite = unittest.makeSuite(TimeAveragesTestCase, "check")
return testSuite
def runTest():
print(__file__)
runner = unittest.TextTestRunner()
runner.run(suite())
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------