test/VisuPrs/Util/paravistest.py

   1 # Copyright (C) 2010-2013  CEA/DEN, EDF R&D
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 """
  21 This module provides auxiliary classes, functions and variables for testing.
  22 """
  23
  24 #from __future__ import print_function
  25
  26 from math import fabs
  27 import os
  28 import tempfile
  29 import getpass
  30 from datetime import date
  31
  32 import salome
  33
  34
  35 # Auxiliary variables
  36
  37 # Data directory
  38 samples_dir = os.getenv("DATA_DIR")
  39 datadir = None
  40 tablesdir = None
  41 if samples_dir is not None:
  42     samples_dir = os.path.normpath(samples_dir)
  43     datadir = samples_dir + "/MedFiles/"
  44     tablesdir = samples_dir + "/Tables/"
  45
  46 # Graphics files extension
  47 pictureext = os.getenv("PIC_EXT")
  48 if pictureext == None:
  49     pictureext = "png"
  50
  51
  52 # Auxiliary classes
  53 class RepresentationType:
  54     """
  55     Types of representation.
  56     """
  57     OUTLINE = 0
  58     POINTS = 1
  59     WIREFRAME = 2
  60     SURFACE = 3
  61     SURFACEEDGES = 4
  62     VOLUME = 5
  63     POINTSPRITE = 6
  64
  65     _type2name = {OUTLINE: 'Outline',
  66                   POINTS: 'Points',
  67                   WIREFRAME: 'Wireframe',
  68                   SURFACE: 'Surface',
  69                   SURFACEEDGES: 'Surface With Edges',
  70                   VOLUME: 'Volume',
  71                   POINTSPRITE: 'Point Sprite'}
  72
  73     @classmethod
  74     def get_name(cls, type):
  75         """Return paraview representation type by the primitive type."""
  76         return cls._type2name[type]
  77
  78
  79 class SalomeSession(object):
  80     def __init__(self):
  81         import runSalome
  82         import sys
  83         #sys.argv += ["--killall"]
  84         #sys.argv += ["--portkill=" + port]
  85         sys.argv += ["--show-desktop=1"]
  86         sys.argv += ["--splash=0"]
  87         sys.argv += ["--modules=MED,PARAVIS"]
  88         sys.argv += ["--standalone=study"]
  89         sys.argv += ["--embedded=SalomeAppEngine,cppContainer,registry,moduleCatalog"]
  90         clt, d = runSalome.main()
  91         port = d['port']
  92         self.port = port
  93         return
  94
  95     #VTN: workaround for crash on CentOS.6.3.64
  96     #def __del__(self):
  97         #os.system('killSalomeWithPort.py {0}'.format(self.port))
  98         #os.system('killSalomeWithPort.py ' + self.port)
  99         #import killSalomeWithPort
 100         #killSalomeWithPort.killMyPort(self.port)
 101         #return
 102     pass
 103
 104
 105 # Auxiliary functions
 106 def test_values(value, et_value, check_error=0):
 107     """Test values."""
 108     error = 0
 109     length = len(value)
 110     et_length = len(et_value)
 111     if (length != et_length):
 112         err_msg = "ERROR!!! There is different number of created " + str(length) + " and etalon " + str(et_length) + " values!!!"
 113         print err_msg
 114         error = error + 1
 115     else:
 116         for i in range(et_length):
 117             if abs(et_value[i]) > 1:
 118                 max_val = abs(0.001 * et_value[i])
 119                 if abs(et_value[i] - value[i]) > max_val:
 120                     err_msg = "ERROR!!! Got value " + str(value[i]) + " is not equal to etalon value " + str(ret_value[i]) + "!!!"
 121                     print err_msg
 122                     error = error + 1
 123             else:
 124                 max_val = 0.001
 125                 if abs(et_value[i] - value[i]) > max_val:
 126                     err_msg = "ERROR!!! Got value " + value[i] + " is not equal to etalon value " + et_value[i] + "!!!"
 127                     error = error + 1
 128     if check_error and error > 0:
 129         err_msg = ("There is(are) some error(s) was(were) found... "
 130                    "For more info see ERRORs above...")
 131         raise RuntimeError(err_msg)
 132     return error
 133
 134
 135 def get_picture_dir(subdir):
 136     res_dir = os.getenv("PARAVIS_TEST_PICS")
 137     if not res_dir:
 138         # Add username and current date to unify the directory
 139         cur_user = getpass.getuser()
 140         cur_date = date.today().strftime("%Y%m%d")
 141         res_dir = tempfile.gettempdir() + \
 142             "/pic_" + cur_user + \
 143             "/test_" + cur_date
 144     # Add subdirectory for the case to the directory path
 145     res_dir += "/" + subdir
 146     # Create the directory if doesn't exist
 147     res_dir = os.path.normpath(res_dir)
 148     if not os.path.exists(res_dir):
 149         os.makedirs(res_dir)
 150     else:
 151         # Clean the directory
 152         for root, dirs, files in os.walk(res_dir):
 153             for f in files:
 154                 os.remove(os.path.join(root, f))
 155
 156     return res_dir
 157
 158
 159 def call_and_check(prs, property_name, value, do_raise=1, compare_toler=-1.0):
 160     """Utility function for 3D viewer test for common check of different
 161     types of presentation parameters set"""
 162     try:
 163         prs.SetPropertyWithName(property_name, value)
 164     except ValueError:
 165         error_string = (str(value) + "value of " + property_name + " is not available for this type of presentations")
 166     else:
 167         error_string = None
 168     is_good = (error_string is None)
 169     if not is_good:
 170         if do_raise:
 171             raise RuntimeError(error_string)
 172         else:
 173             print error_string
 174     else:
 175         # compare just set value and the one got from presentation
 176         really_set_value = prs.GetPropertyValue(property_name)
 177         is_equal = 1
 178         if compare_toler > 0:
 179             is_equal = (fabs(really_set_value - value) < compare_toler)
 180         else:
 181             is_equal = (really_set_value == value)
 182         if not is_equal:
 183             msg = str(really_set_value) + " has been set instead"
 184             if do_raise:
 185                 raise RuntimeError(msg)
 186             else:
 187                 print msg
 188                 is_good = False
 189
 190     return is_good
 191
 192
 193 def compare_lists(value, et_value, check_error=0, eps=1e-04):
 194     """
 195     Compare two lists: the same length and equality of corresponding items
 196     param value - list to be compared
 197     param et_value - etalon list
 198     param check_error - flag to catch exception if errors>0
 199     check_error=0 no exception, check_error !=0 catch exception
 200     param eps - defines tolerance for comparison
 201     return error - number of errors
 202     """
 203
 204     error=0
 205     length = len(value)
 206     et_length = len(et_value)
 207     if length != et_length:
 208         print "ERROR!!! There is different number of items in created ", length, " and etalon ", et_length, " lists!!!"
 209         error=error+1
 210     else:
 211         for i in range(et_length):
 212             if abs(et_value[i]) > 1:
 213                 MAX = abs(eps*et_value[i])
 214             else:
 215                 MAX = eps
 216             if abs(et_value[i] - value[i])> MAX:
 217                 print "ERROR!!!", i, "-th  item", value[i], " is not equal to etalon item", et_value[i], "!!!"
 218                 error=error+1
 219     if check_error and error > 0:
 220         raise RuntimeError, "There is(are) some error(s) was(were) found... For more info see ERRORs above..."
 221     return error
 222
 223
 224 def setShaded(view, shading):
 225     """Utility function to set shaded mode in view"""
 226     if shading == 0:
 227         view.LightDiffuseColor = [1, 1, 1]
 228     if shading == 1:
 229         view.LightDiffuseColor = [0, 0, 0]
 230
 231
 232 def TimeStampId(proxy):
 233     """Return tuple for the given MED proxy: (mesh_name, {field_name: [entity, timestamp_id]})
 234     Originally defined in KERNEL_TEST/Tools/CommonFunctions file.
 235     """
 236     import presentations
 237     mesh_name = presentations.get_mesh_names(proxy).pop()
 238     iterations = {}
 239
 240     # get list of field names
 241     fields_on_points = list(proxy.PointArrays)
 242     fields_on_cells = list(proxy.CellArrays)
 243     all_fields = fields_on_points + fields_on_cells
 244
 245     # get timestamps
 246     timestamps = proxy.TimestepValues.GetData()
 247     timestamp_nb = len(timestamps)
 248
 249     for field in all_fields:
 250         entity = None
 251         if fields_on_points.count(field) > 0:
 252             entity = presentations.EntityType.NODE
 253         elif fields_on_cells.count(field) > 0:
 254             entity = presentations.EntityType.CELL
 255
 256         iterations[field] = [entity, timestamp_nb]
 257
 258     return mesh_name, iterations
 259
 260
 261 def Import_Med_Field(paravis, file, field_names, check_errors=0, prs=[]):
 262     """Builds presentations on the given fields of the MED file.
 263     Originally defined in VISU_TEST/Grids/visu/ImportMedField/begin file.
 264
 265     Arguments:
 266       paravis      : PARAVIS instance
 267       file_name    : the full path to med file
 268       field_names  : the list of field names (for ex: ["pression","temperature","vitesse"])
 269       prs          : [[0,1,...], [], []]; empty list (sublist(s)) is ignored
 270                      0-VISU.TGAUSSPOINTS
 271                      1-VISU.TSCALARMAP
 272                      2-VISU.TISOSURFACE
 273                      3-VISU.TCUTPLANES
 274                      4-VISU.TCUTLINES
 275                      5-VISU.TDEFORMEDSHAPE
 276                      6-VISU.TVECTORS
 277                      7-VISU.TSTREAMLINES
 278                      8-VISU.TPLOT3D
 279                      9-VISU.TSCALARMAPONDEFORMEDSHAPE
 280     """
 281     import presentations
 282
 283     nb_errors = 0
 284
 285     print "File: ", file
 286
 287     # check the file accessibility
 288     if not os.access(file, os.F_OK):
 289         msg = "File " + file + " does not exist!!!"
 290         raise RuntimeError, msg
 291
 292     # import MED file
 293     paravis.ImportFile(file)
 294     proxy = presentations.pv.GetActiveSource()
 295     if proxy is None:
 296         raise RuntimeError, "ERROR!!! Can't import file!!!"
 297
 298     for i in range(len(field_names)):
 299         print "Name of the field: ", field_names[i]
 300
 301         if len(prs) != 0:
 302             if len(prs[i]) != 0:
 303                 mesh_name, iterations = TimeStampId(proxy)
 304
 305                 if iterations.has_key(field_names[i]):
 306                     entity = iterations[field_names[i]][0]
 307                     iteration = iterations[field_names[i]][1]
 308                 else:
 309                     msg="There is no information about TimeStampId of the " + field_names[i] + " field!!!"
 310                     raise RuntimeError, msg
 311
 312                 err = nb_errors
 313
 314                 for type in prs[i]:
 315                     if type==0:
 316                         if presentations.GaussPointsOnField(proxy, entity, field_names[i], iteration) is None:
 317                             print "ERROR!!! Created GaussPoints presentation is None!!!"; nb_errors+=1
 318                     if type==1:
 319                         if presentations.ScalarMapOnField(proxy, entity, field_names[i], iteration) is None:
 320                             print "ERROR!!! Created ScalarMap presentation is None!!!"; nb_errors+=1
 321                     if type==2:
 322                         if presentations.IsoSurfacesOnField(proxy, entity, field_names[i], iteration) is None:
 323                             print "ERROR!!! Created IsoSurfaces presentation is None!!!"; nb_errors+=1
 324                     if type==3:
 325                         if presentations.CutPlanesOnField(proxy, entity, field_names[i], iteration) is None:
 326                             print "ERROR!!! Created CutPlanes presentation is None!!!"; nb_errors+=1
 327                     if type==4:
 328                         if presentations.CutLinesOnField(proxy, entity, field_names[i], iteration) is None:
 329                             print "ERROR!!! Created CutLines presentation is None!!!"; nb_errors+=1
 330                     if type==5:
 331                         if presentations.DeformedShapeOnField(proxy, entity, field_names[i], iteration) is None:
 332                             print "ERROR!!! Created DeformedShape presentation is None!!!"; nb_errors+=1
 333                     if type==6:
 334                         if presentations.VectorsOnField(proxy, entity, field_names[i], iteration) is None:
 335                             print "ERROR!!! Created Vectors presentation is None!!!"; nb_errors+=1
 336                     if type==7:
 337                         if presentations.StreamLinesOnField(proxy, entity, field_names[i], iteration) is None:
 338                             print "ERROR!!! Created StreamLines presentation is None!!!"; nb_errors+=1
 339                     if type==8:
 340                         if presentations.Plot3DOnField(proxy, entity, field_names[i], iteration) is None:
 341                             print "ERROR!!! Created Plot3D presentation is None!!!"; nb_errors+=1
 342                     if type==9:
 343                         if presentations.DeformedShapeAndScalarMapOnField(proxy, entity, field_names[i], iteration) is None:
 344                             print "ERROR!!! Created ScalarMapOnDeformedShape presentation is None!!!"; nb_errors+=1
 345
 346                 # check if number of errors has increased
 347                 if err == nb_errors:
 348                     print "Presentation(s) creation...OK"
 349
 350     if nb_errors > 0 and check_errors:
 351         raise RuntimeError, "There are some errors were occured!!! For more information see ERRORs above..."
 352     else:
 353         return nb_errors
 354
 355 def delete_with_inputs(obj):
 356     """Deletes the given object with all its inputs"""
 357     import pvsimple
 358
 359     obj_to_delete = obj
 360     while obj_to_delete is not None:
 361         tmp_obj = obj_to_delete
 362         obj_to_delete = None
 363         if hasattr(tmp_obj, 'Input'):
 364             obj_to_delete = tmp_obj.Input
 365
 366         pvsimple.Delete(tmp_obj)
 367
 368 # Run Salome
 369 salome_session = SalomeSession()
 370 salome.salome_init()