Salome HOME
IPAL54364: Add Gravity Center measurement
[modules/smesh.git] / src / SMESH_SWIG / smeshBuilder.py
1 # Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
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, or (at your option) any later version.
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 #  File   : smeshBuilder.py
20 #  Author : Francis KLOSS, OCC
21 #  Module : SMESH
22
23 ## @package smeshBuilder
24 #  Python API for SALOME %Mesh module
25
26 ## @defgroup l1_auxiliary Auxiliary methods and structures
27 ## @defgroup l1_creating  Creating meshes
28 ## @{
29 ##   @defgroup l2_impexp     Importing and exporting meshes
30 ##   @{
31 ##     @details
32 ##     These are methods of class \ref smeshBuilder.smeshBuilder "smeshBuilder"
33 ##   @}
34 ##   @defgroup l2_construct  Constructing meshes
35 ##   @defgroup l2_algorithms Defining Algorithms
36 ##   @{
37 ##     @defgroup l3_algos_basic   Basic meshing algorithms
38 ##     @defgroup l3_algos_proj    Projection Algorithms
39 ##     @defgroup l3_algos_segmarv Segments around Vertex
40 ##     @defgroup l3_algos_3dextr  3D extrusion meshing algorithm
41
42 ##   @}
43 ##   @defgroup l2_hypotheses Defining hypotheses
44 ##   @{
45 ##     @defgroup l3_hypos_1dhyps 1D Meshing Hypotheses
46 ##     @defgroup l3_hypos_2dhyps 2D Meshing Hypotheses
47 ##     @defgroup l3_hypos_maxvol Max Element Volume hypothesis
48 ##     @defgroup l3_hypos_quad Quadrangle Parameters hypothesis
49 ##     @defgroup l3_hypos_additi Additional Hypotheses
50
51 ##   @}
52 ##   @defgroup l2_submeshes Constructing sub-meshes
53 ##   @defgroup l2_editing   Editing Meshes
54
55 ## @}
56 ## @defgroup l1_meshinfo  Mesh Information
57 ## @defgroup l1_controls  Quality controls and Filtering
58 ## @defgroup l1_grouping  Grouping elements
59 ## @{
60 ##   @defgroup l2_grps_create Creating groups
61 ##   @defgroup l2_grps_operon Using operations on groups
62 ##   @defgroup l2_grps_delete Deleting Groups
63
64 ## @}
65 ## @defgroup l1_modifying Modifying meshes
66 ## @{
67 ##   @defgroup l2_modif_add      Adding nodes and elements
68 ##   @defgroup l2_modif_del      Removing nodes and elements
69 ##   @defgroup l2_modif_edit     Modifying nodes and elements
70 ##   @defgroup l2_modif_renumber Renumbering nodes and elements
71 ##   @defgroup l2_modif_trsf     Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
72 ##   @defgroup l2_modif_unitetri Uniting triangles
73 ##   @defgroup l2_modif_cutquadr Cutting elements
74 ##   @defgroup l2_modif_changori Changing orientation of elements
75 ##   @defgroup l2_modif_smooth   Smoothing
76 ##   @defgroup l2_modif_extrurev Extrusion and Revolution
77 ##   @defgroup l2_modif_tofromqu Convert to/from Quadratic Mesh
78 ##   @defgroup l2_modif_duplicat Duplication of nodes and elements (to emulate cracks)
79
80 ## @}
81 ## @defgroup l1_measurements Measurements
82
83 import salome
84 from salome.geom import geomBuilder
85
86 import SMESH # This is necessary for back compatibility
87 from   SMESH import *
88 from   salome.smesh.smesh_algorithm import Mesh_Algorithm
89
90 import SALOME
91 import SALOMEDS
92 import os
93
94 ## Private class used to workaround a problem that sometimes isinstance(m, Mesh) returns False
95 #
96 class MeshMeta(type):
97     def __instancecheck__(cls, inst):
98         """Implement isinstance(inst, cls)."""
99         return any(cls.__subclasscheck__(c)
100                    for c in {type(inst), inst.__class__})
101
102     def __subclasscheck__(cls, sub):
103         """Implement issubclass(sub, cls)."""
104         return type.__subclasscheck__(cls, sub) or (cls.__name__ == sub.__name__ and cls.__module__ == sub.__module__)
105
106 ## @addtogroup l1_auxiliary
107 ## @{
108
109 ## Convert an angle from degrees to radians
110 def DegreesToRadians(AngleInDegrees):
111     from math import pi
112     return AngleInDegrees * pi / 180.0
113
114 import salome_notebook
115 notebook = salome_notebook.notebook
116 # Salome notebook variable separator
117 var_separator = ":"
118
119 ## Return list of variable values from salome notebook.
120 #  The last argument, if is callable, is used to modify values got from notebook
121 def ParseParameters(*args):
122     Result = []
123     Parameters = ""
124     hasVariables = False
125     varModifFun=None
126     if args and callable( args[-1] ):
127         args, varModifFun = args[:-1], args[-1]
128     for parameter in args:
129
130         Parameters += str(parameter) + var_separator
131
132         if isinstance(parameter,str):
133             # check if there is an inexistent variable name
134             if not notebook.isVariable(parameter):
135                 raise ValueError, "Variable with name '" + parameter + "' doesn't exist!!!"
136             parameter = notebook.get(parameter)
137             hasVariables = True
138             if varModifFun:
139                 parameter = varModifFun(parameter)
140                 pass
141             pass
142         Result.append(parameter)
143
144         pass
145     Parameters = Parameters[:-1]
146     Result.append( Parameters )
147     Result.append( hasVariables )
148     return Result
149
150 ## Parse parameters while converting variables to radians
151 def ParseAngles(*args):
152     return ParseParameters( *( args + (DegreesToRadians, )))
153
154 ## Substitute PointStruct.__init__() to create SMESH.PointStruct using notebook variables.
155 #  Parameters are stored in PointStruct.parameters attribute
156 def __initPointStruct(point,*args):
157     point.x, point.y, point.z, point.parameters,hasVars = ParseParameters(*args)
158     pass
159 SMESH.PointStruct.__init__ = __initPointStruct
160
161 ## Substitute AxisStruct.__init__() to create SMESH.AxisStruct using notebook variables.
162 #  Parameters are stored in AxisStruct.parameters attribute
163 def __initAxisStruct(ax,*args):
164     if len( args ) != 6:
165         raise RuntimeError,\
166               "Bad nb args (%s) passed in SMESH.AxisStruct(x,y,z,dx,dy,dz)"%(len( args ))
167     ax.x, ax.y, ax.z, ax.vx, ax.vy, ax.vz, ax.parameters,hasVars = ParseParameters(*args)
168     pass
169 SMESH.AxisStruct.__init__ = __initAxisStruct
170
171 smeshPrecisionConfusion = 1.e-07
172 ## Compare real values using smeshPrecisionConfusion as tolerance
173 def IsEqual(val1, val2, tol=smeshPrecisionConfusion):
174     if abs(val1 - val2) < tol:
175         return True
176     return False
177
178 NO_NAME = "NoName"
179
180 ## Return object name
181 def GetName(obj):
182     if obj:
183         # object not null
184         if isinstance(obj, SALOMEDS._objref_SObject):
185             # study object
186             return obj.GetName()
187         try:
188             ior  = salome.orb.object_to_string(obj)
189         except:
190             ior = None
191         if ior:
192             # CORBA object
193             studies = salome.myStudyManager.GetOpenStudies()
194             for sname in studies:
195                 s = salome.myStudyManager.GetStudyByName(sname)
196                 if not s: continue
197                 sobj = s.FindObjectIOR(ior)
198                 if not sobj: continue
199                 return sobj.GetName()
200             if hasattr(obj, "GetName"):
201                 # unknown CORBA object, having GetName() method
202                 return obj.GetName()
203             else:
204                 # unknown CORBA object, no GetName() method
205                 return NO_NAME
206             pass
207         if hasattr(obj, "GetName"):
208             # unknown non-CORBA object, having GetName() method
209             return obj.GetName()
210         pass
211     raise RuntimeError, "Null or invalid object"
212
213 ## Print error message if a hypothesis was not assigned.
214 def TreatHypoStatus(status, hypName, geomName, isAlgo, mesh):
215     if isAlgo:
216         hypType = "algorithm"
217     else:
218         hypType = "hypothesis"
219         pass
220     reason = ""
221     if hasattr( status, "__getitem__" ):
222         status,reason = status[0],status[1]
223     if status == HYP_UNKNOWN_FATAL :
224         reason = "for unknown reason"
225     elif status == HYP_INCOMPATIBLE :
226         reason = "this hypothesis mismatches the algorithm"
227     elif status == HYP_NOTCONFORM :
228         reason = "a non-conform mesh would be built"
229     elif status == HYP_ALREADY_EXIST :
230         if isAlgo: return # it does not influence anything
231         reason = hypType + " of the same dimension is already assigned to this shape"
232     elif status == HYP_BAD_DIM :
233         reason = hypType + " mismatches the shape"
234     elif status == HYP_CONCURENT :
235         reason = "there are concurrent hypotheses on sub-shapes"
236     elif status == HYP_BAD_SUBSHAPE :
237         reason = "the shape is neither the main one, nor its sub-shape, nor a valid group"
238     elif status == HYP_BAD_GEOMETRY:
239         reason = "the algorithm is not applicable to this geometry"
240     elif status == HYP_HIDDEN_ALGO:
241         reason = "it is hidden by an algorithm of an upper dimension, which generates elements of all dimensions"
242     elif status == HYP_HIDING_ALGO:
243         reason = "it hides algorithms of lower dimensions by generating elements of all dimensions"
244     elif status == HYP_NEED_SHAPE:
245         reason = "algorithm can't work without shape"
246     elif status == HYP_INCOMPAT_HYPS:
247         pass
248     else:
249         return
250     where = geomName
251     if where:
252         where = '"%s"' % geomName
253         if mesh:
254             meshName = GetName( mesh )
255             if meshName and meshName != NO_NAME:
256                 where = '"%s" shape in "%s" mesh ' % ( geomName, meshName )
257     if status < HYP_UNKNOWN_FATAL and where:
258         print '"%s" was assigned to %s but %s' %( hypName, where, reason )
259     elif where:
260         print '"%s" was not assigned to %s : %s' %( hypName, where, reason )
261     else:
262         print '"%s" was not assigned : %s' %( hypName, reason )
263         pass
264
265 ## Private method. Add geom (sub-shape of the main shape) into the study if not yet there
266 def AssureGeomPublished(mesh, geom, name=''):
267     if not isinstance( geom, geomBuilder.GEOM._objref_GEOM_Object ):
268         return
269     if not geom.GetStudyEntry() and \
270            mesh.smeshpyD.GetCurrentStudy():
271         ## set the study
272         studyID = mesh.smeshpyD.GetCurrentStudy()._get_StudyId()
273         if studyID != mesh.geompyD.myStudyId:
274             mesh.geompyD.init_geom( mesh.smeshpyD.GetCurrentStudy())
275         ## get a name
276         if not name and geom.GetShapeType() != geomBuilder.GEOM.COMPOUND:
277             # for all groups SubShapeName() return "Compound_-1"
278             name = mesh.geompyD.SubShapeName(geom, mesh.geom)
279         if not name:
280             name = "%s_%s"%(geom.GetShapeType(), id(geom)%10000)
281         ## publish
282         mesh.geompyD.addToStudyInFather( mesh.geom, geom, name )
283     return
284
285 ## Return the first vertex of a geometrical edge by ignoring orientation
286 def FirstVertexOnCurve(mesh, edge):
287     vv = mesh.geompyD.SubShapeAll( edge, geomBuilder.geomBuilder.ShapeType["VERTEX"])
288     if not vv:
289         raise TypeError, "Given object has no vertices"
290     if len( vv ) == 1: return vv[0]
291     v0   = mesh.geompyD.MakeVertexOnCurve(edge,0.)
292     xyz  = mesh.geompyD.PointCoordinates( v0 ) # coords of the first vertex
293     xyz1 = mesh.geompyD.PointCoordinates( vv[0] )
294     xyz2 = mesh.geompyD.PointCoordinates( vv[1] )
295     dist1, dist2 = 0,0
296     for i in range(3):
297         dist1 += abs( xyz[i] - xyz1[i] )
298         dist2 += abs( xyz[i] - xyz2[i] )
299     if dist1 < dist2:
300         return vv[0]
301     else:
302         return vv[1]
303
304 # end of l1_auxiliary
305 ## @}
306
307
308 # Warning: smeshInst is a singleton
309 smeshInst = None
310 engine = None
311 doLcc = False
312 created = False
313
314 ## This class allows to create, load or manipulate meshes.
315 #  It has a set of methods to create, load or copy meshes, to combine several meshes, etc.
316 #  It also has methods to get infos and measure meshes.
317 class smeshBuilder(object, SMESH._objref_SMESH_Gen):
318
319     # MirrorType enumeration
320     POINT = SMESH_MeshEditor.POINT
321     AXIS =  SMESH_MeshEditor.AXIS
322     PLANE = SMESH_MeshEditor.PLANE
323
324     # Smooth_Method enumeration
325     LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH
326     CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH
327
328     PrecisionConfusion = smeshPrecisionConfusion
329
330     # TopAbs_State enumeration
331     [TopAbs_IN, TopAbs_OUT, TopAbs_ON, TopAbs_UNKNOWN] = range(4)
332
333     # Methods of splitting a hexahedron into tetrahedra
334     Hex_5Tet, Hex_6Tet, Hex_24Tet, Hex_2Prisms, Hex_4Prisms = 1, 2, 3, 1, 2
335
336     def __new__(cls):
337         global engine
338         global smeshInst
339         global doLcc
340         #print "==== __new__", engine, smeshInst, doLcc
341
342         if smeshInst is None:
343             # smesh engine is either retrieved from engine, or created
344             smeshInst = engine
345             # Following test avoids a recursive loop
346             if doLcc:
347                 if smeshInst is not None:
348                     # smesh engine not created: existing engine found
349                     doLcc = False
350                 if doLcc:
351                     doLcc = False
352                     # FindOrLoadComponent called:
353                     # 1. CORBA resolution of server
354                     # 2. the __new__ method is called again
355                     #print "==== smeshInst = lcc.FindOrLoadComponent ", engine, smeshInst, doLcc
356                     smeshInst = salome.lcc.FindOrLoadComponent( "FactoryServer", "SMESH" )
357             else:
358                 # FindOrLoadComponent not called
359                 if smeshInst is None:
360                     # smeshBuilder instance is created from lcc.FindOrLoadComponent
361                     #print "==== smeshInst = super(smeshBuilder,cls).__new__(cls) ", engine, smeshInst, doLcc
362                     smeshInst = super(smeshBuilder,cls).__new__(cls)
363                 else:
364                     # smesh engine not created: existing engine found
365                     #print "==== existing ", engine, smeshInst, doLcc
366                     pass
367             #print "====1 ", smeshInst
368             return smeshInst
369
370         #print "====2 ", smeshInst
371         return smeshInst
372
373     def __init__(self):
374         global created
375         #print "--------------- smeshbuilder __init__ ---", created
376         if not created:
377           created = True
378           SMESH._objref_SMESH_Gen.__init__(self)
379
380     ## Dump component to the Python script
381     #  This method overrides IDL function to allow default values for the parameters.
382     #  @ingroup l1_auxiliary
383     def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True):
384         return SMESH._objref_SMESH_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile)
385
386     ## Set mode of DumpPython(), \a historical or \a snapshot.
387     #  In the \a historical mode, the Python Dump script includes all commands
388     #  performed by SMESH engine. In the \a snapshot mode, commands
389     #  relating to objects removed from the Study are excluded from the script
390     #  as well as commands not influencing the current state of meshes
391     #  @ingroup l1_auxiliary
392     def SetDumpPythonHistorical(self, isHistorical):
393         if isHistorical: val = "true"
394         else:            val = "false"
395         SMESH._objref_SMESH_Gen.SetOption(self, "historical_python_dump", val)
396
397     ## Set the current study and Geometry component
398     #  @ingroup l1_auxiliary
399     def init_smesh(self,theStudy,geompyD = None):
400         #print "init_smesh"
401         self.SetCurrentStudy(theStudy,geompyD)
402         if theStudy:
403             global notebook
404             notebook.myStudy = theStudy
405
406     ## Create a mesh. This can be either an empty mesh, possibly having an underlying geometry,
407     #  or a mesh wrapping a CORBA mesh given as a parameter.
408     #  @param obj either (1) a CORBA mesh (SMESH._objref_SMESH_Mesh) got e.g. by calling
409     #         salome.myStudy.FindObjectID("0:1:2:3").GetObject() or
410     #         (2) a Geometrical object for meshing or
411     #         (3) none.
412     #  @param name the name for the new mesh.
413     #  @return an instance of Mesh class.
414     #  @ingroup l2_construct
415     def Mesh(self, obj=0, name=0):
416         if isinstance(obj,str):
417             obj,name = name,obj
418         return Mesh(self,self.geompyD,obj,name)
419
420     ## Return a long value from enumeration
421     #  @ingroup l1_auxiliary
422     def EnumToLong(self,theItem):
423         return theItem._v
424
425     ## Return a string representation of the color.
426     #  To be used with filters.
427     #  @param c color value (SALOMEDS.Color)
428     #  @ingroup l1_auxiliary
429     def ColorToString(self,c):
430         val = ""
431         if isinstance(c, SALOMEDS.Color):
432             val = "%s;%s;%s" % (c.R, c.G, c.B)
433         elif isinstance(c, str):
434             val = c
435         else:
436             raise ValueError, "Color value should be of string or SALOMEDS.Color type"
437         return val
438
439     ## Get PointStruct from vertex
440     #  @param theVertex a GEOM object(vertex)
441     #  @return SMESH.PointStruct
442     #  @ingroup l1_auxiliary
443     def GetPointStruct(self,theVertex):
444         [x, y, z] = self.geompyD.PointCoordinates(theVertex)
445         return PointStruct(x,y,z)
446
447     ## Get DirStruct from vector
448     #  @param theVector a GEOM object(vector)
449     #  @return SMESH.DirStruct
450     #  @ingroup l1_auxiliary
451     def GetDirStruct(self,theVector):
452         vertices = self.geompyD.SubShapeAll( theVector, geomBuilder.geomBuilder.ShapeType["VERTEX"] )
453         if(len(vertices) != 2):
454             print "Error: vector object is incorrect."
455             return None
456         p1 = self.geompyD.PointCoordinates(vertices[0])
457         p2 = self.geompyD.PointCoordinates(vertices[1])
458         pnt = PointStruct(p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
459         dirst = DirStruct(pnt)
460         return dirst
461
462     ## Make DirStruct from a triplet
463     #  @param x,y,z vector components
464     #  @return SMESH.DirStruct
465     #  @ingroup l1_auxiliary
466     def MakeDirStruct(self,x,y,z):
467         pnt = PointStruct(x,y,z)
468         return DirStruct(pnt)
469
470     ## Get AxisStruct from object
471     #  @param theObj a GEOM object (line or plane)
472     #  @return SMESH.AxisStruct
473     #  @ingroup l1_auxiliary
474     def GetAxisStruct(self,theObj):
475         import GEOM
476         edges = self.geompyD.SubShapeAll( theObj, geomBuilder.geomBuilder.ShapeType["EDGE"] )
477         axis = None
478         if len(edges) > 1:
479             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
480             vertex3, vertex4 = self.geompyD.SubShapeAll( edges[1], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
481             vertex1 = self.geompyD.PointCoordinates(vertex1)
482             vertex2 = self.geompyD.PointCoordinates(vertex2)
483             vertex3 = self.geompyD.PointCoordinates(vertex3)
484             vertex4 = self.geompyD.PointCoordinates(vertex4)
485             v1 = [vertex2[0]-vertex1[0], vertex2[1]-vertex1[1], vertex2[2]-vertex1[2]]
486             v2 = [vertex4[0]-vertex3[0], vertex4[1]-vertex3[1], vertex4[2]-vertex3[2]]
487             normal = [ v1[1]*v2[2]-v2[1]*v1[2], v1[2]*v2[0]-v2[2]*v1[0], v1[0]*v2[1]-v2[0]*v1[1] ]
488             axis = AxisStruct(vertex1[0], vertex1[1], vertex1[2], normal[0], normal[1], normal[2])
489             axis._mirrorType = SMESH.SMESH_MeshEditor.PLANE
490         elif len(edges) == 1:
491             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geomBuilder.geomBuilder.ShapeType["VERTEX"] )
492             p1 = self.geompyD.PointCoordinates( vertex1 )
493             p2 = self.geompyD.PointCoordinates( vertex2 )
494             axis = AxisStruct(p1[0], p1[1], p1[2], p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
495             axis._mirrorType = SMESH.SMESH_MeshEditor.AXIS
496         elif theObj.GetShapeType() == GEOM.VERTEX:
497             x,y,z = self.geompyD.PointCoordinates( theObj )
498             axis = AxisStruct( x,y,z, 1,0,0,)
499             axis._mirrorType = SMESH.SMESH_MeshEditor.POINT
500         return axis
501
502     # From SMESH_Gen interface:
503     # ------------------------
504
505     ## Set the given name to the object
506     #  @param obj the object to rename
507     #  @param name a new object name
508     #  @ingroup l1_auxiliary
509     def SetName(self, obj, name):
510         if isinstance( obj, Mesh ):
511             obj = obj.GetMesh()
512         elif isinstance( obj, Mesh_Algorithm ):
513             obj = obj.GetAlgorithm()
514         ior  = salome.orb.object_to_string(obj)
515         SMESH._objref_SMESH_Gen.SetName(self, ior, name)
516
517     ## Set the current mode
518     #  @ingroup l1_auxiliary
519     def SetEmbeddedMode( self,theMode ):
520         SMESH._objref_SMESH_Gen.SetEmbeddedMode(self,theMode)
521
522     ## Get the current mode
523     #  @ingroup l1_auxiliary
524     def IsEmbeddedMode(self):
525         return SMESH._objref_SMESH_Gen.IsEmbeddedMode(self)
526
527     ## Set the current study. Calling SetCurrentStudy( None ) allows to
528     #  switch OFF automatic pubilishing in the Study of mesh objects.
529     #  @ingroup l1_auxiliary
530     def SetCurrentStudy( self, theStudy, geompyD = None ):
531         if not geompyD:
532             from salome.geom import geomBuilder
533             geompyD = geomBuilder.geom
534             pass
535         self.geompyD=geompyD
536         self.SetGeomEngine(geompyD)
537         SMESH._objref_SMESH_Gen.SetCurrentStudy(self,theStudy)
538         global notebook
539         if theStudy:
540             notebook = salome_notebook.NoteBook( theStudy )
541         else:
542             notebook = salome_notebook.NoteBook( salome_notebook.PseudoStudyForNoteBook() )
543         if theStudy:
544             sb = theStudy.NewBuilder()
545             sc = theStudy.FindComponent("SMESH")
546             if sc: sb.LoadWith(sc, self)
547             pass
548         pass
549
550     ## Get the current study
551     #  @ingroup l1_auxiliary
552     def GetCurrentStudy(self):
553         return SMESH._objref_SMESH_Gen.GetCurrentStudy(self)
554
555     ## Create a Mesh object importing data from the given UNV file
556     #  @return an instance of Mesh class
557     #  @ingroup l2_impexp
558     def CreateMeshesFromUNV( self,theFileName ):
559         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromUNV(self,theFileName)
560         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
561         return aMesh
562
563     ## Create a Mesh object(s) importing data from the given MED file
564     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
565     #  @ingroup l2_impexp
566     def CreateMeshesFromMED( self,theFileName ):
567         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromMED(self,theFileName)
568         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
569         return aMeshes, aStatus
570
571     ## Create a Mesh object(s) importing data from the given SAUV file
572     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
573     #  @ingroup l2_impexp
574     def CreateMeshesFromSAUV( self,theFileName ):
575         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromSAUV(self,theFileName)
576         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
577         return aMeshes, aStatus
578
579     ## Create a Mesh object importing data from the given STL file
580     #  @return an instance of Mesh class
581     #  @ingroup l2_impexp
582     def CreateMeshesFromSTL( self, theFileName ):
583         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromSTL(self,theFileName)
584         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
585         return aMesh
586
587     ## Create Mesh objects importing data from the given CGNS file
588     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
589     #  @ingroup l2_impexp
590     def CreateMeshesFromCGNS( self, theFileName ):
591         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromCGNS(self,theFileName)
592         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
593         return aMeshes, aStatus
594
595     ## Create a Mesh object importing data from the given GMF file.
596     #  GMF files must have .mesh extension for the ASCII format and .meshb for
597     #  the binary format.
598     #  @return [ an instance of Mesh class, SMESH.ComputeError ]
599     #  @ingroup l2_impexp
600     def CreateMeshesFromGMF( self, theFileName ):
601         aSmeshMesh, error = SMESH._objref_SMESH_Gen.CreateMeshesFromGMF(self,
602                                                                         theFileName,
603                                                                         True)
604         if error.comment: print "*** CreateMeshesFromGMF() errors:\n", error.comment
605         return Mesh(self, self.geompyD, aSmeshMesh), error
606
607     ## Concatenate the given meshes into one mesh. All groups of input meshes will be
608     #  present in the new mesh.
609     #  @param meshes the meshes, sub-meshes and groups to combine into one mesh
610     #  @param uniteIdenticalGroups if true, groups with same names are united, else they are renamed
611     #  @param mergeNodesAndElements if true, equal nodes and elements are merged
612     #  @param mergeTolerance tolerance for merging nodes
613     #  @param allGroups forces creation of groups corresponding to every input mesh
614     #  @param name name of a new mesh
615     #  @return an instance of Mesh class
616     #  @ingroup l1_creating
617     def Concatenate( self, meshes, uniteIdenticalGroups,
618                      mergeNodesAndElements = False, mergeTolerance = 1e-5, allGroups = False,
619                      name = ""):
620         if not meshes: return None
621         for i,m in enumerate(meshes):
622             if isinstance(m, Mesh):
623                 meshes[i] = m.GetMesh()
624         mergeTolerance,Parameters,hasVars = ParseParameters(mergeTolerance)
625         meshes[0].SetParameters(Parameters)
626         if allGroups:
627             aSmeshMesh = SMESH._objref_SMESH_Gen.ConcatenateWithGroups(
628                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
629         else:
630             aSmeshMesh = SMESH._objref_SMESH_Gen.Concatenate(
631                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
632         aMesh = Mesh(self, self.geompyD, aSmeshMesh, name=name)
633         return aMesh
634
635     ## Create a mesh by copying a part of another mesh.
636     #  @param meshPart a part of mesh to copy, either a Mesh, a sub-mesh or a group;
637     #                  to copy nodes or elements not contained in any mesh object,
638     #                  pass result of Mesh.GetIDSource( list_of_ids, type ) as meshPart
639     #  @param meshName a name of the new mesh
640     #  @param toCopyGroups to create in the new mesh groups the copied elements belongs to
641     #  @param toKeepIDs to preserve order of the copied elements or not
642     #  @return an instance of Mesh class
643     #  @ingroup l1_creating
644     def CopyMesh( self, meshPart, meshName, toCopyGroups=False, toKeepIDs=False):
645         if (isinstance( meshPart, Mesh )):
646             meshPart = meshPart.GetMesh()
647         mesh = SMESH._objref_SMESH_Gen.CopyMesh( self,meshPart,meshName,toCopyGroups,toKeepIDs )
648         return Mesh(self, self.geompyD, mesh)
649
650     ## Return IDs of sub-shapes
651     #  @return the list of integer values
652     #  @ingroup l1_auxiliary
653     def GetSubShapesId( self, theMainObject, theListOfSubObjects ):
654         return SMESH._objref_SMESH_Gen.GetSubShapesId(self,theMainObject, theListOfSubObjects)
655
656     ## Create a pattern mapper. 
657     #  @return an instance of SMESH_Pattern
658     #
659     #  <a href="../tui_modifying_meshes_page.html#tui_pattern_mapping">Example of Patterns usage</a>
660     #  @ingroup l1_modifying
661     def GetPattern(self):
662         return SMESH._objref_SMESH_Gen.GetPattern(self)
663
664     ## Set number of segments per diagonal of boundary box of geometry, by which
665     #  default segment length of appropriate 1D hypotheses is defined in GUI.
666     #  Default value is 10.
667     #  @ingroup l1_auxiliary
668     def SetBoundaryBoxSegmentation(self, nbSegments):
669         SMESH._objref_SMESH_Gen.SetBoundaryBoxSegmentation(self,nbSegments)
670
671     # Filtering. Auxiliary functions:
672     # ------------------------------
673
674     ## Create an empty criterion
675     #  @return SMESH.Filter.Criterion
676     #  @ingroup l1_controls
677     def GetEmptyCriterion(self):
678         Type = self.EnumToLong(FT_Undefined)
679         Compare = self.EnumToLong(FT_Undefined)
680         Threshold = 0
681         ThresholdStr = ""
682         ThresholdID = ""
683         UnaryOp = self.EnumToLong(FT_Undefined)
684         BinaryOp = self.EnumToLong(FT_Undefined)
685         Tolerance = 1e-07
686         TypeOfElement = ALL
687         Precision = -1 ##@1e-07
688         return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID,
689                                 UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision)
690
691     ## Create a criterion by the given parameters
692     #  \n Criterion structures allow to define complex filters by combining them with logical operations (AND / OR) (see example below)
693     #  @param elementType the type of elements(SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
694     #  @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.)
695     #          Type SMESH.FunctorType._items in the Python Console to see all values.
696     #          Note that the items starting from FT_LessThan are not suitable for CritType.
697     #  @param Compare  belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo}
698     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
699     #  @param UnaryOp  SMESH.FT_LogicalNOT or SMESH.FT_Undefined
700     #  @param BinaryOp a binary logical operation SMESH.FT_LogicalAND, SMESH.FT_LogicalOR or
701     #                  SMESH.FT_Undefined
702     #  @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface,
703     #         SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces criteria
704     #  @return SMESH.Filter.Criterion
705     #
706     #  <a href="../tui_filters_page.html#combining_filters">Example of Criteria usage</a>
707     #  @ingroup l1_controls
708     def GetCriterion(self,elementType,
709                      CritType,
710                      Compare = FT_EqualTo,
711                      Threshold="",
712                      UnaryOp=FT_Undefined,
713                      BinaryOp=FT_Undefined,
714                      Tolerance=1e-07):
715         if not CritType in SMESH.FunctorType._items:
716             raise TypeError, "CritType should be of SMESH.FunctorType"
717         aCriterion               = self.GetEmptyCriterion()
718         aCriterion.TypeOfElement = elementType
719         aCriterion.Type          = self.EnumToLong(CritType)
720         aCriterion.Tolerance     = Tolerance
721
722         aThreshold = Threshold
723
724         if Compare in [FT_LessThan, FT_MoreThan, FT_EqualTo]:
725             aCriterion.Compare = self.EnumToLong(Compare)
726         elif Compare == "=" or Compare == "==":
727             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
728         elif Compare == "<":
729             aCriterion.Compare = self.EnumToLong(FT_LessThan)
730         elif Compare == ">":
731             aCriterion.Compare = self.EnumToLong(FT_MoreThan)
732         elif Compare != FT_Undefined:
733             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
734             aThreshold = Compare
735
736         if CritType in [FT_BelongToGeom,     FT_BelongToPlane, FT_BelongToGenSurface,
737                         FT_BelongToCylinder, FT_LyingOnGeom]:
738             # Check that Threshold is GEOM object
739             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object):
740                 aCriterion.ThresholdStr = GetName(aThreshold)
741                 aCriterion.ThresholdID  = aThreshold.GetStudyEntry()
742                 if not aCriterion.ThresholdID:
743                     name = aCriterion.ThresholdStr
744                     if not name:
745                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
746                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
747             # or a name of GEOM object
748             elif isinstance( aThreshold, str ):
749                 aCriterion.ThresholdStr = aThreshold
750             else:
751                 raise TypeError, "The Threshold should be a shape."
752             if isinstance(UnaryOp,float):
753                 aCriterion.Tolerance = UnaryOp
754                 UnaryOp = FT_Undefined
755                 pass
756         elif CritType == FT_BelongToMeshGroup:
757             # Check that Threshold is a group
758             if isinstance(aThreshold, SMESH._objref_SMESH_GroupBase):
759                 if aThreshold.GetType() != elementType:
760                     raise ValueError, "Group type mismatches Element type"
761                 aCriterion.ThresholdStr = aThreshold.GetName()
762                 aCriterion.ThresholdID  = salome.orb.object_to_string( aThreshold )
763                 study = self.GetCurrentStudy()
764                 if study:
765                     so = study.FindObjectIOR( aCriterion.ThresholdID )
766                     if so:
767                         entry = so.GetID()
768                         if entry:
769                             aCriterion.ThresholdID = entry
770             else:
771                 raise TypeError, "The Threshold should be a Mesh Group"
772         elif CritType == FT_RangeOfIds:
773             # Check that Threshold is string
774             if isinstance(aThreshold, str):
775                 aCriterion.ThresholdStr = aThreshold
776             else:
777                 raise TypeError, "The Threshold should be a string."
778         elif CritType == FT_CoplanarFaces:
779             # Check the Threshold
780             if isinstance(aThreshold, int):
781                 aCriterion.ThresholdID = str(aThreshold)
782             elif isinstance(aThreshold, str):
783                 ID = int(aThreshold)
784                 if ID < 1:
785                     raise ValueError, "Invalid ID of mesh face: '%s'"%aThreshold
786                 aCriterion.ThresholdID = aThreshold
787             else:
788                 raise TypeError,\
789                       "The Threshold should be an ID of mesh face and not '%s'"%aThreshold
790         elif CritType == FT_ConnectedElements:
791             # Check the Threshold
792             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): # shape
793                 aCriterion.ThresholdID = aThreshold.GetStudyEntry()
794                 if not aCriterion.ThresholdID:
795                     name = aThreshold.GetName()
796                     if not name:
797                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
798                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
799             elif isinstance(aThreshold, int): # node id
800                 aCriterion.Threshold = aThreshold
801             elif isinstance(aThreshold, list): # 3 point coordinates
802                 if len( aThreshold ) < 3:
803                     raise ValueError, "too few point coordinates, must be 3"
804                 aCriterion.ThresholdStr = " ".join( [str(c) for c in aThreshold[:3]] )
805             elif isinstance(aThreshold, str):
806                 if aThreshold.isdigit():
807                     aCriterion.Threshold = aThreshold # node id
808                 else:
809                     aCriterion.ThresholdStr = aThreshold # hope that it's point coordinates
810             else:
811                 raise TypeError,\
812                       "The Threshold should either a VERTEX, or a node ID, "\
813                       "or a list of point coordinates and not '%s'"%aThreshold
814         elif CritType == FT_ElemGeomType:
815             # Check the Threshold
816             try:
817                 aCriterion.Threshold = self.EnumToLong(aThreshold)
818                 assert( aThreshold in SMESH.GeometryType._items )
819             except:
820                 if isinstance(aThreshold, int):
821                     aCriterion.Threshold = aThreshold
822                 else:
823                     raise TypeError, "The Threshold should be an integer or SMESH.GeometryType."
824                 pass
825             pass
826         elif CritType == FT_EntityType:
827             # Check the Threshold
828             try:
829                 aCriterion.Threshold = self.EnumToLong(aThreshold)
830                 assert( aThreshold in SMESH.EntityType._items )
831             except:
832                 if isinstance(aThreshold, int):
833                     aCriterion.Threshold = aThreshold
834                 else:
835                     raise TypeError, "The Threshold should be an integer or SMESH.EntityType."
836                 pass
837             pass
838         
839         elif CritType == FT_GroupColor:
840             # Check the Threshold
841             try:
842                 aCriterion.ThresholdStr = self.ColorToString(aThreshold)
843             except:
844                 raise TypeError, "The threshold value should be of SALOMEDS.Color type"
845             pass
846         elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_FreeNodes, FT_FreeFaces,
847                           FT_LinearOrQuadratic, FT_BadOrientedVolume,
848                           FT_BareBorderFace, FT_BareBorderVolume,
849                           FT_OverConstrainedFace, FT_OverConstrainedVolume,
850                           FT_EqualNodes,FT_EqualEdges,FT_EqualFaces,FT_EqualVolumes ]:
851             # At this point the Threshold is unnecessary
852             if aThreshold ==  FT_LogicalNOT:
853                 aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
854             elif aThreshold in [FT_LogicalAND, FT_LogicalOR]:
855                 aCriterion.BinaryOp = aThreshold
856         else:
857             # Check Threshold
858             try:
859                 aThreshold = float(aThreshold)
860                 aCriterion.Threshold = aThreshold
861             except:
862                 raise TypeError, "The Threshold should be a number."
863                 return None
864
865         if Threshold ==  FT_LogicalNOT or UnaryOp ==  FT_LogicalNOT:
866             aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
867
868         if Threshold in [FT_LogicalAND, FT_LogicalOR]:
869             aCriterion.BinaryOp = self.EnumToLong(Threshold)
870
871         if UnaryOp in [FT_LogicalAND, FT_LogicalOR]:
872             aCriterion.BinaryOp = self.EnumToLong(UnaryOp)
873
874         if BinaryOp in [FT_LogicalAND, FT_LogicalOR]:
875             aCriterion.BinaryOp = self.EnumToLong(BinaryOp)
876
877         return aCriterion
878
879     ## Create a filter with the given parameters
880     #  @param elementType the type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
881     #  @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.)
882     #          Type SMESH.FunctorType._items in the Python Console to see all values.
883     #          Note that the items starting from FT_LessThan are not suitable for CritType.
884     #  @param Compare  belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo}
885     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
886     #  @param UnaryOp  SMESH.FT_LogicalNOT or SMESH.FT_Undefined
887     #  @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface,
888     #         SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces and SMESH.FT_EqualNodes criteria
889     #  @param mesh the mesh to initialize the filter with
890     #  @return SMESH_Filter
891     #
892     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
893     #  @ingroup l1_controls
894     def GetFilter(self,elementType,
895                   CritType=FT_Undefined,
896                   Compare=FT_EqualTo,
897                   Threshold="",
898                   UnaryOp=FT_Undefined,
899                   Tolerance=1e-07,
900                   mesh=None):
901         aCriterion = self.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
902         aFilterMgr = self.CreateFilterManager()
903         aFilter = aFilterMgr.CreateFilter()
904         aCriteria = []
905         aCriteria.append(aCriterion)
906         aFilter.SetCriteria(aCriteria)
907         if mesh:
908             if isinstance( mesh, Mesh ): aFilter.SetMesh( mesh.GetMesh() )
909             else                       : aFilter.SetMesh( mesh )
910         aFilterMgr.UnRegister()
911         return aFilter
912
913     ## Create a filter from criteria
914     #  @param criteria a list of criteria
915     #  @param binOp binary operator used when binary operator of criteria is undefined
916     #  @return SMESH_Filter
917     #
918     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
919     #  @ingroup l1_controls
920     def GetFilterFromCriteria(self,criteria, binOp=SMESH.FT_LogicalAND):
921         for i in range( len( criteria ) - 1 ):
922             if criteria[i].BinaryOp == self.EnumToLong( SMESH.FT_Undefined ):
923                 criteria[i].BinaryOp = self.EnumToLong( binOp )
924         aFilterMgr = self.CreateFilterManager()
925         aFilter = aFilterMgr.CreateFilter()
926         aFilter.SetCriteria(criteria)
927         aFilterMgr.UnRegister()
928         return aFilter
929
930     ## Create a numerical functor by its type
931     #  @param theCriterion functor type - an item of SMESH.FunctorType enumeration.
932     #          Type SMESH.FunctorType._items in the Python Console to see all items.
933     #          Note that not all items correspond to numerical functors.
934     #  @return SMESH_NumericalFunctor
935     #  @ingroup l1_controls
936     def GetFunctor(self,theCriterion):
937         if isinstance( theCriterion, SMESH._objref_NumericalFunctor ):
938             return theCriterion
939         aFilterMgr = self.CreateFilterManager()
940         functor = None
941         if theCriterion == FT_AspectRatio:
942             functor = aFilterMgr.CreateAspectRatio()
943         elif theCriterion == FT_AspectRatio3D:
944             functor = aFilterMgr.CreateAspectRatio3D()
945         elif theCriterion == FT_Warping:
946             functor = aFilterMgr.CreateWarping()
947         elif theCriterion == FT_MinimumAngle:
948             functor = aFilterMgr.CreateMinimumAngle()
949         elif theCriterion == FT_Taper:
950             functor = aFilterMgr.CreateTaper()
951         elif theCriterion == FT_Skew:
952             functor = aFilterMgr.CreateSkew()
953         elif theCriterion == FT_Area:
954             functor = aFilterMgr.CreateArea()
955         elif theCriterion == FT_Volume3D:
956             functor = aFilterMgr.CreateVolume3D()
957         elif theCriterion == FT_MaxElementLength2D:
958             functor = aFilterMgr.CreateMaxElementLength2D()
959         elif theCriterion == FT_MaxElementLength3D:
960             functor = aFilterMgr.CreateMaxElementLength3D()
961         elif theCriterion == FT_MultiConnection:
962             functor = aFilterMgr.CreateMultiConnection()
963         elif theCriterion == FT_MultiConnection2D:
964             functor = aFilterMgr.CreateMultiConnection2D()
965         elif theCriterion == FT_Length:
966             functor = aFilterMgr.CreateLength()
967         elif theCriterion == FT_Length2D:
968             functor = aFilterMgr.CreateLength2D()
969         elif theCriterion == FT_Deflection2D:
970             functor = aFilterMgr.CreateDeflection2D()
971         elif theCriterion == FT_NodeConnectivityNumber:
972             functor = aFilterMgr.CreateNodeConnectivityNumber()
973         elif theCriterion == FT_BallDiameter:
974             functor = aFilterMgr.CreateBallDiameter()
975         else:
976             print "Error: given parameter is not numerical functor type."
977         aFilterMgr.UnRegister()
978         return functor
979
980     ## Create hypothesis
981     #  @param theHType mesh hypothesis type (string)
982     #  @param theLibName mesh plug-in library name
983     #  @return created hypothesis instance
984     def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"):
985         hyp = SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName )
986
987         if isinstance( hyp, SMESH._objref_SMESH_Algo ):
988             return hyp
989
990         # wrap hypothesis methods
991         #print "HYPOTHESIS", theHType
992         for meth_name in dir( hyp.__class__ ):
993             if not meth_name.startswith("Get") and \
994                not meth_name in dir ( SMESH._objref_SMESH_Hypothesis ):
995                 method = getattr ( hyp.__class__, meth_name )
996                 if callable(method):
997                     setattr( hyp, meth_name, hypMethodWrapper( hyp, method ))
998
999         return hyp
1000
1001     ## Get the mesh statistic
1002     #  @return dictionary "element type" - "count of elements"
1003     #  @ingroup l1_meshinfo
1004     def GetMeshInfo(self, obj):
1005         if isinstance( obj, Mesh ):
1006             obj = obj.GetMesh()
1007         d = {}
1008         if hasattr(obj, "GetMeshInfo"):
1009             values = obj.GetMeshInfo()
1010             for i in range(SMESH.Entity_Last._v):
1011                 if i < len(values): d[SMESH.EntityType._item(i)]=values[i]
1012             pass
1013         return d
1014
1015     ## Get minimum distance between two objects
1016     #
1017     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
1018     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
1019     #
1020     #  @param src1 first source object
1021     #  @param src2 second source object
1022     #  @param id1 node/element id from the first source
1023     #  @param id2 node/element id from the second (or first) source
1024     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
1025     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
1026     #  @return minimum distance value
1027     #  @sa GetMinDistance()
1028     #  @ingroup l1_measurements
1029     def MinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
1030         result = self.GetMinDistance(src1, src2, id1, id2, isElem1, isElem2)
1031         if result is None:
1032             result = 0.0
1033         else:
1034             result = result.value
1035         return result
1036
1037     ## Get measure structure specifying minimum distance data between two objects
1038     #
1039     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
1040     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
1041     #
1042     #  @param src1 first source object
1043     #  @param src2 second source object
1044     #  @param id1 node/element id from the first source
1045     #  @param id2 node/element id from the second (or first) source
1046     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
1047     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
1048     #  @return Measure structure or None if input data is invalid
1049     #  @sa MinDistance()
1050     #  @ingroup l1_measurements
1051     def GetMinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
1052         if isinstance(src1, Mesh): src1 = src1.mesh
1053         if isinstance(src2, Mesh): src2 = src2.mesh
1054         if src2 is None and id2 != 0: src2 = src1
1055         if not hasattr(src1, "_narrow"): return None
1056         src1 = src1._narrow(SMESH.SMESH_IDSource)
1057         if not src1: return None
1058         unRegister = genObjUnRegister()
1059         if id1 != 0:
1060             m = src1.GetMesh()
1061             e = m.GetMeshEditor()
1062             if isElem1:
1063                 src1 = e.MakeIDSource([id1], SMESH.FACE)
1064             else:
1065                 src1 = e.MakeIDSource([id1], SMESH.NODE)
1066             unRegister.set( src1 )
1067             pass
1068         if hasattr(src2, "_narrow"):
1069             src2 = src2._narrow(SMESH.SMESH_IDSource)
1070             if src2 and id2 != 0:
1071                 m = src2.GetMesh()
1072                 e = m.GetMeshEditor()
1073                 if isElem2:
1074                     src2 = e.MakeIDSource([id2], SMESH.FACE)
1075                 else:
1076                     src2 = e.MakeIDSource([id2], SMESH.NODE)
1077                 unRegister.set( src2 )
1078                 pass
1079             pass
1080         aMeasurements = self.CreateMeasurements()
1081         unRegister.set( aMeasurements )
1082         result = aMeasurements.MinDistance(src1, src2)
1083         return result
1084
1085     ## Get bounding box of the specified object(s)
1086     #  @param objects single source object or list of source objects
1087     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
1088     #  @sa GetBoundingBox()
1089     #  @ingroup l1_measurements
1090     def BoundingBox(self, objects):
1091         result = self.GetBoundingBox(objects)
1092         if result is None:
1093             result = (0.0,)*6
1094         else:
1095             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
1096         return result
1097
1098     ## Get measure structure specifying bounding box data of the specified object(s)
1099     #  @param objects single source object or list of source objects
1100     #  @return Measure structure
1101     #  @sa BoundingBox()
1102     #  @ingroup l1_measurements
1103     def GetBoundingBox(self, objects):
1104         if isinstance(objects, tuple):
1105             objects = list(objects)
1106         if not isinstance(objects, list):
1107             objects = [objects]
1108         srclist = []
1109         for o in objects:
1110             if isinstance(o, Mesh):
1111                 srclist.append(o.mesh)
1112             elif hasattr(o, "_narrow"):
1113                 src = o._narrow(SMESH.SMESH_IDSource)
1114                 if src: srclist.append(src)
1115                 pass
1116             pass
1117         aMeasurements = self.CreateMeasurements()
1118         result = aMeasurements.BoundingBox(srclist)
1119         aMeasurements.UnRegister()
1120         return result
1121
1122     ## Get sum of lengths of all 1D elements in the mesh object.
1123     #  @param obj mesh, submesh or group
1124     #  @return sum of lengths of all 1D elements
1125     #  @ingroup l1_measurements
1126     def GetLength(self, obj):
1127         if isinstance(obj, Mesh): obj = obj.mesh
1128         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1129         aMeasurements = self.CreateMeasurements()
1130         value = aMeasurements.Length(obj)
1131         aMeasurements.UnRegister()
1132         return value
1133
1134     ## Get sum of areas of all 2D elements in the mesh object.
1135     #  @param obj mesh, submesh or group
1136     #  @return sum of areas of all 2D elements
1137     #  @ingroup l1_measurements
1138     def GetArea(self, obj):
1139         if isinstance(obj, Mesh): obj = obj.mesh
1140         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1141         aMeasurements = self.CreateMeasurements()
1142         value = aMeasurements.Area(obj)
1143         aMeasurements.UnRegister()
1144         return value
1145
1146     ## Get sum of volumes of all 3D elements in the mesh object.
1147     #  @param obj mesh, submesh or group
1148     #  @return sum of volumes of all 3D elements
1149     #  @ingroup l1_measurements
1150     def GetVolume(self, obj):
1151         if isinstance(obj, Mesh): obj = obj.mesh
1152         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1153         aMeasurements = self.CreateMeasurements()
1154         value = aMeasurements.Volume(obj)
1155         aMeasurements.UnRegister()
1156         return value
1157
1158     ## Get gravity center of all nodes of the mesh object.
1159     #  @param obj mesh, submesh or group
1160     #  @return three components of the gravity center: x,y,z
1161     #  @ingroup l1_measurements
1162     def GetGravityCenter(self, obj):
1163         if isinstance(obj, Mesh): obj = obj.mesh
1164         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1165         aMeasurements = self.CreateMeasurements()
1166         pointStruct = aMeasurements.GravityCenter(obj)
1167         aMeasurements.UnRegister()
1168         return pointStruct.x, pointStruct.y, pointStruct.z
1169
1170     pass # end of class smeshBuilder
1171
1172 import omniORB
1173 #Registering the new proxy for SMESH_Gen
1174 omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshBuilder)
1175
1176 ## Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1177 #  interface to create or load meshes.
1178 #
1179 #  Typical use is:
1180 #  \code
1181 #    import salome
1182 #    salome.salome_init()
1183 #    from salome.smesh import smeshBuilder
1184 #    smesh = smeshBuilder.New(salome.myStudy)
1185 #  \endcode
1186 #  @param  study     SALOME study, generally obtained by salome.myStudy.
1187 #  @param  instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1188 #  @return smeshBuilder instance
1189
1190 def New( study, instance=None):
1191     """
1192     Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1193     interface to create or load meshes.
1194
1195     Typical use is:
1196         import salome
1197         salome.salome_init()
1198         from salome.smesh import smeshBuilder
1199         smesh = smeshBuilder.New(salome.myStudy)
1200
1201     Parameters:
1202         study     SALOME study, generally obtained by salome.myStudy.
1203         instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1204     Returns:
1205         smeshBuilder instance
1206     """
1207     global engine
1208     global smeshInst
1209     global doLcc
1210     engine = instance
1211     if engine is None:
1212       doLcc = True
1213     smeshInst = smeshBuilder()
1214     assert isinstance(smeshInst,smeshBuilder), "Smesh engine class is %s but should be smeshBuilder.smeshBuilder. Import salome.smesh.smeshBuilder before creating the instance."%smeshInst.__class__
1215     smeshInst.init_smesh(study)
1216     return smeshInst
1217
1218
1219 # Public class: Mesh
1220 # ==================
1221
1222 ## This class allows defining and managing a mesh.
1223 #  It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes.
1224 #  It also has methods to define groups of mesh elements, to modify a mesh (by addition of
1225 #  new nodes and elements and by changing the existing entities), to get information
1226 #  about a mesh and to export a mesh in different formats.
1227 class Mesh:
1228     __metaclass__ = MeshMeta
1229
1230     geom = 0
1231     mesh = 0
1232     editor = 0
1233
1234     ## Constructor
1235     #
1236     #  Create a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and
1237     #  sets the GUI name of this mesh to \a name.
1238     #  @param smeshpyD an instance of smeshBuilder class
1239     #  @param geompyD an instance of geomBuilder class
1240     #  @param obj Shape to be meshed or SMESH_Mesh object
1241     #  @param name Study name of the mesh
1242     #  @ingroup l2_construct
1243     def __init__(self, smeshpyD, geompyD, obj=0, name=0):
1244         self.smeshpyD=smeshpyD
1245         self.geompyD=geompyD
1246         if obj is None:
1247             obj = 0
1248         objHasName = False
1249         if obj != 0:
1250             if isinstance(obj, geomBuilder.GEOM._objref_GEOM_Object):
1251                 self.geom = obj
1252                 objHasName = True
1253                 # publish geom of mesh (issue 0021122)
1254                 if not self.geom.GetStudyEntry() and smeshpyD.GetCurrentStudy():
1255                     objHasName = False
1256                     studyID = smeshpyD.GetCurrentStudy()._get_StudyId()
1257                     if studyID != geompyD.myStudyId:
1258                         geompyD.init_geom( smeshpyD.GetCurrentStudy())
1259                         pass
1260                     if name:
1261                         geo_name = name + " shape"
1262                     else:
1263                         geo_name = "%s_%s to mesh"%(self.geom.GetShapeType(), id(self.geom)%100)
1264                     geompyD.addToStudy( self.geom, geo_name )
1265                 self.SetMesh( self.smeshpyD.CreateMesh(self.geom) )
1266
1267             elif isinstance(obj, SMESH._objref_SMESH_Mesh):
1268                 self.SetMesh(obj)
1269         else:
1270             self.SetMesh( self.smeshpyD.CreateEmptyMesh() )
1271         if name:
1272             self.smeshpyD.SetName(self.mesh, name)
1273         elif objHasName:
1274             self.smeshpyD.SetName(self.mesh, GetName(obj)) # + " mesh"
1275
1276         if not self.geom:
1277             self.geom = self.mesh.GetShapeToMesh()
1278
1279         self.editor   = self.mesh.GetMeshEditor()
1280         self.functors = [None] * SMESH.FT_Undefined._v
1281
1282         # set self to algoCreator's
1283         for attrName in dir(self):
1284             attr = getattr( self, attrName )
1285             if isinstance( attr, algoCreator ):
1286                 setattr( self, attrName, attr.copy( self ))
1287                 pass
1288             pass
1289         pass
1290
1291     ## Destructor. Clean-up resources
1292     def __del__(self):
1293         if self.mesh:
1294             #self.mesh.UnRegister()
1295             pass
1296         pass
1297         
1298     ## Initialize the Mesh object from an instance of SMESH_Mesh interface
1299     #  @param theMesh a SMESH_Mesh object
1300     #  @ingroup l2_construct
1301     def SetMesh(self, theMesh):
1302         # do not call Register() as this prevents mesh servant deletion at closing study
1303         #if self.mesh: self.mesh.UnRegister()
1304         self.mesh = theMesh
1305         if self.mesh:
1306             #self.mesh.Register()
1307             self.geom = self.mesh.GetShapeToMesh()
1308         pass
1309
1310     ## Return the mesh, that is an instance of SMESH_Mesh interface
1311     #  @return a SMESH_Mesh object
1312     #  @ingroup l2_construct
1313     def GetMesh(self):
1314         return self.mesh
1315
1316     ## Get the name of the mesh
1317     #  @return the name of the mesh as a string
1318     #  @ingroup l2_construct
1319     def GetName(self):
1320         name = GetName(self.GetMesh())
1321         return name
1322
1323     ## Set a name to the mesh
1324     #  @param name a new name of the mesh
1325     #  @ingroup l2_construct
1326     def SetName(self, name):
1327         self.smeshpyD.SetName(self.GetMesh(), name)
1328
1329     ## Get a sub-mesh object associated to a \a geom geometrical object.
1330     #  @param geom a geometrical object (shape)
1331     #  @param name a name for the sub-mesh in the Object Browser
1332     #  @return an object of type SMESH.SMESH_subMesh, representing a part of mesh,
1333     #          which lies on the given shape
1334     #
1335     #  The sub-mesh object gives access to the IDs of nodes and elements.
1336     #  The sub-mesh object has the following methods:
1337     #  - SMESH.SMESH_subMesh.GetNumberOfElements()
1338     #  - SMESH.SMESH_subMesh.GetNumberOfNodes( all )
1339     #  - SMESH.SMESH_subMesh.GetElementsId()
1340     #  - SMESH.SMESH_subMesh.GetElementsByType( ElementType )
1341     #  - SMESH.SMESH_subMesh.GetNodesId()
1342     #  - SMESH.SMESH_subMesh.GetSubShape()
1343     #  - SMESH.SMESH_subMesh.GetFather()
1344     #  - SMESH.SMESH_subMesh.GetId()
1345     #  @note A sub-mesh is implicitly created when a sub-shape is specified at
1346     #  creating an algorithm, for example: <code>algo1D = mesh.Segment(geom=Edge_1) </code>
1347     #  creates a sub-mesh on @c Edge_1 and assign Wire Discretization algorithm to it.
1348     #  The created sub-mesh can be retrieved from the algorithm:
1349     #  <code>submesh = algo1D.GetSubMesh()</code>
1350     #  @ingroup l2_submeshes
1351     def GetSubMesh(self, geom, name):
1352         AssureGeomPublished( self, geom, name )
1353         submesh = self.mesh.GetSubMesh( geom, name )
1354         return submesh
1355
1356     ## Return the shape associated to the mesh
1357     #  @return a GEOM_Object
1358     #  @ingroup l2_construct
1359     def GetShape(self):
1360         return self.geom
1361
1362     ## Associate the given shape to the mesh (entails the recreation of the mesh)
1363     #  @param geom the shape to be meshed (GEOM_Object)
1364     #  @ingroup l2_construct
1365     def SetShape(self, geom):
1366         self.mesh = self.smeshpyD.CreateMesh(geom)
1367
1368     ## Load mesh from the study after opening the study
1369     def Load(self):
1370         self.mesh.Load()
1371
1372     ## Return true if the hypotheses are defined well
1373     #  @param theSubObject a sub-shape of a mesh shape
1374     #  @return True or False
1375     #  @ingroup l2_construct
1376     def IsReadyToCompute(self, theSubObject):
1377         return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject)
1378
1379     ## Return errors of hypotheses definition.
1380     #  The list of errors is empty if everything is OK.
1381     #  @param theSubObject a sub-shape of a mesh shape
1382     #  @return a list of errors
1383     #  @ingroup l2_construct
1384     def GetAlgoState(self, theSubObject):
1385         return self.smeshpyD.GetAlgoState(self.mesh, theSubObject)
1386
1387     ## Return a geometrical object on which the given element was built.
1388     #  The returned geometrical object, if not nil, is either found in the
1389     #  study or published by this method with the given name
1390     #  @param theElementID the id of the mesh element
1391     #  @param theGeomName the user-defined name of the geometrical object
1392     #  @return GEOM::GEOM_Object instance
1393     #  @ingroup l1_meshinfo
1394     def GetGeometryByMeshElement(self, theElementID, theGeomName):
1395         return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName )
1396
1397     ## Return the mesh dimension depending on the dimension of the underlying shape
1398     #  or, if the mesh is not based on any shape, basing on deimension of elements
1399     #  @return mesh dimension as an integer value [0,3]
1400     #  @ingroup l1_meshinfo
1401     def MeshDimension(self):
1402         if self.mesh.HasShapeToMesh():
1403             shells = self.geompyD.SubShapeAllIDs( self.geom, self.geompyD.ShapeType["SOLID"] )
1404             if len( shells ) > 0 :
1405                 return 3
1406             elif self.geompyD.NumberOfFaces( self.geom ) > 0 :
1407                 return 2
1408             elif self.geompyD.NumberOfEdges( self.geom ) > 0 :
1409                 return 1
1410             else:
1411                 return 0;
1412         else:
1413             if self.NbVolumes() > 0: return 3
1414             if self.NbFaces()   > 0: return 2
1415             if self.NbEdges()   > 0: return 1
1416         return 0
1417
1418     ## Evaluate size of prospective mesh on a shape
1419     #  @return a list where i-th element is a number of elements of i-th SMESH.EntityType
1420     #  To know predicted number of e.g. edges, inquire it this way
1421     #  Evaluate()[ EnumToLong( Entity_Edge )]
1422     #  @ingroup l2_construct
1423     def Evaluate(self, geom=0):
1424         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1425             if self.geom == 0:
1426                 geom = self.mesh.GetShapeToMesh()
1427             else:
1428                 geom = self.geom
1429         return self.smeshpyD.Evaluate(self.mesh, geom)
1430
1431
1432     ## Compute the mesh and return the status of the computation
1433     #  @param geom geomtrical shape on which mesh data should be computed
1434     #  @param discardModifs if True and the mesh has been edited since
1435     #         a last total re-compute and that may prevent successful partial re-compute,
1436     #         then the mesh is cleaned before Compute()
1437     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1438     #  @return True or False
1439     #  @ingroup l2_construct
1440     def Compute(self, geom=0, discardModifs=False, refresh=False):
1441         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1442             if self.geom == 0:
1443                 geom = self.mesh.GetShapeToMesh()
1444             else:
1445                 geom = self.geom
1446         ok = False
1447         try:
1448             if discardModifs and self.mesh.HasModificationsToDiscard(): # issue 0020693
1449                 self.mesh.Clear()
1450             ok = self.smeshpyD.Compute(self.mesh, geom)
1451         except SALOME.SALOME_Exception, ex:
1452             print "Mesh computation failed, exception caught:"
1453             print "    ", ex.details.text
1454         except:
1455             import traceback
1456             print "Mesh computation failed, exception caught:"
1457             traceback.print_exc()
1458         if True:#not ok:
1459             allReasons = ""
1460
1461             # Treat compute errors
1462             computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, geom )
1463             shapeText = ""
1464             for err in computeErrors:
1465                 if self.mesh.HasShapeToMesh():
1466                     shapeText = " on %s" % self.GetSubShapeName( err.subShapeID )
1467                 errText = ""
1468                 stdErrors = ["OK",                   #COMPERR_OK
1469                              "Invalid input mesh",   #COMPERR_BAD_INPUT_MESH
1470                              "std::exception",       #COMPERR_STD_EXCEPTION
1471                              "OCC exception",        #COMPERR_OCC_EXCEPTION
1472                              "..",                   #COMPERR_SLM_EXCEPTION
1473                              "Unknown exception",    #COMPERR_EXCEPTION
1474                              "Memory allocation problem", #COMPERR_MEMORY_PB
1475                              "Algorithm failed",     #COMPERR_ALGO_FAILED
1476                              "Unexpected geometry",  #COMPERR_BAD_SHAPE
1477                              "Warning",              #COMPERR_WARNING
1478                              "Computation cancelled",#COMPERR_CANCELED
1479                              "No mesh on sub-shape"] #COMPERR_NO_MESH_ON_SHAPE
1480                 if err.code > 0:
1481                     if err.code < len(stdErrors): errText = stdErrors[err.code]
1482                 else:
1483                     errText = "code %s" % -err.code
1484                 if errText: errText += ". "
1485                 errText += err.comment
1486                 if allReasons: allReasons += "\n"
1487                 if ok:
1488                     allReasons += '-  "%s"%s - %s' %(err.algoName, shapeText, errText)
1489                 else:
1490                     allReasons += '-  "%s" failed%s. Error: %s' %(err.algoName, shapeText, errText)
1491                 pass
1492
1493             # Treat hyp errors
1494             errors = self.smeshpyD.GetAlgoState( self.mesh, geom )
1495             for err in errors:
1496                 if err.isGlobalAlgo:
1497                     glob = "global"
1498                 else:
1499                     glob = "local"
1500                     pass
1501                 dim = err.algoDim
1502                 name = err.algoName
1503                 if len(name) == 0:
1504                     reason = '%s %sD algorithm is missing' % (glob, dim)
1505                 elif err.state == HYP_MISSING:
1506                     reason = ('%s %sD algorithm "%s" misses %sD hypothesis'
1507                               % (glob, dim, name, dim))
1508                 elif err.state == HYP_NOTCONFORM:
1509                     reason = 'Global "Not Conform mesh allowed" hypothesis is missing'
1510                 elif err.state == HYP_BAD_PARAMETER:
1511                     reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value'
1512                               % ( glob, dim, name ))
1513                 elif err.state == HYP_BAD_GEOMETRY:
1514                     reason = ('%s %sD algorithm "%s" is assigned to mismatching'
1515                               'geometry' % ( glob, dim, name ))
1516                 elif err.state == HYP_HIDDEN_ALGO:
1517                     reason = ('%s %sD algorithm "%s" is ignored due to presence of a %s '
1518                               'algorithm of upper dimension generating %sD mesh'
1519                               % ( glob, dim, name, glob, dim ))
1520                 else:
1521                     reason = ("For unknown reason. "
1522                               "Developer, revise Mesh.Compute() implementation in smeshBuilder.py!")
1523                     pass
1524                 if allReasons: allReasons += "\n"
1525                 allReasons += "-  " + reason
1526                 pass
1527             if not ok or allReasons != "":
1528                 msg = '"' + GetName(self.mesh) + '"'
1529                 if ok: msg += " has been computed with warnings"
1530                 else:  msg += " has not been computed"
1531                 if allReasons != "": msg += ":"
1532                 else:                msg += "."
1533                 print msg
1534                 print allReasons
1535             pass
1536         if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0:
1537             if not isinstance( refresh, list): # not a call from subMesh.Compute()
1538                 smeshgui = salome.ImportComponentGUI("SMESH")
1539                 smeshgui.Init(self.mesh.GetStudyId())
1540                 smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) )
1541                 if refresh: salome.sg.updateObjBrowser(True)
1542
1543         return ok
1544
1545     ## Return a list of error messages (SMESH.ComputeError) of the last Compute()
1546     #  @ingroup l2_construct
1547     def GetComputeErrors(self, shape=0 ):
1548         if shape == 0:
1549             shape = self.mesh.GetShapeToMesh()
1550         return self.smeshpyD.GetComputeErrors( self.mesh, shape )
1551
1552     ## Return a name of a sub-shape by its ID
1553     #  @param subShapeID a unique ID of a sub-shape
1554     #  @return a string describing the sub-shape; possible variants:
1555     #  - "Face_12"    (published sub-shape)
1556     #  - FACE #3      (not published sub-shape)
1557     #  - sub-shape #3 (invalid sub-shape ID)
1558     #  - #3           (error in this function)
1559     #  @ingroup l1_auxiliary
1560     def GetSubShapeName(self, subShapeID ):
1561         if not self.mesh.HasShapeToMesh():
1562             return ""
1563         try:
1564             shapeText = ""
1565             mainIOR  = salome.orb.object_to_string( self.GetShape() )
1566             for sname in salome.myStudyManager.GetOpenStudies():
1567                 s = salome.myStudyManager.GetStudyByName(sname)
1568                 if not s: continue
1569                 mainSO = s.FindObjectIOR(mainIOR)
1570                 if not mainSO: continue
1571                 if subShapeID == 1:
1572                     shapeText = '"%s"' % mainSO.GetName()
1573                 subIt = s.NewChildIterator(mainSO)
1574                 while subIt.More():
1575                     subSO = subIt.Value()
1576                     subIt.Next()
1577                     obj = subSO.GetObject()
1578                     if not obj: continue
1579                     go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object )
1580                     if not go: continue
1581                     try:
1582                         ids = self.geompyD.GetSubShapeID( self.GetShape(), go )
1583                     except:
1584                         continue
1585                     if ids == subShapeID:
1586                         shapeText = '"%s"' % subSO.GetName()
1587                         break
1588             if not shapeText:
1589                 shape = self.geompyD.GetSubShape( self.GetShape(), [subShapeID])
1590                 if shape:
1591                     shapeText = '%s #%s' % (shape.GetShapeType(), subShapeID)
1592                 else:
1593                     shapeText = 'sub-shape #%s' % (subShapeID)
1594         except:
1595             shapeText = "#%s" % (subShapeID)
1596         return shapeText
1597
1598     ## Return a list of sub-shapes meshing of which failed, grouped into GEOM groups by
1599     #  error of an algorithm
1600     #  @param publish if @c True, the returned groups will be published in the study
1601     #  @return a list of GEOM groups each named after a failed algorithm
1602     #  @ingroup l2_construct
1603     def GetFailedShapes(self, publish=False):
1604
1605         algo2shapes = {}
1606         computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, self.GetShape() )
1607         for err in computeErrors:
1608             shape = self.geompyD.GetSubShape( self.GetShape(), [err.subShapeID])
1609             if not shape: continue
1610             if err.algoName in algo2shapes:
1611                 algo2shapes[ err.algoName ].append( shape )
1612             else:
1613                 algo2shapes[ err.algoName ] = [ shape ]
1614             pass
1615
1616         groups = []
1617         for algoName, shapes in algo2shapes.items():
1618             while shapes:
1619                 groupType = self.smeshpyD.EnumToLong( shapes[0].GetShapeType() )
1620                 otherTypeShapes = []
1621                 sameTypeShapes  = []
1622                 group = self.geompyD.CreateGroup( self.geom, groupType )
1623                 for shape in shapes:
1624                     if shape.GetShapeType() == shapes[0].GetShapeType():
1625                         sameTypeShapes.append( shape )
1626                     else:
1627                         otherTypeShapes.append( shape )
1628                 self.geompyD.UnionList( group, sameTypeShapes )
1629                 if otherTypeShapes:
1630                     group.SetName( "%s %s" % ( algoName, shapes[0].GetShapeType() ))
1631                 else:
1632                     group.SetName( algoName )
1633                 groups.append( group )
1634                 shapes = otherTypeShapes
1635             pass
1636         if publish:
1637             for group in groups:
1638                 self.geompyD.addToStudyInFather( self.geom, group, group.GetName() )
1639         return groups
1640
1641     ## Return sub-mesh objects list in meshing order
1642     #  @return list of lists of sub-meshes
1643     #  @ingroup l2_construct
1644     def GetMeshOrder(self):
1645         return self.mesh.GetMeshOrder()
1646
1647     ## Set order in which concurrent sub-meshes should be meshed
1648     #  @param submeshes list of lists of sub-meshes
1649     #  @ingroup l2_construct
1650     def SetMeshOrder(self, submeshes):
1651         return self.mesh.SetMeshOrder(submeshes)
1652
1653     ## Remove all nodes and elements generated on geometry. Imported elements remain.
1654     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1655     #  @ingroup l2_construct
1656     def Clear(self, refresh=False):
1657         self.mesh.Clear()
1658         if ( salome.sg.hasDesktop() and 
1659              salome.myStudyManager.GetStudyByID( self.mesh.GetStudyId() ) ):
1660             smeshgui = salome.ImportComponentGUI("SMESH")
1661             smeshgui.Init(self.mesh.GetStudyId())
1662             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1663             if refresh: salome.sg.updateObjBrowser(True)
1664
1665     ## Remove all nodes and elements of indicated shape
1666     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1667     #  @param geomId the ID of a sub-shape to remove elements on
1668     #  @ingroup l2_submeshes
1669     def ClearSubMesh(self, geomId, refresh=False):
1670         self.mesh.ClearSubMesh(geomId)
1671         if salome.sg.hasDesktop():
1672             smeshgui = salome.ImportComponentGUI("SMESH")
1673             smeshgui.Init(self.mesh.GetStudyId())
1674             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1675             if refresh: salome.sg.updateObjBrowser(True)
1676
1677     ## Compute a tetrahedral mesh using AutomaticLength + MEFISTO + Tetrahedron
1678     #  @param fineness [0.0,1.0] defines mesh fineness
1679     #  @return True or False
1680     #  @ingroup l3_algos_basic
1681     def AutomaticTetrahedralization(self, fineness=0):
1682         dim = self.MeshDimension()
1683         # assign hypotheses
1684         self.RemoveGlobalHypotheses()
1685         self.Segment().AutomaticLength(fineness)
1686         if dim > 1 :
1687             self.Triangle().LengthFromEdges()
1688             pass
1689         if dim > 2 :
1690             self.Tetrahedron()
1691             pass
1692         return self.Compute()
1693
1694     ## Compute an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron
1695     #  @param fineness [0.0, 1.0] defines mesh fineness
1696     #  @return True or False
1697     #  @ingroup l3_algos_basic
1698     def AutomaticHexahedralization(self, fineness=0):
1699         dim = self.MeshDimension()
1700         # assign the hypotheses
1701         self.RemoveGlobalHypotheses()
1702         self.Segment().AutomaticLength(fineness)
1703         if dim > 1 :
1704             self.Quadrangle()
1705             pass
1706         if dim > 2 :
1707             self.Hexahedron()
1708             pass
1709         return self.Compute()
1710
1711     ## Assign a hypothesis
1712     #  @param hyp a hypothesis to assign
1713     #  @param geom a subhape of mesh geometry
1714     #  @return SMESH.Hypothesis_Status
1715     #  @ingroup l2_editing
1716     def AddHypothesis(self, hyp, geom=0):
1717         if isinstance( hyp, geomBuilder.GEOM._objref_GEOM_Object ):
1718             hyp, geom = geom, hyp
1719         if isinstance( hyp, Mesh_Algorithm ):
1720             hyp = hyp.GetAlgorithm()
1721             pass
1722         if not geom:
1723             geom = self.geom
1724             if not geom:
1725                 geom = self.mesh.GetShapeToMesh()
1726             pass
1727         isApplicable = True
1728         if self.mesh.HasShapeToMesh():
1729             hyp_type     = hyp.GetName()
1730             lib_name     = hyp.GetLibName()
1731             # checkAll    = ( not geom.IsSame( self.mesh.GetShapeToMesh() ))
1732             # if checkAll and geom:
1733             #     checkAll = geom.GetType() == 37
1734             checkAll     = False
1735             isApplicable = self.smeshpyD.IsApplicable(hyp_type, lib_name, geom, checkAll)
1736         if isApplicable:
1737             AssureGeomPublished( self, geom, "shape for %s" % hyp.GetName())
1738             status = self.mesh.AddHypothesis(geom, hyp)
1739         else:
1740             status = HYP_BAD_GEOMETRY,""
1741         hyp_name = GetName( hyp )
1742         geom_name = ""
1743         if geom:
1744             geom_name = geom.GetName()
1745         isAlgo = hyp._narrow( SMESH_Algo )
1746         TreatHypoStatus( status, hyp_name, geom_name, isAlgo, self )
1747         return status
1748
1749     ## Return True if an algorithm of hypothesis is assigned to a given shape
1750     #  @param hyp a hypothesis to check
1751     #  @param geom a subhape of mesh geometry
1752     #  @return True of False
1753     #  @ingroup l2_editing
1754     def IsUsedHypothesis(self, hyp, geom):
1755         if not hyp: # or not geom
1756             return False
1757         if isinstance( hyp, Mesh_Algorithm ):
1758             hyp = hyp.GetAlgorithm()
1759             pass
1760         hyps = self.GetHypothesisList(geom)
1761         for h in hyps:
1762             if h.GetId() == hyp.GetId():
1763                 return True
1764         return False
1765
1766     ## Unassign a hypothesis
1767     #  @param hyp a hypothesis to unassign
1768     #  @param geom a sub-shape of mesh geometry
1769     #  @return SMESH.Hypothesis_Status
1770     #  @ingroup l2_editing
1771     def RemoveHypothesis(self, hyp, geom=0):
1772         if not hyp:
1773             return None
1774         if isinstance( hyp, Mesh_Algorithm ):
1775             hyp = hyp.GetAlgorithm()
1776             pass
1777         shape = geom
1778         if not shape:
1779             shape = self.geom
1780             pass
1781         if self.IsUsedHypothesis( hyp, shape ):
1782             return self.mesh.RemoveHypothesis( shape, hyp )
1783         hypName = GetName( hyp )
1784         geoName = GetName( shape )
1785         print "WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName )
1786         return None
1787
1788     ## Get the list of hypotheses added on a geometry
1789     #  @param geom a sub-shape of mesh geometry
1790     #  @return the sequence of SMESH_Hypothesis
1791     #  @ingroup l2_editing
1792     def GetHypothesisList(self, geom):
1793         return self.mesh.GetHypothesisList( geom )
1794
1795     ## Remove all global hypotheses
1796     #  @ingroup l2_editing
1797     def RemoveGlobalHypotheses(self):
1798         current_hyps = self.mesh.GetHypothesisList( self.geom )
1799         for hyp in current_hyps:
1800             self.mesh.RemoveHypothesis( self.geom, hyp )
1801             pass
1802         pass
1803
1804     ## Export the mesh in a file in MED format
1805     ## allowing to overwrite the file if it exists or add the exported data to its contents
1806     #  @param f is the file name
1807     #  @param auto_groups boolean parameter for creating/not creating
1808     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1809     #  the typical use is auto_groups=False.
1810     #  @param version MED format version
1811     #         - MED_V2_1 is obsolete.
1812     #         - MED_V2_2 means current version (kept for compatibility reasons)
1813     #         - MED_LATEST means current version.
1814     #         - MED_MINOR_x where x from 0 to 9 indicates the minor version of MED
1815     #           to use for writing MED files, for backward compatibility :
1816     #           for instance, with SALOME 8.4 use MED 3.2 (minor=2) instead of 3.3,
1817     #           to allow the file to be read with SALOME 8.3.
1818     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1819     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1820     #  @param autoDimension if @c True (default), a space dimension of a MED mesh can be either
1821     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1822     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1823     #         - 3D in the rest cases.<br>
1824     #         If @a autoDimension is @c False, the space dimension is always 3.
1825     #  @param fields list of GEOM fields defined on the shape to mesh.
1826     #  @param geomAssocFields each character of this string means a need to export a 
1827     #         corresponding field; correspondence between fields and characters is following:
1828     #         - 'v' stands for "_vertices _" field;
1829     #         - 'e' stands for "_edges _" field;
1830     #         - 'f' stands for "_faces _" field;
1831     #         - 's' stands for "_solids _" field.
1832     #  @ingroup l2_impexp
1833     def ExportMED(self, f, auto_groups=0, version=MED_LATEST,
1834                   overwrite=1, meshPart=None, autoDimension=True, fields=[], geomAssocFields=''):
1835         if meshPart or fields or geomAssocFields:
1836             unRegister = genObjUnRegister()
1837             if isinstance( meshPart, list ):
1838                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1839                 unRegister.set( meshPart )
1840             self.mesh.ExportPartToMED( meshPart, f, auto_groups, version, overwrite, autoDimension,
1841                                        fields, geomAssocFields)
1842         else:
1843             self.mesh.ExportToMEDX(f, auto_groups, version, overwrite, autoDimension)
1844
1845     ## Export the mesh in a file in SAUV format
1846     #  @param f is the file name
1847     #  @param auto_groups boolean parameter for creating/not creating
1848     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1849     #  the typical use is auto_groups=false.
1850     #  @ingroup l2_impexp
1851     def ExportSAUV(self, f, auto_groups=0):
1852         self.mesh.ExportSAUV(f, auto_groups)
1853
1854     ## Export the mesh in a file in DAT format
1855     #  @param f the file name
1856     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1857     #  @ingroup l2_impexp
1858     def ExportDAT(self, f, meshPart=None):
1859         if meshPart:
1860             unRegister = genObjUnRegister()
1861             if isinstance( meshPart, list ):
1862                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1863                 unRegister.set( meshPart )
1864             self.mesh.ExportPartToDAT( meshPart, f )
1865         else:
1866             self.mesh.ExportDAT(f)
1867
1868     ## Export the mesh in a file in UNV format
1869     #  @param f the file name
1870     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1871     #  @ingroup l2_impexp
1872     def ExportUNV(self, f, meshPart=None):
1873         if meshPart:
1874             unRegister = genObjUnRegister()
1875             if isinstance( meshPart, list ):
1876                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1877                 unRegister.set( meshPart )
1878             self.mesh.ExportPartToUNV( meshPart, f )
1879         else:
1880             self.mesh.ExportUNV(f)
1881
1882     ## Export the mesh in a file in STL format
1883     #  @param f the file name
1884     #  @param ascii defines the file encoding
1885     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1886     #  @ingroup l2_impexp
1887     def ExportSTL(self, f, ascii=1, meshPart=None):
1888         if meshPart:
1889             unRegister = genObjUnRegister()
1890             if isinstance( meshPart, list ):
1891                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1892                 unRegister.set( meshPart )
1893             self.mesh.ExportPartToSTL( meshPart, f, ascii )
1894         else:
1895             self.mesh.ExportSTL(f, ascii)
1896
1897     ## Export the mesh in a file in CGNS format
1898     #  @param f is the file name
1899     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1900     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1901     #  @param groupElemsByType if true all elements of same entity type are exported at ones,
1902     #         else elements are exported in order of their IDs which can cause creation
1903     #         of multiple cgns sections
1904     #  @ingroup l2_impexp
1905     def ExportCGNS(self, f, overwrite=1, meshPart=None, groupElemsByType=False):
1906         unRegister = genObjUnRegister()
1907         if isinstance( meshPart, list ):
1908             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1909             unRegister.set( meshPart )
1910         if isinstance( meshPart, Mesh ):
1911             meshPart = meshPart.mesh
1912         elif not meshPart:
1913             meshPart = self.mesh
1914         self.mesh.ExportCGNS(meshPart, f, overwrite, groupElemsByType)
1915
1916     ## Export the mesh in a file in GMF format.
1917     #  GMF files must have .mesh extension for the ASCII format and .meshb for
1918     #  the bynary format. Other extensions are not allowed.
1919     #  @param f is the file name
1920     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1921     #  @ingroup l2_impexp
1922     def ExportGMF(self, f, meshPart=None):
1923         unRegister = genObjUnRegister()
1924         if isinstance( meshPart, list ):
1925             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1926             unRegister.set( meshPart )
1927         if isinstance( meshPart, Mesh ):
1928             meshPart = meshPart.mesh
1929         elif not meshPart:
1930             meshPart = self.mesh
1931         self.mesh.ExportGMF(meshPart, f, True)
1932
1933     ## Deprecated, used only for compatibility! Please, use ExportMED() method instead.
1934     #  Export the mesh in a file in MED format
1935     #  allowing to overwrite the file if it exists or add the exported data to its contents
1936     #  @param f the file name
1937     #  @param version MED format version:
1938     #         - MED_V2_1 is obsolete.
1939     #         - MED_V2_2 means current version (kept for compatibility reasons)
1940     #         - MED_LATEST means current version.
1941     #         - MED_MINOR_x where x from 0 to 9 indicates the minor version of MED
1942     #           to use for writing MED files, for backward compatibility :
1943     #           for instance, with SALOME 8.4 use MED 3.2 (minor=2) instead of 3.3,
1944     #           to allow the file to be read with SALOME 8.3.
1945     #  @param opt boolean parameter for creating/not creating
1946     #         the groups Group_On_All_Nodes, Group_On_All_Faces, ...
1947     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1948     #  @param autoDimension if @c True (default), a space dimension of a MED mesh can be either
1949     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1950     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1951     #         - 3D in the rest cases.<br>
1952     #         If @a autoDimension is @c False, the space dimension is always 3.
1953     #  @ingroup l2_impexp
1954     def ExportToMED(self, f, version=MED_LATEST, opt=0, overwrite=1, autoDimension=True):
1955         self.mesh.ExportToMEDX(f, opt, version, overwrite, autoDimension)
1956
1957     # Operations with groups:
1958     # ----------------------
1959
1960     ## Create an empty mesh group
1961     #  @param elementType the type of elements in the group; either of 
1962     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
1963     #  @param name the name of the mesh group
1964     #  @return SMESH_Group
1965     #  @ingroup l2_grps_create
1966     def CreateEmptyGroup(self, elementType, name):
1967         return self.mesh.CreateGroup(elementType, name)
1968
1969     ## Create a mesh group based on the geometric object \a grp
1970     #  and gives a \a name, \n if this parameter is not defined
1971     #  the name is the same as the geometric group name \n
1972     #  Note: Works like GroupOnGeom().
1973     #  @param grp  a geometric group, a vertex, an edge, a face or a solid
1974     #  @param name the name of the mesh group
1975     #  @return SMESH_GroupOnGeom
1976     #  @ingroup l2_grps_create
1977     def Group(self, grp, name=""):
1978         return self.GroupOnGeom(grp, name)
1979
1980     ## Create a mesh group based on the geometrical object \a grp
1981     #  and gives a \a name, \n if this parameter is not defined
1982     #  the name is the same as the geometrical group name
1983     #  @param grp  a geometrical group, a vertex, an edge, a face or a solid
1984     #  @param name the name of the mesh group
1985     #  @param typ  the type of elements in the group; either of 
1986     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). If not set, it is
1987     #         automatically detected by the type of the geometry
1988     #  @return SMESH_GroupOnGeom
1989     #  @ingroup l2_grps_create
1990     def GroupOnGeom(self, grp, name="", typ=None):
1991         AssureGeomPublished( self, grp, name )
1992         if name == "":
1993             name = grp.GetName()
1994         if not typ:
1995             typ = self._groupTypeFromShape( grp )
1996         return self.mesh.CreateGroupFromGEOM(typ, name, grp)
1997
1998     ## Pivate method to get a type of group on geometry
1999     def _groupTypeFromShape( self, shape ):
2000         tgeo = str(shape.GetShapeType())
2001         if tgeo == "VERTEX":
2002             typ = NODE
2003         elif tgeo == "EDGE":
2004             typ = EDGE
2005         elif tgeo == "FACE" or tgeo == "SHELL":
2006             typ = FACE
2007         elif tgeo == "SOLID" or tgeo == "COMPSOLID":
2008             typ = VOLUME
2009         elif tgeo == "COMPOUND":
2010             sub = self.geompyD.SubShapeAll( shape, self.geompyD.ShapeType["SHAPE"])
2011             if not sub:
2012                 raise ValueError,"_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape)
2013             return self._groupTypeFromShape( sub[0] )
2014         else:
2015             raise ValueError, \
2016                   "_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape)
2017         return typ
2018
2019     ## Create a mesh group with given \a name based on the \a filter which
2020     ## is a special type of group dynamically updating it's contents during
2021     ## mesh modification
2022     #  @param typ  the type of elements in the group; either of 
2023     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
2024     #  @param name the name of the mesh group
2025     #  @param filter the filter defining group contents
2026     #  @return SMESH_GroupOnFilter
2027     #  @ingroup l2_grps_create
2028     def GroupOnFilter(self, typ, name, filter):
2029         return self.mesh.CreateGroupFromFilter(typ, name, filter)
2030
2031     ## Create a mesh group by the given ids of elements
2032     #  @param groupName the name of the mesh group
2033     #  @param elementType the type of elements in the group; either of 
2034     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
2035     #  @param elemIDs either the list of ids, group, sub-mesh, or filter
2036     #  @return SMESH_Group
2037     #  @ingroup l2_grps_create
2038     def MakeGroupByIds(self, groupName, elementType, elemIDs):
2039         group = self.mesh.CreateGroup(elementType, groupName)
2040         if isinstance( elemIDs, Mesh ):
2041             elemIDs = elemIDs.GetMesh()
2042         if hasattr( elemIDs, "GetIDs" ):
2043             if hasattr( elemIDs, "SetMesh" ):
2044                 elemIDs.SetMesh( self.GetMesh() )
2045             group.AddFrom( elemIDs )
2046         else:
2047             group.Add(elemIDs)
2048         return group
2049
2050     ## Create a mesh group by the given conditions
2051     #  @param groupName the name of the mesh group
2052     #  @param elementType the type of elements(SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
2053     #  @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.)
2054     #          Type SMESH.FunctorType._items in the Python Console to see all values.
2055     #          Note that the items starting from FT_LessThan are not suitable for CritType.
2056     #  @param Compare  belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo}
2057     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
2058     #  @param UnaryOp  SMESH.FT_LogicalNOT or SMESH.FT_Undefined
2059     #  @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface,
2060     #         SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces criteria
2061     #  @return SMESH_GroupOnFilter
2062     #  @ingroup l2_grps_create
2063     def MakeGroup(self,
2064                   groupName,
2065                   elementType,
2066                   CritType=FT_Undefined,
2067                   Compare=FT_EqualTo,
2068                   Threshold="",
2069                   UnaryOp=FT_Undefined,
2070                   Tolerance=1e-07):
2071         aCriterion = self.smeshpyD.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
2072         group = self.MakeGroupByCriterion(groupName, aCriterion)
2073         return group
2074
2075     ## Create a mesh group by the given criterion
2076     #  @param groupName the name of the mesh group
2077     #  @param Criterion the instance of Criterion class
2078     #  @return SMESH_GroupOnFilter
2079     #  @ingroup l2_grps_create
2080     def MakeGroupByCriterion(self, groupName, Criterion):
2081         return self.MakeGroupByCriteria( groupName, [Criterion] )
2082
2083     ## Create a mesh group by the given criteria (list of criteria)
2084     #  @param groupName the name of the mesh group
2085     #  @param theCriteria the list of criteria
2086     #  @param binOp binary operator used when binary operator of criteria is undefined
2087     #  @return SMESH_GroupOnFilter
2088     #  @ingroup l2_grps_create
2089     def MakeGroupByCriteria(self, groupName, theCriteria, binOp=SMESH.FT_LogicalAND):
2090         aFilter = self.smeshpyD.GetFilterFromCriteria( theCriteria, binOp )
2091         group = self.MakeGroupByFilter(groupName, aFilter)
2092         return group
2093
2094     ## Create a mesh group by the given filter
2095     #  @param groupName the name of the mesh group
2096     #  @param theFilter the instance of Filter class
2097     #  @return SMESH_GroupOnFilter
2098     #  @ingroup l2_grps_create
2099     def MakeGroupByFilter(self, groupName, theFilter):
2100         #group = self.CreateEmptyGroup(theFilter.GetElementType(), groupName)
2101         #theFilter.SetMesh( self.mesh )
2102         #group.AddFrom( theFilter )
2103         group = self.GroupOnFilter( theFilter.GetElementType(), groupName, theFilter )
2104         return group
2105
2106     ## Remove a group
2107     #  @ingroup l2_grps_delete
2108     def RemoveGroup(self, group):
2109         self.mesh.RemoveGroup(group)
2110
2111     ## Remove a group with its contents
2112     #  @ingroup l2_grps_delete
2113     def RemoveGroupWithContents(self, group):
2114         self.mesh.RemoveGroupWithContents(group)
2115
2116     ## Get the list of groups existing in the mesh in the order
2117     #  of creation (starting from the oldest one)
2118     #  @param elemType type of elements the groups contain; either of 
2119     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME);
2120     #         by default groups of elements of all types are returned
2121     #  @return a sequence of SMESH_GroupBase
2122     #  @ingroup l2_grps_create
2123     def GetGroups(self, elemType = SMESH.ALL):
2124         groups = self.mesh.GetGroups()
2125         if elemType == SMESH.ALL:
2126             return groups
2127         typedGroups = []
2128         for g in groups:
2129             if g.GetType() == elemType:
2130                 typedGroups.append( g )
2131                 pass
2132             pass
2133         return typedGroups
2134
2135     ## Get the number of groups existing in the mesh
2136     #  @return the quantity of groups as an integer value
2137     #  @ingroup l2_grps_create
2138     def NbGroups(self):
2139         return self.mesh.NbGroups()
2140
2141     ## Get the list of names of groups existing in the mesh
2142     #  @return list of strings
2143     #  @ingroup l2_grps_create
2144     def GetGroupNames(self):
2145         groups = self.GetGroups()
2146         names = []
2147         for group in groups:
2148             names.append(group.GetName())
2149         return names
2150
2151     ## Find groups by name and type
2152     #  @param name name of the group of interest
2153     #  @param elemType type of elements the groups contain; either of 
2154     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME);
2155     #         by default one group of any type of elements is returned
2156     #         if elemType == SMESH.ALL then all groups of any type are returned
2157     #  @return a list of SMESH_GroupBase's
2158     #  @ingroup l2_grps_create
2159     def GetGroupByName(self, name, elemType = None):
2160         groups = []
2161         for group in self.GetGroups():
2162             if group.GetName() == name:
2163                 if elemType is None:
2164                     return [group]
2165                 if ( elemType == SMESH.ALL or 
2166                      group.GetType() == elemType ):
2167                     groups.append( group )
2168         return groups
2169
2170     ## Produce a union of two groups.
2171     #  A new group is created. All mesh elements that are
2172     #  present in the initial groups are added to the new one
2173     #  @return an instance of SMESH_Group
2174     #  @ingroup l2_grps_operon
2175     def UnionGroups(self, group1, group2, name):
2176         return self.mesh.UnionGroups(group1, group2, name)
2177
2178     ## Produce a union list of groups.
2179     #  New group is created. All mesh elements that are present in
2180     #  initial groups are added to the new one
2181     #  @return an instance of SMESH_Group
2182     #  @ingroup l2_grps_operon
2183     def UnionListOfGroups(self, groups, name):
2184       return self.mesh.UnionListOfGroups(groups, name)
2185
2186     ## Prodice an intersection of two groups.
2187     #  A new group is created. All mesh elements that are common
2188     #  for the two initial groups are added to the new one.
2189     #  @return an instance of SMESH_Group
2190     #  @ingroup l2_grps_operon
2191     def IntersectGroups(self, group1, group2, name):
2192         return self.mesh.IntersectGroups(group1, group2, name)
2193
2194     ## Produce an intersection of groups.
2195     #  New group is created. All mesh elements that are present in all
2196     #  initial groups simultaneously are added to the new one
2197     #  @return an instance of SMESH_Group
2198     #  @ingroup l2_grps_operon
2199     def IntersectListOfGroups(self, groups, name):
2200       return self.mesh.IntersectListOfGroups(groups, name)
2201
2202     ## Produce a cut of two groups.
2203     #  A new group is created. All mesh elements that are present in
2204     #  the main group but are not present in the tool group are added to the new one
2205     #  @return an instance of SMESH_Group
2206     #  @ingroup l2_grps_operon
2207     def CutGroups(self, main_group, tool_group, name):
2208         return self.mesh.CutGroups(main_group, tool_group, name)
2209
2210     ## Produce a cut of groups.
2211     #  A new group is created. All mesh elements that are present in main groups
2212     #  but do not present in tool groups are added to the new one
2213     #  @return an instance of SMESH_Group
2214     #  @ingroup l2_grps_operon
2215     def CutListOfGroups(self, main_groups, tool_groups, name):
2216         return self.mesh.CutListOfGroups(main_groups, tool_groups, name)
2217
2218     ##
2219     #  Create a standalone group of entities basing on nodes of other groups.
2220     #  \param groups - list of reference groups, sub-meshes or filters, of any type.
2221     #  \param elemType - a type of elements to include to the new group; either of 
2222     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
2223     #  \param name - a name of the new group.
2224     #  \param nbCommonNodes - a criterion of inclusion of an element to the new group
2225     #         basing on number of element nodes common with reference \a groups.
2226     #         Meaning of possible values are:
2227     #         - SMESH.ALL_NODES - include if all nodes are common,
2228     #         - SMESH.MAIN - include if all corner nodes are common (meaningful for a quadratic mesh),
2229     #         - SMESH.AT_LEAST_ONE - include if one or more node is common,
2230     #         - SMEHS.MAJORITY - include if half of nodes or more are common.
2231     #  \param underlyingOnly - if \c True (default), an element is included to the
2232     #         new group provided that it is based on nodes of an element of \a groups;
2233     #         in this case the reference \a groups are supposed to be of higher dimension
2234     #         than \a elemType, which can be useful for example to get all faces lying on
2235     #         volumes of the reference \a groups.
2236     #  @return an instance of SMESH_Group
2237     #  @ingroup l2_grps_operon
2238     def CreateDimGroup(self, groups, elemType, name,
2239                        nbCommonNodes = SMESH.ALL_NODES, underlyingOnly = True):
2240         if isinstance( groups, SMESH._objref_SMESH_IDSource ):
2241             groups = [groups]
2242         return self.mesh.CreateDimGroup(groups, elemType, name, nbCommonNodes, underlyingOnly)
2243
2244
2245     ## Convert group on geom into standalone group
2246     #  @ingroup l2_grps_operon
2247     def ConvertToStandalone(self, group):
2248         return self.mesh.ConvertToStandalone(group)
2249
2250     # Get some info about mesh:
2251     # ------------------------
2252
2253     ## Return the log of nodes and elements added or removed
2254     #  since the previous clear of the log.
2255     #  @param clearAfterGet log is emptied after Get (safe if concurrents access)
2256     #  @return list of log_block structures:
2257     #                                        commandType
2258     #                                        number
2259     #                                        coords
2260     #                                        indexes
2261     #  @ingroup l1_auxiliary
2262     def GetLog(self, clearAfterGet):
2263         return self.mesh.GetLog(clearAfterGet)
2264
2265     ## Clear the log of nodes and elements added or removed since the previous
2266     #  clear. Must be used immediately after GetLog if clearAfterGet is false.
2267     #  @ingroup l1_auxiliary
2268     def ClearLog(self):
2269         self.mesh.ClearLog()
2270
2271     ## Toggle auto color mode on the object.
2272     #  @param theAutoColor the flag which toggles auto color mode.
2273     #
2274     #  If switched on, a default color of a new group in Create Group dialog is chosen randomly.
2275     #  @ingroup l1_grouping
2276     def SetAutoColor(self, theAutoColor):
2277         self.mesh.SetAutoColor(theAutoColor)
2278
2279     ## Get flag of object auto color mode.
2280     #  @return True or False
2281     #  @ingroup l1_grouping
2282     def GetAutoColor(self):
2283         return self.mesh.GetAutoColor()
2284
2285     ## Get the internal ID
2286     #  @return integer value, which is the internal Id of the mesh
2287     #  @ingroup l1_auxiliary
2288     def GetId(self):
2289         return self.mesh.GetId()
2290
2291     ## Get the study Id
2292     #  @return integer value, which is the study Id of the mesh
2293     #  @ingroup l1_auxiliary
2294     def GetStudyId(self):
2295         return self.mesh.GetStudyId()
2296
2297     ## Check the group names for duplications.
2298     #  Consider the maximum group name length stored in MED file.
2299     #  @return True or False
2300     #  @ingroup l1_grouping
2301     def HasDuplicatedGroupNamesMED(self):
2302         return self.mesh.HasDuplicatedGroupNamesMED()
2303
2304     ## Obtain the mesh editor tool
2305     #  @return an instance of SMESH_MeshEditor
2306     #  @ingroup l1_modifying
2307     def GetMeshEditor(self):
2308         return self.editor
2309
2310     ## Wrap a list of IDs of elements or nodes into SMESH_IDSource which
2311     #  can be passed as argument to a method accepting mesh, group or sub-mesh
2312     #  @param ids list of IDs
2313     #  @param elemType type of elements; this parameter is used to distinguish
2314     #         IDs of nodes from IDs of elements; by default ids are treated as
2315     #         IDs of elements; use SMESH.NODE if ids are IDs of nodes.
2316     #  @return an instance of SMESH_IDSource
2317     #  @warning call UnRegister() for the returned object as soon as it is no more useful:
2318     #          idSrc = mesh.GetIDSource( [1,3,5], SMESH.NODE )
2319     #          mesh.DoSomething( idSrc )
2320     #          idSrc.UnRegister()
2321     #  @ingroup l1_auxiliary
2322     def GetIDSource(self, ids, elemType = SMESH.ALL):
2323         if isinstance( ids, int ):
2324             ids = [ids]
2325         return self.editor.MakeIDSource(ids, elemType)
2326
2327
2328     # Get information about mesh contents:
2329     # ------------------------------------
2330
2331     ## Get the mesh statistic
2332     #  @return dictionary type element - count of elements
2333     #  @ingroup l1_meshinfo
2334     def GetMeshInfo(self, obj = None):
2335         if not obj: obj = self.mesh
2336         return self.smeshpyD.GetMeshInfo(obj)
2337
2338     ## Return the number of nodes in the mesh
2339     #  @return an integer value
2340     #  @ingroup l1_meshinfo
2341     def NbNodes(self):
2342         return self.mesh.NbNodes()
2343
2344     ## Return the number of elements in the mesh
2345     #  @return an integer value
2346     #  @ingroup l1_meshinfo
2347     def NbElements(self):
2348         return self.mesh.NbElements()
2349
2350     ## Return the number of 0d elements in the mesh
2351     #  @return an integer value
2352     #  @ingroup l1_meshinfo
2353     def Nb0DElements(self):
2354         return self.mesh.Nb0DElements()
2355
2356     ## Return the number of ball discrete elements in the mesh
2357     #  @return an integer value
2358     #  @ingroup l1_meshinfo
2359     def NbBalls(self):
2360         return self.mesh.NbBalls()
2361
2362     ## Return the number of edges in the mesh
2363     #  @return an integer value
2364     #  @ingroup l1_meshinfo
2365     def NbEdges(self):
2366         return self.mesh.NbEdges()
2367
2368     ## Return the number of edges with the given order in the mesh
2369     #  @param elementOrder the order of elements:
2370     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2371     #  @return an integer value
2372     #  @ingroup l1_meshinfo
2373     def NbEdgesOfOrder(self, elementOrder):
2374         return self.mesh.NbEdgesOfOrder(elementOrder)
2375
2376     ## Return the number of faces in the mesh
2377     #  @return an integer value
2378     #  @ingroup l1_meshinfo
2379     def NbFaces(self):
2380         return self.mesh.NbFaces()
2381
2382     ## Return the number of faces with the given order in the mesh
2383     #  @param elementOrder the order of elements:
2384     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2385     #  @return an integer value
2386     #  @ingroup l1_meshinfo
2387     def NbFacesOfOrder(self, elementOrder):
2388         return self.mesh.NbFacesOfOrder(elementOrder)
2389
2390     ## Return the number of triangles in the mesh
2391     #  @return an integer value
2392     #  @ingroup l1_meshinfo
2393     def NbTriangles(self):
2394         return self.mesh.NbTriangles()
2395
2396     ## Return the number of triangles with the given order in the mesh
2397     #  @param elementOrder is the order of elements:
2398     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2399     #  @return an integer value
2400     #  @ingroup l1_meshinfo
2401     def NbTrianglesOfOrder(self, elementOrder):
2402         return self.mesh.NbTrianglesOfOrder(elementOrder)
2403
2404     ## Return the number of biquadratic triangles in the mesh
2405     #  @return an integer value
2406     #  @ingroup l1_meshinfo
2407     def NbBiQuadTriangles(self):
2408         return self.mesh.NbBiQuadTriangles()
2409
2410     ## Return the number of quadrangles in the mesh
2411     #  @return an integer value
2412     #  @ingroup l1_meshinfo
2413     def NbQuadrangles(self):
2414         return self.mesh.NbQuadrangles()
2415
2416     ## Return the number of quadrangles with the given order in the mesh
2417     #  @param elementOrder the order of elements:
2418     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2419     #  @return an integer value
2420     #  @ingroup l1_meshinfo
2421     def NbQuadranglesOfOrder(self, elementOrder):
2422         return self.mesh.NbQuadranglesOfOrder(elementOrder)
2423
2424     ## Return the number of biquadratic quadrangles in the mesh
2425     #  @return an integer value
2426     #  @ingroup l1_meshinfo
2427     def NbBiQuadQuadrangles(self):
2428         return self.mesh.NbBiQuadQuadrangles()
2429
2430     ## Return the number of polygons of given order in the mesh
2431     #  @param elementOrder the order of elements:
2432     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2433     #  @return an integer value
2434     #  @ingroup l1_meshinfo
2435     def NbPolygons(self, elementOrder = SMESH.ORDER_ANY):
2436         return self.mesh.NbPolygonsOfOrder(elementOrder)
2437
2438     ## Return the number of volumes in the mesh
2439     #  @return an integer value
2440     #  @ingroup l1_meshinfo
2441     def NbVolumes(self):
2442         return self.mesh.NbVolumes()
2443
2444     ## Return the number of volumes with the given order in the mesh
2445     #  @param elementOrder  the order of elements:
2446     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2447     #  @return an integer value
2448     #  @ingroup l1_meshinfo
2449     def NbVolumesOfOrder(self, elementOrder):
2450         return self.mesh.NbVolumesOfOrder(elementOrder)
2451
2452     ## Return the number of tetrahedrons in the mesh
2453     #  @return an integer value
2454     #  @ingroup l1_meshinfo
2455     def NbTetras(self):
2456         return self.mesh.NbTetras()
2457
2458     ## Return the number of tetrahedrons with the given order in the mesh
2459     #  @param elementOrder  the order of elements:
2460     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2461     #  @return an integer value
2462     #  @ingroup l1_meshinfo
2463     def NbTetrasOfOrder(self, elementOrder):
2464         return self.mesh.NbTetrasOfOrder(elementOrder)
2465
2466     ## Return the number of hexahedrons in the mesh
2467     #  @return an integer value
2468     #  @ingroup l1_meshinfo
2469     def NbHexas(self):
2470         return self.mesh.NbHexas()
2471
2472     ## Return the number of hexahedrons with the given order in the mesh
2473     #  @param elementOrder  the order of elements:
2474     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2475     #  @return an integer value
2476     #  @ingroup l1_meshinfo
2477     def NbHexasOfOrder(self, elementOrder):
2478         return self.mesh.NbHexasOfOrder(elementOrder)
2479
2480     ## Return the number of triquadratic hexahedrons in the mesh
2481     #  @return an integer value
2482     #  @ingroup l1_meshinfo
2483     def NbTriQuadraticHexas(self):
2484         return self.mesh.NbTriQuadraticHexas()
2485
2486     ## Return the number of pyramids in the mesh
2487     #  @return an integer value
2488     #  @ingroup l1_meshinfo
2489     def NbPyramids(self):
2490         return self.mesh.NbPyramids()
2491
2492     ## Return the number of pyramids with the given order in the mesh
2493     #  @param elementOrder  the order of elements:
2494     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2495     #  @return an integer value
2496     #  @ingroup l1_meshinfo
2497     def NbPyramidsOfOrder(self, elementOrder):
2498         return self.mesh.NbPyramidsOfOrder(elementOrder)
2499
2500     ## Return the number of prisms in the mesh
2501     #  @return an integer value
2502     #  @ingroup l1_meshinfo
2503     def NbPrisms(self):
2504         return self.mesh.NbPrisms()
2505
2506     ## Return the number of prisms with the given order in the mesh
2507     #  @param elementOrder  the order of elements:
2508     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2509     #  @return an integer value
2510     #  @ingroup l1_meshinfo
2511     def NbPrismsOfOrder(self, elementOrder):
2512         return self.mesh.NbPrismsOfOrder(elementOrder)
2513
2514     ## Return the number of hexagonal prisms in the mesh
2515     #  @return an integer value
2516     #  @ingroup l1_meshinfo
2517     def NbHexagonalPrisms(self):
2518         return self.mesh.NbHexagonalPrisms()
2519
2520     ## Return the number of polyhedrons in the mesh
2521     #  @return an integer value
2522     #  @ingroup l1_meshinfo
2523     def NbPolyhedrons(self):
2524         return self.mesh.NbPolyhedrons()
2525
2526     ## Return the number of submeshes in the mesh
2527     #  @return an integer value
2528     #  @ingroup l1_meshinfo
2529     def NbSubMesh(self):
2530         return self.mesh.NbSubMesh()
2531
2532     ## Return the list of mesh elements IDs
2533     #  @return the list of integer values
2534     #  @ingroup l1_meshinfo
2535     def GetElementsId(self):
2536         return self.mesh.GetElementsId()
2537
2538     ## Return the list of IDs of mesh elements with the given type
2539     #  @param elementType  the required type of elements, either of
2540     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2541     #  @return list of integer values
2542     #  @ingroup l1_meshinfo
2543     def GetElementsByType(self, elementType):
2544         return self.mesh.GetElementsByType(elementType)
2545
2546     ## Return the list of mesh nodes IDs
2547     #  @return the list of integer values
2548     #  @ingroup l1_meshinfo
2549     def GetNodesId(self):
2550         return self.mesh.GetNodesId()
2551
2552     # Get the information about mesh elements:
2553     # ------------------------------------
2554
2555     ## Return the type of mesh element
2556     #  @return the value from SMESH::ElementType enumeration
2557     #          Type SMESH.ElementType._items in the Python Console to see all possible values.
2558     #  @ingroup l1_meshinfo
2559     def GetElementType(self, id, iselem=True):
2560         return self.mesh.GetElementType(id, iselem)
2561
2562     ## Return the geometric type of mesh element
2563     #  @return the value from SMESH::EntityType enumeration
2564     #          Type SMESH.EntityType._items in the Python Console to see all possible values.
2565     #  @ingroup l1_meshinfo
2566     def GetElementGeomType(self, id):
2567         return self.mesh.GetElementGeomType(id)
2568
2569     ## Return the shape type of mesh element
2570     #  @return the value from SMESH::GeometryType enumeration.
2571     #          Type SMESH.GeometryType._items in the Python Console to see all possible values.
2572     #  @ingroup l1_meshinfo
2573     def GetElementShape(self, id):
2574         return self.mesh.GetElementShape(id)
2575
2576     ## Return the list of submesh elements IDs
2577     #  @param Shape a geom object(sub-shape)
2578     #         Shape must be the sub-shape of a ShapeToMesh()
2579     #  @return the list of integer values
2580     #  @ingroup l1_meshinfo
2581     def GetSubMeshElementsId(self, Shape):
2582         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2583             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2584         else:
2585             ShapeID = Shape
2586         return self.mesh.GetSubMeshElementsId(ShapeID)
2587
2588     ## Return the list of submesh nodes IDs
2589     #  @param Shape a geom object(sub-shape)
2590     #         Shape must be the sub-shape of a ShapeToMesh()
2591     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
2592     #  @return the list of integer values
2593     #  @ingroup l1_meshinfo
2594     def GetSubMeshNodesId(self, Shape, all):
2595         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2596             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2597         else:
2598             ShapeID = Shape
2599         return self.mesh.GetSubMeshNodesId(ShapeID, all)
2600
2601     ## Return type of elements on given shape
2602     #  @param Shape a geom object(sub-shape)
2603     #         Shape must be a sub-shape of a ShapeToMesh()
2604     #  @return element type
2605     #  @ingroup l1_meshinfo
2606     def GetSubMeshElementType(self, Shape):
2607         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2608             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2609         else:
2610             ShapeID = Shape
2611         return self.mesh.GetSubMeshElementType(ShapeID)
2612
2613     ## Get the mesh description
2614     #  @return string value
2615     #  @ingroup l1_meshinfo
2616     def Dump(self):
2617         return self.mesh.Dump()
2618
2619
2620     # Get the information about nodes and elements of a mesh by its IDs:
2621     # -----------------------------------------------------------
2622
2623     ## Get XYZ coordinates of a node
2624     #  \n If there is no nodes for the given ID - return an empty list
2625     #  @return a list of double precision values
2626     #  @ingroup l1_meshinfo
2627     def GetNodeXYZ(self, id):
2628         return self.mesh.GetNodeXYZ(id)
2629
2630     ## Return list of IDs of inverse elements for the given node
2631     #  \n If there is no node for the given ID - return an empty list
2632     #  @return a list of integer values
2633     #  @ingroup l1_meshinfo
2634     def GetNodeInverseElements(self, id):
2635         return self.mesh.GetNodeInverseElements(id)
2636
2637     ## Return the position of a node on the shape
2638     #  @return SMESH::NodePosition
2639     #  @ingroup l1_meshinfo
2640     def GetNodePosition(self,NodeID):
2641         return self.mesh.GetNodePosition(NodeID)
2642
2643     ## Return the position of an element on the shape
2644     #  @return SMESH::ElementPosition
2645     #  @ingroup l1_meshinfo
2646     def GetElementPosition(self,ElemID):
2647         return self.mesh.GetElementPosition(ElemID)
2648
2649     ## Return the ID of the shape, on which the given node was generated.
2650     #  @return an integer value > 0 or -1 if there is no node for the given
2651     #          ID or the node is not assigned to any geometry
2652     #  @ingroup l1_meshinfo
2653     def GetShapeID(self, id):
2654         return self.mesh.GetShapeID(id)
2655
2656     ## Return the ID of the shape, on which the given element was generated.
2657     #  @return an integer value > 0 or -1 if there is no element for the given
2658     #          ID or the element is not assigned to any geometry
2659     #  @ingroup l1_meshinfo
2660     def GetShapeIDForElem(self,id):
2661         return self.mesh.GetShapeIDForElem(id)
2662
2663     ## Return the number of nodes of the given element
2664     #  @return an integer value > 0 or -1 if there is no element for the given ID
2665     #  @ingroup l1_meshinfo
2666     def GetElemNbNodes(self, id):
2667         return self.mesh.GetElemNbNodes(id)
2668
2669     ## Return the node ID the given (zero based) index for the given element
2670     #  \n If there is no element for the given ID - return -1
2671     #  \n If there is no node for the given index - return -2
2672     #  @return an integer value
2673     #  @ingroup l1_meshinfo
2674     def GetElemNode(self, id, index):
2675         return self.mesh.GetElemNode(id, index)
2676
2677     ## Return the IDs of nodes of the given element
2678     #  @return a list of integer values
2679     #  @ingroup l1_meshinfo
2680     def GetElemNodes(self, id):
2681         return self.mesh.GetElemNodes(id)
2682
2683     ## Return true if the given node is the medium node in the given quadratic element
2684     #  @ingroup l1_meshinfo
2685     def IsMediumNode(self, elementID, nodeID):
2686         return self.mesh.IsMediumNode(elementID, nodeID)
2687
2688     ## Return true if the given node is the medium node in one of quadratic elements
2689     #  @param nodeID ID of the node
2690     #  @param elementType  the type of elements to check a state of the node, either of
2691     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2692     #  @ingroup l1_meshinfo
2693     def IsMediumNodeOfAnyElem(self, nodeID, elementType = SMESH.ALL ):
2694         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2695
2696     ## Return the number of edges for the given element
2697     #  @ingroup l1_meshinfo
2698     def ElemNbEdges(self, id):
2699         return self.mesh.ElemNbEdges(id)
2700
2701     ## Return the number of faces for the given element
2702     #  @ingroup l1_meshinfo
2703     def ElemNbFaces(self, id):
2704         return self.mesh.ElemNbFaces(id)
2705
2706     ## Return nodes of given face (counted from zero) for given volumic element.
2707     #  @ingroup l1_meshinfo
2708     def GetElemFaceNodes(self,elemId, faceIndex):
2709         return self.mesh.GetElemFaceNodes(elemId, faceIndex)
2710
2711     ## Return three components of normal of given mesh face
2712     #  (or an empty array in KO case)
2713     #  @ingroup l1_meshinfo
2714     def GetFaceNormal(self, faceId, normalized=False):
2715         return self.mesh.GetFaceNormal(faceId,normalized)
2716
2717     ## Return an element based on all given nodes.
2718     #  @ingroup l1_meshinfo
2719     def FindElementByNodes(self, nodes):
2720         return self.mesh.FindElementByNodes(nodes)
2721
2722     ## Return elements including all given nodes.
2723     #  @ingroup l1_meshinfo
2724     def GetElementsByNodes(self, nodes, elemType=SMESH.ALL):
2725         return self.mesh.GetElementsByNodes( nodes, elemType )
2726
2727     ## Return true if the given element is a polygon
2728     #  @ingroup l1_meshinfo
2729     def IsPoly(self, id):
2730         return self.mesh.IsPoly(id)
2731
2732     ## Return true if the given element is quadratic
2733     #  @ingroup l1_meshinfo
2734     def IsQuadratic(self, id):
2735         return self.mesh.IsQuadratic(id)
2736
2737     ## Return diameter of a ball discrete element or zero in case of an invalid \a id
2738     #  @ingroup l1_meshinfo
2739     def GetBallDiameter(self, id):
2740         return self.mesh.GetBallDiameter(id)
2741
2742     ## Return XYZ coordinates of the barycenter of the given element
2743     #  \n If there is no element for the given ID - return an empty list
2744     #  @return a list of three double values
2745     #  @ingroup l1_meshinfo
2746     def BaryCenter(self, id):
2747         return self.mesh.BaryCenter(id)
2748
2749     ## Pass mesh elements through the given filter and return IDs of fitting elements
2750     #  @param theFilter SMESH_Filter
2751     #  @return a list of ids
2752     #  @ingroup l1_controls
2753     def GetIdsFromFilter(self, theFilter):
2754         theFilter.SetMesh( self.mesh )
2755         return theFilter.GetIDs()
2756
2757     # Get mesh measurements information:
2758     # ------------------------------------
2759
2760     ## Verify whether a 2D mesh element has free edges (edges connected to one face only)\n
2761     #  Return a list of special structures (borders).
2762     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
2763     #  @ingroup l1_measurements
2764     def GetFreeBorders(self):
2765         aFilterMgr = self.smeshpyD.CreateFilterManager()
2766         aPredicate = aFilterMgr.CreateFreeEdges()
2767         aPredicate.SetMesh(self.mesh)
2768         aBorders = aPredicate.GetBorders()
2769         aFilterMgr.UnRegister()
2770         return aBorders
2771
2772     ## Get minimum distance between two nodes, elements or distance to the origin
2773     #  @param id1 first node/element id
2774     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2775     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2776     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2777     #  @return minimum distance value
2778     #  @sa GetMinDistance()
2779     #  @ingroup l1_measurements
2780     def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2781         aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2)
2782         return aMeasure.value
2783
2784     ## Get measure structure specifying minimum distance data between two objects
2785     #  @param id1 first node/element id
2786     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2787     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2788     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2789     #  @return Measure structure
2790     #  @sa MinDistance()
2791     #  @ingroup l1_measurements
2792     def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2793         if isElem1:
2794             id1 = self.editor.MakeIDSource([id1], SMESH.FACE)
2795         else:
2796             id1 = self.editor.MakeIDSource([id1], SMESH.NODE)
2797         if id2 != 0:
2798             if isElem2:
2799                 id2 = self.editor.MakeIDSource([id2], SMESH.FACE)
2800             else:
2801                 id2 = self.editor.MakeIDSource([id2], SMESH.NODE)
2802             pass
2803         else:
2804             id2 = None
2805
2806         aMeasurements = self.smeshpyD.CreateMeasurements()
2807         aMeasure = aMeasurements.MinDistance(id1, id2)
2808         genObjUnRegister([aMeasurements,id1, id2])
2809         return aMeasure
2810
2811     ## Get bounding box of the specified object(s)
2812     #  @param objects single source object or list of source objects or list of nodes/elements IDs
2813     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2814     #  @c False specifies that @a objects are nodes
2815     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
2816     #  @sa GetBoundingBox()
2817     #  @ingroup l1_measurements
2818     def BoundingBox(self, objects=None, isElem=False):
2819         result = self.GetBoundingBox(objects, isElem)
2820         if result is None:
2821             result = (0.0,)*6
2822         else:
2823             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
2824         return result
2825
2826     ## Get measure structure specifying bounding box data of the specified object(s)
2827     #  @param IDs single source object or list of source objects or list of nodes/elements IDs
2828     #  @param isElem if @a IDs is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2829     #  @c False specifies that @a objects are nodes
2830     #  @return Measure structure
2831     #  @sa BoundingBox()
2832     #  @ingroup l1_measurements
2833     def GetBoundingBox(self, IDs=None, isElem=False):
2834         if IDs is None:
2835             IDs = [self.mesh]
2836         elif isinstance(IDs, tuple):
2837             IDs = list(IDs)
2838         if not isinstance(IDs, list):
2839             IDs = [IDs]
2840         if len(IDs) > 0 and isinstance(IDs[0], int):
2841             IDs = [IDs]
2842         srclist = []
2843         unRegister = genObjUnRegister()
2844         for o in IDs:
2845             if isinstance(o, Mesh):
2846                 srclist.append(o.mesh)
2847             elif hasattr(o, "_narrow"):
2848                 src = o._narrow(SMESH.SMESH_IDSource)
2849                 if src: srclist.append(src)
2850                 pass
2851             elif isinstance(o, list):
2852                 if isElem:
2853                     srclist.append(self.editor.MakeIDSource(o, SMESH.FACE))
2854                 else:
2855                     srclist.append(self.editor.MakeIDSource(o, SMESH.NODE))
2856                 unRegister.set( srclist[-1] )
2857                 pass
2858             pass
2859         aMeasurements = self.smeshpyD.CreateMeasurements()
2860         unRegister.set( aMeasurements )
2861         aMeasure = aMeasurements.BoundingBox(srclist)
2862         return aMeasure
2863
2864     # Mesh edition (SMESH_MeshEditor functionality):
2865     # ---------------------------------------------
2866
2867     ## Remove the elements from the mesh by ids
2868     #  @param IDsOfElements is a list of ids of elements to remove
2869     #  @return True or False
2870     #  @ingroup l2_modif_del
2871     def RemoveElements(self, IDsOfElements):
2872         return self.editor.RemoveElements(IDsOfElements)
2873
2874     ## Remove nodes from mesh by ids
2875     #  @param IDsOfNodes is a list of ids of nodes to remove
2876     #  @return True or False
2877     #  @ingroup l2_modif_del
2878     def RemoveNodes(self, IDsOfNodes):
2879         return self.editor.RemoveNodes(IDsOfNodes)
2880
2881     ## Remove all orphan (free) nodes from mesh
2882     #  @return number of the removed nodes
2883     #  @ingroup l2_modif_del
2884     def RemoveOrphanNodes(self):
2885         return self.editor.RemoveOrphanNodes()
2886
2887     ## Add a node to the mesh by coordinates
2888     #  @return Id of the new node
2889     #  @ingroup l2_modif_add
2890     def AddNode(self, x, y, z):
2891         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2892