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