Salome HOME
132313ef0b3e69a1997b1946dbaaeb93f568d3a6
[modules/smesh.git] / src / SMESH_SWIG / smeshBuilder.py
1 # Copyright (C) 2007-2014  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
524     #  @ingroup l1_auxiliary
525     def SetCurrentStudy( self, theStudy, geompyD = None ):
526         #self.SetCurrentStudy(theStudy)
527         if not geompyD:
528             from salome.geom import geomBuilder
529             geompyD = geomBuilder.geom
530             pass
531         self.geompyD=geompyD
532         self.SetGeomEngine(geompyD)
533         SMESH._objref_SMESH_Gen.SetCurrentStudy(self,theStudy)
534         global notebook
535         if theStudy:
536             notebook = salome_notebook.NoteBook( theStudy )
537         else:
538             notebook = salome_notebook.NoteBook( salome_notebook.PseudoStudyForNoteBook() )
539
540     ## Gets the current study
541     #  @ingroup l1_auxiliary
542     def GetCurrentStudy(self):
543         #return self.GetCurrentStudy()
544         return SMESH._objref_SMESH_Gen.GetCurrentStudy(self)
545
546     ## Creates a Mesh object importing data from the given UNV file
547     #  @return an instance of Mesh class
548     #  @ingroup l2_impexp
549     def CreateMeshesFromUNV( self,theFileName ):
550         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromUNV(self,theFileName)
551         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
552         return aMesh
553
554     ## Creates a Mesh object(s) importing data from the given MED file
555     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
556     #  @ingroup l2_impexp
557     def CreateMeshesFromMED( self,theFileName ):
558         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromMED(self,theFileName)
559         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
560         return aMeshes, aStatus
561
562     ## Creates a Mesh object(s) importing data from the given SAUV file
563     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
564     #  @ingroup l2_impexp
565     def CreateMeshesFromSAUV( self,theFileName ):
566         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromSAUV(self,theFileName)
567         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
568         return aMeshes, aStatus
569
570     ## Creates a Mesh object importing data from the given STL file
571     #  @return an instance of Mesh class
572     #  @ingroup l2_impexp
573     def CreateMeshesFromSTL( self, theFileName ):
574         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromSTL(self,theFileName)
575         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
576         return aMesh
577
578     ## Creates Mesh objects importing data from the given CGNS file
579     #  @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus )
580     #  @ingroup l2_impexp
581     def CreateMeshesFromCGNS( self, theFileName ):
582         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromCGNS(self,theFileName)
583         aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ]
584         return aMeshes, aStatus
585
586     ## Creates a Mesh object importing data from the given GMF file.
587     #  GMF files must have .mesh extension for the ASCII format and .meshb for
588     #  the binary format.
589     #  @return [ an instance of Mesh class, SMESH.ComputeError ]
590     #  @ingroup l2_impexp
591     def CreateMeshesFromGMF( self, theFileName ):
592         aSmeshMesh, error = SMESH._objref_SMESH_Gen.CreateMeshesFromGMF(self,
593                                                                         theFileName,
594                                                                         True)
595         if error.comment: print "*** CreateMeshesFromGMF() errors:\n", error.comment
596         return Mesh(self, self.geompyD, aSmeshMesh), error
597
598     ## Concatenate the given meshes into one mesh.
599     #  @return an instance of Mesh class
600     #  @param meshes the meshes to combine into one mesh
601     #  @param uniteIdenticalGroups if true, groups with same names are united, else they are renamed
602     #  @param mergeNodesAndElements if true, equal nodes and elements aremerged
603     #  @param mergeTolerance tolerance for merging nodes
604     #  @param allGroups forces creation of groups of all elements
605     #  @param name name of a new mesh
606     def Concatenate( self, meshes, uniteIdenticalGroups,
607                      mergeNodesAndElements = False, mergeTolerance = 1e-5, allGroups = False,
608                      name = ""):
609         if not meshes: return None
610         for i,m in enumerate(meshes):
611             if isinstance(m, Mesh):
612                 meshes[i] = m.GetMesh()
613         mergeTolerance,Parameters,hasVars = ParseParameters(mergeTolerance)
614         meshes[0].SetParameters(Parameters)
615         if allGroups:
616             aSmeshMesh = SMESH._objref_SMESH_Gen.ConcatenateWithGroups(
617                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
618         else:
619             aSmeshMesh = SMESH._objref_SMESH_Gen.Concatenate(
620                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
621         aMesh = Mesh(self, self.geompyD, aSmeshMesh, name=name)
622         return aMesh
623
624     ## Create a mesh by copying a part of another mesh.
625     #  @param meshPart a part of mesh to copy, either a Mesh, a sub-mesh or a group;
626     #                  to copy nodes or elements not contained in any mesh object,
627     #                  pass result of Mesh.GetIDSource( list_of_ids, type ) as meshPart
628     #  @param meshName a name of the new mesh
629     #  @param toCopyGroups to create in the new mesh groups the copied elements belongs to
630     #  @param toKeepIDs to preserve order of the copied elements or not
631     #  @return an instance of Mesh class
632     def CopyMesh( self, meshPart, meshName, toCopyGroups=False, toKeepIDs=False):
633         if (isinstance( meshPart, Mesh )):
634             meshPart = meshPart.GetMesh()
635         mesh = SMESH._objref_SMESH_Gen.CopyMesh( self,meshPart,meshName,toCopyGroups,toKeepIDs )
636         return Mesh(self, self.geompyD, mesh)
637
638     ## From SMESH_Gen interface
639     #  @return the list of integer values
640     #  @ingroup l1_auxiliary
641     def GetSubShapesId( self, theMainObject, theListOfSubObjects ):
642         return SMESH._objref_SMESH_Gen.GetSubShapesId(self,theMainObject, theListOfSubObjects)
643
644     ## From SMESH_Gen interface. Creates a pattern
645     #  @return an instance of SMESH_Pattern
646     #
647     #  <a href="../tui_modifying_meshes_page.html#tui_pattern_mapping">Example of Patterns usage</a>
648     #  @ingroup l2_modif_patterns
649     def GetPattern(self):
650         return SMESH._objref_SMESH_Gen.GetPattern(self)
651
652     ## Sets number of segments per diagonal of boundary box of geometry by which
653     #  default segment length of appropriate 1D hypotheses is defined.
654     #  Default value is 10
655     #  @ingroup l1_auxiliary
656     def SetBoundaryBoxSegmentation(self, nbSegments):
657         SMESH._objref_SMESH_Gen.SetBoundaryBoxSegmentation(self,nbSegments)
658
659     # Filtering. Auxiliary functions:
660     # ------------------------------
661
662     ## Creates an empty criterion
663     #  @return SMESH.Filter.Criterion
664     #  @ingroup l1_controls
665     def GetEmptyCriterion(self):
666         Type = self.EnumToLong(FT_Undefined)
667         Compare = self.EnumToLong(FT_Undefined)
668         Threshold = 0
669         ThresholdStr = ""
670         ThresholdID = ""
671         UnaryOp = self.EnumToLong(FT_Undefined)
672         BinaryOp = self.EnumToLong(FT_Undefined)
673         Tolerance = 1e-07
674         TypeOfElement = ALL
675         Precision = -1 ##@1e-07
676         return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID,
677                                 UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision)
678
679     ## Creates a criterion by the given parameters
680     #  \n Criterion structures allow to define complex filters by combining them with logical operations (AND / OR) (see example below)
681     #  @param elementType the type of elements(NODE, EDGE, FACE, VOLUME)
682     #  @param CritType the type of criterion (FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc.)
683     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
684     #  @param Threshold the threshold value (range of ids as string, shape, numeric)
685     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
686     #  @param BinaryOp a binary logical operation FT_LogicalAND, FT_LogicalOR or
687     #                  FT_Undefined (must be for the last criterion of all criteria)
688     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
689     #         FT_LyingOnGeom, FT_CoplanarFaces criteria
690     #  @return SMESH.Filter.Criterion
691     #
692     #  <a href="../tui_filters_page.html#combining_filters">Example of Criteria usage</a>
693     #  @ingroup l1_controls
694     def GetCriterion(self,elementType,
695                      CritType,
696                      Compare = FT_EqualTo,
697                      Threshold="",
698                      UnaryOp=FT_Undefined,
699                      BinaryOp=FT_Undefined,
700                      Tolerance=1e-07):
701         if not CritType in SMESH.FunctorType._items:
702             raise TypeError, "CritType should be of SMESH.FunctorType"
703         aCriterion               = self.GetEmptyCriterion()
704         aCriterion.TypeOfElement = elementType
705         aCriterion.Type          = self.EnumToLong(CritType)
706         aCriterion.Tolerance     = Tolerance
707
708         aThreshold = Threshold
709
710         if Compare in [FT_LessThan, FT_MoreThan, FT_EqualTo]:
711             aCriterion.Compare = self.EnumToLong(Compare)
712         elif Compare == "=" or Compare == "==":
713             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
714         elif Compare == "<":
715             aCriterion.Compare = self.EnumToLong(FT_LessThan)
716         elif Compare == ">":
717             aCriterion.Compare = self.EnumToLong(FT_MoreThan)
718         elif Compare != FT_Undefined:
719             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
720             aThreshold = Compare
721
722         if CritType in [FT_BelongToGeom,     FT_BelongToPlane, FT_BelongToGenSurface,
723                         FT_BelongToCylinder, FT_LyingOnGeom]:
724             # Checks that Threshold is GEOM object
725             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object):
726                 aCriterion.ThresholdStr = GetName(aThreshold)
727                 aCriterion.ThresholdID  = aThreshold.GetStudyEntry()
728                 if not aCriterion.ThresholdID:
729                     name = aCriterion.ThresholdStr
730                     if not name:
731                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
732                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
733                     #raise RuntimeError, "Threshold shape must be published"
734             else:
735                 print "Error: The Threshold should be a shape."
736                 return None
737             if isinstance(UnaryOp,float):
738                 aCriterion.Tolerance = UnaryOp
739                 UnaryOp = FT_Undefined
740                 pass
741         elif CritType == FT_RangeOfIds:
742             # Checks that Threshold is string
743             if isinstance(aThreshold, str):
744                 aCriterion.ThresholdStr = aThreshold
745             else:
746                 print "Error: The Threshold should be a string."
747                 return None
748         elif CritType == FT_CoplanarFaces:
749             # Checks the Threshold
750             if isinstance(aThreshold, int):
751                 aCriterion.ThresholdID = str(aThreshold)
752             elif isinstance(aThreshold, str):
753                 ID = int(aThreshold)
754                 if ID < 1:
755                     raise ValueError, "Invalid ID of mesh face: '%s'"%aThreshold
756                 aCriterion.ThresholdID = aThreshold
757             else:
758                 raise ValueError,\
759                       "The Threshold should be an ID of mesh face and not '%s'"%aThreshold
760         elif CritType == FT_ConnectedElements:
761             # Checks the Threshold
762             if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): # shape
763                 aCriterion.ThresholdID = aThreshold.GetStudyEntry()
764                 if not aCriterion.ThresholdID:
765                     name = aThreshold.GetName()
766                     if not name:
767                         name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000)
768                     aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name )
769             elif isinstance(aThreshold, int): # node id
770                 aCriterion.Threshold = aThreshold
771             elif isinstance(aThreshold, list): # 3 point coordinates
772                 if len( aThreshold ) < 3:
773                     raise ValueError, "too few point coordinates, must be 3"
774                 aCriterion.ThresholdStr = " ".join( [str(c) for c in aThreshold[:3]] )
775             elif isinstance(aThreshold, str):
776                 if aThreshold.isdigit():
777                     aCriterion.Threshold = aThreshold # node id
778                 else:
779                     aCriterion.ThresholdStr = aThreshold # hope that it's point coordinates
780             else:
781                 raise ValueError,\
782                       "The Threshold should either a VERTEX, or a node ID, "\
783                       "or a list of point coordinates and not '%s'"%aThreshold
784         elif CritType == FT_ElemGeomType:
785             # Checks the Threshold
786             try:
787                 aCriterion.Threshold = self.EnumToLong(aThreshold)
788                 assert( aThreshold in SMESH.GeometryType._items )
789             except:
790                 if isinstance(aThreshold, int):
791                     aCriterion.Threshold = aThreshold
792                 else:
793                     print "Error: The Threshold should be an integer or SMESH.GeometryType."
794                     return None
795                 pass
796             pass
797         elif CritType == FT_EntityType:
798             # Checks the Threshold
799             try:
800                 aCriterion.Threshold = self.EnumToLong(aThreshold)
801                 assert( aThreshold in SMESH.EntityType._items )
802             except:
803                 if isinstance(aThreshold, int):
804                     aCriterion.Threshold = aThreshold
805                 else:
806                     print "Error: The Threshold should be an integer or SMESH.EntityType."
807                     return None
808                 pass
809             pass
810         
811         elif CritType == FT_GroupColor:
812             # Checks the Threshold
813             try:
814                 aCriterion.ThresholdStr = self.ColorToString(aThreshold)
815             except:
816                 print "Error: The threshold value should be of SALOMEDS.Color type"
817                 return None
818             pass
819         elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_FreeNodes, FT_FreeFaces,
820                           FT_LinearOrQuadratic, FT_BadOrientedVolume,
821                           FT_BareBorderFace, FT_BareBorderVolume,
822                           FT_OverConstrainedFace, FT_OverConstrainedVolume,
823                           FT_EqualNodes,FT_EqualEdges,FT_EqualFaces,FT_EqualVolumes ]:
824             # At this point the Threshold is unnecessary
825             if aThreshold ==  FT_LogicalNOT:
826                 aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
827             elif aThreshold in [FT_LogicalAND, FT_LogicalOR]:
828                 aCriterion.BinaryOp = aThreshold
829         else:
830             # Check Threshold
831             try:
832                 aThreshold = float(aThreshold)
833                 aCriterion.Threshold = aThreshold
834             except:
835                 print "Error: The Threshold should be a number."
836                 return None
837
838         if Threshold ==  FT_LogicalNOT or UnaryOp ==  FT_LogicalNOT:
839             aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
840
841         if Threshold in [FT_LogicalAND, FT_LogicalOR]:
842             aCriterion.BinaryOp = self.EnumToLong(Threshold)
843
844         if UnaryOp in [FT_LogicalAND, FT_LogicalOR]:
845             aCriterion.BinaryOp = self.EnumToLong(UnaryOp)
846
847         if BinaryOp in [FT_LogicalAND, FT_LogicalOR]:
848             aCriterion.BinaryOp = self.EnumToLong(BinaryOp)
849
850         return aCriterion
851
852     ## Creates a filter with the given parameters
853     #  @param elementType the type of elements in the group
854     #  @param CritType the type of criterion ( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
855     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
856     #  @param Threshold the threshold value (range of id ids as string, shape, numeric)
857     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
858     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
859     #         FT_LyingOnGeom, FT_CoplanarFaces and FT_EqualNodes criteria
860     #  @param mesh the mesh to initialize the filter with
861     #  @return SMESH_Filter
862     #
863     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
864     #  @ingroup l1_controls
865     def GetFilter(self,elementType,
866                   CritType=FT_Undefined,
867                   Compare=FT_EqualTo,
868                   Threshold="",
869                   UnaryOp=FT_Undefined,
870                   Tolerance=1e-07,
871                   mesh=None):
872         aCriterion = self.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
873         aFilterMgr = self.CreateFilterManager()
874         aFilter = aFilterMgr.CreateFilter()
875         aCriteria = []
876         aCriteria.append(aCriterion)
877         aFilter.SetCriteria(aCriteria)
878         if mesh:
879             if isinstance( mesh, Mesh ): aFilter.SetMesh( mesh.GetMesh() )
880             else                       : aFilter.SetMesh( mesh )
881         aFilterMgr.UnRegister()
882         return aFilter
883
884     ## Creates a filter from criteria
885     #  @param criteria a list of criteria
886     #  @param binOp binary operator used when binary operator of criteria is undefined
887     #  @return SMESH_Filter
888     #
889     #  <a href="../tui_filters_page.html#tui_filters">Example of Filters usage</a>
890     #  @ingroup l1_controls
891     def GetFilterFromCriteria(self,criteria, binOp=SMESH.FT_LogicalAND):
892         for i in range( len( criteria ) - 1 ):
893             if criteria[i].BinaryOp == self.EnumToLong( SMESH.FT_Undefined ):
894                 criteria[i].BinaryOp = self.EnumToLong( binOp )
895         aFilterMgr = self.CreateFilterManager()
896         aFilter = aFilterMgr.CreateFilter()
897         aFilter.SetCriteria(criteria)
898         aFilterMgr.UnRegister()
899         return aFilter
900
901     ## Creates a numerical functor by its type
902     #  @param theCriterion FT_...; functor type
903     #  @return SMESH_NumericalFunctor
904     #  @ingroup l1_controls
905     def GetFunctor(self,theCriterion):
906         if isinstance( theCriterion, SMESH._objref_NumericalFunctor ):
907             return theCriterion
908         aFilterMgr = self.CreateFilterManager()
909         functor = None
910         if theCriterion == FT_AspectRatio:
911             functor = aFilterMgr.CreateAspectRatio()
912         elif theCriterion == FT_AspectRatio3D:
913             functor = aFilterMgr.CreateAspectRatio3D()
914         elif theCriterion == FT_Warping:
915             functor = aFilterMgr.CreateWarping()
916         elif theCriterion == FT_MinimumAngle:
917             functor = aFilterMgr.CreateMinimumAngle()
918         elif theCriterion == FT_Taper:
919             functor = aFilterMgr.CreateTaper()
920         elif theCriterion == FT_Skew:
921             functor = aFilterMgr.CreateSkew()
922         elif theCriterion == FT_Area:
923             functor = aFilterMgr.CreateArea()
924         elif theCriterion == FT_Volume3D:
925             functor = aFilterMgr.CreateVolume3D()
926         elif theCriterion == FT_MaxElementLength2D:
927             functor = aFilterMgr.CreateMaxElementLength2D()
928         elif theCriterion == FT_MaxElementLength3D:
929             functor = aFilterMgr.CreateMaxElementLength3D()
930         elif theCriterion == FT_MultiConnection:
931             functor = aFilterMgr.CreateMultiConnection()
932         elif theCriterion == FT_MultiConnection2D:
933             functor = aFilterMgr.CreateMultiConnection2D()
934         elif theCriterion == FT_Length:
935             functor = aFilterMgr.CreateLength()
936         elif theCriterion == FT_Length2D:
937             functor = aFilterMgr.CreateLength2D()
938         else:
939             print "Error: given parameter is not numerical functor type."
940         aFilterMgr.UnRegister()
941         return functor
942
943     ## Creates hypothesis
944     #  @param theHType mesh hypothesis type (string)
945     #  @param theLibName mesh plug-in library name
946     #  @return created hypothesis instance
947     def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"):
948         hyp = SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName )
949
950         if isinstance( hyp, SMESH._objref_SMESH_Algo ):
951             return hyp
952
953         # wrap hypothesis methods
954         #print "HYPOTHESIS", theHType
955         for meth_name in dir( hyp.__class__ ):
956             if not meth_name.startswith("Get") and \
957                not meth_name in dir ( SMESH._objref_SMESH_Hypothesis ):
958                 method = getattr ( hyp.__class__, meth_name )
959                 if callable(method):
960                     setattr( hyp, meth_name, hypMethodWrapper( hyp, method ))
961
962         return hyp
963
964     ## Gets the mesh statistic
965     #  @return dictionary "element type" - "count of elements"
966     #  @ingroup l1_meshinfo
967     def GetMeshInfo(self, obj):
968         if isinstance( obj, Mesh ):
969             obj = obj.GetMesh()
970         d = {}
971         if hasattr(obj, "GetMeshInfo"):
972             values = obj.GetMeshInfo()
973             for i in range(SMESH.Entity_Last._v):
974                 if i < len(values): d[SMESH.EntityType._item(i)]=values[i]
975             pass
976         return d
977
978     ## Get minimum distance between two objects
979     #
980     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
981     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
982     #
983     #  @param src1 first source object
984     #  @param src2 second source object
985     #  @param id1 node/element id from the first source
986     #  @param id2 node/element id from the second (or first) source
987     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
988     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
989     #  @return minimum distance value
990     #  @sa GetMinDistance()
991     #  @ingroup l1_measurements
992     def MinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
993         result = self.GetMinDistance(src1, src2, id1, id2, isElem1, isElem2)
994         if result is None:
995             result = 0.0
996         else:
997             result = result.value
998         return result
999
1000     ## Get measure structure specifying minimum distance data between two objects
1001     #
1002     #  If @a src2 is None, and @a id2 = 0, distance from @a src1 / @a id1 to the origin is computed.
1003     #  If @a src2 is None, and @a id2 != 0, it is assumed that both @a id1 and @a id2 belong to @a src1.
1004     #
1005     #  @param src1 first source object
1006     #  @param src2 second source object
1007     #  @param id1 node/element id from the first source
1008     #  @param id2 node/element id from the second (or first) source
1009     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
1010     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
1011     #  @return Measure structure or None if input data is invalid
1012     #  @sa MinDistance()
1013     #  @ingroup l1_measurements
1014     def GetMinDistance(self, src1, src2=None, id1=0, id2=0, isElem1=False, isElem2=False):
1015         if isinstance(src1, Mesh): src1 = src1.mesh
1016         if isinstance(src2, Mesh): src2 = src2.mesh
1017         if src2 is None and id2 != 0: src2 = src1
1018         if not hasattr(src1, "_narrow"): return None
1019         src1 = src1._narrow(SMESH.SMESH_IDSource)
1020         if not src1: return None
1021         unRegister = genObjUnRegister()
1022         if id1 != 0:
1023             m = src1.GetMesh()
1024             e = m.GetMeshEditor()
1025             if isElem1:
1026                 src1 = e.MakeIDSource([id1], SMESH.FACE)
1027             else:
1028                 src1 = e.MakeIDSource([id1], SMESH.NODE)
1029             unRegister.set( src1 )
1030             pass
1031         if hasattr(src2, "_narrow"):
1032             src2 = src2._narrow(SMESH.SMESH_IDSource)
1033             if src2 and id2 != 0:
1034                 m = src2.GetMesh()
1035                 e = m.GetMeshEditor()
1036                 if isElem2:
1037                     src2 = e.MakeIDSource([id2], SMESH.FACE)
1038                 else:
1039                     src2 = e.MakeIDSource([id2], SMESH.NODE)
1040                 unRegister.set( src2 )
1041                 pass
1042             pass
1043         aMeasurements = self.CreateMeasurements()
1044         unRegister.set( aMeasurements )
1045         result = aMeasurements.MinDistance(src1, src2)
1046         return result
1047
1048     ## Get bounding box of the specified object(s)
1049     #  @param objects single source object or list of source objects
1050     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
1051     #  @sa GetBoundingBox()
1052     #  @ingroup l1_measurements
1053     def BoundingBox(self, objects):
1054         result = self.GetBoundingBox(objects)
1055         if result is None:
1056             result = (0.0,)*6
1057         else:
1058             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
1059         return result
1060
1061     ## Get measure structure specifying bounding box data of the specified object(s)
1062     #  @param objects single source object or list of source objects
1063     #  @return Measure structure
1064     #  @sa BoundingBox()
1065     #  @ingroup l1_measurements
1066     def GetBoundingBox(self, objects):
1067         if isinstance(objects, tuple):
1068             objects = list(objects)
1069         if not isinstance(objects, list):
1070             objects = [objects]
1071         srclist = []
1072         for o in objects:
1073             if isinstance(o, Mesh):
1074                 srclist.append(o.mesh)
1075             elif hasattr(o, "_narrow"):
1076                 src = o._narrow(SMESH.SMESH_IDSource)
1077                 if src: srclist.append(src)
1078                 pass
1079             pass
1080         aMeasurements = self.CreateMeasurements()
1081         result = aMeasurements.BoundingBox(srclist)
1082         aMeasurements.UnRegister()
1083         return result
1084
1085     ## Get sum of lengths of all 1D elements in the mesh object.
1086     #  @param obj mesh, submesh or group
1087     #  @return sum of lengths of all 1D elements
1088     #  @ingroup l1_measurements
1089     def GetLength(self, obj):
1090         if isinstance(obj, Mesh): obj = obj.mesh
1091         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1092         aMeasurements = self.CreateMeasurements()
1093         value = aMeasurements.Length(obj)
1094         aMeasurements.UnRegister()
1095         return value
1096
1097     ## Get sum of areas of all 2D elements in the mesh object.
1098     #  @param obj mesh, submesh or group
1099     #  @return sum of areas of all 2D elements
1100     #  @ingroup l1_measurements
1101     def GetArea(self, obj):
1102         if isinstance(obj, Mesh): obj = obj.mesh
1103         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1104         aMeasurements = self.CreateMeasurements()
1105         value = aMeasurements.Area(obj)
1106         aMeasurements.UnRegister()
1107         return value
1108
1109     ## Get sum of volumes of all 3D elements in the mesh object.
1110     #  @param obj mesh, submesh or group
1111     #  @return sum of volumes of all 3D elements
1112     #  @ingroup l1_measurements
1113     def GetVolume(self, obj):
1114         if isinstance(obj, Mesh): obj = obj.mesh
1115         if isinstance(obj, Mesh_Algorithm): obj = obj.GetSubMesh()
1116         aMeasurements = self.CreateMeasurements()
1117         value = aMeasurements.Volume(obj)
1118         aMeasurements.UnRegister()
1119         return value
1120
1121     pass # end of class smeshBuilder
1122
1123 import omniORB
1124 #Registering the new proxy for SMESH_Gen
1125 omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshBuilder)
1126
1127 ## Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1128 #  interface to create or load meshes.
1129 #
1130 #  Typical use is:
1131 #  \code
1132 #    import salome
1133 #    salome.salome_init()
1134 #    from salome.smesh import smeshBuilder
1135 #    smesh = smeshBuilder.New(theStudy)
1136 #  \endcode
1137 #  @param  study     SALOME study, generally obtained by salome.myStudy.
1138 #  @param  instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1139 #  @return smeshBuilder instance
1140
1141 def New( study, instance=None):
1142     """
1143     Create a new smeshBuilder instance.The smeshBuilder class provides the Python
1144     interface to create or load meshes.
1145
1146     Typical use is:
1147         import salome
1148         salome.salome_init()
1149         from salome.smesh import smeshBuilder
1150         smesh = smeshBuilder.New(theStudy)
1151
1152     Parameters:
1153         study     SALOME study, generally obtained by salome.myStudy.
1154         instance  CORBA proxy of SMESH Engine. If None, the default Engine is used.
1155     Returns:
1156         smeshBuilder instance
1157     """
1158     global engine
1159     global smeshInst
1160     global doLcc
1161     engine = instance
1162     if engine is None:
1163       doLcc = True
1164     smeshInst = smeshBuilder()
1165     assert isinstance(smeshInst,smeshBuilder), "Smesh engine class is %s but should be smeshBuilder.smeshBuilder. Import salome.smesh.smeshBuilder before creating the instance."%smeshInst.__class__
1166     smeshInst.init_smesh(study)
1167     return smeshInst
1168
1169
1170 # Public class: Mesh
1171 # ==================
1172
1173 ## This class allows defining and managing a mesh.
1174 #  It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes.
1175 #  It also has methods to define groups of mesh elements, to modify a mesh (by addition of
1176 #  new nodes and elements and by changing the existing entities), to get information
1177 #  about a mesh and to export a mesh into different formats.
1178 class Mesh:
1179     __metaclass__ = MeshMeta
1180
1181     geom = 0
1182     mesh = 0
1183     editor = 0
1184
1185     ## Constructor
1186     #
1187     #  Creates a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and
1188     #  sets the GUI name of this mesh to \a name.
1189     #  @param smeshpyD an instance of smeshBuilder class
1190     #  @param geompyD an instance of geomBuilder class
1191     #  @param obj Shape to be meshed or SMESH_Mesh object
1192     #  @param name Study name of the mesh
1193     #  @ingroup l2_construct
1194     def __init__(self, smeshpyD, geompyD, obj=0, name=0):
1195         self.smeshpyD=smeshpyD
1196         self.geompyD=geompyD
1197         if obj is None:
1198             obj = 0
1199         objHasName = False
1200         if obj != 0:
1201             if isinstance(obj, geomBuilder.GEOM._objref_GEOM_Object):
1202                 self.geom = obj
1203                 objHasName = True
1204                 # publish geom of mesh (issue 0021122)
1205                 if not self.geom.GetStudyEntry() and smeshpyD.GetCurrentStudy():
1206                     objHasName = False
1207                     studyID = smeshpyD.GetCurrentStudy()._get_StudyId()
1208                     if studyID != geompyD.myStudyId:
1209                         geompyD.init_geom( smeshpyD.GetCurrentStudy())
1210                         pass
1211                     if name:
1212                         geo_name = name + " shape"
1213                     else:
1214                         geo_name = "%s_%s to mesh"%(self.geom.GetShapeType(), id(self.geom)%100)
1215                     geompyD.addToStudy( self.geom, geo_name )
1216                 self.SetMesh( self.smeshpyD.CreateMesh(self.geom) )
1217
1218             elif isinstance(obj, SMESH._objref_SMESH_Mesh):
1219                 self.SetMesh(obj)
1220         else:
1221             self.SetMesh( self.smeshpyD.CreateEmptyMesh() )
1222         if name:
1223             self.smeshpyD.SetName(self.mesh, name)
1224         elif objHasName:
1225             self.smeshpyD.SetName(self.mesh, GetName(obj)) # + " mesh"
1226
1227         if not self.geom:
1228             self.geom = self.mesh.GetShapeToMesh()
1229
1230         self.editor   = self.mesh.GetMeshEditor()
1231         self.functors = [None] * SMESH.FT_Undefined._v
1232
1233         # set self to algoCreator's
1234         for attrName in dir(self):
1235             attr = getattr( self, attrName )
1236             if isinstance( attr, algoCreator ):
1237                 #print "algoCreator ", attrName
1238                 setattr( self, attrName, attr.copy( self ))
1239                 pass
1240             pass
1241         pass
1242
1243     ## Destructor. Clean-up resources
1244     def __del__(self):
1245         if self.mesh:
1246             #self.mesh.UnRegister()
1247             pass
1248         pass
1249         
1250     ## Initializes the Mesh object from an instance of SMESH_Mesh interface
1251     #  @param theMesh a SMESH_Mesh object
1252     #  @ingroup l2_construct
1253     def SetMesh(self, theMesh):
1254         # do not call Register() as this prevents mesh servant deletion at closing study
1255         #if self.mesh: self.mesh.UnRegister()
1256         self.mesh = theMesh
1257         if self.mesh:
1258             #self.mesh.Register()
1259             self.geom = self.mesh.GetShapeToMesh()
1260         pass
1261
1262     ## Returns the mesh, that is an instance of SMESH_Mesh interface
1263     #  @return a SMESH_Mesh object
1264     #  @ingroup l2_construct
1265     def GetMesh(self):
1266         return self.mesh
1267
1268     ## Gets the name of the mesh
1269     #  @return the name of the mesh as a string
1270     #  @ingroup l2_construct
1271     def GetName(self):
1272         name = GetName(self.GetMesh())
1273         return name
1274
1275     ## Sets a name to the mesh
1276     #  @param name a new name of the mesh
1277     #  @ingroup l2_construct
1278     def SetName(self, name):
1279         self.smeshpyD.SetName(self.GetMesh(), name)
1280
1281     ## Gets the subMesh object associated to a \a theSubObject geometrical object.
1282     #  The subMesh object gives access to the IDs of nodes and elements.
1283     #  @param geom a geometrical object (shape)
1284     #  @param name a name for the submesh
1285     #  @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape
1286     #  @ingroup l2_submeshes
1287     def GetSubMesh(self, geom, name):
1288         AssureGeomPublished( self, geom, name )
1289         submesh = self.mesh.GetSubMesh( geom, name )
1290         return submesh
1291
1292     ## Returns the shape associated to the mesh
1293     #  @return a GEOM_Object
1294     #  @ingroup l2_construct
1295     def GetShape(self):
1296         return self.geom
1297
1298     ## Associates the given shape to the mesh (entails the recreation of the mesh)
1299     #  @param geom the shape to be meshed (GEOM_Object)
1300     #  @ingroup l2_construct
1301     def SetShape(self, geom):
1302         self.mesh = self.smeshpyD.CreateMesh(geom)
1303
1304     ## Loads mesh from the study after opening the study
1305     def Load(self):
1306         self.mesh.Load()
1307
1308     ## Returns true if the hypotheses are defined well
1309     #  @param theSubObject a sub-shape of a mesh shape
1310     #  @return True or False
1311     #  @ingroup l2_construct
1312     def IsReadyToCompute(self, theSubObject):
1313         return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject)
1314
1315     ## Returns errors of hypotheses definition.
1316     #  The list of errors is empty if everything is OK.
1317     #  @param theSubObject a sub-shape of a mesh shape
1318     #  @return a list of errors
1319     #  @ingroup l2_construct
1320     def GetAlgoState(self, theSubObject):
1321         return self.smeshpyD.GetAlgoState(self.mesh, theSubObject)
1322
1323     ## Returns a geometrical object on which the given element was built.
1324     #  The returned geometrical object, if not nil, is either found in the
1325     #  study or published by this method with the given name
1326     #  @param theElementID the id of the mesh element
1327     #  @param theGeomName the user-defined name of the geometrical object
1328     #  @return GEOM::GEOM_Object instance
1329     #  @ingroup l2_construct
1330     def GetGeometryByMeshElement(self, theElementID, theGeomName):
1331         return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName )
1332
1333     ## Returns the mesh dimension depending on the dimension of the underlying shape
1334     #  or, if the mesh is not based on any shape, basing on deimension of elements
1335     #  @return mesh dimension as an integer value [0,3]
1336     #  @ingroup l1_auxiliary
1337     def MeshDimension(self):
1338         if self.mesh.HasShapeToMesh():
1339             shells = self.geompyD.SubShapeAllIDs( self.geom, self.geompyD.ShapeType["SOLID"] )
1340             if len( shells ) > 0 :
1341                 return 3
1342             elif self.geompyD.NumberOfFaces( self.geom ) > 0 :
1343                 return 2
1344             elif self.geompyD.NumberOfEdges( self.geom ) > 0 :
1345                 return 1
1346             else:
1347                 return 0;
1348         else:
1349             if self.NbVolumes() > 0: return 3
1350             if self.NbFaces()   > 0: return 2
1351             if self.NbEdges()   > 0: return 1
1352         return 0
1353
1354     ## Evaluates size of prospective mesh on a shape
1355     #  @return a list where i-th element is a number of elements of i-th SMESH.EntityType
1356     #  To know predicted number of e.g. edges, inquire it this way
1357     #  Evaluate()[ EnumToLong( Entity_Edge )]
1358     def Evaluate(self, geom=0):
1359         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1360             if self.geom == 0:
1361                 geom = self.mesh.GetShapeToMesh()
1362             else:
1363                 geom = self.geom
1364         return self.smeshpyD.Evaluate(self.mesh, geom)
1365
1366
1367     ## Computes the mesh and returns the status of the computation
1368     #  @param geom geomtrical shape on which mesh data should be computed
1369     #  @param discardModifs if True and the mesh has been edited since
1370     #         a last total re-compute and that may prevent successful partial re-compute,
1371     #         then the mesh is cleaned before Compute()
1372     #  @return True or False
1373     #  @ingroup l2_construct
1374     def Compute(self, geom=0, discardModifs=False):
1375         if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object):
1376             if self.geom == 0:
1377                 geom = self.mesh.GetShapeToMesh()
1378             else:
1379                 geom = self.geom
1380         ok = False
1381         try:
1382             if discardModifs and self.mesh.HasModificationsToDiscard(): # issue 0020693
1383                 self.mesh.Clear()
1384             ok = self.smeshpyD.Compute(self.mesh, geom)
1385         except SALOME.SALOME_Exception, ex:
1386             print "Mesh computation failed, exception caught:"
1387             print "    ", ex.details.text
1388         except:
1389             import traceback
1390             print "Mesh computation failed, exception caught:"
1391             traceback.print_exc()
1392         if True:#not ok:
1393             allReasons = ""
1394
1395             # Treat compute errors
1396             computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, geom )
1397             for err in computeErrors:
1398                 shapeText = ""
1399                 if self.mesh.HasShapeToMesh():
1400                     try:
1401                         mainIOR  = salome.orb.object_to_string(geom)
1402                         for sname in salome.myStudyManager.GetOpenStudies():
1403                             s = salome.myStudyManager.GetStudyByName(sname)
1404                             if not s: continue
1405                             mainSO = s.FindObjectIOR(mainIOR)
1406                             if not mainSO: continue
1407                             if err.subShapeID == 1:
1408                                 shapeText = ' on "%s"' % mainSO.GetName()
1409                             subIt = s.NewChildIterator(mainSO)
1410                             while subIt.More():
1411                                 subSO = subIt.Value()
1412                                 subIt.Next()
1413                                 obj = subSO.GetObject()
1414                                 if not obj: continue
1415                                 go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object )
1416                                 if not go: continue
1417                                 ids = go.GetSubShapeIndices()
1418                                 if len(ids) == 1 and ids[0] == err.subShapeID:
1419                                     shapeText = ' on "%s"' % subSO.GetName()
1420                                     break
1421                         if not shapeText:
1422                             shape = self.geompyD.GetSubShape( geom, [err.subShapeID])
1423                             if shape:
1424                                 shapeText = " on %s #%s" % (shape.GetShapeType(), err.subShapeID)
1425                             else:
1426                                 shapeText = " on subshape #%s" % (err.subShapeID)
1427                     except:
1428                         shapeText = " on subshape #%s" % (err.subShapeID)
1429                 errText = ""
1430                 stdErrors = ["OK",                   #COMPERR_OK
1431                              "Invalid input mesh",   #COMPERR_BAD_INPUT_MESH
1432                              "std::exception",       #COMPERR_STD_EXCEPTION
1433                              "OCC exception",        #COMPERR_OCC_EXCEPTION
1434                              "..",                   #COMPERR_SLM_EXCEPTION
1435                              "Unknown exception",    #COMPERR_EXCEPTION
1436                              "Memory allocation problem", #COMPERR_MEMORY_PB
1437                              "Algorithm failed",     #COMPERR_ALGO_FAILED
1438                              "Unexpected geometry",  #COMPERR_BAD_SHAPE
1439                              "Warning",              #COMPERR_WARNING
1440                              "Computation cancelled",#COMPERR_CANCELED
1441                              "No mesh on sub-shape"] #COMPERR_NO_MESH_ON_SHAPE
1442                 if err.code > 0:
1443                     if err.code < len(stdErrors): errText = stdErrors[err.code]
1444                 else:
1445                     errText = "code %s" % -err.code
1446                 if errText: errText += ". "
1447                 errText += err.comment
1448                 if allReasons != "":allReasons += "\n"
1449                 if ok:
1450                     allReasons += '-  "%s"%s - %s' %(err.algoName, shapeText, errText)
1451                 else:
1452                     allReasons += '-  "%s" failed%s. Error: %s' %(err.algoName, shapeText, errText)
1453                 pass
1454
1455             # Treat hyp errors
1456             errors = self.smeshpyD.GetAlgoState( self.mesh, geom )
1457             for err in errors:
1458                 if err.isGlobalAlgo:
1459                     glob = "global"
1460                 else:
1461                     glob = "local"
1462                     pass
1463                 dim = err.algoDim
1464                 name = err.algoName
1465                 if len(name) == 0:
1466                     reason = '%s %sD algorithm is missing' % (glob, dim)
1467                 elif err.state == HYP_MISSING:
1468                     reason = ('%s %sD algorithm "%s" misses %sD hypothesis'
1469                               % (glob, dim, name, dim))
1470                 elif err.state == HYP_NOTCONFORM:
1471                     reason = 'Global "Not Conform mesh allowed" hypothesis is missing'
1472                 elif err.state == HYP_BAD_PARAMETER:
1473                     reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value'
1474                               % ( glob, dim, name ))
1475                 elif err.state == HYP_BAD_GEOMETRY:
1476                     reason = ('%s %sD algorithm "%s" is assigned to mismatching'
1477                               'geometry' % ( glob, dim, name ))
1478                 elif err.state == HYP_HIDDEN_ALGO:
1479                     reason = ('%s %sD algorithm "%s" is ignored due to presence of a %s '
1480                               'algorithm of upper dimension generating %sD mesh'
1481                               % ( glob, dim, name, glob, dim ))
1482                 else:
1483                     reason = ("For unknown reason. "
1484                               "Developer, revise Mesh.Compute() implementation in smeshBuilder.py!")
1485                     pass
1486                 if allReasons != "":allReasons += "\n"
1487                 allReasons += "-  " + reason
1488                 pass
1489             if not ok or allReasons != "":
1490                 msg = '"' + GetName(self.mesh) + '"'
1491                 if ok: msg += " has been computed with warnings"
1492                 else:  msg += " has not been computed"
1493                 if allReasons != "": msg += ":"
1494                 else:                msg += "."
1495                 print msg
1496                 print allReasons
1497             pass
1498         if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0:
1499             smeshgui = salome.ImportComponentGUI("SMESH")
1500             smeshgui.Init(self.mesh.GetStudyId())
1501             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) )
1502             salome.sg.updateObjBrowser(1)
1503             pass
1504         return ok
1505
1506     ## Return submesh objects list in meshing order
1507     #  @return list of list of submesh objects
1508     #  @ingroup l2_construct
1509     def GetMeshOrder(self):
1510         return self.mesh.GetMeshOrder()
1511
1512     ## Return submesh objects list in meshing order
1513     #  @return list of list of submesh objects
1514     #  @ingroup l2_construct
1515     def SetMeshOrder(self, submeshes):
1516         return self.mesh.SetMeshOrder(submeshes)
1517
1518     ## Removes all nodes and elements
1519     #  @ingroup l2_construct
1520     def Clear(self):
1521         self.mesh.Clear()
1522         if ( salome.sg.hasDesktop() and 
1523              salome.myStudyManager.GetStudyByID( self.mesh.GetStudyId() )):
1524             smeshgui = salome.ImportComponentGUI("SMESH")
1525             smeshgui.Init(self.mesh.GetStudyId())
1526             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1527             salome.sg.updateObjBrowser(1)
1528
1529     ## Removes all nodes and elements of indicated shape
1530     #  @ingroup l2_construct
1531     def ClearSubMesh(self, geomId):
1532         self.mesh.ClearSubMesh(geomId)
1533         if salome.sg.hasDesktop():
1534             smeshgui = salome.ImportComponentGUI("SMESH")
1535             smeshgui.Init(self.mesh.GetStudyId())
1536             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1537             salome.sg.updateObjBrowser(1)
1538
1539     ## Computes a tetrahedral mesh using AutomaticLength + MEFISTO + Tetrahedron
1540     #  @param fineness [0.0,1.0] defines mesh fineness
1541     #  @return True or False
1542     #  @ingroup l3_algos_basic
1543     def AutomaticTetrahedralization(self, fineness=0):
1544         dim = self.MeshDimension()
1545         # assign hypotheses
1546         self.RemoveGlobalHypotheses()
1547         self.Segment().AutomaticLength(fineness)
1548         if dim > 1 :
1549             self.Triangle().LengthFromEdges()
1550             pass
1551         if dim > 2 :
1552             self.Tetrahedron()
1553             pass
1554         return self.Compute()
1555
1556     ## Computes an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron
1557     #  @param fineness [0.0, 1.0] defines mesh fineness
1558     #  @return True or False
1559     #  @ingroup l3_algos_basic
1560     def AutomaticHexahedralization(self, fineness=0):
1561         dim = self.MeshDimension()
1562         # assign the hypotheses
1563         self.RemoveGlobalHypotheses()
1564         self.Segment().AutomaticLength(fineness)
1565         if dim > 1 :
1566             self.Quadrangle()
1567             pass
1568         if dim > 2 :
1569             self.Hexahedron()
1570             pass
1571         return self.Compute()
1572
1573     ## Assigns a hypothesis
1574     #  @param hyp a hypothesis to assign
1575     #  @param geom a subhape of mesh geometry
1576     #  @return SMESH.Hypothesis_Status
1577     #  @ingroup l2_hypotheses
1578     def AddHypothesis(self, hyp, geom=0):
1579         if isinstance( hyp, Mesh_Algorithm ):
1580             hyp = hyp.GetAlgorithm()
1581             pass
1582         if not geom:
1583             geom = self.geom
1584             if not geom:
1585                 geom = self.mesh.GetShapeToMesh()
1586             pass
1587         isApplicable = True
1588         if self.mesh.HasShapeToMesh():
1589             hyp_type     = hyp.GetName()
1590             lib_name     = hyp.GetLibName()
1591             checkAll    = ( not geom.IsSame( self.mesh.GetShapeToMesh() ))
1592             if checkAll and geom:
1593                 checkAll = geom.GetType() == 37
1594             isApplicable = self.smeshpyD.IsApplicable(hyp_type, lib_name, geom, checkAll)
1595         if isApplicable:
1596             AssureGeomPublished( self, geom, "shape for %s" % hyp.GetName())
1597             status = self.mesh.AddHypothesis(geom, hyp)
1598         else:
1599             status = HYP_BAD_GEOMETRY,""
1600         hyp_name = GetName( hyp )
1601         geom_name = ""
1602         if geom:
1603             geom_name = geom.GetName()
1604         isAlgo = hyp._narrow( SMESH_Algo )
1605         TreatHypoStatus( status, hyp_name, geom_name, isAlgo, self )
1606         return status
1607
1608     ## Return True if an algorithm of hypothesis is assigned to a given shape
1609     #  @param hyp a hypothesis to check
1610     #  @param geom a subhape of mesh geometry
1611     #  @return True of False
1612     #  @ingroup l2_hypotheses
1613     def IsUsedHypothesis(self, hyp, geom):
1614         if not hyp: # or not geom
1615             return False
1616         if isinstance( hyp, Mesh_Algorithm ):
1617             hyp = hyp.GetAlgorithm()
1618             pass
1619         hyps = self.GetHypothesisList(geom)
1620         for h in hyps:
1621             if h.GetId() == hyp.GetId():
1622                 return True
1623         return False
1624
1625     ## Unassigns a hypothesis
1626     #  @param hyp a hypothesis to unassign
1627     #  @param geom a sub-shape of mesh geometry
1628     #  @return SMESH.Hypothesis_Status
1629     #  @ingroup l2_hypotheses
1630     def RemoveHypothesis(self, hyp, geom=0):
1631         if not hyp:
1632             return None
1633         if isinstance( hyp, Mesh_Algorithm ):
1634             hyp = hyp.GetAlgorithm()
1635             pass
1636         shape = geom
1637         if not shape:
1638             shape = self.geom
1639             pass
1640         if self.IsUsedHypothesis( hyp, shape ):
1641             return self.mesh.RemoveHypothesis( shape, hyp )
1642         hypName = GetName( hyp )
1643         geoName = GetName( shape )
1644         print "WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName )
1645         return None
1646
1647     ## Gets the list of hypotheses added on a geometry
1648     #  @param geom a sub-shape of mesh geometry
1649     #  @return the sequence of SMESH_Hypothesis
1650     #  @ingroup l2_hypotheses
1651     def GetHypothesisList(self, geom):
1652         return self.mesh.GetHypothesisList( geom )
1653
1654     ## Removes all global hypotheses
1655     #  @ingroup l2_hypotheses
1656     def RemoveGlobalHypotheses(self):
1657         current_hyps = self.mesh.GetHypothesisList( self.geom )
1658         for hyp in current_hyps:
1659             self.mesh.RemoveHypothesis( self.geom, hyp )
1660             pass
1661         pass
1662
1663    ## Exports the mesh in a file in MED format and chooses the \a version of MED format
1664     ## allowing to overwrite the file if it exists or add the exported data to its contents
1665     #  @param f is the file name
1666     #  @param auto_groups boolean parameter for creating/not creating
1667     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1668     #  the typical use is auto_groups=false.
1669     #  @param version MED format version(MED_V2_1 or MED_V2_2)
1670     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1671     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1672     #  @param autoDimension: if @c True (default), a space dimension of a MED mesh can be either
1673     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1674     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1675     #         - 3D in the rest cases.
1676     #         If @a autoDimension is @c False, the space dimension is always 3.
1677     #  @param fields : list of GEOM fields defined on the shape to mesh.
1678     #  @param geomAssocFields : each character of this string means a need to export a 
1679     #         corresponding field; correspondence between fields and characters is following:
1680     #         - 'v' stands for _vertices_ field;
1681     #         - 'e' stands for _edges_ field;
1682     #         - 'f' stands for _faces_ field;
1683     #         - 's' stands for _solids_ field.
1684     #  @ingroup l2_impexp
1685     def ExportMED(self, f, auto_groups=0, version=MED_V2_2,
1686                   overwrite=1, meshPart=None, autoDimension=True, fields=[], geomAssocFields=''):
1687         if meshPart or fields or geomAssocFields:
1688             unRegister = genObjUnRegister()
1689             if isinstance( meshPart, list ):
1690                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1691                 unRegister.set( meshPart )
1692             self.mesh.ExportPartToMED( meshPart, f, auto_groups, version, overwrite, autoDimension,
1693                                        fields, geomAssocFields)
1694         else:
1695             self.mesh.ExportToMEDX(f, auto_groups, version, overwrite, autoDimension)
1696
1697     ## Exports the mesh in a file in SAUV format
1698     #  @param f is the file name
1699     #  @param auto_groups boolean parameter for creating/not creating
1700     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1701     #  the typical use is auto_groups=false.
1702     #  @ingroup l2_impexp
1703     def ExportSAUV(self, f, auto_groups=0):
1704         self.mesh.ExportSAUV(f, auto_groups)
1705
1706     ## Exports the mesh in a file in DAT format
1707     #  @param f the file name
1708     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1709     #  @ingroup l2_impexp
1710     def ExportDAT(self, f, meshPart=None):
1711         if meshPart:
1712             unRegister = genObjUnRegister()
1713             if isinstance( meshPart, list ):
1714                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1715                 unRegister.set( meshPart )
1716             self.mesh.ExportPartToDAT( meshPart, f )
1717         else:
1718             self.mesh.ExportDAT(f)
1719
1720     ## Exports the mesh in a file in UNV format
1721     #  @param f the file name
1722     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1723     #  @ingroup l2_impexp
1724     def ExportUNV(self, f, meshPart=None):
1725         if meshPart:
1726             unRegister = genObjUnRegister()
1727             if isinstance( meshPart, list ):
1728                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1729                 unRegister.set( meshPart )
1730             self.mesh.ExportPartToUNV( meshPart, f )
1731         else:
1732             self.mesh.ExportUNV(f)
1733
1734     ## Export the mesh in a file in STL format
1735     #  @param f the file name
1736     #  @param ascii defines the file encoding
1737     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1738     #  @ingroup l2_impexp
1739     def ExportSTL(self, f, ascii=1, meshPart=None):
1740         if meshPart:
1741             unRegister = genObjUnRegister()
1742             if isinstance( meshPart, list ):
1743                 meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1744                 unRegister.set( meshPart )
1745             self.mesh.ExportPartToSTL( meshPart, f, ascii )
1746         else:
1747             self.mesh.ExportSTL(f, ascii)
1748
1749     ## Exports the mesh in a file in CGNS format
1750     #  @param f is the file name
1751     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1752     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1753     #  @ingroup l2_impexp
1754     def ExportCGNS(self, f, overwrite=1, meshPart=None):
1755         unRegister = genObjUnRegister()
1756         if isinstance( meshPart, list ):
1757             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1758             unRegister.set( meshPart )
1759         if isinstance( meshPart, Mesh ):
1760             meshPart = meshPart.mesh
1761         elif not meshPart:
1762             meshPart = self.mesh
1763         self.mesh.ExportCGNS(meshPart, f, overwrite)
1764
1765     ## Exports the mesh in a file in GMF format.
1766     #  GMF files must have .mesh extension for the ASCII format and .meshb for
1767     #  the bynary format. Other extensions are not allowed.
1768     #  @param f is the file name
1769     #  @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh
1770     #  @ingroup l2_impexp
1771     def ExportGMF(self, f, meshPart=None):
1772         unRegister = genObjUnRegister()
1773         if isinstance( meshPart, list ):
1774             meshPart = self.GetIDSource( meshPart, SMESH.ALL )
1775             unRegister.set( meshPart )
1776         if isinstance( meshPart, Mesh ):
1777             meshPart = meshPart.mesh
1778         elif not meshPart:
1779             meshPart = self.mesh
1780         self.mesh.ExportGMF(meshPart, f, True)
1781
1782     ## Deprecated, used only for compatibility! Please, use ExportToMEDX() method instead.
1783     #  Exports the mesh in a file in MED format and chooses the \a version of MED format
1784     ## allowing to overwrite the file if it exists or add the exported data to its contents
1785     #  @param f the file name
1786     #  @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2
1787     #  @param opt boolean parameter for creating/not creating
1788     #         the groups Group_On_All_Nodes, Group_On_All_Faces, ...
1789     #  @param overwrite boolean parameter for overwriting/not overwriting the file
1790     #  @param autoDimension: if @c True (default), a space dimension of a MED mesh can be either
1791     #         - 1D if all mesh nodes lie on OX coordinate axis, or
1792     #         - 2D if all mesh nodes lie on XOY coordinate plane, or
1793     #         - 3D in the rest cases.
1794     #
1795     #         If @a autoDimension is @c False, the space dimension is always 3.
1796     #  @ingroup l2_impexp
1797     def ExportToMED(self, f, version, opt=0, overwrite=1, autoDimension=True):
1798         self.mesh.ExportToMEDX(f, opt, version, overwrite, autoDimension)
1799
1800     # Operations with groups:
1801     # ----------------------
1802
1803     ## Creates an empty mesh group
1804     #  @param elementType the type of elements in the group
1805     #  @param name the name of the mesh group
1806     #  @return SMESH_Group
1807     #  @ingroup l2_grps_create
1808     def CreateEmptyGroup(self, elementType, name):
1809         return self.mesh.CreateGroup(elementType, name)
1810
1811     ## Creates a mesh group based on the geometric object \a grp
1812     #  and gives a \a name, \n if this parameter is not defined
1813     #  the name is the same as the geometric group name \n
1814     #  Note: Works like GroupOnGeom().
1815     #  @param grp  a geometric group, a vertex, an edge, a face or a solid
1816     #  @param name the name of the mesh group
1817     #  @return SMESH_GroupOnGeom
1818     #  @ingroup l2_grps_create
1819     def Group(self, grp, name=""):
1820         return self.GroupOnGeom(grp, name)
1821
1822     ## Creates a mesh group based on the geometrical object \a grp
1823     #  and gives a \a name, \n if this parameter is not defined
1824     #  the name is the same as the geometrical group name
1825     #  @param grp  a geometrical group, a vertex, an edge, a face or a solid
1826     #  @param name the name of the mesh group
1827     #  @param typ  the type of elements in the group. If not set, it is
1828     #              automatically detected by the type of the geometry
1829     #  @return SMESH_GroupOnGeom
1830     #  @ingroup l2_grps_create
1831     def GroupOnGeom(self, grp, name="", typ=None):
1832         AssureGeomPublished( self, grp, name )
1833         if name == "":
1834             name = grp.GetName()
1835         if not typ:
1836             typ = self._groupTypeFromShape( grp )
1837         return self.mesh.CreateGroupFromGEOM(typ, name, grp)
1838
1839     ## Pivate method to get a type of group on geometry
1840     def _groupTypeFromShape( self, shape ):
1841         tgeo = str(shape.GetShapeType())
1842         if tgeo == "VERTEX":
1843             typ = NODE
1844         elif tgeo == "EDGE":
1845             typ = EDGE
1846         elif tgeo == "FACE" or tgeo == "SHELL":
1847             typ = FACE
1848         elif tgeo == "SOLID" or tgeo == "COMPSOLID":
1849             typ = VOLUME
1850         elif tgeo == "COMPOUND":
1851             sub = self.geompyD.SubShapeAll( shape, self.geompyD.ShapeType["SHAPE"])
1852             if not sub:
1853                 raise ValueError,"_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape)
1854             return self._groupTypeFromShape( sub[0] )
1855         else:
1856             raise ValueError, \
1857                   "_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape)
1858         return typ
1859
1860     ## Creates a mesh group with given \a name based on the \a filter which
1861     ## is a special type of group dynamically updating it's contents during
1862     ## mesh modification
1863     #  @param typ  the type of elements in the group
1864     #  @param name the name of the mesh group
1865     #  @param filter the filter defining group contents
1866     #  @return SMESH_GroupOnFilter
1867     #  @ingroup l2_grps_create
1868     def GroupOnFilter(self, typ, name, filter):
1869         return self.mesh.CreateGroupFromFilter(typ, name, filter)
1870
1871     ## Creates a mesh group by the given ids of elements
1872     #  @param groupName the name of the mesh group
1873     #  @param elementType the type of elements in the group
1874     #  @param elemIDs the list of ids
1875     #  @return SMESH_Group
1876     #  @ingroup l2_grps_create
1877     def MakeGroupByIds(self, groupName, elementType, elemIDs):
1878         group = self.mesh.CreateGroup(elementType, groupName)
1879         if hasattr( elemIDs, "GetIDs" ):
1880             if hasattr( elemIDs, "SetMesh" ):
1881                 elemIDs.SetMesh( self.GetMesh() )
1882             group.AddFrom( elemIDs )
1883         else:
1884             group.Add(elemIDs)
1885         return group
1886
1887     ## Creates a mesh group by the given conditions
1888     #  @param groupName the name of the mesh group
1889     #  @param elementType the type of elements in the group
1890     #  @param CritType the type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
1891     #  @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
1892     #  @param Threshold the threshold value (range of id ids as string, shape, numeric)
1893     #  @param UnaryOp FT_LogicalNOT or FT_Undefined
1894     #  @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface,
1895     #         FT_LyingOnGeom, FT_CoplanarFaces criteria
1896     #  @return SMESH_GroupOnFilter
1897     #  @ingroup l2_grps_create
1898     def MakeGroup(self,
1899                   groupName,
1900                   elementType,
1901                   CritType=FT_Undefined,
1902                   Compare=FT_EqualTo,
1903                   Threshold="",
1904                   UnaryOp=FT_Undefined,
1905                   Tolerance=1e-07):
1906         aCriterion = self.smeshpyD.GetCriterion(elementType, CritType, Compare, Threshold, UnaryOp, FT_Undefined,Tolerance)
1907         group = self.MakeGroupByCriterion(groupName, aCriterion)
1908         return group
1909
1910     ## Creates a mesh group by the given criterion
1911     #  @param groupName the name of the mesh group
1912     #  @param Criterion the instance of Criterion class
1913     #  @return SMESH_GroupOnFilter
1914     #  @ingroup l2_grps_create
1915     def MakeGroupByCriterion(self, groupName, Criterion):
1916         return self.MakeGroupByCriteria( groupName, [Criterion] )
1917
1918     ## Creates a mesh group by the given criteria (list of criteria)
1919     #  @param groupName the name of the mesh group
1920     #  @param theCriteria the list of criteria
1921     #  @param binOp binary operator used when binary operator of criteria is undefined
1922     #  @return SMESH_GroupOnFilter
1923     #  @ingroup l2_grps_create
1924     def MakeGroupByCriteria(self, groupName, theCriteria, binOp=SMESH.FT_LogicalAND):
1925         aFilter = self.smeshpyD.GetFilterFromCriteria( theCriteria, binOp )
1926         group = self.MakeGroupByFilter(groupName, aFilter)
1927         return group
1928
1929     ## Creates a mesh group by the given filter
1930     #  @param groupName the name of the mesh group
1931     #  @param theFilter the instance of Filter class
1932     #  @return SMESH_GroupOnFilter
1933     #  @ingroup l2_grps_create
1934     def MakeGroupByFilter(self, groupName, theFilter):
1935         #group = self.CreateEmptyGroup(theFilter.GetElementType(), groupName)
1936         #theFilter.SetMesh( self.mesh )
1937         #group.AddFrom( theFilter )
1938         group = self.GroupOnFilter( theFilter.GetElementType(), groupName, theFilter )
1939         return group
1940
1941     ## Removes a group
1942     #  @ingroup l2_grps_delete
1943     def RemoveGroup(self, group):
1944         self.mesh.RemoveGroup(group)
1945
1946     ## Removes a group with its contents
1947     #  @ingroup l2_grps_delete
1948     def RemoveGroupWithContents(self, group):
1949         self.mesh.RemoveGroupWithContents(group)
1950
1951     ## Gets the list of groups existing in the mesh in the order of creation (starting from the oldest one)
1952     #  @return a sequence of SMESH_GroupBase
1953     #  @ingroup l2_grps_create
1954     def GetGroups(self):
1955         return self.mesh.GetGroups()
1956
1957     ## Gets the number of groups existing in the mesh
1958     #  @return the quantity of groups as an integer value
1959     #  @ingroup l2_grps_create
1960     def NbGroups(self):
1961         return self.mesh.NbGroups()
1962
1963     ## Gets the list of names of groups existing in the mesh
1964     #  @return list of strings
1965     #  @ingroup l2_grps_create
1966     def GetGroupNames(self):
1967         groups = self.GetGroups()
1968         names = []
1969         for group in groups:
1970             names.append(group.GetName())
1971         return names
1972
1973     ## Produces a union of two groups
1974     #  A new group is created. All mesh elements that are
1975     #  present in the initial groups are added to the new one
1976     #  @return an instance of SMESH_Group
1977     #  @ingroup l2_grps_operon
1978     def UnionGroups(self, group1, group2, name):
1979         return self.mesh.UnionGroups(group1, group2, name)
1980
1981     ## Produces a union list of groups
1982     #  New group is created. All mesh elements that are present in
1983     #  initial groups are added to the new one
1984     #  @return an instance of SMESH_Group
1985     #  @ingroup l2_grps_operon
1986     def UnionListOfGroups(self, groups, name):
1987       return self.mesh.UnionListOfGroups(groups, name)
1988
1989     ## Prodices an intersection of two groups
1990     #  A new group is created. All mesh elements that are common
1991     #  for the two initial groups are added to the new one.
1992     #  @return an instance of SMESH_Group
1993     #  @ingroup l2_grps_operon
1994     def IntersectGroups(self, group1, group2, name):
1995         return self.mesh.IntersectGroups(group1, group2, name)
1996
1997     ## Produces an intersection of groups
1998     #  New group is created. All mesh elements that are present in all
1999     #  initial groups simultaneously are added to the new one
2000     #  @return an instance of SMESH_Group
2001     #  @ingroup l2_grps_operon
2002     def IntersectListOfGroups(self, groups, name):
2003       return self.mesh.IntersectListOfGroups(groups, name)
2004
2005     ## Produces a cut of two groups
2006     #  A new group is created. All mesh elements that are present in
2007     #  the main group but are not present in the tool group are added to the new one
2008     #  @return an instance of SMESH_Group
2009     #  @ingroup l2_grps_operon
2010     def CutGroups(self, main_group, tool_group, name):
2011         return self.mesh.CutGroups(main_group, tool_group, name)
2012
2013     ## Produces a cut of groups
2014     #  A new group is created. All mesh elements that are present in main groups
2015     #  but do not present in tool groups are added to the new one
2016     #  @return an instance of SMESH_Group
2017     #  @ingroup l2_grps_operon
2018     def CutListOfGroups(self, main_groups, tool_groups, name):
2019       return self.mesh.CutListOfGroups(main_groups, tool_groups, name)
2020
2021     ## Produces a group of elements of specified type using list of existing groups
2022     #  A new group is created. System
2023     #  1) extracts all nodes on which groups elements are built
2024     #  2) combines all elements of specified dimension laying on these nodes
2025     #  @return an instance of SMESH_Group
2026     #  @ingroup l2_grps_operon
2027     def CreateDimGroup(self, groups, elem_type, name):
2028       return self.mesh.CreateDimGroup(groups, elem_type, name)
2029
2030
2031     ## Convert group on geom into standalone group
2032     #  @ingroup l2_grps_delete
2033     def ConvertToStandalone(self, group):
2034         return self.mesh.ConvertToStandalone(group)
2035
2036     # Get some info about mesh:
2037     # ------------------------
2038
2039     ## Returns the log of nodes and elements added or removed
2040     #  since the previous clear of the log.
2041     #  @param clearAfterGet log is emptied after Get (safe if concurrents access)
2042     #  @return list of log_block structures:
2043     #                                        commandType
2044     #                                        number
2045     #                                        coords
2046     #                                        indexes
2047     #  @ingroup l1_auxiliary
2048     def GetLog(self, clearAfterGet):
2049         return self.mesh.GetLog(clearAfterGet)
2050
2051     ## Clears the log of nodes and elements added or removed since the previous
2052     #  clear. Must be used immediately after GetLog if clearAfterGet is false.
2053     #  @ingroup l1_auxiliary
2054     def ClearLog(self):
2055         self.mesh.ClearLog()
2056
2057     ## Toggles auto color mode on the object.
2058     #  @param theAutoColor the flag which toggles auto color mode.
2059     #  @ingroup l1_auxiliary
2060     def SetAutoColor(self, theAutoColor):
2061         self.mesh.SetAutoColor(theAutoColor)
2062
2063     ## Gets flag of object auto color mode.
2064     #  @return True or False
2065     #  @ingroup l1_auxiliary
2066     def GetAutoColor(self):
2067         return self.mesh.GetAutoColor()
2068
2069     ## Gets the internal ID
2070     #  @return integer value, which is the internal Id of the mesh
2071     #  @ingroup l1_auxiliary
2072     def GetId(self):
2073         return self.mesh.GetId()
2074
2075     ## Get the study Id
2076     #  @return integer value, which is the study Id of the mesh
2077     #  @ingroup l1_auxiliary
2078     def GetStudyId(self):
2079         return self.mesh.GetStudyId()
2080
2081     ## Checks the group names for duplications.
2082     #  Consider the maximum group name length stored in MED file.
2083     #  @return True or False
2084     #  @ingroup l1_auxiliary
2085     def HasDuplicatedGroupNamesMED(self):
2086         return self.mesh.HasDuplicatedGroupNamesMED()
2087
2088     ## Obtains the mesh editor tool
2089     #  @return an instance of SMESH_MeshEditor
2090     #  @ingroup l1_modifying
2091     def GetMeshEditor(self):
2092         return self.editor
2093
2094     ## Wrap a list of IDs of elements or nodes into SMESH_IDSource which
2095     #  can be passed as argument to a method accepting mesh, group or sub-mesh
2096     #  @return an instance of SMESH_IDSource
2097     #  @ingroup l1_auxiliary
2098     def GetIDSource(self, ids, elemType):
2099         return self.editor.MakeIDSource(ids, elemType)
2100
2101
2102     # Get informations about mesh contents:
2103     # ------------------------------------
2104
2105     ## Gets the mesh stattistic
2106     #  @return dictionary type element - count of elements
2107     #  @ingroup l1_meshinfo
2108     def GetMeshInfo(self, obj = None):
2109         if not obj: obj = self.mesh
2110         return self.smeshpyD.GetMeshInfo(obj)
2111
2112     ## Returns the number of nodes in the mesh
2113     #  @return an integer value
2114     #  @ingroup l1_meshinfo
2115     def NbNodes(self):
2116         return self.mesh.NbNodes()
2117
2118     ## Returns the number of elements in the mesh
2119     #  @return an integer value
2120     #  @ingroup l1_meshinfo
2121     def NbElements(self):
2122         return self.mesh.NbElements()
2123
2124     ## Returns the number of 0d elements in the mesh
2125     #  @return an integer value
2126     #  @ingroup l1_meshinfo
2127     def Nb0DElements(self):
2128         return self.mesh.Nb0DElements()
2129
2130     ## Returns the number of ball discrete elements in the mesh
2131     #  @return an integer value
2132     #  @ingroup l1_meshinfo
2133     def NbBalls(self):
2134         return self.mesh.NbBalls()
2135
2136     ## Returns the number of edges in the mesh
2137     #  @return an integer value
2138     #  @ingroup l1_meshinfo
2139     def NbEdges(self):
2140         return self.mesh.NbEdges()
2141
2142     ## Returns the number of edges with the given order in the mesh
2143     #  @param elementOrder the order of elements:
2144     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2145     #  @return an integer value
2146     #  @ingroup l1_meshinfo
2147     def NbEdgesOfOrder(self, elementOrder):
2148         return self.mesh.NbEdgesOfOrder(elementOrder)
2149
2150     ## Returns the number of faces in the mesh
2151     #  @return an integer value
2152     #  @ingroup l1_meshinfo
2153     def NbFaces(self):
2154         return self.mesh.NbFaces()
2155
2156     ## Returns the number of faces with the given order in the mesh
2157     #  @param elementOrder the order of elements:
2158     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2159     #  @return an integer value
2160     #  @ingroup l1_meshinfo
2161     def NbFacesOfOrder(self, elementOrder):
2162         return self.mesh.NbFacesOfOrder(elementOrder)
2163
2164     ## Returns the number of triangles in the mesh
2165     #  @return an integer value
2166     #  @ingroup l1_meshinfo
2167     def NbTriangles(self):
2168         return self.mesh.NbTriangles()
2169
2170     ## Returns the number of triangles with the given order in the mesh
2171     #  @param elementOrder is the order of elements:
2172     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2173     #  @return an integer value
2174     #  @ingroup l1_meshinfo
2175     def NbTrianglesOfOrder(self, elementOrder):
2176         return self.mesh.NbTrianglesOfOrder(elementOrder)
2177
2178     ## Returns the number of biquadratic triangles in the mesh
2179     #  @return an integer value
2180     #  @ingroup l1_meshinfo
2181     def NbBiQuadTriangles(self):
2182         return self.mesh.NbBiQuadTriangles()
2183
2184     ## Returns the number of quadrangles in the mesh
2185     #  @return an integer value
2186     #  @ingroup l1_meshinfo
2187     def NbQuadrangles(self):
2188         return self.mesh.NbQuadrangles()
2189
2190     ## Returns the number of quadrangles with the given order in the mesh
2191     #  @param elementOrder the order of elements:
2192     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2193     #  @return an integer value
2194     #  @ingroup l1_meshinfo
2195     def NbQuadranglesOfOrder(self, elementOrder):
2196         return self.mesh.NbQuadranglesOfOrder(elementOrder)
2197
2198     ## Returns the number of biquadratic quadrangles in the mesh
2199     #  @return an integer value
2200     #  @ingroup l1_meshinfo
2201     def NbBiQuadQuadrangles(self):
2202         return self.mesh.NbBiQuadQuadrangles()
2203
2204     ## Returns the number of polygons in the mesh
2205     #  @return an integer value
2206     #  @ingroup l1_meshinfo
2207     def NbPolygons(self):
2208         return self.mesh.NbPolygons()
2209
2210     ## Returns the number of volumes in the mesh
2211     #  @return an integer value
2212     #  @ingroup l1_meshinfo
2213     def NbVolumes(self):
2214         return self.mesh.NbVolumes()
2215
2216     ## Returns the number of volumes with the given order in the mesh
2217     #  @param elementOrder  the order of elements:
2218     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2219     #  @return an integer value
2220     #  @ingroup l1_meshinfo
2221     def NbVolumesOfOrder(self, elementOrder):
2222         return self.mesh.NbVolumesOfOrder(elementOrder)
2223
2224     ## Returns the number of tetrahedrons in the mesh
2225     #  @return an integer value
2226     #  @ingroup l1_meshinfo
2227     def NbTetras(self):
2228         return self.mesh.NbTetras()
2229
2230     ## Returns the number of tetrahedrons with the given order in the mesh
2231     #  @param elementOrder  the order of elements:
2232     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2233     #  @return an integer value
2234     #  @ingroup l1_meshinfo
2235     def NbTetrasOfOrder(self, elementOrder):
2236         return self.mesh.NbTetrasOfOrder(elementOrder)
2237
2238     ## Returns the number of hexahedrons in the mesh
2239     #  @return an integer value
2240     #  @ingroup l1_meshinfo
2241     def NbHexas(self):
2242         return self.mesh.NbHexas()
2243
2244     ## Returns the number of hexahedrons with the given order in the mesh
2245     #  @param elementOrder  the order of elements:
2246     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2247     #  @return an integer value
2248     #  @ingroup l1_meshinfo
2249     def NbHexasOfOrder(self, elementOrder):
2250         return self.mesh.NbHexasOfOrder(elementOrder)
2251
2252     ## Returns the number of triquadratic hexahedrons in the mesh
2253     #  @return an integer value
2254     #  @ingroup l1_meshinfo
2255     def NbTriQuadraticHexas(self):
2256         return self.mesh.NbTriQuadraticHexas()
2257
2258     ## Returns the number of pyramids in the mesh
2259     #  @return an integer value
2260     #  @ingroup l1_meshinfo
2261     def NbPyramids(self):
2262         return self.mesh.NbPyramids()
2263
2264     ## Returns the number of pyramids with the given order in the mesh
2265     #  @param elementOrder  the order of elements:
2266     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2267     #  @return an integer value
2268     #  @ingroup l1_meshinfo
2269     def NbPyramidsOfOrder(self, elementOrder):
2270         return self.mesh.NbPyramidsOfOrder(elementOrder)
2271
2272     ## Returns the number of prisms in the mesh
2273     #  @return an integer value
2274     #  @ingroup l1_meshinfo
2275     def NbPrisms(self):
2276         return self.mesh.NbPrisms()
2277
2278     ## Returns the number of prisms with the given order in the mesh
2279     #  @param elementOrder  the order of elements:
2280     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
2281     #  @return an integer value
2282     #  @ingroup l1_meshinfo
2283     def NbPrismsOfOrder(self, elementOrder):
2284         return self.mesh.NbPrismsOfOrder(elementOrder)
2285
2286     ## Returns the number of hexagonal prisms in the mesh
2287     #  @return an integer value
2288     #  @ingroup l1_meshinfo
2289     def NbHexagonalPrisms(self):
2290         return self.mesh.NbHexagonalPrisms()
2291
2292     ## Returns the number of polyhedrons in the mesh
2293     #  @return an integer value
2294     #  @ingroup l1_meshinfo
2295     def NbPolyhedrons(self):
2296         return self.mesh.NbPolyhedrons()
2297
2298     ## Returns the number of submeshes in the mesh
2299     #  @return an integer value
2300     #  @ingroup l1_meshinfo
2301     def NbSubMesh(self):
2302         return self.mesh.NbSubMesh()
2303
2304     ## Returns the list of mesh elements IDs
2305     #  @return the list of integer values
2306     #  @ingroup l1_meshinfo
2307     def GetElementsId(self):
2308         return self.mesh.GetElementsId()
2309
2310     ## Returns the list of IDs of mesh elements with the given type
2311     #  @param elementType  the required type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME)
2312     #  @return list of integer values
2313     #  @ingroup l1_meshinfo
2314     def GetElementsByType(self, elementType):
2315         return self.mesh.GetElementsByType(elementType)
2316
2317     ## Returns the list of mesh nodes IDs
2318     #  @return the list of integer values
2319     #  @ingroup l1_meshinfo
2320     def GetNodesId(self):
2321         return self.mesh.GetNodesId()
2322
2323     # Get the information about mesh elements:
2324     # ------------------------------------
2325
2326     ## Returns the type of mesh element
2327     #  @return the value from SMESH::ElementType enumeration
2328     #  @ingroup l1_meshinfo
2329     def GetElementType(self, id, iselem):
2330         return self.mesh.GetElementType(id, iselem)
2331
2332     ## Returns the geometric type of mesh element
2333     #  @return the value from SMESH::EntityType enumeration
2334     #  @ingroup l1_meshinfo
2335     def GetElementGeomType(self, id):
2336         return self.mesh.GetElementGeomType(id)
2337
2338     ## Returns the shape type of mesh element
2339     #  @return the value from SMESH::GeometryType enumeration
2340     #  @ingroup l1_meshinfo
2341     def GetElementShape(self, id):
2342         return self.mesh.GetElementShape(id)
2343
2344     ## Returns the list of submesh elements IDs
2345     #  @param Shape a geom object(sub-shape) IOR
2346     #         Shape must be the sub-shape of a ShapeToMesh()
2347     #  @return the list of integer values
2348     #  @ingroup l1_meshinfo
2349     def GetSubMeshElementsId(self, Shape):
2350         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2351             ShapeID = Shape.GetSubShapeIndices()[0]
2352         else:
2353             ShapeID = Shape
2354         return self.mesh.GetSubMeshElementsId(ShapeID)
2355
2356     ## Returns the list of submesh nodes IDs
2357     #  @param Shape a geom object(sub-shape) IOR
2358     #         Shape must be the sub-shape of a ShapeToMesh()
2359     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
2360     #  @return the list of integer values
2361     #  @ingroup l1_meshinfo
2362     def GetSubMeshNodesId(self, Shape, all):
2363         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2364             ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape )
2365         else:
2366             ShapeID = Shape
2367         return self.mesh.GetSubMeshNodesId(ShapeID, all)
2368
2369     ## Returns type of elements on given shape
2370     #  @param Shape a geom object(sub-shape) IOR
2371     #         Shape must be a sub-shape of a ShapeToMesh()
2372     #  @return element type
2373     #  @ingroup l1_meshinfo
2374     def GetSubMeshElementType(self, Shape):
2375         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2376             ShapeID = Shape.GetSubShapeIndices()[0]
2377         else:
2378             ShapeID = Shape
2379         return self.mesh.GetSubMeshElementType(ShapeID)
2380
2381     ## Gets the mesh description
2382     #  @return string value
2383     #  @ingroup l1_meshinfo
2384     def Dump(self):
2385         return self.mesh.Dump()
2386
2387
2388     # Get the information about nodes and elements of a mesh by its IDs:
2389     # -----------------------------------------------------------
2390
2391     ## Gets XYZ coordinates of a node
2392     #  \n If there is no nodes for the given ID - returns an empty list
2393     #  @return a list of double precision values
2394     #  @ingroup l1_meshinfo
2395     def GetNodeXYZ(self, id):
2396         return self.mesh.GetNodeXYZ(id)
2397
2398     ## Returns list of IDs of inverse elements for the given node
2399     #  \n If there is no node for the given ID - returns an empty list
2400     #  @return a list of integer values
2401     #  @ingroup l1_meshinfo
2402     def GetNodeInverseElements(self, id):
2403         return self.mesh.GetNodeInverseElements(id)
2404
2405     ## @brief Returns the position of a node on the shape
2406     #  @return SMESH::NodePosition
2407     #  @ingroup l1_meshinfo
2408     def GetNodePosition(self,NodeID):
2409         return self.mesh.GetNodePosition(NodeID)
2410
2411     ## @brief Returns the position of an element on the shape
2412     #  @return SMESH::ElementPosition
2413     #  @ingroup l1_meshinfo
2414     def GetElementPosition(self,ElemID):
2415         return self.mesh.GetElementPosition(ElemID)
2416
2417     ## If the given element is a node, returns the ID of shape
2418     #  \n If there is no node for the given ID - returns -1
2419     #  @return an integer value
2420     #  @ingroup l1_meshinfo
2421     def GetShapeID(self, id):
2422         return self.mesh.GetShapeID(id)
2423
2424     ## Returns the ID of the result shape after
2425     #  FindShape() from SMESH_MeshEditor for the given element
2426     #  \n If there is no element for the given ID - returns -1
2427     #  @return an integer value
2428     #  @ingroup l1_meshinfo
2429     def GetShapeIDForElem(self,id):
2430         return self.mesh.GetShapeIDForElem(id)
2431
2432     ## Returns the number of nodes for the given element
2433     #  \n If there is no element for the given ID - returns -1
2434     #  @return an integer value
2435     #  @ingroup l1_meshinfo
2436     def GetElemNbNodes(self, id):
2437         return self.mesh.GetElemNbNodes(id)
2438
2439     ## Returns the node ID the given (zero based) index for the given element
2440     #  \n If there is no element for the given ID - returns -1
2441     #  \n If there is no node for the given index - returns -2
2442     #  @return an integer value
2443     #  @ingroup l1_meshinfo
2444     def GetElemNode(self, id, index):
2445         return self.mesh.GetElemNode(id, index)
2446
2447     ## Returns the IDs of nodes of the given element
2448     #  @return a list of integer values
2449     #  @ingroup l1_meshinfo
2450     def GetElemNodes(self, id):
2451         return self.mesh.GetElemNodes(id)
2452
2453     ## Returns true if the given node is the medium node in the given quadratic element
2454     #  @ingroup l1_meshinfo
2455     def IsMediumNode(self, elementID, nodeID):
2456         return self.mesh.IsMediumNode(elementID, nodeID)
2457
2458     ## Returns true if the given node is the medium node in one of quadratic elements
2459     #  @ingroup l1_meshinfo
2460     def IsMediumNodeOfAnyElem(self, nodeID, elementType):
2461         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2462
2463     ## Returns the number of edges for the given element
2464     #  @ingroup l1_meshinfo
2465     def ElemNbEdges(self, id):
2466         return self.mesh.ElemNbEdges(id)
2467
2468     ## Returns the number of faces for the given element
2469     #  @ingroup l1_meshinfo
2470     def ElemNbFaces(self, id):
2471         return self.mesh.ElemNbFaces(id)
2472
2473     ## Returns nodes of given face (counted from zero) for given volumic element.
2474     #  @ingroup l1_meshinfo
2475     def GetElemFaceNodes(self,elemId, faceIndex):
2476         return self.mesh.GetElemFaceNodes(elemId, faceIndex)
2477
2478     ## Returns three components of normal of given mesh face
2479     #  (or an empty array in KO case)
2480     #  @ingroup l1_meshinfo
2481     def GetFaceNormal(self, faceId, normalized=False):
2482         return self.mesh.GetFaceNormal(faceId,normalized)
2483
2484     ## Returns an element based on all given nodes.
2485     #  @ingroup l1_meshinfo
2486     def FindElementByNodes(self,nodes):
2487         return self.mesh.FindElementByNodes(nodes)
2488
2489     ## Returns true if the given element is a polygon
2490     #  @ingroup l1_meshinfo
2491     def IsPoly(self, id):
2492         return self.mesh.IsPoly(id)
2493
2494     ## Returns true if the given element is quadratic
2495     #  @ingroup l1_meshinfo
2496     def IsQuadratic(self, id):
2497         return self.mesh.IsQuadratic(id)
2498
2499     ## Returns diameter of a ball discrete element or zero in case of an invalid \a id
2500     #  @ingroup l1_meshinfo
2501     def GetBallDiameter(self, id):
2502         return self.mesh.GetBallDiameter(id)
2503
2504     ## Returns XYZ coordinates of the barycenter of the given element
2505     #  \n If there is no element for the given ID - returns an empty list
2506     #  @return a list of three double values
2507     #  @ingroup l1_meshinfo
2508     def BaryCenter(self, id):
2509         return self.mesh.BaryCenter(id)
2510
2511     ## Passes mesh elements through the given filter and return IDs of fitting elements
2512     #  @param theFilter SMESH_Filter
2513     #  @return a list of ids
2514     #  @ingroup l1_controls
2515     def GetIdsFromFilter(self, theFilter):
2516         theFilter.SetMesh( self.mesh )
2517         return theFilter.GetIDs()
2518
2519     ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n
2520     #  Returns a list of special structures (borders).
2521     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
2522     #  @ingroup l1_controls
2523     def GetFreeBorders(self):
2524         aFilterMgr = self.smeshpyD.CreateFilterManager()
2525         aPredicate = aFilterMgr.CreateFreeEdges()
2526         aPredicate.SetMesh(self.mesh)
2527         aBorders = aPredicate.GetBorders()
2528         aFilterMgr.UnRegister()
2529         return aBorders
2530
2531
2532     # Get mesh measurements information:
2533     # ------------------------------------
2534
2535     ## Get minimum distance between two nodes, elements or distance to the origin
2536     #  @param id1 first node/element id
2537     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2538     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2539     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2540     #  @return minimum distance value
2541     #  @sa GetMinDistance()
2542     def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2543         aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2)
2544         return aMeasure.value
2545
2546     ## Get measure structure specifying minimum distance data between two objects
2547     #  @param id1 first node/element id
2548     #  @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed)
2549     #  @param isElem1 @c True if @a id1 is element id, @c False if it is node id
2550     #  @param isElem2 @c True if @a id2 is element id, @c False if it is node id
2551     #  @return Measure structure
2552     #  @sa MinDistance()
2553     def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False):
2554         if isElem1:
2555             id1 = self.editor.MakeIDSource([id1], SMESH.FACE)
2556         else:
2557             id1 = self.editor.MakeIDSource([id1], SMESH.NODE)
2558         if id2 != 0:
2559             if isElem2:
2560                 id2 = self.editor.MakeIDSource([id2], SMESH.FACE)
2561             else:
2562                 id2 = self.editor.MakeIDSource([id2], SMESH.NODE)
2563             pass
2564         else:
2565             id2 = None
2566
2567         aMeasurements = self.smeshpyD.CreateMeasurements()
2568         aMeasure = aMeasurements.MinDistance(id1, id2)
2569         genObjUnRegister([aMeasurements,id1, id2])
2570         return aMeasure
2571
2572     ## Get bounding box of the specified object(s)
2573     #  @param objects single source object or list of source objects or list of nodes/elements IDs
2574     #  @param isElem if @a objects is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2575     #  @c False specifies that @a objects are nodes
2576     #  @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ)
2577     #  @sa GetBoundingBox()
2578     def BoundingBox(self, objects=None, isElem=False):
2579         result = self.GetBoundingBox(objects, isElem)
2580         if result is None:
2581             result = (0.0,)*6
2582         else:
2583             result = (result.minX, result.minY, result.minZ, result.maxX, result.maxY, result.maxZ)
2584         return result
2585
2586     ## Get measure structure specifying bounding box data of the specified object(s)
2587     #  @param IDs single source object or list of source objects or list of nodes/elements IDs
2588     #  @param isElem if @a IDs is a list of IDs, @c True value in this parameters specifies that @a objects are elements,
2589     #  @c False specifies that @a objects are nodes
2590     #  @return Measure structure
2591     #  @sa BoundingBox()
2592     def GetBoundingBox(self, IDs=None, isElem=False):
2593         if IDs is None:
2594             IDs = [self.mesh]
2595         elif isinstance(IDs, tuple):
2596             IDs = list(IDs)
2597         if not isinstance(IDs, list):
2598             IDs = [IDs]
2599         if len(IDs) > 0 and isinstance(IDs[0], int):
2600             IDs = [IDs]
2601         srclist = []
2602         unRegister = genObjUnRegister()
2603         for o in IDs:
2604             if isinstance(o, Mesh):
2605                 srclist.append(o.mesh)
2606             elif hasattr(o, "_narrow"):
2607                 src = o._narrow(SMESH.SMESH_IDSource)
2608                 if src: srclist.append(src)
2609                 pass
2610             elif isinstance(o, list):
2611                 if isElem:
2612                     srclist.append(self.editor.MakeIDSource(o, SMESH.FACE))
2613                 else:
2614                     srclist.append(self.editor.MakeIDSource(o, SMESH.NODE))
2615                 unRegister.set( srclist[-1] )
2616                 pass
2617             pass
2618         aMeasurements = self.smeshpyD.CreateMeasurements()
2619         unRegister.set( aMeasurements )
2620         aMeasure = aMeasurements.BoundingBox(srclist)
2621         return aMeasure
2622
2623     # Mesh edition (SMESH_MeshEditor functionality):
2624     # ---------------------------------------------
2625
2626     ## Removes the elements from the mesh by ids
2627     #  @param IDsOfElements is a list of ids of elements to remove
2628     #  @return True or False
2629     #  @ingroup l2_modif_del
2630     def RemoveElements(self, IDsOfElements):
2631         return self.editor.RemoveElements(IDsOfElements)
2632
2633     ## Removes nodes from mesh by ids
2634     #  @param IDsOfNodes is a list of ids of nodes to remove
2635     #  @return True or False
2636     #  @ingroup l2_modif_del
2637     def RemoveNodes(self, IDsOfNodes):
2638         return self.editor.RemoveNodes(IDsOfNodes)
2639
2640     ## Removes all orphan (free) nodes from mesh
2641     #  @return number of the removed nodes
2642     #  @ingroup l2_modif_del
2643     def RemoveOrphanNodes(self):
2644         return self.editor.RemoveOrphanNodes()
2645
2646     ## Add a node to the mesh by coordinates
2647     #  @return Id of the new node
2648     #  @ingroup l2_modif_add
2649     def AddNode(self, x, y, z):
2650         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2651         if hasVars: self.mesh.SetParameters(Parameters)
2652         return self.editor.AddNode( x, y, z)
2653
2654     ## Creates a 0D element on a node with given number.
2655     #  @param IDOfNode the ID of node for creation of the element.
2656     #  @return the Id of the new 0D element
2657     #  @ingroup l2_modif_add
2658     def Add0DElement(self, IDOfNode):
2659         return self.editor.Add0DElement(IDOfNode)
2660
2661     ## Create 0D elements on all nodes of the given elements except those 
2662     #  nodes on which a 0D element already exists.
2663     #  @param theObject an object on whose nodes 0D elements will be created.
2664     #         It can be mesh, sub-mesh, group, list of element IDs or a holder
2665     #         of nodes IDs created by calling mesh.GetIDSource( nodes, SMESH.NODE )
2666     #  @param theGroupName optional name of a group to add 0D elements created
2667     #         and/or found on nodes of \a theObject.
2668     #  @return an object (a new group or a temporary SMESH_IDSource) holding
2669     #          IDs of new and/or found 0D elements. IDs of 0D elements 
2670     #          can be retrieved from the returned object by calling GetIDs()
2671     #  @ingroup l2_modif_add
2672     def Add0DElementsToAllNodes(self, theObject, theGroupName=""):
2673         unRegister = genObjUnRegister()
2674         if isinstance( theObject, Mesh ):
2675             theObject = theObject.GetMesh()
2676         if isinstance( theObject, list ):
2677             theObject = self.GetIDSource( theObject, SMESH.ALL )
2678             unRegister.set( theObject )
2679         return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName )
2680
2681     ## Creates a ball element on a node with given ID.
2682     #  @param IDOfNode the ID of node for creation of the element.
2683     #  @param diameter the bal diameter.
2684     #  @return the Id of the new ball element
2685     #  @ingroup l2_modif_add
2686     def AddBall(self, IDOfNode, diameter):
2687         return self.editor.AddBall( IDOfNode, diameter )
2688
2689     ## Creates a linear or quadratic edge (this is determined
2690     #  by the number of given nodes).
2691     #  @param IDsOfNodes the list of node IDs for creation of the element.
2692     #  The order of nodes in this list should correspond to the description
2693     #  of MED. \n This description is located by the following link:
2694     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2695     #  @return the Id of the new edge
2696     #  @ingroup l2_modif_add
2697     def AddEdge(self, IDsOfNodes):
2698         return self.editor.AddEdge(IDsOfNodes)
2699
2700     ## Creates a linear or quadratic face (this is determined
2701     #  by the number of given nodes).
2702     #  @param IDsOfNodes the list of node IDs for creation of the element.
2703     #  The order of nodes in this list should correspond to the description
2704     #  of MED. \n This description is located by the following link:
2705     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2706     #  @return the Id of the new face
2707     #  @ingroup l2_modif_add
2708     def AddFace(self, IDsOfNodes):
2709         return self.editor.AddFace(IDsOfNodes)
2710
2711     ## Adds a polygonal face to the mesh by the list of node IDs
2712     #  @param IdsOfNodes the list of node IDs for creation of the element.
2713     #  @return the Id of the new face
2714     #  @ingroup l2_modif_add
2715     def AddPolygonalFace(self, IdsOfNodes):
2716         return self.editor.AddPolygonalFace(IdsOfNodes)
2717
2718     ## Creates both simple and quadratic volume (this is determined
2719     #  by the number of given nodes).
2720     #  @param IDsOfNodes the list of node IDs for creation of the element.
2721     #  The order of nodes in this list should correspond to the description
2722     #  of MED. \n This description is located by the following link:
2723     #  http://www.code-aster.org/outils/med/html/modele_de_donnees.html#3.
2724     #  @return the Id of the new volumic element
2725     #  @ingroup l2_modif_add
2726     def AddVolume(self, IDsOfNodes):
2727         return self.editor.AddVolume(IDsOfNodes)
2728
2729     ## Creates a volume of many faces, giving nodes for each face.
2730     #  @param IdsOfNodes the list of node IDs for volume creation face by face.
2731     #  @param Quantities the list of integer values, Quantities[i]
2732     #         gives the quantity of nodes in face number i.
2733     #  @return the Id of the new volumic element
2734     #  @ingroup l2_modif_add
2735     def AddPolyhedralVolume (self, IdsOfNodes, Quantities):
2736         return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities)
2737
2738     ## Creates a volume of many faces, giving the IDs of the existing faces.
2739     #  @param IdsOfFaces the list of face IDs for volume creation.
2740     #
2741     #  Note:  The created volume will refer only to the nodes
2742     #         of the given faces, not to the faces themselves.
2743     #  @return the Id of the new volumic element
2744     #  @ingroup l2_modif_add
2745     def AddPolyhedralVolumeByFaces (self, IdsOfFaces):
2746         return self.editor.AddPolyhedralVolumeByFaces(IdsOfFaces)
2747
2748
2749     ## @brief Binds a node to a vertex
2750     #  @param NodeID a node ID
2751     #  @param Vertex a vertex or vertex ID
2752     #  @return True if succeed else raises an exception
2753     #  @ingroup l2_modif_add
2754     def SetNodeOnVertex(self, NodeID, Vertex):
2755         if ( isinstance( Vertex, geomBuilder.GEOM._objref_GEOM_Object)):
2756             VertexID = Vertex.GetSubShapeIndices()[0]
2757         else:
2758             VertexID = Vertex
2759         try:
2760             self.editor.SetNodeOnVertex(NodeID, VertexID)
2761         except SALOME.SALOME_Exception, inst:
2762             raise ValueError, inst.details.text
2763         return True
2764
2765
2766     ## @brief Stores the node position on an edge
2767     #  @param NodeID a node ID
2768     #  @param Edge an edge or edge ID
2769     #  @param paramOnEdge a parameter on the edge where the node is located
2770     #  @return True if succeed else raises an exception
2771     #  @ingroup l2_modif_add
2772     def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge):
2773         if ( isinstance( Edge, geomBuilder.GEOM._objref_GEOM_Object)):
2774             EdgeID = Edge.GetSubShapeIndices()[0]
2775         else:
2776             EdgeID = Edge
2777         try:
2778             self.editor.SetNodeOnEdge(NodeID, EdgeID, paramOnEdge)
2779         except SALOME.SALOME_Exception, inst:
2780             raise ValueError, inst.details.text
2781         return True
2782
2783     ## @brief Stores node position on a face
2784     #  @param NodeID a node ID
2785     #  @param Face a face or face ID
2786     #  @param u U parameter on the face where the node is located
2787     #  @param v V parameter on the face where the node is located
2788     #  @return True if succeed else raises an exception
2789     #  @ingroup l2_modif_add
2790     def SetNodeOnFace(self, NodeID, Face, u, v):
2791         if ( isinstance( Face, geomBuilder.GEOM._objref_GEOM_Object)):
2792             FaceID = Face.GetSubShapeIndices()[0]
2793         else:
2794             FaceID = Face
2795         try:
2796             self.editor.SetNodeOnFace(NodeID, FaceID, u, v)
2797         except SALOME.SALOME_Exception, inst:
2798             raise ValueError, inst.details.text
2799         return True
2800
2801     ## @brief Binds a node to a solid
2802     #  @param NodeID a node ID
2803     #  @param Solid  a solid or solid ID
2804     #  @return True if succeed else raises an exception
2805     #  @ingroup l2_modif_add
2806     def SetNodeInVolume(self, NodeID, Solid):
2807         if ( isinstance( Solid, geomBuilder.GEOM._objref_GEOM_Object)):
2808             SolidID = Solid.GetSubShapeIndices()[0]
2809         else:
2810             SolidID = Solid
2811         try:
2812             self.editor.SetNodeInVolume(NodeID, SolidID)
2813         except SALOME.SALOME_Exception, inst:
2814             raise ValueError, inst.details.text
2815         return True
2816
2817     ## @brief Bind an element to a shape
2818     #  @param ElementID an element ID
2819     #  @param Shape a shape or shape ID
2820     #  @return True if succeed else raises an exception
2821     #  @ingroup l2_modif_add
2822     def SetMeshElementOnShape(self, ElementID, Shape):
2823         if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)):
2824             ShapeID = Shape.GetSubShapeIndices()[0]
2825         else:
2826             ShapeID = Shape
2827         try:
2828             self.editor.SetMeshElementOnShape(ElementID, ShapeID)
2829         except SALOME.SALOME_Exception, inst:
2830             raise ValueError, inst.details.text
2831         return True
2832
2833
2834     ## Moves the node with the given id
2835     #  @param NodeID the id of the node
2836     #  @param x  a new X coordinate
2837     #  @param y  a new Y coordinate
2838     #  @param z  a new Z coordinate
2839     #  @return True if succeed else False
2840     #  @ingroup l2_modif_movenode
2841     def MoveNode(self, NodeID, x, y, z):
2842         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2843         if hasVars: self.mesh.SetParameters(Parameters)
2844         return self.editor.MoveNode(NodeID, x, y, z)
2845
2846     ## Finds the node closest to a point and moves it to a point location
2847     #  @param x  the X coordinate of a point
2848     #  @param y  the Y coordinate of a point
2849     #  @param z  the Z coordinate of a point
2850     #  @param NodeID if specified (>0), the node with this ID is moved,
2851     #  otherwise, the node closest to point (@a x,@a y,@a z) is moved
2852     #  @return the ID of a node
2853     #  @ingroup l2_modif_throughp
2854     def MoveClosestNodeToPoint(self, x, y, z, NodeID):
2855         x,y,z,Parameters,hasVars = ParseParameters(x,y,z)
2856         if hasVars: self.mesh.SetParameters(Parameters)
2857         return self.editor.MoveClosestNodeToPoint(x, y, z, NodeID)
2858
2859     ## Finds the node closest to a point
2860     #  @param x  the X coordinate of a point
2861     #  @param y  the Y coordinate of a point
2862     #  @param z  the Z coordinate of a point
2863     #  @return the ID of a node
2864     #  @ingroup l2_modif_throughp
2865     def FindNodeClosestTo(self, x, y, z):
2866         #preview = self.mesh.GetMeshEditPreviewer()
2867         #return preview.MoveClosestNodeToPoint(x, y, z, -1)
2868         return self.editor.FindNodeClosestTo(x, y, z)
2869
2870     ## Finds the elements where a point lays IN or ON
2871     #  @param x  the X coordinate of a point
2872     #  @param y  the Y coordinate of a point
2873     #  @param z  the Z coordinate of a point
2874     #  @param elementType type of elements to find (SMESH.ALL type
2875     #         means elements of any type excluding nodes, discrete and 0D elements)
2876     #  @param meshPart a part of mesh (group, sub-mesh) to search within
2877     #  @return list of IDs of found elements
2878     #  @ingroup l2_modif_throughp
2879     def FindElementsByPoint(self, x, y, z, elementType = SMESH.ALL, meshPart=None):
2880         if meshPart:
2881             return self.editor.FindAmongElementsByPoint( meshPart, x, y, z, elementType );
2882         else:
2883             return self.editor.FindElementsByPoint(x, y, z, elementType)
2884
2885     # Return point state in a closed 2D mesh in terms of TopAbs_State enumeration:
2886     # 0-IN, 1-OUT, 2-ON, 3-UNKNOWN
2887     # TopAbs_UNKNOWN state means that either mesh is wrong or the analysis fails.
2888
2889     def GetPointState(self, x, y, z):
2890         return self.editor.GetPointState(x, y, z)
2891
2892     ## Finds the node closest to a point and moves it to a point location
2893     #  @param x  the X coordinate of a point
2894     #  @param y  the Y coordinate of a point
2895     #  @param z  the Z coordinate of a point
2896     #  @return the ID of a moved node
2897     #  @ingroup l2_modif_throughp
2898     def MeshToPassThroughAPoint(self, x, y, z):
2899         return self.editor.MoveClosestNodeToPoint(x, y, z, -1)
2900
2901     ## Replaces two neighbour triangles sharing Node1-Node2 link
2902     #  with the triangles built on the same 4 nodes but having other common link.
2903     #  @param NodeID1  the ID of the first node
2904     #  @param NodeID2  the ID of the second node
2905     #  @return false if proper faces were not found
2906     #  @ingroup l2_modif_invdiag
2907     def InverseDiag(self, NodeID1, NodeID2):
2908         return self.editor.InverseDiag(NodeID1, NodeID2)
2909
2910     ## Replaces two neighbour triangles sharing Node1-Node2 link
2911     #  with a quadrangle built on the same 4 nodes.
2912     #  @param NodeID1  the ID of the first node
2913     #  @param NodeID2  the ID of the second node
2914     #  @return false if proper faces were not found
2915     #  @ingroup l2_modif_unitetri
2916     def DeleteDiag(self, NodeID1, NodeID2):
2917         return self.editor.DeleteDiag(NodeID1, NodeID2)
2918
2919     ## Reorients elements by ids
2920     #  @param IDsOfElements if undefined reorients all mesh elements
2921     #  @return True if succeed else False
2922     #  @ingroup l2_modif_changori
2923     def Reorient(self, IDsOfElements=None):
2924         if IDsOfElements == None:
2925             IDsOfElements = self.GetElementsId()
2926         return self.editor.Reorient(IDsOfElements)
2927
2928     ## Reorients all elements of the object
2929     #  @param theObject mesh, submesh or group
2930     #  @return True if succeed else False
2931     #  @ingroup l2_modif_changori
2932     def ReorientObject(self, theObject):
2933         if ( isinstance( theObject, Mesh )):
2934             theObject = theObject.GetMesh()
2935         return self.editor.ReorientObject(theObject)
2936
2937     ## Reorient faces contained in \a the2DObject.
2938     #  @param the2DObject is a mesh, sub-mesh, group or list of IDs of 2D elements
2939     #  @param theDirection is a desired direction of normal of \a theFace.
2940     #         It can be either a GEOM vector or a list of coordinates [x,y,z].
2941     #  @param theFaceOrPoint defines a face of \a the2DObject whose normal will be
2942     #         compared with theDirection. It can be either ID of face or a point
2943     #         by which the face will be found. The point can be given as either
2944     #         a GEOM vertex or a list of point coordinates.
2945     #  @return number of reoriented faces
2946     #  @ingroup l2_modif_changori
2947     def Reorient2D(self, the2DObject, theDirection, theFaceOrPoint ):
2948         unRegister = genObjUnRegister()
2949         # check the2DObject
2950         if isinstance( the2DObject, Mesh ):
2951             the2DObject = the2DObject.GetMesh()
2952         if isinstance( the2DObject, list ):
2953             the2DObject = self.GetIDSource( the2DObject, SMESH.FACE )
2954             unRegister.set( the2DObject )
2955         # check theDirection
2956         if isinstance( theDirection, geomBuilder.GEOM._objref_GEOM_Object):
2957             theDirection = self.smeshpyD.GetDirStruct( theDirection )
2958         if isinstance( theDirection, list ):
2959             theDirection = self.smeshpyD.MakeDirStruct( *theDirection  )
2960         # prepare theFace and thePoint
2961         theFace = theFaceOrPoint
2962         thePoint = PointStruct(0,0,0)
2963         if isinstance( theFaceOrPoint, geomBuilder.GEOM._objref_GEOM_Object):
2964             thePoint = self.smeshpyD.GetPointStruct( theFaceOrPoint )
2965             theFace = -1
2966         if isinstance( theFaceOrPoint, list ):
2967             thePoint = PointStruct( *theFaceOrPoint )
2968             theFace = -1
2969         if isinstance( theFaceOrPoint, PointStruct ):
2970             thePoint = theFaceOrPoint
2971             theFace = -1
2972         return self.editor.Reorient2D( the2DObject, theDirection, theFace, thePoint )
2973
2974     ## Reorient faces according to adjacent volumes.
2975     #  @param the2DObject is a mesh, sub-mesh, group or list of
2976     #         either IDs of faces or face groups.
2977     #  @param the3DObject is a mesh, sub-mesh, group or list of IDs of volumes.
2978     #  @param theOutsideNormal to orient faces to have their normals
2979     #         pointing either \a outside or \a inside the adjacent volumes.
2980     #  @return number of reoriented faces.
2981     #  @ingroup l2_modif_changori
2982     def Reorient2DBy3D(self, the2DObject, the3DObject, theOutsideNormal=True ):
2983         unRegister = genObjUnRegister()
2984         # check the2DObject
2985         if not isinstance( the2DObject, list ):
2986             the2DObject = [ the2DObject ]
2987         elif the2DObject and isinstance( the2DObject[0], int ):
2988             the2DObject = self.GetIDSource( the2DObject, SMESH.FACE )
2989             unRegister.set( the2DObject )
2990             the2DObject = [ the2DObject ]
2991         for i,obj2D in enumerate( the2DObject ):
2992             if isinstance( obj2D, Mesh ):
2993                 the2DObject[i] = obj2D.GetMesh()
2994             if isinstance( obj2D, list ):
2995                 the2DObject[i] = self.GetIDSource( obj2D, SMESH.FACE )
2996                 unRegister.set( the2DObject[i] )
2997         # check the3DObject
2998         if isinstance( the3DObject, Mesh ):
2999             the3DObject = the3DObject.GetMesh()
3000         if isinstance( the3DObject, list ):
3001             the3DObject = self.GetIDSource( the3DObject, SMESH.VOLUME )
3002             unRegister.set( the3DObject )
3003         return self.editor.Reorient2DBy3D( the2DObject, the3DObject, theOutsideNormal )
3004
3005     ## Fuses the neighbouring triangles into quadrangles.
3006     #  @param IDsOfElements The triangles to be fused,
3007     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
3008     #                       choose a neighbour to fuse with.
3009     #  @param MaxAngle      is the maximum angle between element normals at which the fusion
3010     #                       is still performed; theMaxAngle is mesured in radians.
3011     #                       Also it could be a name of variable which defines angle in degrees.
3012     #  @return TRUE in case of success, FALSE otherwise.
3013     #  @ingroup l2_modif_unitetri
3014     def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle):
3015         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
3016         self.mesh.SetParameters(Parameters)
3017         if not IDsOfElements:
3018             IDsOfElements = self.GetElementsId()
3019         Functor = self.smeshpyD.GetFunctor(theCriterion)
3020         return self.editor.TriToQuad(IDsOfElements, Functor, MaxAngle)
3021
3022     ## Fuses the neighbouring triangles of the object into quadrangles
3023     #  @param theObject is mesh, submesh or group
3024     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
3025     #         choose a neighbour to fuse with.
3026     #  @param MaxAngle   a max angle between element normals at which the fusion
3027     #                   is still performed; theMaxAngle is mesured in radians.
3028     #  @return TRUE in case of success, FALSE otherwise.
3029     #  @ingroup l2_modif_unitetri
3030     def TriToQuadObject (self, theObject, theCriterion, MaxAngle):
3031         MaxAngle,Parameters,hasVars = ParseAngles(MaxAngle)
3032         self.mesh.SetParameters(Parameters)
3033         if isinstance( theObject, Mesh ):
3034             theObject = theObject.GetMesh()
3035         Functor = self.smeshpyD.GetFunctor(theCriterion)
3036         return self.editor.TriToQuadObject(theObject, Functor, MaxAngle)
3037
3038     ## Splits quadrangles into triangles.
3039     #  @param IDsOfElements the faces to be splitted.
3040     #  @param theCriterion   is a numerical functor, in terms of enum SMESH.FunctorType, used to
3041     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
3042     #         value, then quadrangles will be split by the smallest diagonal.
3043     #  @return TRUE in case of success, FALSE otherwise.
3044     #  @ingroup l2_modif_cutquadr
3045     def QuadToTri (self, IDsOfElements, theCriterion = None):
3046         if IDsOfElements == []:
3047             IDsOfElements = self.GetElementsId()
3048         if theCriterion is None:
3049             theCriterion = FT_MaxElementLength2D
3050         Functor = self.smeshpyD.GetFunctor(theCriterion)
3051         return self.editor.QuadToTri(IDsOfElements, Functor)
3052
3053     ## Splits quadrangles into triangles.
3054     #  @param theObject the object from which the list of elements is taken,
3055     #         this is mesh, submesh or group
3056     #  @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to
3057     #         choose a diagonal for splitting. If @a theCriterion is None, which is a default
3058     #         value, then quadrangles will be split by the smallest diagonal.
3059     #  @return TRUE in case of success, FALSE otherwise.
3060     #  @ingroup l2_modif_cutquadr
3061     def QuadToTriObject (self, theObject, theCriterion = None):
3062         if ( isinstance( theObject, Mesh )):
3063             theObject = theObject.GetMesh()
3064         if theCriterion is None:
3065             theCriterion = FT_MaxElementLength2D
3066         Functor = self.smeshpyD.GetFunctor(theCriterion)
3067         return self.editor.QuadToTriObject(theObject, Functor)
3068
3069     ## Splits each of given quadrangles into 4 triangles. A node is added at the center of
3070     #  a quadrangle.
3071     #  @param theElements the faces to be splitted. This can be either mesh, sub-mesh,
3072     #         group or a list of face IDs. By default all quadrangles are split
3073     #  @ingroup l2_modif_cutquadr
3074     def QuadTo4Tri (self, theElements=[]):
3075         unRegister = genObjUnRegister()
3076         if isinstance( theElements, Mesh ):
3077             theElements = theElements.mesh
3078         elif not theElements:
3079             theElements = self.mesh
3080         elif isinstance( theElements, list ):
3081             theElements = self.GetIDSource( theElements, SMESH.FACE )
3082             unRegister.set( theElements )
3083         return self.editor.QuadTo4Tri( theElements )
3084
3085     ## Splits quadrangles into triangles.
3086     #  @param IDsOfElements the faces to be splitted
3087     #  @param Diag13        is used to choose a diagonal for splitting.
3088     #  @return TRUE in case of success, FALSE otherwise.
3089     #  @ingroup l2_modif_cutquadr
3090     def SplitQuad (self, IDsOfElements, Diag13):
3091         if IDsOfElements == []:
3092             IDsOfElements = self.GetElementsId()
3093         return self.editor.SplitQuad(IDsOfElements, Diag13)
3094
3095     ## Splits quadrangles into triangles.
3096     #  @param theObject the object from which the list of elements is taken,
3097     #         this is mesh, submesh or group
3098     #  @param Diag13    is used to choose a diagonal for splitting.
3099     #  @return TRUE in case of success, FALSE otherwise.
3100     #  @ingroup l2_modif_cutquadr
3101     def SplitQuadObject (self, theObject, Diag13):
3102         if ( isinstance( theObject, Mesh )):
3103             theObject = theObject.GetMesh()
3104         return self.editor.SplitQuadObject(theObject, Diag13)
3105
3106     ## Finds a better splitting of the given quadrangle.
3107     #  @param IDOfQuad   the ID of the quadrangle to be splitted.
3108     #  @param theCriterion  is a numerical functor, in terms of enum SMESH.FunctorType, used to
3109     #         choose a diagonal for splitting.
3110     #  @return 1 if 1-3 diagonal is better, 2 if 2-4
3111     #          diagonal is better, 0 if error occurs.
3112     #  @ingroup l2_modif_cutquadr
3113     def BestSplit (self, IDOfQuad, theCriterion):
3114         return self.editor.BestSplit(IDOfQuad, self.smeshpyD.GetFunctor(theCriterion))
3115
3116     ## Splits volumic elements into tetrahedrons
3117     #  @param elems either a list of elements or a mesh or a group or a submesh or a filter
3118     #  @param method  flags passing splitting method:
3119     #         smesh.Hex_5Tet, smesh.Hex_6Tet, smesh.Hex_24Tet.
3120     #         smesh.Hex_5Tet - to split the hexahedron into 5 tetrahedrons, etc.
3121     #  @ingroup l2_modif_cutquadr
3122     def SplitVolumesIntoTetra(self, elems, method=smeshBuilder.Hex_5Tet ):
3123         unRegister = genObjUnRegister()
3124         if isinstance( elems, Mesh ):
3125             elems = elems.GetMesh()
3126         if ( isinstance( elems, list )):
3127             elems = self.editor.MakeIDSource(elems, SMESH.VOLUME)
3128             unRegister.set( elems )
3129         self.editor.SplitVolumesIntoTetra(elems, method)
3130
3131     ## Splits hexahedra into prisms
3132     #  @param elems either a list of elements or a mesh or a group or a submesh or a filter
3133     #  @param startHexPoint a point used to find a hexahedron for which @a facetNormal
3134     #         gives a normal vector defining facets to split into triangles.
3135     #         @a startHexPoint can be either a triple of coordinates or a vertex.
3136     #  @param facetNormal a normal to a facet to split into triangles of a
3137     #         hexahedron found by @a startHexPoint.
3138     #         @a facetNormal can be either a triple of coordinates or an edge.
3139     #  @param method  flags passing splitting method: smesh.Hex_2Prisms, smesh.Hex_4Prisms.
3140     #         smesh.Hex_2Prisms - to split the hexahedron into 2 prisms, etc.
3141     #  @param allDomains if @c False, only hexahedra adjacent to one closest
3142     #         to @a startHexPoint are split, else @a startHexPoint
3143     #         is used to find the facet to split in all domains present in @a elems.
3144     #  @ingroup l2_modif_cutquadr
3145     def SplitHexahedraIntoPrisms(self, elems, startHexPoint, facetNormal,
3146                                  method=smeshBuilder.Hex_2Prisms, allDomains=False ):
3147         # IDSource
3148         unRegister = genObjUnRegister()
3149         if isinstance( elems, Mesh ):
3150             elems = elems.GetMesh()
3151         if ( isinstance( elems, list )):
3152             elems = self.editor.MakeIDSource(elems, SMESH.VOLUME)
3153             unRegister.set( elems )
3154             pass
3155         # axis
3156         if isinstance( startHexPoint, geomBuilder.GEOM._objref_GEOM_Object):
3157             startHexPoint = self.smeshpyD.GetPointStruct( startHexPoint )
3158         elif isinstance( startHexPoint, list ):
3159             startHexPoint = SMESH.PointStruct( startHexPoint[0],
3160                                                startHexPoint[1],
3161                                                startHexPoint[2])
3162         if isinstance( facetNormal, geomBuilder.GEOM._objref_GEOM_Object):
3163             facetNormal = self.smeshpyD.GetDirStruct( facetNormal )
3164         elif isinstance( facetNormal, list ):
3165             facetNormal = self.smeshpyD.MakeDirStruct( facetNormal[0],
3166                                                        facetNormal[1],
3167                                                        facetNormal[2])
3168         self.mesh.SetParameters( startHexPoint.parameters + facetNormal.PS.parameters )
3169
3170         self.editor.SplitHexahedraIntoPrisms(elems, startHexPoint, facetNormal, method, allDomains)
3171
3172     ## Splits quadrangle faces near triangular facets of volumes
3173     #
3174     #  @ingroup l1_auxiliary
3175     def SplitQuadsNearTriangularFacets(self):
3176         faces_array = self.GetElementsByType(SMESH.FACE)
3177         for face_id in faces_array:
3178             if self.GetElemNbNodes(face_id) == 4: # quadrangle
3179                 quad_nodes = self.mesh.GetElemNodes(face_id)
3180                 node1_elems = self.GetNodeInverseElements(quad_nodes[1 -1])
3181                 isVolumeFound = False
3182                 for node1_elem in node1_elems:
3183                     if not isVolumeFound:
3184                         if self.GetElementType(node1_elem, True) == SMESH.VOLUME:
3185                             nb_nodes = self.GetElemNbNodes(node1_elem)
3186                             if 3 < nb_nodes and nb_nodes < 7: # tetra or penta, or prism
3187                                 volume_elem = node1_elem
3188                                 volume_nodes = self.mesh.GetElemNodes(volume_elem)
3189                                 if volume_nodes.count(quad_nodes[2 -1]) > 0: # 1,2
3190                                     if volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,2,4
3191                                         isVolumeFound = True
3192                                         if volume_nodes.count(quad_nodes[3 -1]) == 0: # 1,2,4 & !3
3193                                             self.SplitQuad([face_id], False) # diagonal 2-4
3194                                     elif volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,2,3 & !4
3195                                         isVolumeFound = True
3196                                         self.SplitQuad([face_id], True) # diagonal 1-3
3197                                 elif volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,4 & !2
3198                                     if volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,4,3 & !2
3199                                         isVolumeFound = True
3200                                         self.SplitQuad([face_id], True) # diagonal 1-3
3201
3202     ## @brief Splits hexahedrons into tetrahedrons.
3203     #
3204     #  This operation uses pattern mapping functionality for splitting.
3205     #  @param theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group.
3206     #  @param theNode000,theNode001 within the range [0,7]; gives the orientation of the
3207     #         pattern relatively each hexahedron: the (0,0,0) key-point of the pattern
3208     #         will be mapped into <VAR>theNode000</VAR>-th node of each volume, the (0,0,1)
3209     #         key-point will be mapped into <VAR>theNode001</VAR>-th node of each volume.
3210     #         The (0,0,0) key-point of the used pattern corresponds to a non-split corner.
3211     #  @return TRUE in case of success, FALSE otherwise.
3212     #  @ingroup l1_auxiliary
3213     def SplitHexaToTetras (self, theObject, theNode000, theNode001):
3214         # Pattern:     5.---------.6
3215         #              /|#*      /|
3216         #             / | #*    / |
3217         #            /  |  # * /  |
3218         #           /   |   # /*  |
3219         # (0,0,1) 4.---------.7 * |
3220         #          |#*  |1   | # *|
3221         #          | # *.----|---#.2
3222         #          |  #/ *   |   /
3223         #          |  /#  *  |  /
3224         #          | /   # * | /
3225         #          |/      #*|/
3226         # (0,0,0) 0.---------.3
3227         pattern_tetra = "!!! Nb of points: \n 8 \n\
3228         !!! Points: \n\
3229         0 0 0  !- 0 \n\
3230         0 1 0  !- 1 \n\
3231         1 1 0  !- 2 \n\
3232         1 0 0  !- 3 \n\
3233         0 0 1  !- 4 \n\
3234         0 1 1  !- 5 \n\
3235         1 1 1  !- 6 \n\
3236         1 0 1  !- 7 \n\
3237         !!! Indices of points of 6 tetras: \n\
3238         0 3 4 1 \n\
3239         7 4 3 1 \n\
3240         4 7 5 1 \n\
3241         6 2 5 7 \n\
3242         1 5 2 7 \n\
3243         2 3 1 7 \n"
3244
3245         pattern = self.smeshpyD.GetPattern()
3246         isDone  = pattern.LoadFromFile(pattern_tetra)
3247         if not isDone:
3248             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
3249             return isDone
3250
3251         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
3252         isDone = pattern.MakeMesh(self.mesh, False, False)
3253         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
3254
3255         # split quafrangle faces near triangular facets of volumes
3256         self.SplitQuadsNearTriangularFacets()
3257
3258         return isDone
3259
3260     ## @brief Split hexahedrons into prisms.
3261     #
3262     #  Uses the pattern mapping functionality for splitting.
3263     #  @param theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken;
3264     #  @param theNode000,theNode001 (within the range [0,7]) gives the orientation of the
3265     #         pattern relatively each hexahedron: keypoint (0,0,0) of the pattern
3266     #         will be mapped into the <VAR>theNode000</VAR>-th node of each volume, keypoint (0,0,1)
3267     #         will be mapped into the <VAR>theNode001</VAR>-th node of each volume.
3268     #         Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners.
3269     #  @return TRUE in case of success, FALSE otherwise.
3270     #  @ingroup l1_auxiliary
3271     def SplitHexaToPrisms (self, theObject, theNode000, theNode001):
3272         # Pattern:     5.---------.6
3273         #              /|#       /|
3274         #             / | #     / |
3275         #            /  |  #   /  |
3276         #           /   |   # /   |
3277         # (0,0,1) 4.---------.7   |
3278         #          |    |    |    |
3279         #          |   1.----|----.2
3280         #          |   / *   |   /
3281         #          |  /   *  |  /
3282         #          | /     * | /
3283         #          |/       *|/
3284         # (0,0,0) 0.---------.3
3285         pattern_prism = "!!! Nb of points: \n 8 \n\
3286         !!! Points: \n\