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