Salome HOME
Merge tag 'V8_3_0a2' into ngr/python3_dev
[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 import collections
94
95 ## Private class used to workaround a problem that sometimes isinstance(m, Mesh) returns False
96 #
97 class MeshMeta(type):
98     def __instancecheck__(cls, inst):
99         """Implement isinstance(inst, cls)."""
100         return any(cls.__subclasscheck__(c)
101                    for c in {type(inst), inst.__class__})
102
103     def __subclasscheck__(cls, sub):
104         """Implement issubclass(sub, cls)."""
105         return type.__subclasscheck__(cls, sub) or (cls.__name__ == sub.__name__ and cls.__module__ == sub.__module__)
106
107 ## @addtogroup l1_auxiliary
108 ## @{
109
110 ## Convert an angle from degrees to radians
111 def DegreesToRadians(AngleInDegrees):
112     from math import pi
113     return AngleInDegrees * pi / 180.0
114
115 import salome_notebook
116 notebook = salome_notebook.notebook
117 # Salome notebook variable separator
118 var_separator = ":"
119
120 ## Return list of variable values from salome notebook.
121 #  The last argument, if is callable, is used to modify values got from notebook
122 def ParseParameters(*args):
123     Result = []
124     Parameters = ""
125     hasVariables = False
126     varModifFun=None
127     if args and isinstance( args[-1], collections.Callable):
128         args, varModifFun = args[:-1], args[-1]
129     for parameter in args:
130
131         Parameters += str(parameter) + var_separator
132
133         if isinstance(parameter,str):
134             # check if there is an inexistent variable name
135             if not notebook.isVariable(parameter):
136                 raise ValueError("Variable with name '" + parameter + "' doesn't exist!!!")
137             parameter = notebook.get(parameter)
138             hasVariables = True
139             if varModifFun:
140                 parameter = varModifFun(parameter)
141                 pass
142             pass
143         Result.append(parameter)
144
145         pass
146     Parameters = Parameters[:-1]
147     Result.append( Parameters )
148     Result.append( hasVariables )
149     return Result
150
151 ## Parse parameters while converting variables to radians
152 def ParseAngles(*args):
153     return ParseParameters( *( args + (DegreesToRadians, )))
154
155 ## Substitute PointStruct.__init__() to create SMESH.PointStruct using notebook variables.
156 #  Parameters are stored in PointStruct.parameters attribute
157 def __initPointStruct(point,*args):
158     point.x, point.y, point.z, point.parameters,hasVars = ParseParameters(*args)
159     pass
160 SMESH.PointStruct.__init__ = __initPointStruct
161
162 ## Substitute AxisStruct.__init__() to create SMESH.AxisStruct using notebook variables.
163 #  Parameters are stored in AxisStruct.parameters attribute
164 def __initAxisStruct(ax,*args):
165     if len( args ) != 6:
166         raise RuntimeError("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(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] = list(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, *args):
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, *args):
374         global created
375         #print "--------------- smeshbuilder __init__ ---", created
376         if not created:
377             created = True
378             SMESH._objref_SMESH_Gen.__init__(self, *args)
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("The Threshold should be an ID of mesh face and not '%s'"%aThreshold)
789         elif CritType == FT_ConnectedElements:
790             # Check the Threshold
791             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): # shape
792                 aCriterion.ThresholdID = aThreshold.GetStudyEntry()
793                 if not aCriterion.ThresholdID:
794                     name = aThreshold.GetName()
795                     if not name:
796                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
797                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
798             elif isinstance(aThreshold, int): # node id
799                 aCriterion.Threshold = aThreshold
800             elif isinstance(aThreshold, list): # 3 point coordinates
801                 if len( aThreshold ) < 3:
802                     raise ValueError("too few point coordinates, must be 3")
803                 aCriterion.ThresholdStr = " ".join( [str(c) for c in aThreshold[:3]] )
804             elif isinstance(aThreshold, str):
805                 if aThreshold.isdigit():
806                     aCriterion.Threshold = aThreshold # node id
807                 else:
808                     aCriterion.ThresholdStr = aThreshold # hope that it's point coordinates
809             else:
810                 raise TypeError("The Threshold should either a VERTEX, or a node ID, "\
811                       "or a list of point coordinates and not '%s'"%aThreshold)
812         elif CritType == FT_ElemGeomType:
813             # Check the Threshold
814             try:
815                 aCriterion.Threshold = self.EnumToLong(aThreshold)
816                 assert( aThreshold in SMESH.GeometryType._items )
817             except:
818                 if isinstance(aThreshold, int):
819                     aCriterion.Threshold = aThreshold
820                 else:
821                     raise TypeError("The Threshold should be an integer or SMESH.GeometryType.")
822                 pass
823             pass
824         elif CritType == FT_EntityType:
825             # Check the Threshold
826             try:
827                 aCriterion.Threshold = self.EnumToLong(aThreshold)
828                 assert( aThreshold in SMESH.EntityType._items )
829             except:
830                 if isinstance(aThreshold, int):
831                     aCriterion.Threshold = aThreshold
832                 else:
833                     raise TypeError("The Threshold should be an integer or SMESH.EntityType.")
834                 pass
835             pass
836
837         elif CritType == FT_GroupColor:
838             # Check the Threshold
839             try:
840                 aCriterion.ThresholdStr = self.ColorToString(aThreshold)
841             except:
842                 raise TypeError("The threshold value should be of SALOMEDS.Color type")
843             pass
844         elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_FreeNodes, FT_FreeFaces,
845                           FT_LinearOrQuadratic, FT_BadOrientedVolume,
846                           FT_BareBorderFace, FT_BareBorderVolume,
847                           FT_OverConstrainedFace, FT_OverConstrainedVolume,
848                           FT_EqualNodes,FT_EqualEdges,FT_EqualFaces,FT_EqualVolumes ]:
849             # At this point the Threshold is unnecessary
850             if aThreshold ==  FT_LogicalNOT:
851                 aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
852             elif aThreshold in [FT_LogicalAND, FT_LogicalOR]:
853                 aCriterion.BinaryOp = aThreshold
854         else:
855             # Check Threshold
856             try:
857                 aThreshold = float(aThreshold)
858                 aCriterion.Threshold = aThreshold
859             except:
860                 raise TypeError("The Threshold should be a number.")
861                 return None
862
863         if Threshold ==  FT_LogicalNOT or UnaryOp ==  FT_LogicalNOT:
864             aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
865
866         if Threshold in [FT_LogicalAND, FT_LogicalOR]:
867             aCriterion.BinaryOp = self.EnumToLong(Threshold)
868
869         if UnaryOp in [FT_LogicalAND, FT_LogicalOR]:
870             aCriterion.BinaryOp = self.EnumToLong(UnaryOp)
871
872         if BinaryOp in [FT_LogicalAND, FT_LogicalOR]:
873             aCriterion.BinaryOp = self.EnumToLong(BinaryOp)
874
875         return aCriterion
876
877     ## Create a filter with the given parameters
878     #  @param elementType the type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
879     #  @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.)
880     #          Type SMESH.FunctorType._items in the Python Console to see all values.
881     #          Note that the items starting from FT_LessThan are not suitable for CritType.
882     #  @param Compare  belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo}
883     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
884     #  @param UnaryOp  SMESH.FT_LogicalNOT or SMESH.FT_Undefined
885     #  @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface,
886     #         SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces and SMESH.FT_EqualNodes criteria
887     #  @param mesh the mesh to initialize the filter with
888     #  @return SMESH_Filter
889     #
890     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
891     #  @ingroup l1_controls
892     def GetFilter(self,elementType,
893                   CritType=FT_Undefined,
894                   Compare=FT_EqualTo,
895                   Threshold="",
896                   UnaryOp=FT_Undefined,
897                   Tolerance=1e-07,
898                   mesh=None):
899         aCriterion = self.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
900         aFilterMgr = self.CreateFilterManager()
901         aFilter = aFilterMgr.CreateFilter()
902         aCriteria = []
903         aCriteria.append(aCriterion)
904         aFilter.SetCriteria(aCriteria)
905         if mesh:
906             if isinstance( mesh, Mesh ): aFilter.SetMesh( mesh.GetMesh() )
907             else                       : aFilter.SetMesh( mesh )
908         aFilterMgr.UnRegister()
909         return aFilter
910
911     ## Create a filter from criteria
912     #  @param criteria a list of criteria
913     #  @param binOp binary operator used when binary operator of criteria is undefined
914     #  @return SMESH_Filter
915     #
916     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
917     #  @ingroup l1_controls
918     def GetFilterFromCriteria(self,criteria, binOp=SMESH.FT_LogicalAND):
919         for i in range( len( criteria ) - 1 ):
920             if criteria[i].BinaryOp == self.EnumToLong( SMESH.FT_Undefined ):
921                 criteria[i].BinaryOp = self.EnumToLong( binOp )
922         aFilterMgr = self.CreateFilterManager()
923         aFilter = aFilterMgr.CreateFilter()
924         aFilter.SetCriteria(criteria)
925         aFilterMgr.UnRegister()
926         return aFilter
927
928     ## Create a numerical functor by its type
929     #  @param theCriterion functor type - an item of SMESH.FunctorType enumeration.
930     #          Type SMESH.FunctorType._items in the Python Console to see all items.
931     #          Note that not all items correspond to numerical functors.
932     #  @return SMESH_NumericalFunctor
933     #  @ingroup l1_controls
934     def GetFunctor(self,theCriterion):
935         if isinstance( theCriterion, SMESH._objref_NumericalFunctor ):
936             return theCriterion
937         aFilterMgr = self.CreateFilterManager()
938         functor = None
939         if theCriterion == FT_AspectRatio:
940             functor = aFilterMgr.CreateAspectRatio()
941         elif theCriterion == FT_AspectRatio3D:
942             functor = aFilterMgr.CreateAspectRatio3D()
943         elif theCriterion == FT_Warping:
944             functor = aFilterMgr.CreateWarping()
945         elif theCriterion == FT_MinimumAngle:
946             functor = aFilterMgr.CreateMinimumAngle()
947         elif theCriterion == FT_Taper:
948             functor = aFilterMgr.CreateTaper()
949         elif theCriterion == FT_Skew:
950             functor = aFilterMgr.CreateSkew()
951         elif theCriterion == FT_Area:
952             functor = aFilterMgr.CreateArea()
953         elif theCriterion == FT_Volume3D:
954             functor = aFilterMgr.CreateVolume3D()
955         elif theCriterion == FT_MaxElementLength2D:
956             functor = aFilterMgr.CreateMaxElementLength2D()
957         elif theCriterion == FT_MaxElementLength3D:
958             functor = aFilterMgr.CreateMaxElementLength3D()
959         elif theCriterion == FT_MultiConnection:
960             functor = aFilterMgr.CreateMultiConnection()
961         elif theCriterion == FT_MultiConnection2D:
962             functor = aFilterMgr.CreateMultiConnection2D()
963         elif theCriterion == FT_Length:
964             functor = aFilterMgr.CreateLength()
965         elif theCriterion == FT_Length2D:
966             functor = aFilterMgr.CreateLength2D()
967         elif theCriterion == FT_NodeConnectivityNumber:
968             functor = aFilterMgr.CreateNodeConnectivityNumber()
969         elif theCriterion == FT_BallDiameter:
970             functor = aFilterMgr.CreateBallDiameter()
971         else:
972             print("Error: given parameter is not numerical functor type.")
973         aFilterMgr.UnRegister()
974         return functor
975
976     ## Create hypothesis
977     #  @param theHType mesh hypothesis type (string)
978     #  @param theLibName mesh plug-in library name
979     #  @return created hypothesis instance
980     def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"):
981         hyp = SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName )
982
983         if isinstance( hyp, SMESH._objref_SMESH_Algo ):
984             return hyp
985
986         # wrap hypothesis methods
987         #print "HYPOTHESIS", theHType
988         for meth_name in dir( hyp.__class__ ):
989             if not meth_name.startswith("Get") and \
990                not meth_name in dir ( SMESH._objref_SMESH_Hypothesis ):
991                 method = getattr ( hyp.__class__, meth_name )
992                 if isinstance(method, collections.Callable):
993                     setattr( hyp, meth_name, hypMethodWrapper( hyp, method ))
994
995         return hyp
996
997     ## Get the mesh statistic
998     #  @return dictionary "element type" - "count of elements"
999     #  @ingroup l1_meshinfo
1000     def GetMeshInfo(self, obj):
1001         if isinstance( obj, Mesh ):
1002             obj = obj.GetMesh()
1003         d = {}
1004         if hasattr(obj, "GetMeshInfo"):
1005             values = obj.GetMeshInfo()
1006             for i in range(SMESH.Entity_Last._v):
1007                 if i < len(values): d[SMESH.EntityType._item(i)]=values[i]
1008             pass
1009         return d
1010
1011     ## Get minimum distance between two objects
1012     #
1013     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
1014     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
1015     #
1016     #  @param src1 first source object
1017     #  @param src2 second source object
1018     #  @param id1 node/element id from the first source
1019     #  @param id2 node/element id from the second (or first) source
1020     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
1021     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
1022     #  @return minimum distance value
1023     #  @sa GetMinDistance()
1024     #  @ingroup l1_measurements
1025     def MinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
1026         result = self.GetMinDistance(src1, src2, id1, id2, isElem1, isElem2)
1027         if result is None:
1028             result = 0.0
1029         else:
1030             result = result.value
1031         return result
1032
1033     ## Get measure structure specifying minimum distance data between two objects
1034     #
1035     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
1036     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
1037     #
1038     #  @param src1 first source object
1039     #  @param src2 second source object
1040     #  @param id1 node/element id from the first source
1041     #  @param id2 node/element id from the second (or first) source
1042     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
1043     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
1044     #  @return Measure structure or None if input data is invalid
1045     #  @sa MinDistance()
1046     #  @ingroup l1_measurements
1047     def GetMinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
1048         if isinstance(src1, Mesh): src1 = src1.mesh
1049         if isinstance(src2, Mesh): src2 = src2.mesh
1050         if src2 is None and id2 != 0: src2 = src1
1051         if not hasattr(src1, "_narrow"): return None
1052         src1 = src1._narrow(SMESH.SMESH_IDSource)
1053         if not src1: return None
1054         unRegister = genObjUnRegister()
1055         if id1 != 0:
1056             m = src1.GetMesh()
1057             e = m.GetMeshEditor()
1058             if isElem1:
1059                 src1 = e.MakeIDSource([id1], SMESH.FACE)
1060             else:
1061                 src1 = e.MakeIDSource([id1], SMESH.NODE)
1062             unRegister.set( src1 )
1063             pass
1064         if hasattr(src2, "_narrow"):
1065             src2 = src2._narrow(SMESH.SMESH_IDSource)
1066             if src2 and id2 != 0:
1067                 m = src2.GetMesh()
1068                 e = m.GetMeshEditor()
1069                 if isElem2:
1070                     src2 = e.MakeIDSource([id2], SMESH.FACE)
1071                 else:
1072                     src2 = e.MakeIDSource([id2], SMESH.NODE)
1073                 unRegister.set( src2 )
1074                 pass
1075             pass
1076         aMeasurements = self.CreateMeasurements()
1077         unRegister.set( aMeasurements )
1078         result = aMeasurements.MinDistance(src1, src2)
1079         return result
1080
1081     ## Get bounding box of the specified object(s)
1082     #  @param objects single source object or list of source objects
1083     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
1084     #  @sa GetBoundingBox()
1085     #  @ingroup l1_measurements
1086     def BoundingBox(self, objects):
1087         result = self.GetBoundingBox(objects)
1088         if result is None:
1089             result = (0.0,)*6
1090         else:
1091             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
1092         return result
1093
1094     ## Get measure structure specifying bounding box data of the specified object(s)
1095     #  @param objects single source object or list of source objects
1096     #  @return Measure structure
1097     #  @sa BoundingBox()
1098     #  @ingroup l1_measurements
1099     def GetBoundingBox(self, objects):
1100         if isinstance(objects, tuple):
1101             objects = list(objects)
1102         if not isinstance(objects, list):
1103             objects = [objects]
1104         srclist = []
1105         for o in objects:
1106             if isinstance(o, Mesh):
1107                 srclist.append(o.mesh)
1108             elif hasattr(o, "_narrow"):
1109                 src = o._narrow(SMESH.SMESH_IDSource)
1110                 if src: srclist.append(src)
1111                 pass
1112             pass
1113         aMeasurements = self.CreateMeasurements()
1114         result = aMeasurements.BoundingBox(srclist)
1115         aMeasurements.UnRegister()
1116         return result
1117
1118     ## Get sum of lengths of all 1D elements in the mesh object.
1119     #  @param obj mesh, submesh or group
1120     #  @return sum of lengths of all 1D elements
1121     #  @ingroup l1_measurements
1122     def GetLength(self, obj):
1123         if isinstance(obj, Mesh): obj = obj.mesh
1124         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1125         aMeasurements = self.CreateMeasurements()
1126         value = aMeasurements.Length(obj)
1127         aMeasurements.UnRegister()
1128         return value
1129
1130     ## Get sum of areas of all 2D elements in the mesh object.
1131     #  @param obj mesh, submesh or group
1132     #  @return sum of areas of all 2D elements
1133     #  @ingroup l1_measurements
1134     def GetArea(self, obj):
1135         if isinstance(obj, Mesh): obj = obj.mesh
1136         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1137         aMeasurements = self.CreateMeasurements()
1138         value = aMeasurements.Area(obj)
1139         aMeasurements.UnRegister()
1140         return value
1141
1142     ## Get sum of volumes of all 3D elements in the mesh object.
1143     #  @param obj mesh, submesh or group
1144     #  @return sum of volumes of all 3D elements
1145     #  @ingroup l1_measurements
1146     def GetVolume(self, obj):
1147         if isinstance(obj, Mesh): obj = obj.mesh
1148         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1149         aMeasurements = self.CreateMeasurements()
1150         value = aMeasurements.Volume(obj)
1151         aMeasurements.UnRegister()
1152         return value
1153
1154     pass # end of class smeshBuilder
1155
1156 import omniORB
1157 #Registering the new proxy for SMESH_Gen
1158 omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshBuilder)
1159
1160 ## Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1161 #  interface to create or load meshes.
1162 #
1163 #  Typical use is:
1164 #  \code
1165 #    import salome
1166 #    salome.salome_init()
1167 #    from salome.smesh import smeshBuilder
1168 #    smesh = smeshBuilder.New(salome.myStudy)
1169 #  \endcode
1170 #  @param  study     SALOME study, generally obtained by salome.myStudy.
1171 #  @param  instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1172 #  @return smeshBuilder instance
1173
1174 def New( study, instance=None):
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         import salome
1181         salome.salome_init()
1182         from salome.smesh import smeshBuilder
1183         smesh = smeshBuilder.New(salome.myStudy)
1184
1185     Parameters:
1186         study     SALOME study, generally obtained by salome.myStudy.
1187         instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1188     Returns:
1189         smeshBuilder instance
1190     """
1191     global engine
1192     global smeshInst
1193     global doLcc
1194     engine = instance
1195     if engine is None:
1196         doLcc = True
1197     smeshInst = smeshBuilder()
1198     assert isinstance(smeshInst,smeshBuilder), "Smesh engine class is %s but should be smeshBuilder.smeshBuilder. Import salome.smesh.smeshBuilder before creating the instance."%smeshInst.__class__
1199     smeshInst.init_smesh(study)
1200     return smeshInst
1201
1202
1203 # Public class: Mesh
1204 # ==================
1205
1206 ## This class allows defining and managing a mesh.
1207 #  It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes.
1208 #  It also has methods to define groups of mesh elements, to modify a mesh (by addition of
1209 #  new nodes and elements and by changing the existing entities), to get information
1210 #  about a mesh and to export a mesh in different formats.
1211 class Mesh(metaclass=MeshMeta):
1212     geom = 0
1213     mesh = 0
1214     editor = 0
1215
1216     ## Constructor
1217     #
1218     #  Create a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and
1219     #  sets the GUI name of this mesh to \a name.
1220     #  @param smeshpyD an instance of smeshBuilder class
1221     #  @param geompyD an instance of geomBuilder class
1222     #  @param obj Shape to be meshed or SMESH_Mesh object
1223     #  @param name Study name of the mesh
1224     #  @ingroup l2_construct
1225     def __init__(self, smeshpyD, geompyD, obj=0, name=0):
1226         self.smeshpyD=smeshpyD
1227         self.geompyD=geompyD
1228         if obj is None:
1229             obj = 0
1230         objHasName = False
1231         if obj != 0:
1232             if isinstance(obj, geomBuilder.GEOM._objref_GEOM_Object):
1233                 self.geom = obj
1234                 objHasName = True
1235                 # publish geom of mesh (issue 0021122)
1236                 if not self.geom.GetStudyEntry() and smeshpyD.GetCurrentStudy():
1237                     objHasName = False
1238                     studyID = smeshpyD.GetCurrentStudy()._get_StudyId()
1239                     if studyID != geompyD.myStudyId:
1240                         geompyD.init_geom( smeshpyD.GetCurrentStudy())
1241                         pass
1242                     if name:
1243                         geo_name = name + " shape"
1244                     else:
1245                         geo_name = "%s_%s to mesh"%(self.geom.GetShapeType(), id(self.geom)%100)
1246                     geompyD.addToStudy( self.geom, geo_name )
1247                 self.SetMesh( self.smeshpyD.CreateMesh(self.geom) )
1248
1249             elif isinstance(obj, SMESH._objref_SMESH_Mesh):
1250                 self.SetMesh(obj)
1251         else:
1252             self.SetMesh( self.smeshpyD.CreateEmptyMesh() )
1253         if name:
1254             self.smeshpyD.SetName(self.mesh, name)
1255         elif objHasName:
1256             self.smeshpyD.SetName(self.mesh, GetName(obj)) # + " mesh"
1257
1258         if not self.geom:
1259             self.geom = self.mesh.GetShapeToMesh()
1260
1261         self.editor   = self.mesh.GetMeshEditor()
1262         self.functors = [None] * SMESH.FT_Undefined._v
1263
1264         # set self to algoCreator's
1265         for attrName in dir(self):
1266             attr = getattr( self, attrName )
1267             if isinstance( attr, algoCreator ):
1268                 setattr( self, attrName, attr.copy( self ))
1269                 pass
1270             pass
1271         pass
1272
1273     ## Destructor. Clean-up resources
1274     def __del__(self):
1275         if self.mesh:
1276             #self.mesh.UnRegister()
1277             pass
1278         pass
1279
1280     ## Initialize the Mesh object from an instance of SMESH_Mesh interface
1281     #  @param theMesh a SMESH_Mesh object
1282     #  @ingroup l2_construct
1283     def SetMesh(self, theMesh):
1284         # do not call Register() as this prevents mesh servant deletion at closing study
1285         #if self.mesh: self.mesh.UnRegister()
1286         self.mesh = theMesh
1287         if self.mesh:
1288             #self.mesh.Register()
1289             self.geom = self.mesh.GetShapeToMesh()
1290         pass
1291
1292     ## Return the mesh, that is an instance of SMESH_Mesh interface
1293     #  @return a SMESH_Mesh object
1294     #  @ingroup l2_construct
1295     def GetMesh(self):
1296         return self.mesh
1297
1298     ## Get the name of the mesh
1299     #  @return the name of the mesh as a string
1300     #  @ingroup l2_construct
1301     def GetName(self):
1302         name = GetName(self.GetMesh())
1303         return name
1304
1305     ## Set a name to the mesh
1306     #  @param name a new name of the mesh
1307     #  @ingroup l2_construct
1308     def SetName(self, name):
1309         self.smeshpyD.SetName(self.GetMesh(), name)
1310
1311     ## Get a sub-mesh object associated to a \a geom geometrical object.
1312     #  @param geom a geometrical object (shape)
1313     #  @param name a name for the sub-mesh in the Object Browser
1314     #  @return an object of type SMESH.SMESH_subMesh, representing a part of mesh,
1315     #          which lies on the given shape
1316     #
1317     #  The sub-mesh object gives access to the IDs of nodes and elements.
1318     #  The sub-mesh object has the following methods:
1319     #  - SMESH.SMESH_subMesh.GetNumberOfElements()
1320     #  - SMESH.SMESH_subMesh.GetNumberOfNodes( all )
1321     #  - SMESH.SMESH_subMesh.GetElementsId()
1322     #  - SMESH.SMESH_subMesh.GetElementsByType( ElementType )
1323     #  - SMESH.SMESH_subMesh.GetNodesId()
1324     #  - SMESH.SMESH_subMesh.GetSubShape()
1325     #  - SMESH.SMESH_subMesh.GetFather()
1326     #  - SMESH.SMESH_subMesh.GetId()
1327     #  @note A sub-mesh is implicitly created when a sub-shape is specified at
1328     #  creating an algorithm, for example: <code>algo1D = mesh.Segment(geom=Edge_1) </code>
1329     #  creates a sub-mesh on @c Edge_1 and assign Wire Discretization algorithm to it.
1330     #  The created sub-mesh can be retrieved from the algorithm:
1331     #  <code>submesh = algo1D.GetSubMesh()</code>
1332     #  @ingroup l2_submeshes
1333     def GetSubMesh(self, geom, name):
1334         AssureGeomPublished( self, geom, name )
1335         submesh = self.mesh.GetSubMesh( geom, name )
1336         return submesh
1337
1338     ## Return the shape associated to the mesh
1339     #  @return a GEOM_Object
1340     #  @ingroup l2_construct
1341     def GetShape(self):
1342         return self.geom
1343
1344     ## Associate the given shape to the mesh (entails the recreation of the mesh)
1345     #  @param geom the shape to be meshed (GEOM_Object)
1346     #  @ingroup l2_construct
1347     def SetShape(self, geom):
1348         self.mesh = self.smeshpyD.CreateMesh(geom)
1349
1350     ## Load mesh from the study after opening the study
1351     def Load(self):
1352         self.mesh.Load()
1353
1354     ## Return true if the hypotheses are defined well
1355     #  @param theSubObject a sub-shape of a mesh shape
1356     #  @return True or False
1357     #  @ingroup l2_construct
1358     def IsReadyToCompute(self, theSubObject):
1359         return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject)
1360
1361     ## Return errors of hypotheses definition.
1362     #  The list of errors is empty if everything is OK.
1363     #  @param theSubObject a sub-shape of a mesh shape
1364     #  @return a list of errors
1365     #  @ingroup l2_construct
1366     def GetAlgoState(self, theSubObject):
1367         return self.smeshpyD.GetAlgoState(self.mesh, theSubObject)
1368
1369     ## Return a geometrical object on which the given element was built.
1370     #  The returned geometrical object, if not nil, is either found in the
1371     #  study or published by this method with the given name
1372     #  @param theElementID the id of the mesh element
1373     #  @param theGeomName the user-defined name of the geometrical object
1374     #  @return GEOM::GEOM_Object instance
1375     #  @ingroup l1_meshinfo
1376     def GetGeometryByMeshElement(self, theElementID, theGeomName):
1377         return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName )
1378
1379     ## Return the mesh dimension depending on the dimension of the underlying shape
1380     #  or, if the mesh is not based on any shape, basing on deimension of elements
1381     #  @return mesh dimension as an integer value [0,3]
1382     #  @ingroup l1_meshinfo
1383     def MeshDimension(self):
1384         if self.mesh.HasShapeToMesh():
1385             shells = self.geompyD.SubShapeAllIDs( self.geom, self.geompyD.ShapeType["SOLID"] )
1386             if len( shells ) > 0 :
1387                 return 3
1388             elif self.geompyD.NumberOfFaces( self.geom ) > 0 :
1389                 return 2
1390             elif self.geompyD.NumberOfEdges( self.geom ) > 0 :
1391                 return 1
1392             else:
1393                 return 0;
1394         else:
1395             if self.NbVolumes() > 0: return 3
1396             if self.NbFaces()   > 0: return 2
1397             if self.NbEdges()   > 0: return 1
1398         return 0
1399
1400     ## Evaluate size of prospective mesh on a shape
1401     #  @return a list where i-th element is a number of elements of i-th SMESH.EntityType
1402     #  To know predicted number of e.g. edges, inquire it this way
1403     #  Evaluate()[ EnumToLong( Entity_Edge )]
1404     #  @ingroup l2_construct
1405     def Evaluate(self, geom=0):
1406         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1407             if self.geom == 0:
1408                 geom = self.mesh.GetShapeToMesh()
1409             else:
1410                 geom = self.geom
1411         return self.smeshpyD.Evaluate(self.mesh, geom)
1412
1413
1414     ## Compute the mesh and return the status of the computation
1415     #  @param geom geomtrical shape on which mesh data should be computed
1416     #  @param discardModifs if True and the mesh has been edited since
1417     #         a last total re-compute and that may prevent successful partial re-compute,
1418     #         then the mesh is cleaned before Compute()
1419     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1420     #  @return True or False
1421     #  @ingroup l2_construct
1422     def Compute(self, geom=0, discardModifs=False, refresh=False):
1423         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1424             if self.geom == 0:
1425                 geom = self.mesh.GetShapeToMesh()
1426             else:
1427                 geom = self.geom
1428         ok = False
1429         try:
1430             if discardModifs and self.mesh.HasModificationsToDiscard(): # issue 0020693
1431                 self.mesh.Clear()
1432             ok = self.smeshpyD.Compute(self.mesh, geom)
1433         except SALOME.SALOME_Exception as ex:
1434             print("Mesh computation failed, exception caught:")
1435             print("    ", ex.details.text)
1436         except:
1437             import traceback
1438             print("Mesh computation failed, exception caught:")
1439             traceback.print_exc()
1440         if True:#not ok:
1441             allReasons = ""
1442
1443             # Treat compute errors
1444             computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, geom )
1445             shapeText = ""
1446             for err in computeErrors:
1447                 if self.mesh.HasShapeToMesh():
1448                     shapeText = " on %s" % self.GetSubShapeName( err.subShapeID )
1449                 errText = ""
1450                 stdErrors = ["OK",                   #COMPERR_OK
1451                              "Invalid input mesh",   #COMPERR_BAD_INPUT_MESH
1452                              "std::exception",       #COMPERR_STD_EXCEPTION
1453                              "OCC exception",        #COMPERR_OCC_EXCEPTION
1454                              "..",                   #COMPERR_SLM_EXCEPTION
1455                              "Unknown exception",    #COMPERR_EXCEPTION
1456                              "Memory allocation problem", #COMPERR_MEMORY_PB
1457                              "Algorithm failed",     #COMPERR_ALGO_FAILED
1458                              "Unexpected geometry",  #COMPERR_BAD_SHAPE
1459                              "Warning",              #COMPERR_WARNING
1460                              "Computation cancelled",#COMPERR_CANCELED
1461                              "No mesh on sub-shape"] #COMPERR_NO_MESH_ON_SHAPE
1462                 if err.code > 0:
1463                     if err.code < len(stdErrors): errText = stdErrors[err.code]
1464                 else:
1465                     errText = "code %s" % -err.code
1466                 if errText: errText += ". "
1467                 errText += err.comment
1468                 if allReasons: allReasons += "\n"
1469                 if ok:
1470                     allReasons += '-  "%s"%s - %s' %(err.algoName, shapeText, errText)
1471                 else:
1472                     allReasons += '-  "%s" failed%s. Error: %s' %(err.algoName, shapeText, errText)
1473                 pass
1474
1475             # Treat hyp errors
1476             errors = self.smeshpyD.GetAlgoState( self.mesh, geom )
1477             for err in errors:
1478                 if err.isGlobalAlgo:
1479                     glob = "global"
1480                 else:
1481                     glob = "local"
1482                     pass
1483                 dim = err.algoDim
1484                 name = err.algoName
1485                 if len(name) == 0:
1486                     reason = '%s %sD algorithm is missing' % (glob, dim)
1487                 elif err.state == HYP_MISSING:
1488                     reason = ('%s %sD algorithm "%s" misses %sD hypothesis'
1489                               % (glob, dim, name, dim))
1490                 elif err.state == HYP_NOTCONFORM:
1491                     reason = 'Global "Not Conform mesh allowed" hypothesis is missing'
1492                 elif err.state == HYP_BAD_PARAMETER:
1493                     reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value'
1494                               % ( glob, dim, name ))
1495                 elif err.state == HYP_BAD_GEOMETRY:
1496                     reason = ('%s %sD algorithm "%s" is assigned to mismatching'
1497                               'geometry' % ( glob, dim, name ))
1498                 elif err.state == HYP_HIDDEN_ALGO:
1499                     reason = ('%s %sD algorithm "%s" is ignored due to presence of a %s '
1500                               'algorithm of upper dimension generating %sD mesh'
1501                               % ( glob, dim, name, glob, dim ))
1502                 else:
1503                     reason = ("For unknown reason. "
1504                               "Developer, revise Mesh.Compute() implementation in smeshBuilder.py!")
1505                     pass
1506                 if allReasons: allReasons += "\n"
1507                 allReasons += "-  " + reason
1508                 pass
1509             if not ok or allReasons != "":
1510                 msg = '"' + GetName(self.mesh) + '"'
1511                 if ok: msg += " has been computed with warnings"
1512                 else:  msg += " has not been computed"
1513                 if allReasons != "": msg += ":"
1514                 else:                msg += "."
1515                 print(msg)
1516                 print(allReasons)
1517             pass
1518         if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0:
1519             if not isinstance( refresh, list): # not a call from subMesh.Compute()
1520                 smeshgui = salome.ImportComponentGUI("SMESH")
1521                 smeshgui.Init(self.mesh.GetStudyId())
1522                 smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) )
1523                 if refresh: salome.sg.updateObjBrowser(True)
1524
1525         return ok
1526
1527     ## Return a list of error messages (SMESH.ComputeError) of the last Compute()
1528     #  @ingroup l2_construct
1529     def GetComputeErrors(self, shape=0 ):
1530         if shape == 0:
1531             shape = self.mesh.GetShapeToMesh()
1532         return self.smeshpyD.GetComputeErrors( self.mesh, shape )
1533
1534     ## Return a name of a sub-shape by its ID
1535     #  @param subShapeID a unique ID of a sub-shape
1536     #  @return a string describing the sub-shape; possible variants:
1537     #  - "Face_12"    (published sub-shape)
1538     #  - FACE #3      (not published sub-shape)
1539     #  - sub-shape #3 (invalid sub-shape ID)
1540     #  - #3           (error in this function)
1541     #  @ingroup l1_auxiliary
1542     def GetSubShapeName(self, subShapeID ):
1543         if not self.mesh.HasShapeToMesh():
1544             return ""
1545         try:
1546             shapeText = ""
1547             mainIOR  = salome.orb.object_to_string( self.GetShape() )
1548             for sname in salome.myStudyManager.GetOpenStudies():
1549                 s = salome.myStudyManager.GetStudyByName(sname)
1550                 if not s: continue
1551                 mainSO = s.FindObjectIOR(mainIOR)
1552                 if not mainSO: continue
1553                 if subShapeID == 1:
1554                     shapeText = '"%s"' % mainSO.GetName()
1555                 subIt = s.NewChildIterator(mainSO)
1556                 while subIt.More():
1557                     subSO = subIt.Value()
1558                     subIt.Next()
1559                     obj = subSO.GetObject()
1560                     if not obj: continue
1561                     go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object )
1562                     if not go: continue
1563                     try:
1564                         ids = self.geompyD.GetSubShapeID( self.GetShape(), go )
1565                     except:
1566                         continue
1567                     if ids == subShapeID:
1568                         shapeText = '"%s"' % subSO.GetName()
1569                         break
1570             if not shapeText:
1571                 shape = self.geompyD.GetSubShape( self.GetShape(), [subShapeID])
1572                 if shape:
1573                     shapeText = '%s #%s' % (shape.GetShapeType(), subShapeID)
1574                 else:
1575                     shapeText = 'sub-shape #%s' % (subShapeID)
1576         except:
1577             shapeText = "#%s" % (subShapeID)
1578         return shapeText
1579
1580     ## Return a list of sub-shapes meshing of which failed, grouped into GEOM groups by
1581     #  error of an algorithm
1582     #  @param publish if @c True, the returned groups will be published in the study
1583     #  @return a list of GEOM groups each named after a failed algorithm
1584     #  @ingroup l2_construct
1585     def GetFailedShapes(self, publish=False):
1586
1587         algo2shapes = {}
1588         computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, self.GetShape() )
1589         for err in computeErrors:
1590             shape = self.geompyD.GetSubShape( self.GetShape(), [err.subShapeID])
1591             if not shape: continue
1592             if err.algoName in algo2shapes:
1593                 algo2shapes[ err.algoName ].append( shape )
1594             else:
1595                 algo2shapes[ err.algoName ] = [ shape ]
1596             pass
1597
1598         groups = []
1599         for algoName, shapes in list(algo2shapes.items()):
1600             while shapes:
1601                 groupType = self.smeshpyD.EnumToLong( shapes[0].GetShapeType() )
1602                 otherTypeShapes = []
1603                 sameTypeShapes  = []
1604                 group = self.geompyD.CreateGroup( self.geom, groupType )
1605                 for shape in shapes:
1606                     if shape.GetShapeType() == shapes[0].GetShapeType():
1607                         sameTypeShapes.append( shape )
1608                     else:
1609                         otherTypeShapes.append( shape )
1610                 self.geompyD.UnionList( group, sameTypeShapes )
1611                 if otherTypeShapes:
1612                     group.SetName( "%s %s" % ( algoName, shapes[0].GetShapeType() ))
1613                 else:
1614                     group.SetName( algoName )
1615                 groups.append( group )
1616                 shapes = otherTypeShapes
1617             pass
1618         if publish:
1619             for group in groups:
1620                 self.geompyD.addToStudyInFather( self.geom, group, group.GetName() )
1621         return groups
1622
1623     ## Return sub-mesh objects list in meshing order
1624     #  @return list of lists of sub-meshes
1625     #  @ingroup l2_construct
1626     def GetMeshOrder(self):
1627         return self.mesh.GetMeshOrder()
1628
1629     ## Set order in which concurrent sub-meshes should be meshed
1630     #  @param submeshes list of lists of sub-meshes
1631     #  @ingroup l2_construct
1632     def SetMeshOrder(self, submeshes):
1633         return self.mesh.SetMeshOrder(submeshes)
1634
1635     ## Remove all nodes and elements generated on geometry. Imported elements remain.
1636     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1637     #  @ingroup l2_construct
1638     def Clear(self, refresh=False):
1639         self.mesh.Clear()
1640         if ( salome.sg.hasDesktop() and
1641              salome.myStudyManager.GetStudyByID( self.mesh.GetStudyId() ) ):
1642             smeshgui = salome.ImportComponentGUI("SMESH")
1643             smeshgui.Init(self.mesh.GetStudyId())
1644             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1645             if refresh: salome.sg.updateObjBrowser(True)
1646
1647     ## Remove all nodes and elements of indicated shape
1648     #  @param refresh if @c True, Object browser is automatically updated (when running in GUI)
1649     #  @param geomId the ID of a sub-shape to remove elements on
1650     #  @ingroup l2_submeshes
1651     def ClearSubMesh(self, geomId, refresh=False):
1652         self.mesh.ClearSubMesh(geomId)
1653         if salome.sg.hasDesktop():
1654             smeshgui = salome.ImportComponentGUI("SMESH")
1655             smeshgui.Init(self.mesh.GetStudyId())
1656             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1657             if refresh: salome.sg.updateObjBrowser(True)
1658
1659     ## Compute a tetrahedral mesh using AutomaticLength + MEFISTO + Tetrahedron
1660     #  @param fineness [0.0,1.0] defines mesh fineness
1661     #  @return True or False
1662     #  @ingroup l3_algos_basic
1663     def AutomaticTetrahedralization(self, fineness=0):
1664         dim = self.MeshDimension()
1665         # assign hypotheses
1666         self.RemoveGlobalHypotheses()
1667         self.Segment().AutomaticLength(fineness)
1668         if dim > 1 :
1669             self.Triangle().LengthFromEdges()
1670             pass
1671         if dim > 2 :
1672             self.Tetrahedron()
1673             pass
1674         return self.Compute()
1675
1676     ## Compute an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron
1677     #  @param fineness [0.0, 1.0] defines mesh fineness
1678     #  @return True or False
1679     #  @ingroup l3_algos_basic
1680     def AutomaticHexahedralization(self, fineness=0):
1681         dim = self.MeshDimension()
1682         # assign the hypotheses
1683         self.RemoveGlobalHypotheses()
1684         self.Segment().AutomaticLength(fineness)
1685         if dim > 1 :
1686             self.Quadrangle()
1687             pass
1688         if dim > 2 :
1689             self.Hexahedron()
1690             pass
1691         return self.Compute()
1692
1693     ## Assign a hypothesis
1694     #  @param hyp a hypothesis to assign
1695     #  @param geom a subhape of mesh geometry
1696     #  @return SMESH.Hypothesis_Status
1697     #  @ingroup l2_editing
1698     def AddHypothesis(self, hyp, geom=0):
1699         if isinstance( hyp, geomBuilder.GEOM._objref_GEOM_Object ):
1700             hyp, geom = geom, hyp
1701         if isinstance( hyp, Mesh_Algorithm ):
1702             hyp = hyp.GetAlgorithm()
1703             pass
1704         if not geom:
1705             geom = self.geom
1706             if not geom:
1707                 geom = self.mesh.GetShapeToMesh()
1708             pass
1709         isApplicable = True
1710         if self.mesh.HasShapeToMesh():
1711             hyp_type     = hyp.GetName()
1712             lib_name     = hyp.GetLibName()
1713             # checkAll    = ( not geom.IsSame( self.mesh.GetShapeToMesh() ))
1714             # if checkAll and geom:
1715             #     checkAll = geom.GetType() == 37
1716             checkAll     = False
1717             isApplicable = self.smeshpyD.IsApplicable(hyp_type, lib_name, geom, checkAll)
1718         if isApplicable:
1719             AssureGeomPublished( self, geom, "shape for %s" % hyp.GetName())
1720             status = self.mesh.AddHypothesis(geom, hyp)
1721         else:
1722             status = HYP_BAD_GEOMETRY,""
1723         hyp_name = GetName( hyp )
1724         geom_name = ""
1725         if geom:
1726             geom_name = geom.GetName()
1727         isAlgo = hyp._narrow( SMESH_Algo )
1728         TreatHypoStatus( status, hyp_name, geom_name, isAlgo, self )
1729         return status
1730
1731     ## Return True if an algorithm of hypothesis is assigned to a given shape
1732     #  @param hyp a hypothesis to check
1733     #  @param geom a subhape of mesh geometry
1734     #  @return True of False
1735     #  @ingroup l2_editing
1736     def IsUsedHypothesis(self, hyp, geom):
1737         if not hyp: # or not geom
1738             return False
1739         if isinstance( hyp, Mesh_Algorithm ):
1740             hyp = hyp.GetAlgorithm()
1741             pass
1742         hyps = self.GetHypothesisList(geom)
1743         for h in hyps:
1744             if h.GetId() == hyp.GetId():
1745                 return True
1746         return False
1747
1748     ## Unassign a hypothesis
1749     #  @param hyp a hypothesis to unassign
1750     #  @param geom a sub-shape of mesh geometry
1751     #  @return SMESH.Hypothesis_Status
1752     #  @ingroup l2_editing
1753     def RemoveHypothesis(self, hyp, geom=0):
1754         if not hyp:
1755             return None
1756         if isinstance( hyp, Mesh_Algorithm ):
1757             hyp = hyp.GetAlgorithm()
1758             pass
1759         shape = geom
1760         if not shape:
1761             shape = self.geom
1762             pass
1763         if self.IsUsedHypothesis( hyp, shape ):
1764             return self.mesh.RemoveHypothesis( shape, hyp )
1765         hypName = GetName( hyp )
1766         geoName = GetName( shape )
1767         print("WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName ))
1768         return None
1769
1770     ## Get the list of hypotheses added on a geometry
1771     #  @param geom a sub-shape of mesh geometry
1772     #  @return the sequence of SMESH_Hypothesis
1773     #  @ingroup l2_editing
1774     def GetHypothesisList(self, geom):
1775         return self.mesh.GetHypothesisList( geom )
1776
1777     ## Remove all global hypotheses
1778     #  @ingroup l2_editing
1779     def RemoveGlobalHypotheses(self):
1780         current_hyps = self.mesh.GetHypothesisList( self.geom )
1781         for hyp in current_hyps:
1782             self.mesh.RemoveHypothesis( self.geom, hyp )
1783             pass
1784         pass
1785
1786     ## Export the mesh in a file in MED format
1787     ## allowing to overwrite the file if it exists or add the exported data to its contents
1788     #  @param f is the file name
1789     #  @param auto_groups boolean parameter for creating/not creating
1790     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1791     #  the typical use is auto_groups=False.
1792     #  @param version MED format version (MED_V2_1 or MED_V2_2,
1793     #                 the latter meaning any current version). The parameter is
1794     #                 obsolete since MED_V2_1 is no longer supported.
1795     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1796     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1797     #  @param autoDimension if @c True (default), a space dimension of a MED mesh can be either
1798     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1799     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1800     #         - 3D in the rest cases.<br>
1801     #         If @a autoDimension is @c False, the space dimension is always 3.
1802     #  @param fields list of GEOM fields defined on the shape to mesh.
1803     #  @param geomAssocFields each character of this string means a need to export a
1804     #         corresponding field; correspondence between fields and characters is following:
1805     #         - 'v' stands for "_vertices _" field;
1806     #         - 'e' stands for "_edges _" field;
1807     #         - 'f' stands for "_faces _" field;
1808     #         - 's' stands for "_solids _" field.
1809     #  @ingroup l2_impexp
1810     def ExportMED(self, f, auto_groups=0, version=MED_V2_2,
1811                   overwrite=1, meshPart=None, autoDimension=True, fields=[], geomAssocFields=''):
1812         if meshPart or fields or geomAssocFields:
1813             unRegister = genObjUnRegister()
1814             if isinstance( meshPart, list ):
1815                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1816                 unRegister.set( meshPart )
1817             self.mesh.ExportPartToMED( meshPart, f, auto_groups, version, overwrite, autoDimension,
1818                                        fields, geomAssocFields)
1819         else:
1820             self.mesh.ExportToMEDX(f, auto_groups, version, overwrite, autoDimension)
1821
1822     ## Export the mesh in a file in SAUV format
1823     #  @param f is the file name
1824     #  @param auto_groups boolean parameter for creating/not creating
1825     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1826     #  the typical use is auto_groups=false.
1827     #  @ingroup l2_impexp
1828     def ExportSAUV(self, f, auto_groups=0):
1829         self.mesh.ExportSAUV(f, auto_groups)
1830
1831     ## Export the mesh in a file in DAT format
1832     #  @param f the file name
1833     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1834     #  @ingroup l2_impexp
1835     def ExportDAT(self, f, meshPart=None):
1836         if meshPart:
1837             unRegister = genObjUnRegister()
1838             if isinstance( meshPart, list ):
1839                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1840                 unRegister.set( meshPart )
1841             self.mesh.ExportPartToDAT( meshPart, f )
1842         else:
1843             self.mesh.ExportDAT(f)
1844
1845     ## Export the mesh in a file in UNV format
1846     #  @param f the file name
1847     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1848     #  @ingroup l2_impexp
1849     def ExportUNV(self, f, meshPart=None):
1850         if meshPart:
1851             unRegister = genObjUnRegister()
1852             if isinstance( meshPart, list ):
1853                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1854                 unRegister.set( meshPart )
1855             self.mesh.ExportPartToUNV( meshPart, f )
1856         else:
1857             self.mesh.ExportUNV(f)
1858
1859     ## Export the mesh in a file in STL format
1860     #  @param f the file name
1861     #  @param ascii defines the file encoding
1862     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1863     #  @ingroup l2_impexp
1864     def ExportSTL(self, f, ascii=1, meshPart=None):
1865         if meshPart:
1866             unRegister = genObjUnRegister()
1867             if isinstance( meshPart, list ):
1868                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1869                 unRegister.set( meshPart )
1870             self.mesh.ExportPartToSTL( meshPart, f, ascii )
1871         else:
1872             self.mesh.ExportSTL(f, ascii)
1873
1874     ## Export the mesh in a file in CGNS format
1875     #  @param f is the file name
1876     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1877     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1878     #  @ingroup l2_impexp
1879     def ExportCGNS(self, f, overwrite=1, meshPart=None):
1880         unRegister = genObjUnRegister()
1881         if isinstance( meshPart, list ):
1882             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1883             unRegister.set( meshPart )
1884         if isinstance( meshPart, Mesh ):
1885             meshPart = meshPart.mesh
1886         elif not meshPart:
1887             meshPart = self.mesh
1888         self.mesh.ExportCGNS(meshPart, f, overwrite)
1889
1890     ## Export the mesh in a file in GMF format.
1891     #  GMF files must have .mesh extension for the ASCII format and .meshb for
1892     #  the bynary format. Other extensions are not allowed.
1893     #  @param f is the file name
1894     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1895     #  @ingroup l2_impexp
1896     def ExportGMF(self, f, meshPart=None):
1897         unRegister = genObjUnRegister()
1898         if isinstance( meshPart, list ):
1899             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1900             unRegister.set( meshPart )
1901         if isinstance( meshPart, Mesh ):
1902             meshPart = meshPart.mesh
1903         elif not meshPart:
1904             meshPart = self.mesh
1905         self.mesh.ExportGMF(meshPart, f, True)
1906
1907     ## Deprecated, used only for compatibility! Please, use ExportMED() method instead.
1908     #  Export the mesh in a file in MED format
1909     #  allowing to overwrite the file if it exists or add the exported data to its contents
1910     #  @param f the file name
1911     #  @param version MED format version (MED_V2_1 or MED_V2_2,
1912     #                 the latter meaning any current version). The parameter is
1913     #                 obsolete since MED_V2_1 is no longer supported.
1914     #  @param opt boolean parameter for creating/not creating
1915     #         the groups Group_On_All_Nodes, Group_On_All_Faces, ...
1916     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1917     #  @param autoDimension if @c True (default), a space dimension of a MED mesh can be either
1918     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1919     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1920     #         - 3D in the rest cases.<br>
1921     #         If @a autoDimension is @c False, the space dimension is always 3.
1922     #  @ingroup l2_impexp
1923     def ExportToMED(self, f, version=MED_V2_2, opt=0, overwrite=1, autoDimension=True):
1924         self.mesh.ExportToMEDX(f, opt, version, overwrite, autoDimension)
1925
1926     # Operations with groups:
1927     # ----------------------
1928
1929     ## Create an empty mesh group
1930     #  @param elementType the type of elements in the group; either of
1931     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
1932     #  @param name the name of the mesh group
1933     #  @return SMESH_Group
1934     #  @ingroup l2_grps_create
1935     def CreateEmptyGroup(self, elementType, name):
1936         return self.mesh.CreateGroup(elementType, name)
1937
1938     ## Create a mesh group based on the geometric object \a grp
1939     #  and gives a \a name, \n if this parameter is not defined
1940     #  the name is the same as the geometric group name \n
1941     #  Note: Works like GroupOnGeom().
1942     #  @param grp  a geometric group, a vertex, an edge, a face or a solid
1943     #  @param name the name of the mesh group
1944     #  @return SMESH_GroupOnGeom
1945     #  @ingroup l2_grps_create
1946     def Group(self, grp, name=""):
1947         return self.GroupOnGeom(grp, name)
1948
1949     ## Create a mesh group based on the geometrical object \a grp
1950     #  and gives a \a name, \n if this parameter is not defined
1951     #  the name is the same as the geometrical group name
1952     #  @param grp  a geometrical group, a vertex, an edge, a face or a solid
1953     #  @param name the name of the mesh group
1954     #  @param typ  the type of elements in the group; either of
1955     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). If not set, it is
1956     #         automatically detected by the type of the geometry
1957     #  @return SMESH_GroupOnGeom
1958     #  @ingroup l2_grps_create
1959     def GroupOnGeom(self, grp, name="", typ=None):
1960         AssureGeomPublished( self, grp, name )
1961         if name == "":
1962             name = grp.GetName()
1963         if not typ:
1964             typ = self._groupTypeFromShape( grp )
1965         return self.mesh.CreateGroupFromGEOM(typ, name, grp)
1966
1967     ## Pivate method to get a type of group on geometry
1968     def _groupTypeFromShape( self, shape ):
1969         tgeo = str(shape.GetShapeType())
1970         if tgeo == "VERTEX":
1971             typ = NODE
1972         elif tgeo == "EDGE":
1973             typ = EDGE
1974         elif tgeo == "FACE" or tgeo == "SHELL":
1975             typ = FACE
1976         elif tgeo == "SOLID" or tgeo == "COMPSOLID":
1977             typ = VOLUME
1978         elif tgeo == "COMPOUND":
1979             sub = self.geompyD.SubShapeAll( shape, self.geompyD.ShapeType["SHAPE"])
1980             if not sub:
1981                 raise ValueError("_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape))
1982             return self._groupTypeFromShape( sub[0] )
1983         else:
1984             raise ValueError("_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape))
1985         return typ
1986
1987     ## Create a mesh group with given \a name based on the \a filter which
1988     ## is a special type of group dynamically updating it's contents during
1989     ## mesh modification
1990     #  @param typ  the type of elements in the group; either of
1991     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
1992     #  @param name the name of the mesh group
1993     #  @param filter the filter defining group contents
1994     #  @return SMESH_GroupOnFilter
1995     #  @ingroup l2_grps_create
1996     def GroupOnFilter(self, typ, name, filter):
1997         return self.mesh.CreateGroupFromFilter(typ, name, filter)
1998
1999     ## Create a mesh group by the given ids of elements
2000     #  @param groupName the name of the mesh group
2001     #  @param elementType the type of elements in the group; either of
2002     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
2003     #  @param elemIDs either the list of ids, group, sub-mesh, or filter
2004     #  @return SMESH_Group
2005     #  @ingroup l2_grps_create
2006     def MakeGroupByIds(self, groupName, elementType, elemIDs):
2007         group = self.mesh.CreateGroup(elementType, groupName)
2008         if hasattr( elemIDs, "GetIDs" ):
2009             if hasattr( elemIDs, "SetMesh" ):
2010                 elemIDs.SetMesh( self.GetMesh() )
2011             group.AddFrom( elemIDs )
2012         else:
2013             group.Add(elemIDs)
2014         return group
2015
2016     ## Create a mesh group by the given conditions
2017     #  @param groupName the name of the mesh group
2018     #  @param elementType the type of elements(SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME)
2019     #  @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.)
2020     #          Type SMESH.FunctorType._items in the Python Console to see all values.
2021     #          Note that the items starting from FT_LessThan are not suitable for CritType.
2022     #  @param Compare  belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo}
2023     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
2024     #  @param UnaryOp  SMESH.FT_LogicalNOT or SMESH.FT_Undefined
2025     #  @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface,
2026     #         SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces criteria
2027     #  @return SMESH_GroupOnFilter
2028     #  @ingroup l2_grps_create
2029     def MakeGroup(self,
2030                   groupName,
2031                   elementType,
2032                   CritType=FT_Undefined,
2033                   Compare=FT_EqualTo,
2034                   Threshold="",
2035                   UnaryOp=FT_Undefined,
2036                   Tolerance=1e-07):
2037         aCriterion = self.smeshpyD.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
2038         group = self.MakeGroupByCriterion(groupName, aCriterion)
2039         return group
2040
2041     ## Create a mesh group by the given criterion
2042     #  @param groupName the name of the mesh group
2043     #  @param Criterion the instance of Criterion class
2044     #  @return SMESH_GroupOnFilter
2045     #  @ingroup l2_grps_create
2046     def MakeGroupByCriterion(self, groupName, Criterion):
2047         return self.MakeGroupByCriteria( groupName, [Criterion] )
2048
2049     ## Create a mesh group by the given criteria (list of criteria)
2050     #  @param groupName the name of the mesh group
2051     #  @param theCriteria the list of criteria
2052     #  @param binOp binary operator used when binary operator of criteria is undefined
2053     #  @return SMESH_GroupOnFilter
2054     #  @ingroup l2_grps_create
2055     def MakeGroupByCriteria(self, groupName, theCriteria, binOp=SMESH.FT_LogicalAND):
2056         aFilter = self.smeshpyD.GetFilterFromCriteria( theCriteria, binOp )
2057         group = self.MakeGroupByFilter(groupName, aFilter)
2058         return group
2059
2060     ## Create a mesh group by the given filter
2061     #  @param groupName the name of the mesh group
2062     #  @param theFilter the instance of Filter class
2063     #  @return SMESH_GroupOnFilter
2064     #  @ingroup l2_grps_create
2065     def MakeGroupByFilter(self, groupName, theFilter):
2066         #group = self.CreateEmptyGroup(theFilter.GetElementType(), groupName)
2067         #theFilter.SetMesh( self.mesh )
2068         #group.AddFrom( theFilter )
2069         group = self.GroupOnFilter( theFilter.GetElementType(), groupName, theFilter )
2070         return group
2071
2072     ## Remove a group
2073     #  @ingroup l2_grps_delete
2074     def RemoveGroup(self, group):
2075         self.mesh.RemoveGroup(group)
2076
2077     ## Remove a group with its contents
2078     #  @ingroup l2_grps_delete
2079     def RemoveGroupWithContents(self, group):
2080         self.mesh.RemoveGroupWithContents(group)
2081
2082     ## Get the list of groups existing in the mesh in the order
2083     #  of creation (starting from the oldest one)
2084     #  @param elemType type of elements the groups contain; either of
2085     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME);
2086     #         by default groups of elements of all types are returned
2087     #  @return a sequence of SMESH_GroupBase
2088     #  @ingroup l2_grps_create
2089     def GetGroups(self, elemType = SMESH.ALL):
2090         groups = self.mesh.GetGroups()
2091         if elemType == SMESH.ALL:
2092             return groups
2093         typedGroups = []
2094         for g in groups:
2095             if g.GetType() == elemType:
2096                 typedGroups.append( g )
2097                 pass
2098             pass
2099         return typedGroups
2100
2101     ## Get the number of groups existing in the mesh
2102     #  @return the quantity of groups as an integer value
2103     #  @ingroup l2_grps_create
2104     def NbGroups(self):
2105         return self.mesh.NbGroups()
2106
2107     ## Get the list of names of groups existing in the mesh
2108     #  @return list of strings
2109     #  @ingroup l2_grps_create
2110     def GetGroupNames(self):
2111         groups = self.GetGroups()
2112         names = []
2113         for group in groups:
2114             names.append(group.GetName())
2115         return names
2116
2117     ## Find groups by name and type
2118     #  @param name name of the group of interest
2119     #  @param elemType type of elements the groups contain; either of
2120     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME);
2121     #         by default one group of any type of elements is returned
2122     #         if elemType == SMESH.ALL then all groups of any type are returned
2123     #  @return a list of SMESH_GroupBase's
2124     #  @ingroup l2_grps_create
2125     def GetGroupByName(self, name, elemType = None):
2126         groups = []
2127         for group in self.GetGroups():
2128             if group.GetName() == name:
2129                 if elemType is None:
2130                     return [group]
2131                 if ( elemType == SMESH.ALL or
2132                      group.GetType() == elemType ):
2133                     groups.append( group )
2134         return groups
2135
2136     ## Produce a union of two groups.
2137     #  A new group is created. All mesh elements that are
2138     #  present in the initial groups are added to the new one
2139     #  @return an instance of SMESH_Group
2140     #  @ingroup l2_grps_operon
2141     def UnionGroups(self, group1, group2, name):
2142         return self.mesh.UnionGroups(group1, group2, name)
2143
2144     ## Produce a union list of groups.
2145     #  New group is created. All mesh elements that are present in
2146     #  initial groups are added to the new one
2147     #  @return an instance of SMESH_Group
2148     #  @ingroup l2_grps_operon
2149     def UnionListOfGroups(self, groups, name):
2150         return self.mesh.UnionListOfGroups(groups, name)
2151
2152     ## Prodice an intersection of two groups.
2153     #  A new group is created. All mesh elements that are common
2154     #  for the two initial groups are added to the new one.
2155     #  @return an instance of SMESH_Group
2156     #  @ingroup l2_grps_operon
2157     def IntersectGroups(self, group1, group2, name):
2158         return self.mesh.IntersectGroups(group1, group2, name)
2159
2160     ## Produce an intersection of groups.
2161     #  New group is created. All mesh elements that are present in all
2162     #  initial groups simultaneously are added to the new one
2163     #  @return an instance of SMESH_Group
2164     #  @ingroup l2_grps_operon
2165     def IntersectListOfGroups(self, groups, name):
2166         return self.mesh.IntersectListOfGroups(groups, name)
2167
2168     ## Produce a cut of two groups.
2169     #  A new group is created. All mesh elements that are present in
2170     #  the main group but are not present in the tool group are added to the new one
2171     #  @return an instance of SMESH_Group
2172     #  @ingroup l2_grps_operon
2173     def CutGroups(self, main_group, tool_group, name):
2174         return self.mesh.CutGroups(main_group, tool_group, name)
2175
2176     ## Produce a cut of groups.
2177     #  A new group is created. All mesh elements that are present in main groups
2178     #  but do not present in tool groups are added to the new one
2179     #  @return an instance of SMESH_Group
2180     #  @ingroup l2_grps_operon
2181     def CutListOfGroups(self, main_groups, tool_groups, name):
2182         return self.mesh.CutListOfGroups(main_groups, tool_groups, name)
2183
2184     ##
2185     #  Create a standalone group of entities basing on nodes of other groups.
2186     #  \param groups - list of reference groups, sub-meshes or filters, of any type.
2187     #  \param elemType - a type of elements to include to the new group; either of
2188     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME).
2189     #  \param name - a name of the new group.
2190     #  \param nbCommonNodes - a criterion of inclusion of an element to the new group
2191     #         basing on number of element nodes common with reference \a groups.
2192     #         Meaning of possible values are:
2193     #         - SMESH.ALL_NODES - include if all nodes are common,
2194     #         - SMESH.MAIN - include if all corner nodes are common (meaningful for a quadratic mesh),
2195     #         - SMESH.AT_LEAST_ONE - include if one or more node is common,
2196     #         - SMEHS.MAJORITY - include if half of nodes or more are common.
2197     #  \param underlyingOnly - if \c True (default), an element is included to the
2198     #         new group provided that it is based on nodes of an element of \a groups;
2199     #         in this case the reference \a groups are supposed to be of higher dimension
2200     #         than \a elemType, which can be useful for example to get all faces lying on
2201     #         volumes of the reference \a groups.
2202     #  @return an instance of SMESH_Group
2203     #  @ingroup l2_grps_operon
2204     def CreateDimGroup(self, groups, elemType, name,
2205                        nbCommonNodes = SMESH.ALL_NODES, underlyingOnly = True):
2206         if isinstance( groups, SMESH._objref_SMESH_IDSource ):
2207             groups = [groups]
2208         return self.mesh.CreateDimGroup(groups, elemType, name, nbCommonNodes, underlyingOnly)
2209
2210
2211     ## Convert group on geom into standalone group
2212     #  @ingroup l2_grps_operon
2213     def ConvertToStandalone(self, group):
2214         return self.mesh.ConvertToStandalone(group)
2215
2216     # Get some info about mesh:
2217     # ------------------------
2218
2219     ## Return the log of nodes and elements added or removed
2220     #  since the previous clear of the log.
2221     #  @param clearAfterGet log is emptied after Get (safe if concurrents access)
2222     #  @return list of log_block structures:
2223     #                                        commandType
2224     #                                        number
2225     #                                        coords
2226     #                                        indexes
2227     #  @ingroup l1_auxiliary
2228     def GetLog(self, clearAfterGet):
2229         return self.mesh.GetLog(clearAfterGet)
2230
2231     ## Clear the log of nodes and elements added or removed since the previous
2232     #  clear. Must be used immediately after GetLog if clearAfterGet is false.
2233     #  @ingroup l1_auxiliary
2234     def ClearLog(self):
2235         self.mesh.ClearLog()
2236
2237     ## Toggle auto color mode on the object.
2238     #  @param theAutoColor the flag which toggles auto color mode.
2239     #
2240     #  If switched on, a default color of a new group in Create Group dialog is chosen randomly.
2241     #  @ingroup l1_grouping
2242     def SetAutoColor(self, theAutoColor):
2243         self.mesh.SetAutoColor(theAutoColor)
2244
2245     ## Get flag of object auto color mode.
2246     #  @return True or False
2247     #  @ingroup l1_grouping
2248     def GetAutoColor(self):
2249         return self.mesh.GetAutoColor()
2250
2251     ## Get the internal ID
2252     #  @return integer value, which is the internal Id of the mesh
2253     #  @ingroup l1_auxiliary
2254     def GetId(self):
2255         return self.mesh.GetId()
2256
2257     ## Get the study Id
2258     #  @return integer value, which is the study Id of the mesh
2259     #  @ingroup l1_auxiliary
2260     def GetStudyId(self):
2261         return self.mesh.GetStudyId()
2262
2263     ## Check the group names for duplications.
2264     #  Consider the maximum group name length stored in MED file.
2265     #  @return True or False
2266     #  @ingroup l1_grouping
2267     def HasDuplicatedGroupNamesMED(self):
2268         return self.mesh.HasDuplicatedGroupNamesMED()
2269
2270     ## Obtain the mesh editor tool
2271     #  @return an instance of SMESH_MeshEditor
2272     #  @ingroup l1_modifying
2273     def GetMeshEditor(self):
2274         return self.editor
2275
2276     ## Wrap a list of IDs of elements or nodes into SMESH_IDSource which
2277     #  can be passed as argument to a method accepting mesh, group or sub-mesh
2278     #  @param ids list of IDs
2279     #  @param elemType type of elements; this parameter is used to distinguish
2280     #         IDs of nodes from IDs of elements; by default ids are treated as
2281     #         IDs of elements; use SMESH.NODE if ids are IDs of nodes.
2282     #  @return an instance of SMESH_IDSource
2283     #  @warning call UnRegister() for the returned object as soon as it is no more useful:
2284     #          idSrc = mesh.GetIDSource( [1,3,5], SMESH.NODE )
2285     #          mesh.DoSomething( idSrc )
2286     #          idSrc.UnRegister()
2287     #  @ingroup l1_auxiliary
2288     def GetIDSource(self, ids, elemType = SMESH.ALL):
2289         if isinstance( ids, int ):
2290             ids = [ids]
2291         return self.editor.MakeIDSource(ids, elemType)
2292
2293
2294     # Get informations about mesh contents:
2295     # ------------------------------------
2296
2297     ## Get the mesh stattistic
2298     #  @return dictionary type element - count of elements
2299     #  @ingroup l1_meshinfo
2300     def GetMeshInfo(self, obj = None):
2301         if not obj: obj = self.mesh
2302         return self.smeshpyD.GetMeshInfo(obj)
2303
2304     ## Return the number of nodes in the mesh
2305     #  @return an integer value
2306     #  @ingroup l1_meshinfo
2307     def NbNodes(self):
2308         return self.mesh.NbNodes()
2309
2310     ## Return the number of elements in the mesh
2311     #  @return an integer value
2312     #  @ingroup l1_meshinfo
2313     def NbElements(self):
2314         return self.mesh.NbElements()
2315
2316     ## Return the number of 0d elements in the mesh
2317     #  @return an integer value
2318     #  @ingroup l1_meshinfo
2319     def Nb0DElements(self):
2320         return self.mesh.Nb0DElements()
2321
2322     ## Return the number of ball discrete elements in the mesh
2323     #  @return an integer value
2324     #  @ingroup l1_meshinfo
2325     def NbBalls(self):
2326         return self.mesh.NbBalls()
2327
2328     ## Return the number of edges in the mesh
2329     #  @return an integer value
2330     #  @ingroup l1_meshinfo
2331     def NbEdges(self):
2332         return self.mesh.NbEdges()
2333
2334     ## Return the number of edges with the given order in the mesh
2335     #  @param elementOrder the order of elements:
2336     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2337     #  @return an integer value
2338     #  @ingroup l1_meshinfo
2339     def NbEdgesOfOrder(self, elementOrder):
2340         return self.mesh.NbEdgesOfOrder(elementOrder)
2341
2342     ## Return the number of faces in the mesh
2343     #  @return an integer value
2344     #  @ingroup l1_meshinfo
2345     def NbFaces(self):
2346         return self.mesh.NbFaces()
2347
2348     ## Return the number of faces with the given order in the mesh
2349     #  @param elementOrder the order of elements:
2350     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2351     #  @return an integer value
2352     #  @ingroup l1_meshinfo
2353     def NbFacesOfOrder(self, elementOrder):
2354         return self.mesh.NbFacesOfOrder(elementOrder)
2355
2356     ## Return the number of triangles in the mesh
2357     #  @return an integer value
2358     #  @ingroup l1_meshinfo
2359     def NbTriangles(self):
2360         return self.mesh.NbTriangles()
2361
2362     ## Return the number of triangles with the given order in the mesh
2363     #  @param elementOrder is the order of elements:
2364     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2365     #  @return an integer value
2366     #  @ingroup l1_meshinfo
2367     def NbTrianglesOfOrder(self, elementOrder):
2368         return self.mesh.NbTrianglesOfOrder(elementOrder)
2369
2370     ## Return the number of biquadratic triangles in the mesh
2371     #  @return an integer value
2372     #  @ingroup l1_meshinfo
2373     def NbBiQuadTriangles(self):
2374         return self.mesh.NbBiQuadTriangles()
2375
2376     ## Return the number of quadrangles in the mesh
2377     #  @return an integer value
2378     #  @ingroup l1_meshinfo
2379     def NbQuadrangles(self):
2380         return self.mesh.NbQuadrangles()
2381
2382     ## Return the number of quadrangles 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 NbQuadranglesOfOrder(self, elementOrder):
2388         return self.mesh.NbQuadranglesOfOrder(elementOrder)
2389
2390     ## Return the number of biquadratic quadrangles in the mesh
2391     #  @return an integer value
2392     #  @ingroup l1_meshinfo
2393     def NbBiQuadQuadrangles(self):
2394         return self.mesh.NbBiQuadQuadrangles()
2395
2396     ## Return the number of polygons of given order in the mesh
2397     #  @param elementOrder 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 NbPolygons(self, elementOrder = SMESH.ORDER_ANY):
2402         return self.mesh.NbPolygonsOfOrder(elementOrder)
2403
2404     ## Return the number of volumes in the mesh
2405     #  @return an integer value
2406     #  @ingroup l1_meshinfo
2407     def NbVolumes(self):
2408         return self.mesh.NbVolumes()
2409
2410     ## Return the number of volumes with the given order in the mesh
2411     #  @param elementOrder  the order of elements:
2412     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2413     #  @return an integer value
2414     #  @ingroup l1_meshinfo
2415     def NbVolumesOfOrder(self, elementOrder):
2416         return self.mesh.NbVolumesOfOrder(elementOrder)
2417
2418     ## Return the number of tetrahedrons in the mesh
2419     #  @return an integer value
2420     #  @ingroup l1_meshinfo
2421     def NbTetras(self):
2422         return self.mesh.NbTetras()
2423
2424     ## Return the number of tetrahedrons with the given order in the mesh
2425     #  @param elementOrder  the order of elements:
2426     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2427     #  @return an integer value
2428     #  @ingroup l1_meshinfo
2429     def NbTetrasOfOrder(self, elementOrder):
2430         return self.mesh.NbTetrasOfOrder(elementOrder)
2431
2432     ## Return the number of hexahedrons in the mesh
2433     #  @return an integer value
2434     #  @ingroup l1_meshinfo
2435     def NbHexas(self):
2436         return self.mesh.NbHexas()
2437
2438     ## Return the number of hexahedrons with the given order in the mesh
2439     #  @param elementOrder  the order of elements:
2440     #         SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC
2441     #  @return an integer value
2442     #  @ingroup l1_meshinfo
2443     def NbHexasOfOrder(self, elementOrder):
2444         return self.mesh.NbHexasOfOrder(elementOrder)
2445
2446     ## Return the number of triquadratic hexahedrons in the mesh
2447     #  @return an integer value
2448     #  @ingroup l1_meshinfo
2449     def NbTriQuadraticHexas(self):
2450         return self.mesh.NbTriQuadraticHexas()
2451
2452     ## Return the number of pyramids in the mesh
2453     #  @return an integer value
2454     #  @ingroup l1_meshinfo
2455     def NbPyramids(self):
2456         return self.mesh.NbPyramids()
2457
2458     ## Return the number of pyramids 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 NbPyramidsOfOrder(self, elementOrder):
2464         return self.mesh.NbPyramidsOfOrder(elementOrder)
2465
2466     ## Return the number of prisms in the mesh
2467     #  @return an integer value
2468     #  @ingroup l1_meshinfo
2469     def NbPrisms(self):
2470         return self.mesh.NbPrisms()
2471
2472     ## Return the number of prisms 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 NbPrismsOfOrder(self, elementOrder):
2478         return self.mesh.NbPrismsOfOrder(elementOrder)
2479
2480     ## Return the number of hexagonal prisms in the mesh
2481     #  @return an integer value
2482     #  @ingroup l1_meshinfo
2483     def NbHexagonalPrisms(self):
2484         return self.mesh.NbHexagonalPrisms()
2485
2486     ## Return the number of polyhedrons in the mesh
2487     #  @return an integer value
2488     #  @ingroup l1_meshinfo
2489     def NbPolyhedrons(self):
2490         return self.mesh.NbPolyhedrons()
2491
2492     ## Return the number of submeshes in the mesh
2493     #  @return an integer value
2494     #  @ingroup l1_meshinfo
2495     def NbSubMesh(self):
2496         return self.mesh.NbSubMesh()
2497
2498     ## Return the list of mesh elements IDs
2499     #  @return the list of integer values
2500     #  @ingroup l1_meshinfo
2501     def GetElementsId(self):
2502         return self.mesh.GetElementsId()
2503
2504     ## Return the list of IDs of mesh elements with the given type
2505     #  @param elementType  the required type of elements, either of
2506     #         (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2507     #  @return list of integer values
2508     #  @ingroup l1_meshinfo
2509     def GetElementsByType(self, elementType):
2510         return self.mesh.GetElementsByType(elementType)
2511
2512     ## Return the list of mesh nodes IDs
2513     #  @return the list of integer values
2514     #  @ingroup l1_meshinfo
2515     def GetNodesId(self):
2516         return self.mesh.GetNodesId()
2517
2518     # Get the information about mesh elements:
2519     # ------------------------------------
2520
2521     ## Return the type of mesh element
2522     #  @return the value from SMESH::ElementType enumeration
2523     #          Type SMESH.ElementType._items in the Python Console to see all possible values.
2524     #  @ingroup l1_meshinfo
2525     def GetElementType(self, id, iselem=True):
2526         return self.mesh.GetElementType(id, iselem)
2527
2528     ## Return the geometric type of mesh element
2529     #  @return the value from SMESH::EntityType enumeration
2530     #          Type SMESH.EntityType._items in the Python Console to see all possible values.
2531     #  @ingroup l1_meshinfo
2532     def GetElementGeomType(self, id):
2533         return self.mesh.GetElementGeomType(id)
2534
2535     ## Return the shape type of mesh element
2536     #  @return the value from SMESH::GeometryType enumeration.
2537     #          Type SMESH.GeometryType._items in the Python Console to see all possible values.
2538     #  @ingroup l1_meshinfo
2539     def GetElementShape(self, id):
2540         return self.mesh.GetElementShape(id)
2541
2542     ## Return the list of submesh elements IDs
2543     #  @param Shape a geom object(sub-shape)
2544     #         Shape must be the sub-shape of a ShapeToMesh()
2545     #  @return the list of integer values
2546     #  @ingroup l1_meshinfo
2547     def GetSubMeshElementsId(self, Shape):
2548         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2549             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2550         else:
2551             ShapeID = Shape
2552         return self.mesh.GetSubMeshElementsId(ShapeID)
2553
2554     ## Return the list of submesh nodes IDs
2555     #  @param Shape a geom object(sub-shape)
2556     #         Shape must be the sub-shape of a ShapeToMesh()
2557     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
2558     #  @return the list of integer values
2559     #  @ingroup l1_meshinfo
2560     def GetSubMeshNodesId(self, Shape, all):
2561         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2562             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2563         else:
2564             ShapeID = Shape
2565         return self.mesh.GetSubMeshNodesId(ShapeID, all)
2566
2567     ## Return type of elements on given shape
2568     #  @param Shape a geom object(sub-shape)
2569     #         Shape must be a sub-shape of a ShapeToMesh()
2570     #  @return element type
2571     #  @ingroup l1_meshinfo
2572     def GetSubMeshElementType(self, Shape):
2573         if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object):
2574             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2575         else:
2576             ShapeID = Shape
2577         return self.mesh.GetSubMeshElementType(ShapeID)
2578
2579     ## Get the mesh description
2580     #  @return string value
2581     #  @ingroup l1_meshinfo
2582     def Dump(self):
2583         return self.mesh.Dump()
2584
2585
2586     # Get the information about nodes and elements of a mesh by its IDs:
2587     # -----------------------------------------------------------
2588
2589     ## Get XYZ coordinates of a node
2590     #  \n If there is no nodes for the given ID - return an empty list
2591     #  @return a list of double precision values
2592     #  @ingroup l1_meshinfo
2593     def GetNodeXYZ(self, id):
2594         return self.mesh.GetNodeXYZ(id)
2595
2596     ## Return list of IDs of inverse elements for the given node
2597     #  \n If there is no node for the given ID - return an empty list
2598     #  @return a list of integer values
2599     #  @ingroup l1_meshinfo
2600     def GetNodeInverseElements(self, id):
2601         return self.mesh.GetNodeInverseElements(id)
2602
2603     ## Return the position of a node on the shape
2604     #  @return SMESH::NodePosition
2605     #  @ingroup l1_meshinfo
2606     def GetNodePosition(self,NodeID):
2607         return self.mesh.GetNodePosition(NodeID)
2608
2609     ## Return the position of an element on the shape
2610     #  @return SMESH::ElementPosition
2611     #  @ingroup l1_meshinfo
2612     def GetElementPosition(self,ElemID):
2613         return self.mesh.GetElementPosition(ElemID)
2614
2615     ## Return the ID of the shape, on which the given node was generated.
2616     #  @return an integer value > 0 or -1 if there is no node for the given
2617     #          ID or the node is not assigned to any geometry
2618     #  @ingroup l1_meshinfo
2619     def GetShapeID(self, id):
2620         return self.mesh.GetShapeID(id)
2621
2622     ## Return the ID of the shape, on which the given element was generated.
2623     #  @return an integer value > 0 or -1 if there is no element for the given
2624     #          ID or the element is not assigned to any geometry
2625     #  @ingroup l1_meshinfo
2626     def GetShapeIDForElem(self,id):
2627         return self.mesh.GetShapeIDForElem(id)
2628
2629     ## Return the number of nodes of the given element
2630     #  @return an integer value > 0 or -1 if there is no element for the given ID
2631     #  @ingroup l1_meshinfo
2632     def GetElemNbNodes(self, id):
2633         return self.mesh.GetElemNbNodes(id)
2634
2635     ## Return the node ID the given (zero based) index for the given element
2636     #  \n If there is no element for the given ID - return -1
2637     #  \n If there is no node for the given index - return -2
2638     #  @return an integer value
2639     #  @ingroup l1_meshinfo
2640     def GetElemNode(self, id, index):
2641         return self.mesh.GetElemNode(id, index)
2642
2643     ## Return the IDs of nodes of the given element
2644     #  @return a list of integer values
2645     #  @ingroup l1_meshinfo
2646     def GetElemNodes(self, id):
2647         return self.mesh.GetElemNodes(id)
2648
2649     ## Return true if the given node is the medium node in the given quadratic element
2650     #  @ingroup l1_meshinfo
2651     def IsMediumNode(self, elementID, nodeID):
2652         return self.mesh.IsMediumNode(elementID, nodeID)
2653
2654     ## Return true if the given node is the medium node in one of quadratic elements
2655     #  @param nodeID ID of the node
2656     #  @param elementType  the type of elements to check a state of the node, either of
2657     #         (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2658     #  @ingroup l1_meshinfo
2659     def IsMediumNodeOfAnyElem(self, nodeID, elementType = SMESH.ALL ):
2660         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2661
2662     ## Return the number of edges for the given element
2663     #  @ingroup l1_meshinfo
2664     def ElemNbEdges(self, id):
2665         return self.mesh.ElemNbEdges(id)
2666
2667     ## Return the number of faces for the given element
2668     #  @ingroup l1_meshinfo
2669     def ElemNbFaces(self, id):
2670         return self.mesh.ElemNbFaces(id)
2671
2672     ## Return nodes of given face (counted from zero) for given volumic element.
2673     #  @ingroup l1_meshinfo
2674     def GetElemFaceNodes(self,elemId, faceIndex):
2675         return self.mesh.GetElemFaceNodes(elemId, faceIndex)
2676
2677     ## Return three components of normal of given mesh face
2678     #  (or an empty array in KO case)
2679     #  @ingroup l1_meshinfo
2680     def GetFaceNormal(self, faceId, normalized=False):
2681         return self.mesh.GetFaceNormal(faceId,normalized)
2682
2683     ## Return an element based on all given nodes.
2684     #  @ingroup l1_meshinfo
2685     def FindElementByNodes(self,nodes):
2686         return self.mesh.FindElementByNodes(nodes)
2687
2688     ## Return true if the given element is a polygon
2689     #  @ingroup l1_meshinfo
2690     def IsPoly(self, id):
2691         return self.mesh.IsPoly(id)
2692
2693     ## Return true if the given element is quadratic
2694     #  @ingroup l1_meshinfo
2695     def IsQuadratic(self, id):
2696         return self.mesh.IsQuadratic(id)
2697
2698     ## Return diameter of a ball discrete element or zero in case of an invalid \a id
2699     #  @ingroup l1_meshinfo
2700     def GetBallDiameter(self, id):
2701         return self.mesh.GetBallDiameter(id)
2702
2703     ## Return XYZ coordinates of the barycenter of the given element
2704     #  \n If there is no element for the given ID - return an empty list
2705     #  @return a list of three double values
2706     #  @ingroup l1_meshinfo
2707     def BaryCenter(self, id):
2708         return self.mesh.BaryCenter(id)
2709
2710     ## Pass mesh elements through the given filter and return IDs of fitting elements
2711     #  @param theFilter SMESH_Filter
2712     #  @return a list of ids
2713     #  @ingroup l1_controls
2714     def GetIdsFromFilter(self, theFilter):
2715         theFilter.SetMesh( self.mesh )
2716         return theFilter.GetIDs()
2717
2718     # Get mesh measurements information:
2719     # ------------------------------------
2720
2721     ## Verify whether a 2D mesh element has free edges (edges connected to one face only)\n
2722     #  Return a list of special structures (borders).
2723     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
2724     #  @ingroup l1_measurements
2725     def GetFreeBorders(self):
2726         aFilterMgr = self.smeshpyD.CreateFilterManager()
2727         aPredicate = aFilterMgr.CreateFreeEdges()
2728         aPredicate.SetMesh(self.mesh)
2729         aBorders = aPredicate.GetBorders()
2730         aFilterMgr.UnRegister()
2731         return aBorders
2732
2733     ## Get minimum distance between two nodes, elements or distance to the origin
2734     #  @param id1 first node/element id
2735     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2736     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2737     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2738     #  @return minimum distance value
2739     #  @sa GetMinDistance()
2740     #  @ingroup l1_measurements
2741     def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2742         aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2)
2743         return aMeasure.value
2744
2745     ## Get measure structure specifying minimum distance data between two objects
2746     #  @param id1 first node/element id
2747     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2748     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2749     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2750     #  @return Measure structure
2751     #  @sa MinDistance()
2752     #  @ingroup l1_measurements
2753     def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2754         if isElem1:
2755             id1 = self.editor.MakeIDSource([id1], SMESH.FACE)
2756         else:
2757             id1 = self.editor.MakeIDSource([id1], SMESH.NODE)
2758         if id2 != 0:
2759             if isElem2:
2760                 id2 = self.editor.MakeIDSource([id2], SMESH.FACE)
2761             else:
2762                 id2 = self.editor.MakeIDSource([id2], SMESH.NODE)
2763             pass
2764         else:
2765             id2 = None
2766
2767         aMeasurements = self.smeshpyD.CreateMeasurements()
2768         aMeasure = aMeasurements.MinDistance(id1, id2)
2769         genObjUnRegister([aMeasurements,id1, id2])
2770         return aMeasure
2771
2772     ## Get bounding box of the specified object(s)
2773     #  @param objects single source object or list of source objects or list of nodes/elements IDs
2774     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2775     #  @c False specifies that @a objects are nodes
2776     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
2777     #  @sa GetBoundingBox()
2778     #  @ingroup l1_measurements
2779     def BoundingBox(self, objects=None, isElem=False):
2780         result = self.GetBoundingBox(objects, isElem)
2781         if result is None:
2782             result = (0.0,)*6
2783         else:
2784             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
2785         return result
2786
2787     ## Get measure structure specifying bounding box data of the specified object(s)
2788     #  @param IDs single source object or list of source objects or list of nodes/elements IDs
2789     #  @param isElem if @a IDs is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2790     #  @c False specifies that @a objects are nodes
2791     #  @return Measure structure
2792     #  @sa BoundingBox()
2793     #  @ingroup l1_measurements
2794     def GetBoundingBox(self, IDs=None, isElem=False):
2795         if IDs is None:
2796             IDs = [self.mesh]
2797         elif isinstance(IDs, tuple):
2798             IDs = list(IDs)
2799         if not isinstance(IDs, list):
2800             IDs = [IDs]
2801         if len(IDs) > 0 and isinstance(IDs[0], int):
2802             IDs = [IDs]
2803         srclist = []
2804         unRegister = genObjUnRegister()
2805         for o in IDs:
2806             if isinstance(o, Mesh):
2807                 srclist.append(o.mesh)
2808             elif hasattr(o, "_narrow"):
2809                 src = o._narrow(SMESH.SMESH_IDSource)
2810                 if src: srclist.append(src)
2811                 pass
2812             elif isinstance(o, list):
2813                 if isElem:
2814                     srclist.append(self.editor.MakeIDSource(o, SMESH.FACE))
2815                 else:
2816                     srclist.append(self.editor.MakeIDSource(o, SMESH.NODE))
2817                 unRegister.set( srclist[-1] )
2818                 pass
2819             pass
2820         aMeasurements = self.smeshpyD.CreateMeasurements()
2821         unRegister.set( aMeasurements )
2822         aMeasure = aMeasurements.BoundingBox(srclist)
2823         return aMeasure
2824
2825     # Mesh edition (SMESH_MeshEditor functionality):
2826     # ---------------------------------------------
2827
2828     ## Remove the elements from the mesh by ids
2829     #  @param IDsOfElements is a list of ids of elements to remove
2830     #  @return True or False
2831     #  @ingroup l2_modif_del
2832     def RemoveElements(self, IDsOfElements):
2833         return self.editor.RemoveElements(IDsOfElements)
2834
2835     ## Remove nodes from mesh by ids
2836     #  @param IDsOfNodes is a list of ids of nodes to remove
2837     #  @return True or False
2838     #  @ingroup l2_modif_del
2839     def RemoveNodes(self, IDsOfNodes):
2840         return self.editor.RemoveNodes(IDsOfNodes)
2841
2842     ## Remove all orphan (free) nodes from mesh
2843     #  @return number of the removed nodes
2844     #  @ingroup l2_modif_del
2845     def RemoveOrphanNodes(self):
2846         return self.editor.RemoveOrphanNodes()
2847
2848     ## Add a node to the mesh by coordinates
2849     #  @return Id of the new node
2850     #  @ingroup l2_modif_add
2851     def AddNode(self, x, y, z):
2852         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2853         if hasVars: self.mesh.SetParameters(Parameters)
2854         return self.editor.AddNode( x, y, z)
2855
2856     ## Create a 0D element on a node with given number.
2857     #  @param IDOfNode the ID of node for creation of the element.
2858     #  @param DuplicateElements to add one more 0D element to a node or not
2859     #  @return the Id of the new 0D element
2860     #  @ingroup l2_modif_add
2861     def Add0DElement( self, IDOfNode, DuplicateElements=True ):
2862         return self.editor.Add0DElement( IDOfNode, DuplicateElements )
2863
2864     ## Create 0D elements on all nodes of the given elements except those
2865     #  nodes on which a 0D element already exists.
2866     #  @param theObject an object on whose nodes 0D elements will be created.
2867     #         It can be mesh, sub-mesh, group, list of element IDs or a holder
2868     #         of nodes IDs created by calling mesh.GetIDSource( nodes, SMESH.NODE )
2869     #  @param theGroupName optional name of a group to add 0D elements created
2870     #         and/or found on nodes of \a theObject.
2871     #  @param DuplicateElements to add one more 0D element to a node or not
2872     #  @return an object (a new group or a temporary SMESH_IDSource) holding
2873     #          IDs of new and/or found 0D elements. IDs of 0D elements
2874     #          can be retrieved from the returned object by calling GetIDs()
2875     #  @ingroup l2_modif_add
2876     def Add0DElementsToAllNodes(self, theObject, theGroupName="", DuplicateElements=False):
2877         unRegister = genObjUnRegister()
2878         if isinstance( theObject, Mesh ):
2879             theObject = theObject.GetMesh()
2880         elif isinstance( theObject, list ):
2881             theObject = self.GetIDSource( theObject, SMESH.ALL )
2882             unRegister.set( theObject )
2883         return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName, DuplicateElements )
2884
2885     ## Create a ball element on a node with given ID.
2886     #  @param IDOfNode the ID of node for creation of the element.
2887     #  @param diameter the bal diameter.
2888     #  @return the Id of the new ball element
2889     #  @ingroup l2_modif_add
2890     def AddBall(self, IDOfNode, diameter):
2891         return self.editor.AddBall( IDOfNode, diameter )
2892