Salome HOME
Merge from BR_phase16 branch (09/12/09)
[modules/smesh.git] / src / SMESH_SWIG / smeshDC.py
1 #  -*- coding: iso-8859-1 -*-
2 #  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
3 #
4 #  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 #  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 #
7 #  This library is free software; you can redistribute it and/or
8 #  modify it under the terms of the GNU Lesser General Public
9 #  License as published by the Free Software Foundation; either
10 #  version 2.1 of the License.
11 #
12 #  This library is distributed in the hope that it will be useful,
13 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
14 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 #  Lesser General Public License for more details.
16 #
17 #  You should have received a copy of the GNU Lesser General Public
18 #  License along with this library; if not, write to the Free Software
19 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
20 #
21 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #
23 #  File   : smesh.py
24 #  Author : Francis KLOSS, OCC
25 #  Module : SMESH
26 #
27 """
28  \namespace smesh
29  \brief Module smesh
30 """
31
32 ## @defgroup l1_auxiliary Auxiliary methods and structures
33 ## @defgroup l1_creating  Creating meshes
34 ## @{
35 ##   @defgroup l2_impexp     Importing and exporting meshes
36 ##   @defgroup l2_construct  Constructing meshes
37 ##   @defgroup l2_algorithms Defining Algorithms
38 ##   @{
39 ##     @defgroup l3_algos_basic   Basic meshing algorithms
40 ##     @defgroup l3_algos_proj    Projection Algorithms
41 ##     @defgroup l3_algos_radialp Radial Prism
42 ##     @defgroup l3_algos_segmarv Segments around Vertex
43 ##     @defgroup l3_algos_3dextr  3D extrusion meshing algorithm
44
45 ##   @}
46 ##   @defgroup l2_hypotheses Defining hypotheses
47 ##   @{
48 ##     @defgroup l3_hypos_1dhyps 1D Meshing Hypotheses
49 ##     @defgroup l3_hypos_2dhyps 2D Meshing Hypotheses
50 ##     @defgroup l3_hypos_maxvol Max Element Volume hypothesis
51 ##     @defgroup l3_hypos_netgen Netgen 2D and 3D hypotheses
52 ##     @defgroup l3_hypos_ghs3dh GHS3D Parameters hypothesis
53 ##     @defgroup l3_hypos_blsurf BLSURF Parameters hypothesis
54 ##     @defgroup l3_hypos_hexotic Hexotic Parameters hypothesis
55 ##     @defgroup l3_hypos_additi Additional Hypotheses
56
57 ##   @}
58 ##   @defgroup l2_submeshes Constructing submeshes
59 ##   @defgroup l2_compounds Building Compounds
60 ##   @defgroup l2_editing   Editing Meshes
61
62 ## @}
63 ## @defgroup l1_meshinfo  Mesh Information
64 ## @defgroup l1_controls  Quality controls and Filtering
65 ## @defgroup l1_grouping  Grouping elements
66 ## @{
67 ##   @defgroup l2_grps_create Creating groups
68 ##   @defgroup l2_grps_edit   Editing groups
69 ##   @defgroup l2_grps_operon Using operations on groups
70 ##   @defgroup l2_grps_delete Deleting Groups
71
72 ## @}
73 ## @defgroup l1_modifying Modifying meshes
74 ## @{
75 ##   @defgroup l2_modif_add      Adding nodes and elements
76 ##   @defgroup l2_modif_del      Removing nodes and elements
77 ##   @defgroup l2_modif_edit     Modifying nodes and elements
78 ##   @defgroup l2_modif_renumber Renumbering nodes and elements
79 ##   @defgroup l2_modif_trsf     Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
80 ##   @defgroup l2_modif_movenode Moving nodes
81 ##   @defgroup l2_modif_throughp Mesh through point
82 ##   @defgroup l2_modif_invdiag  Diagonal inversion of elements
83 ##   @defgroup l2_modif_unitetri Uniting triangles
84 ##   @defgroup l2_modif_changori Changing orientation of elements
85 ##   @defgroup l2_modif_cutquadr Cutting quadrangles
86 ##   @defgroup l2_modif_smooth   Smoothing
87 ##   @defgroup l2_modif_extrurev Extrusion and Revolution
88 ##   @defgroup l2_modif_patterns Pattern mapping
89 ##   @defgroup l2_modif_tofromqu Convert to/from Quadratic Mesh
90
91 ## @}
92
93 import salome
94 import geompyDC
95
96 import SMESH # This is necessary for back compatibility
97 from   SMESH import *
98
99 import StdMeshers
100
101 import SALOME
102
103 # import NETGENPlugin module if possible
104 noNETGENPlugin = 0
105 try:
106     import NETGENPlugin
107 except ImportError:
108     noNETGENPlugin = 1
109     pass
110
111 # import GHS3DPlugin module if possible
112 noGHS3DPlugin = 0
113 try:
114     import GHS3DPlugin
115 except ImportError:
116     noGHS3DPlugin = 1
117     pass
118
119 # import GHS3DPRLPlugin module if possible
120 noGHS3DPRLPlugin = 0
121 try:
122     import GHS3DPRLPlugin
123 except ImportError:
124     noGHS3DPRLPlugin = 1
125     pass
126
127 # import HexoticPlugin module if possible
128 noHexoticPlugin = 0
129 try:
130     import HexoticPlugin
131 except ImportError:
132     noHexoticPlugin = 1
133     pass
134
135 # import BLSURFPlugin module if possible
136 noBLSURFPlugin = 0
137 try:
138     import BLSURFPlugin
139 except ImportError:
140     noBLSURFPlugin = 1
141     pass
142
143 ## @addtogroup l1_auxiliary
144 ## @{
145
146 # Types of algorithms
147 REGULAR    = 1
148 PYTHON     = 2
149 COMPOSITE  = 3
150 SOLE       = 0
151 SIMPLE     = 1
152
153 MEFISTO       = 3
154 NETGEN        = 4
155 GHS3D         = 5
156 FULL_NETGEN   = 6
157 NETGEN_2D     = 7
158 NETGEN_1D2D   = NETGEN
159 NETGEN_1D2D3D = FULL_NETGEN
160 NETGEN_FULL   = FULL_NETGEN
161 Hexa    = 8
162 Hexotic = 9
163 BLSURF  = 10
164 GHS3DPRL = 11
165
166 # MirrorType enumeration
167 POINT = SMESH_MeshEditor.POINT
168 AXIS =  SMESH_MeshEditor.AXIS
169 PLANE = SMESH_MeshEditor.PLANE
170
171 # Smooth_Method enumeration
172 LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH
173 CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH
174
175 # Fineness enumeration (for NETGEN)
176 VeryCoarse = 0
177 Coarse     = 1
178 Moderate   = 2
179 Fine       = 3
180 VeryFine   = 4
181 Custom     = 5
182
183 # Optimization level of GHS3D
184 # V3.1
185 None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization = 0,1,2,3
186 # V4.1 (partialy redefines V3.1). Issue 0020574
187 None_Optimization, Light_Optimization, Standard_Optimization, StandardPlus_Optimization, Strong_Optimization = 0,1,2,3,4
188
189 # Topology treatment way of BLSURF
190 FromCAD, PreProcess, PreProcessPlus = 0,1,2
191
192 # Element size flag of BLSURF
193 DefaultSize, DefaultGeom, Custom = 0,0,1
194
195 PrecisionConfusion = 1e-07
196
197 ## Converts an angle from degrees to radians
198 def DegreesToRadians(AngleInDegrees):
199     from math import pi
200     return AngleInDegrees * pi / 180.0
201
202 # Salome notebook variable separator
203 var_separator = ":"
204
205 # Parametrized substitute for PointStruct
206 class PointStructStr:
207
208     x = 0
209     y = 0
210     z = 0
211     xStr = ""
212     yStr = ""
213     zStr = ""
214
215     def __init__(self, xStr, yStr, zStr):
216         self.xStr = xStr
217         self.yStr = yStr
218         self.zStr = zStr
219         if isinstance(xStr, str) and notebook.isVariable(xStr):
220             self.x = notebook.get(xStr)
221         else:
222             self.x = xStr
223         if isinstance(yStr, str) and notebook.isVariable(yStr):
224             self.y = notebook.get(yStr)
225         else:
226             self.y = yStr
227         if isinstance(zStr, str) and notebook.isVariable(zStr):
228             self.z = notebook.get(zStr)
229         else:
230             self.z = zStr
231
232 # Parametrized substitute for PointStruct (with 6 parameters)
233 class PointStructStr6:
234
235     x1 = 0
236     y1 = 0
237     z1 = 0
238     x2 = 0
239     y2 = 0
240     z2 = 0
241     xStr1 = ""
242     yStr1 = ""
243     zStr1 = ""
244     xStr2 = ""
245     yStr2 = ""
246     zStr2 = ""
247
248     def __init__(self, x1Str, x2Str, y1Str, y2Str, z1Str, z2Str):
249         self.x1Str = x1Str
250         self.x2Str = x2Str
251         self.y1Str = y1Str
252         self.y2Str = y2Str
253         self.z1Str = z1Str
254         self.z2Str = z2Str
255         if isinstance(x1Str, str) and notebook.isVariable(x1Str):
256             self.x1 = notebook.get(x1Str)
257         else:
258             self.x1 = x1Str
259         if isinstance(x2Str, str) and notebook.isVariable(x2Str):
260             self.x2 = notebook.get(x2Str)
261         else:
262             self.x2 = x2Str
263         if isinstance(y1Str, str) and notebook.isVariable(y1Str):
264             self.y1 = notebook.get(y1Str)
265         else:
266             self.y1 = y1Str
267         if isinstance(y2Str, str) and notebook.isVariable(y2Str):
268             self.y2 = notebook.get(y2Str)
269         else:
270             self.y2 = y2Str
271         if isinstance(z1Str, str) and notebook.isVariable(z1Str):
272             self.z1 = notebook.get(z1Str)
273         else:
274             self.z1 = z1Str
275         if isinstance(z2Str, str) and notebook.isVariable(z2Str):
276             self.z2 = notebook.get(z2Str)
277         else:
278             self.z2 = z2Str
279
280 # Parametrized substitute for AxisStruct
281 class AxisStructStr:
282
283     x = 0
284     y = 0
285     z = 0
286     dx = 0
287     dy = 0
288     dz = 0
289     xStr = ""
290     yStr = ""
291     zStr = ""
292     dxStr = ""
293     dyStr = ""
294     dzStr = ""
295
296     def __init__(self, xStr, yStr, zStr, dxStr, dyStr, dzStr):
297         self.xStr = xStr
298         self.yStr = yStr
299         self.zStr = zStr
300         self.dxStr = dxStr
301         self.dyStr = dyStr
302         self.dzStr = dzStr
303         if isinstance(xStr, str) and notebook.isVariable(xStr):
304             self.x = notebook.get(xStr)
305         else:
306             self.x = xStr
307         if isinstance(yStr, str) and notebook.isVariable(yStr):
308             self.y = notebook.get(yStr)
309         else:
310             self.y = yStr
311         if isinstance(zStr, str) and notebook.isVariable(zStr):
312             self.z = notebook.get(zStr)
313         else:
314             self.z = zStr
315         if isinstance(dxStr, str) and notebook.isVariable(dxStr):
316             self.dx = notebook.get(dxStr)
317         else:
318             self.dx = dxStr
319         if isinstance(dyStr, str) and notebook.isVariable(dyStr):
320             self.dy = notebook.get(dyStr)
321         else:
322             self.dy = dyStr
323         if isinstance(dzStr, str) and notebook.isVariable(dzStr):
324             self.dz = notebook.get(dzStr)
325         else:
326             self.dz = dzStr
327
328 # Parametrized substitute for DirStruct
329 class DirStructStr:
330
331     def __init__(self, pointStruct):
332         self.pointStruct = pointStruct
333
334 # Returns list of variable values from salome notebook
335 def ParsePointStruct(Point):
336     Parameters = 2*var_separator
337     if isinstance(Point, PointStructStr):
338         Parameters = str(Point.xStr) + var_separator + str(Point.yStr) + var_separator + str(Point.zStr)
339         Point = PointStruct(Point.x, Point.y, Point.z)
340     return Point, Parameters
341
342 # Returns list of variable values from salome notebook
343 def ParseDirStruct(Dir):
344     Parameters = 2*var_separator
345     if isinstance(Dir, DirStructStr):
346         pntStr = Dir.pointStruct
347         if isinstance(pntStr, PointStructStr6):
348             Parameters = str(pntStr.x1Str) + var_separator + str(pntStr.x2Str) + var_separator
349             Parameters += str(pntStr.y1Str) + var_separator + str(pntStr.y2Str) + var_separator 
350             Parameters += str(pntStr.z1Str) + var_separator + str(pntStr.z2Str)
351             Point = PointStruct(pntStr.x2 - pntStr.x1, pntStr.y2 - pntStr.y1, pntStr.z2 - pntStr.z1)
352         else:
353             Parameters = str(pntStr.xStr) + var_separator + str(pntStr.yStr) + var_separator + str(pntStr.zStr)
354             Point = PointStruct(pntStr.x, pntStr.y, pntStr.z)
355         Dir = DirStruct(Point)
356     return Dir, Parameters
357
358 # Returns list of variable values from salome notebook
359 def ParseAxisStruct(Axis):
360     Parameters = 5*var_separator
361     if isinstance(Axis, AxisStructStr):
362         Parameters = str(Axis.xStr) + var_separator + str(Axis.yStr) + var_separator + str(Axis.zStr) + var_separator
363         Parameters += str(Axis.dxStr) + var_separator + str(Axis.dyStr) + var_separator + str(Axis.dzStr)
364         Axis = AxisStruct(Axis.x, Axis.y, Axis.z, Axis.dx, Axis.dy, Axis.dz)
365     return Axis, Parameters
366
367 ## Return list of variable values from salome notebook
368 def ParseAngles(list):
369     Result = []
370     Parameters = ""
371     for parameter in list:
372         if isinstance(parameter,str) and notebook.isVariable(parameter):
373             Result.append(DegreesToRadians(notebook.get(parameter)))
374             pass
375         else:
376             Result.append(parameter)
377             pass
378         
379         Parameters = Parameters + str(parameter)
380         Parameters = Parameters + var_separator
381         pass
382     Parameters = Parameters[:len(Parameters)-1]
383     return Result, Parameters
384     
385 def IsEqual(val1, val2, tol=PrecisionConfusion):
386     if abs(val1 - val2) < tol:
387         return True
388     return False
389
390 NO_NAME = "NoName"
391
392 ## Gets object name
393 def GetName(obj):
394     ior  = salome.orb.object_to_string(obj)
395     sobj = salome.myStudy.FindObjectIOR(ior)
396     if sobj is None:
397         return NO_NAME
398     else:
399         attr = sobj.FindAttribute("AttributeName")[1]
400         return attr.Value()
401
402 ## Prints error message if a hypothesis was not assigned.
403 def TreatHypoStatus(status, hypName, geomName, isAlgo):
404     if isAlgo:
405         hypType = "algorithm"
406     else:
407         hypType = "hypothesis"
408         pass
409     if status == HYP_UNKNOWN_FATAL :
410         reason = "for unknown reason"
411     elif status == HYP_INCOMPATIBLE :
412         reason = "this hypothesis mismatches the algorithm"
413     elif status == HYP_NOTCONFORM :
414         reason = "a non-conform mesh would be built"
415     elif status == HYP_ALREADY_EXIST :
416         reason = hypType + " of the same dimension is already assigned to this shape"
417     elif status == HYP_BAD_DIM :
418         reason = hypType + " mismatches the shape"
419     elif status == HYP_CONCURENT :
420         reason = "there are concurrent hypotheses on sub-shapes"
421     elif status == HYP_BAD_SUBSHAPE :
422         reason = "the shape is neither the main one, nor its subshape, nor a valid group"
423     elif status == HYP_BAD_GEOMETRY:
424         reason = "geometry mismatches the expectation of the algorithm"
425     elif status == HYP_HIDDEN_ALGO:
426         reason = "it is hidden by an algorithm of an upper dimension, which generates elements of all dimensions"
427     elif status == HYP_HIDING_ALGO:
428         reason = "it hides algorithms of lower dimensions by generating elements of all dimensions"
429     elif status == HYP_NEED_SHAPE:
430         reason = "Algorithm can't work without shape"
431     else:
432         return
433     hypName = '"' + hypName + '"'
434     geomName= '"' + geomName+ '"'
435     if status < HYP_UNKNOWN_FATAL:
436         print hypName, "was assigned to",    geomName,"but", reason
437     else:
438         print hypName, "was not assigned to",geomName,":", reason
439         pass
440
441 ## Check meshing plugin availability
442 def CheckPlugin(plugin):
443     if plugin == NETGEN and noNETGENPlugin:
444         print "Warning: NETGENPlugin module unavailable"
445         return False
446     elif plugin == GHS3D and noGHS3DPlugin:
447         print "Warning: GHS3DPlugin module unavailable"
448         return False
449     elif plugin == GHS3DPRL and noGHS3DPRLPlugin:
450         print "Warning: GHS3DPRLPlugin module unavailable"
451         return False
452     elif plugin == Hexotic and noHexoticPlugin:
453         print "Warning: HexoticPlugin module unavailable"
454         return False
455     elif plugin == BLSURF and noBLSURFPlugin:
456         print "Warning: BLSURFPlugin module unavailable"
457         return False
458     return True
459     
460 # end of l1_auxiliary
461 ## @}
462
463 # All methods of this class are accessible directly from the smesh.py package.
464 class smeshDC(SMESH._objref_SMESH_Gen):
465
466     ## Sets the current study and Geometry component
467     #  @ingroup l1_auxiliary
468     def init_smesh(self,theStudy,geompyD):
469         self.SetCurrentStudy(theStudy,geompyD)
470
471     ## Creates an empty Mesh. This mesh can have an underlying geometry.
472     #  @param obj the Geometrical object on which the mesh is built. If not defined,
473     #             the mesh will have no underlying geometry.
474     #  @param name the name for the new mesh.
475     #  @return an instance of Mesh class.
476     #  @ingroup l2_construct
477     def Mesh(self, obj=0, name=0):
478         if isinstance(obj,str):
479             obj,name = name,obj
480         return Mesh(self,self.geompyD,obj,name)
481
482     ## Returns a long value from enumeration
483     #  Should be used for SMESH.FunctorType enumeration
484     #  @ingroup l1_controls
485     def EnumToLong(self,theItem):
486         return theItem._v
487
488     ## Gets PointStruct from vertex
489     #  @param theVertex a GEOM object(vertex)
490     #  @return SMESH.PointStruct
491     #  @ingroup l1_auxiliary
492     def GetPointStruct(self,theVertex):
493         [x, y, z] = self.geompyD.PointCoordinates(theVertex)
494         return PointStruct(x,y,z)
495
496     ## Gets DirStruct from vector
497     #  @param theVector a GEOM object(vector)
498     #  @return SMESH.DirStruct
499     #  @ingroup l1_auxiliary
500     def GetDirStruct(self,theVector):
501         vertices = self.geompyD.SubShapeAll( theVector, geompyDC.ShapeType["VERTEX"] )
502         if(len(vertices) != 2):
503             print "Error: vector object is incorrect."
504             return None
505         p1 = self.geompyD.PointCoordinates(vertices[0])
506         p2 = self.geompyD.PointCoordinates(vertices[1])
507         pnt = PointStruct(p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
508         dirst = DirStruct(pnt)
509         return dirst
510
511     ## Makes DirStruct from a triplet
512     #  @param x,y,z vector components
513     #  @return SMESH.DirStruct
514     #  @ingroup l1_auxiliary
515     def MakeDirStruct(self,x,y,z):
516         pnt = PointStruct(x,y,z)
517         return DirStruct(pnt)
518
519     ## Get AxisStruct from object
520     #  @param theObj a GEOM object (line or plane)
521     #  @return SMESH.AxisStruct
522     #  @ingroup l1_auxiliary
523     def GetAxisStruct(self,theObj):
524         edges = self.geompyD.SubShapeAll( theObj, geompyDC.ShapeType["EDGE"] )
525         if len(edges) > 1:
526             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geompyDC.ShapeType["VERTEX"] )
527             vertex3, vertex4 = self.geompyD.SubShapeAll( edges[1], geompyDC.ShapeType["VERTEX"] )
528             vertex1 = self.geompyD.PointCoordinates(vertex1)
529             vertex2 = self.geompyD.PointCoordinates(vertex2)
530             vertex3 = self.geompyD.PointCoordinates(vertex3)
531             vertex4 = self.geompyD.PointCoordinates(vertex4)
532             v1 = [vertex2[0]-vertex1[0], vertex2[1]-vertex1[1], vertex2[2]-vertex1[2]]
533             v2 = [vertex4[0]-vertex3[0], vertex4[1]-vertex3[1], vertex4[2]-vertex3[2]]
534             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] ]
535             axis = AxisStruct(vertex1[0], vertex1[1], vertex1[2], normal[0], normal[1], normal[2])
536             return axis
537         elif len(edges) == 1:
538             vertex1, vertex2 = self.geompyD.SubShapeAll( edges[0], geompyDC.ShapeType["VERTEX"] )
539             p1 = self.geompyD.PointCoordinates( vertex1 )
540             p2 = self.geompyD.PointCoordinates( vertex2 )
541             axis = AxisStruct(p1[0], p1[1], p1[2], p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2])
542             return axis
543         return None
544
545     # From SMESH_Gen interface:
546     # ------------------------
547
548     ## Sets the given name to the object
549     #  @param obj the object to rename
550     #  @param name a new object name
551     #  @ingroup l1_auxiliary
552     def SetName(self, obj, name):
553         if isinstance( obj, Mesh ):
554             obj = obj.GetMesh()
555         elif isinstance( obj, Mesh_Algorithm ):
556             obj = obj.GetAlgorithm()
557         ior  = salome.orb.object_to_string(obj)
558         SMESH._objref_SMESH_Gen.SetName(self, ior, name)
559
560     ## Sets the current mode
561     #  @ingroup l1_auxiliary
562     def SetEmbeddedMode( self,theMode ):
563         #self.SetEmbeddedMode(theMode)
564         SMESH._objref_SMESH_Gen.SetEmbeddedMode(self,theMode)
565
566     ## Gets the current mode
567     #  @ingroup l1_auxiliary
568     def IsEmbeddedMode(self):
569         #return self.IsEmbeddedMode()
570         return SMESH._objref_SMESH_Gen.IsEmbeddedMode(self)
571
572     ## Sets the current study
573     #  @ingroup l1_auxiliary
574     def SetCurrentStudy( self, theStudy, geompyD = None ):
575         #self.SetCurrentStudy(theStudy)
576         if not geompyD:
577             import geompy
578             geompyD = geompy.geom
579             pass
580         self.geompyD=geompyD
581         self.SetGeomEngine(geompyD)
582         SMESH._objref_SMESH_Gen.SetCurrentStudy(self,theStudy)
583
584     ## Gets the current study
585     #  @ingroup l1_auxiliary
586     def GetCurrentStudy(self):
587         #return self.GetCurrentStudy()
588         return SMESH._objref_SMESH_Gen.GetCurrentStudy(self)
589
590     ## Creates a Mesh object importing data from the given UNV file
591     #  @return an instance of Mesh class
592     #  @ingroup l2_impexp
593     def CreateMeshesFromUNV( self,theFileName ):
594         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromUNV(self,theFileName)
595         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
596         return aMesh
597
598     ## Creates a Mesh object(s) importing data from the given MED file
599     #  @return a list of Mesh class instances
600     #  @ingroup l2_impexp
601     def CreateMeshesFromMED( self,theFileName ):
602         aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromMED(self,theFileName)
603         aMeshes = []
604         for iMesh in range(len(aSmeshMeshes)) :
605             aMesh = Mesh(self, self.geompyD, aSmeshMeshes[iMesh])
606             aMeshes.append(aMesh)
607         return aMeshes, aStatus
608
609     ## Creates a Mesh object importing data from the given STL file
610     #  @return an instance of Mesh class
611     #  @ingroup l2_impexp
612     def CreateMeshesFromSTL( self, theFileName ):
613         aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromSTL(self,theFileName)
614         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
615         return aMesh
616
617     ## From SMESH_Gen interface
618     #  @return the list of integer values
619     #  @ingroup l1_auxiliary
620     def GetSubShapesId( self, theMainObject, theListOfSubObjects ):
621         return SMESH._objref_SMESH_Gen.GetSubShapesId(self,theMainObject, theListOfSubObjects)
622
623     ## From SMESH_Gen interface. Creates a pattern
624     #  @return an instance of SMESH_Pattern
625     #
626     #  <a href="../tui_modifying_meshes_page.html#tui_pattern_mapping">Example of Patterns usage</a>
627     #  @ingroup l2_modif_patterns
628     def GetPattern(self):
629         return SMESH._objref_SMESH_Gen.GetPattern(self)
630
631     ## Sets number of segments per diagonal of boundary box of geometry by which
632     #  default segment length of appropriate 1D hypotheses is defined.
633     #  Default value is 10
634     #  @ingroup l1_auxiliary
635     def SetBoundaryBoxSegmentation(self, nbSegments):
636         SMESH._objref_SMESH_Gen.SetBoundaryBoxSegmentation(self,nbSegments)
637
638     ## Concatenate the given meshes into one mesh.
639     #  @return an instance of Mesh class
640     #  @param meshes the meshes to combine into one mesh
641     #  @param uniteIdenticalGroups if true, groups with same names are united, else they are renamed
642     #  @param mergeNodesAndElements if true, equal nodes and elements aremerged
643     #  @param mergeTolerance tolerance for merging nodes
644     #  @param allGroups forces creation of groups of all elements
645     def Concatenate( self, meshes, uniteIdenticalGroups,
646                      mergeNodesAndElements = False, mergeTolerance = 1e-5, allGroups = False):
647         mergeTolerance,Parameters = geompyDC.ParseParameters(mergeTolerance)
648         if allGroups:
649             aSmeshMesh = SMESH._objref_SMESH_Gen.ConcatenateWithGroups(
650                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
651         else:
652             aSmeshMesh = SMESH._objref_SMESH_Gen.Concatenate(
653                 self,meshes,uniteIdenticalGroups,mergeNodesAndElements,mergeTolerance)
654         aSmeshMesh.SetParameters(Parameters)
655         aMesh = Mesh(self, self.geompyD, aSmeshMesh)
656         return aMesh
657
658     # Filtering. Auxiliary functions:
659     # ------------------------------
660
661     ## Creates an empty criterion
662     #  @return SMESH.Filter.Criterion
663     #  @ingroup l1_controls
664     def GetEmptyCriterion(self):
665         Type = self.EnumToLong(FT_Undefined)
666         Compare = self.EnumToLong(FT_Undefined)
667         Threshold = 0
668         ThresholdStr = ""
669         ThresholdID = ""
670         UnaryOp = self.EnumToLong(FT_Undefined)
671         BinaryOp = self.EnumToLong(FT_Undefined)
672         Tolerance = 1e-07
673         TypeOfElement = ALL
674         Precision = -1 ##@1e-07
675         return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID,
676                                 UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision)
677
678     ## Creates a criterion by the given parameters
679     #  @param elementType the type of elements(NODE, EDGE, FACE, VOLUME)
680     #  @param CritType the type of criterion (FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc.)
681     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
682     #  @param Treshold the threshold value (range of ids as string, shape, numeric)
683     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
684     #  @param BinaryOp a binary logical operation FT_LogicalAND, FT_LogicalOR or
685     #                  FT_Undefined (must be for the last criterion of all criteria)
686     #  @return SMESH.Filter.Criterion
687     #  @ingroup l1_controls
688     def GetCriterion(self,elementType,
689                      CritType,
690                      Compare = FT_EqualTo,
691                      Treshold="",
692                      UnaryOp=FT_Undefined,
693                      BinaryOp=FT_Undefined):
694         aCriterion = self.GetEmptyCriterion()
695         aCriterion.TypeOfElement = elementType
696         aCriterion.Type = self.EnumToLong(CritType)
697
698         aTreshold = Treshold
699
700         if Compare in [FT_LessThan, FT_MoreThan, FT_EqualTo]:
701             aCriterion.Compare = self.EnumToLong(Compare)
702         elif Compare == "=" or Compare == "==":
703             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
704         elif Compare == "<":
705             aCriterion.Compare = self.EnumToLong(FT_LessThan)
706         elif Compare == ">":
707             aCriterion.Compare = self.EnumToLong(FT_MoreThan)
708         else:
709             aCriterion.Compare = self.EnumToLong(FT_EqualTo)
710             aTreshold = Compare
711
712         if CritType in [FT_BelongToGeom,     FT_BelongToPlane, FT_BelongToGenSurface,
713                         FT_BelongToCylinder, FT_LyingOnGeom]:
714             # Checks the treshold
715             if isinstance(aTreshold, geompyDC.GEOM._objref_GEOM_Object):
716                 aCriterion.ThresholdStr = GetName(aTreshold)
717                 aCriterion.ThresholdID = salome.ObjectToID(aTreshold)
718             else:
719                 print "Error: The treshold should be a shape."
720                 return None
721         elif CritType == FT_RangeOfIds:
722             # Checks the treshold
723             if isinstance(aTreshold, str):
724                 aCriterion.ThresholdStr = aTreshold
725             else:
726                 print "Error: The treshold should be a string."
727                 return None
728         elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_BadOrientedVolume, FT_FreeNodes,
729                           FT_FreeFaces, FT_ElemGeomType, FT_GroupColor]:
730             # At this point the treshold is unnecessary
731             if aTreshold ==  FT_LogicalNOT:
732                 aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
733             elif aTreshold in [FT_LogicalAND, FT_LogicalOR]:
734                 aCriterion.BinaryOp = aTreshold
735         else:
736             # Check treshold
737             try:
738                 aTreshold = float(aTreshold)
739                 aCriterion.Threshold = aTreshold
740             except:
741                 print "Error: The treshold should be a number."
742                 return None
743
744         if Treshold ==  FT_LogicalNOT or UnaryOp ==  FT_LogicalNOT:
745             aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT)
746
747         if Treshold in [FT_LogicalAND, FT_LogicalOR]:
748             aCriterion.BinaryOp = self.EnumToLong(Treshold)
749
750         if UnaryOp in [FT_LogicalAND, FT_LogicalOR]:
751             aCriterion.BinaryOp = self.EnumToLong(UnaryOp)
752
753         if BinaryOp in [FT_LogicalAND, FT_LogicalOR]:
754             aCriterion.BinaryOp = self.EnumToLong(BinaryOp)
755
756         return aCriterion
757
758     ## Creates a filter with the given parameters
759     #  @param elementType the type of elements in the group
760     #  @param CritType the type of criterion ( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
761     #  @param Compare  belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
762     #  @param Treshold the threshold value (range of id ids as string, shape, numeric)
763     #  @param UnaryOp  FT_LogicalNOT or FT_Undefined
764     #  @return SMESH_Filter
765     #  @ingroup l1_controls
766     def GetFilter(self,elementType,
767                   CritType=FT_Undefined,
768                   Compare=FT_EqualTo,
769                   Treshold="",
770                   UnaryOp=FT_Undefined):
771         aCriterion = self.GetCriterion(elementType, CritType, Compare, Treshold, UnaryOp, FT_Undefined)
772         aFilterMgr = self.CreateFilterManager()
773         aFilter = aFilterMgr.CreateFilter()
774         aCriteria = []
775         aCriteria.append(aCriterion)
776         aFilter.SetCriteria(aCriteria)
777         return aFilter
778
779     ## Creates a numerical functor by its type
780     #  @param theCriterion FT_...; functor type
781     #  @return SMESH_NumericalFunctor
782     #  @ingroup l1_controls
783     def GetFunctor(self,theCriterion):
784         aFilterMgr = self.CreateFilterManager()
785         if theCriterion == FT_AspectRatio:
786             return aFilterMgr.CreateAspectRatio()
787         elif theCriterion == FT_AspectRatio3D:
788             return aFilterMgr.CreateAspectRatio3D()
789         elif theCriterion == FT_Warping:
790             return aFilterMgr.CreateWarping()
791         elif theCriterion == FT_MinimumAngle:
792             return aFilterMgr.CreateMinimumAngle()
793         elif theCriterion == FT_Taper:
794             return aFilterMgr.CreateTaper()
795         elif theCriterion == FT_Skew:
796             return aFilterMgr.CreateSkew()
797         elif theCriterion == FT_Area:
798             return aFilterMgr.CreateArea()
799         elif theCriterion == FT_Volume3D:
800             return aFilterMgr.CreateVolume3D()
801         elif theCriterion == FT_MultiConnection:
802             return aFilterMgr.CreateMultiConnection()
803         elif theCriterion == FT_MultiConnection2D:
804             return aFilterMgr.CreateMultiConnection2D()
805         elif theCriterion == FT_Length:
806             return aFilterMgr.CreateLength()
807         elif theCriterion == FT_Length2D:
808             return aFilterMgr.CreateLength2D()
809         else:
810             print "Error: given parameter is not numerucal functor type."
811
812     ## Creates hypothesis
813     #  @param theHType mesh hypothesis type (string)
814     #  @param theLibName mesh plug-in library name
815     #  @return created hypothesis instance
816     def CreateHypothesis(self, theHType, theLibName="libStdMeshersEngine.so"):
817         return SMESH._objref_SMESH_Gen.CreateHypothesis(self, theHType, theLibName )
818
819     ## Gets the mesh stattistic
820     #  @return dictionary type element - count of elements
821     #  @ingroup l1_meshinfo
822     def GetMeshInfo(self, obj):
823         if isinstance( obj, Mesh ):
824             obj = obj.GetMesh()
825         d = {}
826         if hasattr(obj, "_narrow") and obj._narrow(SMESH.SMESH_IDSource):
827             values = obj.GetMeshInfo() 
828             for i in range(SMESH.Entity_Last._v):
829                 if i < len(values): d[SMESH.EntityType._item(i)]=values[i]
830             pass
831         return d
832
833 import omniORB
834 #Registering the new proxy for SMESH_Gen
835 omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshDC)
836
837
838 # Public class: Mesh
839 # ==================
840
841 ## This class allows defining and managing a mesh.
842 #  It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes.
843 #  It also has methods to define groups of mesh elements, to modify a mesh (by addition of
844 #  new nodes and elements and by changing the existing entities), to get information
845 #  about a mesh and to export a mesh into different formats.
846 class Mesh:
847
848     geom = 0
849     mesh = 0
850     editor = 0
851
852     ## Constructor
853     #
854     #  Creates a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and
855     #  sets the GUI name of this mesh to \a name.
856     #  @param smeshpyD an instance of smeshDC class
857     #  @param geompyD an instance of geompyDC class
858     #  @param obj Shape to be meshed or SMESH_Mesh object
859     #  @param name Study name of the mesh
860     #  @ingroup l2_construct
861     def __init__(self, smeshpyD, geompyD, obj=0, name=0):
862         self.smeshpyD=smeshpyD
863         self.geompyD=geompyD
864         if obj is None:
865             obj = 0
866         if obj != 0:
867             if isinstance(obj, geompyDC.GEOM._objref_GEOM_Object):
868                 self.geom = obj
869                 self.mesh = self.smeshpyD.CreateMesh(self.geom)
870             elif isinstance(obj, SMESH._objref_SMESH_Mesh):
871                 self.SetMesh(obj)
872         else:
873             self.mesh = self.smeshpyD.CreateEmptyMesh()
874         if name != 0:
875             self.smeshpyD.SetName(self.mesh, name)
876         elif obj != 0:
877             self.smeshpyD.SetName(self.mesh, GetName(obj))
878
879         if not self.geom:
880             self.geom = self.mesh.GetShapeToMesh()
881
882         self.editor = self.mesh.GetMeshEditor()
883
884     ## Initializes the Mesh object from an instance of SMESH_Mesh interface
885     #  @param theMesh a SMESH_Mesh object
886     #  @ingroup l2_construct
887     def SetMesh(self, theMesh):
888         self.mesh = theMesh
889         self.geom = self.mesh.GetShapeToMesh()
890
891     ## Returns the mesh, that is an instance of SMESH_Mesh interface
892     #  @return a SMESH_Mesh object
893     #  @ingroup l2_construct
894     def GetMesh(self):
895         return self.mesh
896
897     ## Gets the name of the mesh
898     #  @return the name of the mesh as a string
899     #  @ingroup l2_construct
900     def GetName(self):
901         name = GetName(self.GetMesh())
902         return name
903
904     ## Sets a name to the mesh
905     #  @param name a new name of the mesh
906     #  @ingroup l2_construct
907     def SetName(self, name):
908         self.smeshpyD.SetName(self.GetMesh(), name)
909
910     ## Gets the subMesh object associated to a \a theSubObject geometrical object.
911     #  The subMesh object gives access to the IDs of nodes and elements.
912     #  @param theSubObject a geometrical object (shape)
913     #  @param theName a name for the submesh
914     #  @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape
915     #  @ingroup l2_submeshes
916     def GetSubMesh(self, theSubObject, theName):
917         submesh = self.mesh.GetSubMesh(theSubObject, theName)
918         return submesh
919
920     ## Returns the shape associated to the mesh
921     #  @return a GEOM_Object
922     #  @ingroup l2_construct
923     def GetShape(self):
924         return self.geom
925
926     ## Associates the given shape to the mesh (entails the recreation of the mesh)
927     #  @param geom the shape to be meshed (GEOM_Object)
928     #  @ingroup l2_construct
929     def SetShape(self, geom):
930         self.mesh = self.smeshpyD.CreateMesh(geom)
931
932     ## Returns true if the hypotheses are defined well
933     #  @param theSubObject a subshape of a mesh shape
934     #  @return True or False
935     #  @ingroup l2_construct
936     def IsReadyToCompute(self, theSubObject):
937         return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject)
938
939     ## Returns errors of hypotheses definition.
940     #  The list of errors is empty if everything is OK.
941     #  @param theSubObject a subshape of a mesh shape
942     #  @return a list of errors
943     #  @ingroup l2_construct
944     def GetAlgoState(self, theSubObject):
945         return self.smeshpyD.GetAlgoState(self.mesh, theSubObject)
946
947     ## Returns a geometrical object on which the given element was built.
948     #  The returned geometrical object, if not nil, is either found in the
949     #  study or published by this method with the given name
950     #  @param theElementID the id of the mesh element
951     #  @param theGeomName the user-defined name of the geometrical object
952     #  @return GEOM::GEOM_Object instance
953     #  @ingroup l2_construct
954     def GetGeometryByMeshElement(self, theElementID, theGeomName):
955         return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName )
956
957     ## Returns the mesh dimension depending on the dimension of the underlying shape
958     #  @return mesh dimension as an integer value [0,3]
959     #  @ingroup l1_auxiliary
960     def MeshDimension(self):
961         shells = self.geompyD.SubShapeAllIDs( self.geom, geompyDC.ShapeType["SHELL"] )
962         if len( shells ) > 0 :
963             return 3
964         elif self.geompyD.NumberOfFaces( self.geom ) > 0 :
965             return 2
966         elif self.geompyD.NumberOfEdges( self.geom ) > 0 :
967             return 1
968         else:
969             return 0;
970         pass
971
972     ## Creates a segment discretization 1D algorithm.
973     #  If the optional \a algo parameter is not set, this algorithm is REGULAR.
974     #  \n If the optional \a geom parameter is not set, this algorithm is global.
975     #  Otherwise, this algorithm defines a submesh based on \a geom subshape.
976     #  @param algo the type of the required algorithm. Possible values are:
977     #     - smesh.REGULAR,
978     #     - smesh.PYTHON for discretization via a python function,
979     #     - smesh.COMPOSITE for meshing a set of edges on one face side as a whole.
980     #  @param geom If defined is the subshape to be meshed
981     #  @return an instance of Mesh_Segment or Mesh_Segment_Python, or Mesh_CompositeSegment class
982     #  @ingroup l3_algos_basic
983     def Segment(self, algo=REGULAR, geom=0):
984         ## if Segment(geom) is called by mistake
985         if isinstance( algo, geompyDC.GEOM._objref_GEOM_Object):
986             algo, geom = geom, algo
987             if not algo: algo = REGULAR
988             pass
989         if algo == REGULAR:
990             return Mesh_Segment(self,  geom)
991         elif algo == PYTHON:
992             return Mesh_Segment_Python(self, geom)
993         elif algo == COMPOSITE:
994             return Mesh_CompositeSegment(self, geom)
995         else:
996             return Mesh_Segment(self, geom)
997
998     ## Enables creation of nodes and segments usable by 2D algoritms.
999     #  The added nodes and segments must be bound to edges and vertices by
1000     #  SetNodeOnVertex(), SetNodeOnEdge() and SetMeshElementOnShape()
1001     #  If the optional \a geom parameter is not set, this algorithm is global.
1002     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1003     #  @param geom the subshape to be manually meshed
1004     #  @return StdMeshers_UseExisting_1D algorithm that generates nothing
1005     #  @ingroup l3_algos_basic
1006     def UseExistingSegments(self, geom=0):
1007         algo = Mesh_UseExisting(1,self,geom)
1008         return algo.GetAlgorithm()
1009
1010     ## Enables creation of nodes and faces usable by 3D algoritms.
1011     #  The added nodes and faces must be bound to geom faces by SetNodeOnFace()
1012     #  and SetMeshElementOnShape()
1013     #  If the optional \a geom parameter is not set, this algorithm is global.
1014     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1015     #  @param geom the subshape to be manually meshed
1016     #  @return StdMeshers_UseExisting_2D algorithm that generates nothing
1017     #  @ingroup l3_algos_basic
1018     def UseExistingFaces(self, geom=0):
1019         algo = Mesh_UseExisting(2,self,geom)
1020         return algo.GetAlgorithm()
1021
1022     ## Creates a triangle 2D algorithm for faces.
1023     #  If the optional \a geom parameter is not set, this algorithm is global.
1024     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1025     #  @param algo values are: smesh.MEFISTO || smesh.NETGEN_1D2D || smesh.NETGEN_2D || smesh.BLSURF
1026     #  @param geom If defined, the subshape to be meshed (GEOM_Object)
1027     #  @return an instance of Mesh_Triangle algorithm
1028     #  @ingroup l3_algos_basic
1029     def Triangle(self, algo=MEFISTO, geom=0):
1030         ## if Triangle(geom) is called by mistake
1031         if (isinstance(algo, geompyDC.GEOM._objref_GEOM_Object)):
1032             geom = algo
1033             algo = MEFISTO
1034
1035         return Mesh_Triangle(self, algo, geom)
1036
1037     ## Creates a quadrangle 2D algorithm for faces.
1038     #  If the optional \a geom parameter is not set, this algorithm is global.
1039     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1040     #  @param geom If defined, the subshape to be meshed (GEOM_Object)
1041     #  @return an instance of Mesh_Quadrangle algorithm
1042     #  @ingroup l3_algos_basic
1043     def Quadrangle(self, geom=0):
1044         return Mesh_Quadrangle(self,  geom)
1045
1046     ## Creates a tetrahedron 3D algorithm for solids.
1047     #  The parameter \a algo permits to choose the algorithm: NETGEN or GHS3D
1048     #  If the optional \a geom parameter is not set, this algorithm is global.
1049     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1050     #  @param algo values are: smesh.NETGEN, smesh.GHS3D, smesh.GHS3DPRL, smesh.FULL_NETGEN
1051     #  @param geom If defined, the subshape to be meshed (GEOM_Object)
1052     #  @return an instance of Mesh_Tetrahedron algorithm
1053     #  @ingroup l3_algos_basic
1054     def Tetrahedron(self, algo=NETGEN, geom=0):
1055         ## if Tetrahedron(geom) is called by mistake
1056         if ( isinstance( algo, geompyDC.GEOM._objref_GEOM_Object)):
1057             algo, geom = geom, algo
1058             if not algo: algo = NETGEN
1059             pass
1060         return Mesh_Tetrahedron(self,  algo, geom)
1061
1062     ## Creates a hexahedron 3D algorithm for solids.
1063     #  If the optional \a geom parameter is not set, this algorithm is global.
1064     #  \n Otherwise, this algorithm defines a submesh based on \a geom subshape.
1065     #  @param algo possible values are: smesh.Hexa, smesh.Hexotic
1066     #  @param geom If defined, the subshape to be meshed (GEOM_Object)
1067     #  @return an instance of Mesh_Hexahedron algorithm
1068     #  @ingroup l3_algos_basic
1069     def Hexahedron(self, algo=Hexa, geom=0):
1070         ## if Hexahedron(geom, algo) or Hexahedron(geom) is called by mistake
1071         if ( isinstance(algo, geompyDC.GEOM._objref_GEOM_Object) ):
1072             if   geom in [Hexa, Hexotic]: algo, geom = geom, algo
1073             elif geom == 0:               algo, geom = Hexa, algo
1074         return Mesh_Hexahedron(self, algo, geom)
1075
1076     ## Deprecated, used only for compatibility!
1077     #  @return an instance of Mesh_Netgen algorithm
1078     #  @ingroup l3_algos_basic
1079     def Netgen(self, is3D, geom=0):
1080         return Mesh_Netgen(self,  is3D, geom)
1081
1082     ## Creates a projection 1D algorithm for edges.
1083     #  If the optional \a geom parameter is not set, this algorithm is global.
1084     #  Otherwise, this algorithm defines a submesh based on \a geom subshape.
1085     #  @param geom If defined, the subshape to be meshed
1086     #  @return an instance of Mesh_Projection1D algorithm
1087     #  @ingroup l3_algos_proj
1088     def Projection1D(self, geom=0):
1089         return Mesh_Projection1D(self,  geom)
1090
1091     ## Creates a projection 2D algorithm for faces.
1092     #  If the optional \a geom parameter is not set, this algorithm is global.
1093     #  Otherwise, this algorithm defines a submesh based on \a geom subshape.
1094     #  @param geom If defined, the subshape to be meshed
1095     #  @return an instance of Mesh_Projection2D algorithm
1096     #  @ingroup l3_algos_proj
1097     def Projection2D(self, geom=0):
1098         return Mesh_Projection2D(self,  geom)
1099
1100     ## Creates a projection 3D algorithm for solids.
1101     #  If the optional \a geom parameter is not set, this algorithm is global.
1102     #  Otherwise, this algorithm defines a submesh based on \a geom subshape.
1103     #  @param geom If defined, the subshape to be meshed
1104     #  @return an instance of Mesh_Projection3D algorithm
1105     #  @ingroup l3_algos_proj
1106     def Projection3D(self, geom=0):
1107         return Mesh_Projection3D(self,  geom)
1108
1109     ## Creates a 3D extrusion (Prism 3D) or RadialPrism 3D algorithm for solids.
1110     #  If the optional \a geom parameter is not set, this algorithm is global.
1111     #  Otherwise, this algorithm defines a submesh based on \a geom subshape.
1112     #  @param geom If defined, the subshape to be meshed
1113     #  @return an instance of Mesh_Prism3D or Mesh_RadialPrism3D algorithm
1114     #  @ingroup l3_algos_radialp l3_algos_3dextr
1115     def Prism(self, geom=0):
1116         shape = geom
1117         if shape==0:
1118             shape = self.geom
1119         nbSolids = len( self.geompyD.SubShapeAll( shape, geompyDC.ShapeType["SOLID"] ))
1120         nbShells = len( self.geompyD.SubShapeAll( shape, geompyDC.ShapeType["SHELL"] ))
1121         if nbSolids == 0 or nbSolids == nbShells:
1122             return Mesh_Prism3D(self,  geom)
1123         return Mesh_RadialPrism3D(self,  geom)
1124
1125     ## Evaluates size of prospective mesh on a shape
1126     #  @return True or False
1127     def Evaluate(self, geom=0):
1128         if geom == 0 or not isinstance(geom, geompyDC.GEOM._objref_GEOM_Object):
1129             if self.geom == 0:
1130                 geom = self.mesh.GetShapeToMesh()
1131             else:
1132                 geom = self.geom
1133         return self.smeshpyD.Evaluate(self.mesh, geom)
1134
1135
1136     ## Computes the mesh and returns the status of the computation
1137     #  @return True or False
1138     #  @ingroup l2_construct
1139     def Compute(self, geom=0):
1140         if geom == 0 or not isinstance(geom, geompyDC.GEOM._objref_GEOM_Object):
1141             if self.geom == 0:
1142                 geom = self.mesh.GetShapeToMesh()
1143             else:
1144                 geom = self.geom
1145         ok = False
1146         try:
1147             ok = self.smeshpyD.Compute(self.mesh, geom)
1148         except SALOME.SALOME_Exception, ex:
1149             print "Mesh computation failed, exception caught:"
1150             print "    ", ex.details.text
1151         except:
1152             import traceback
1153             print "Mesh computation failed, exception caught:"
1154             traceback.print_exc()
1155         if True:#not ok:
1156             errors = self.smeshpyD.GetAlgoState( self.mesh, geom )
1157             allReasons = ""
1158             for err in errors:
1159                 if err.isGlobalAlgo:
1160                     glob = "global"
1161                 else:
1162                     glob = "local"
1163                     pass
1164                 dim = err.algoDim
1165                 name = err.algoName
1166                 if len(name) == 0:
1167                     reason = '%s %sD algorithm is missing' % (glob, dim)
1168                 elif err.state == HYP_MISSING:
1169                     reason = ('%s %sD algorithm "%s" misses %sD hypothesis'
1170                               % (glob, dim, name, dim))
1171                 elif err.state == HYP_NOTCONFORM:
1172                     reason = 'Global "Not Conform mesh allowed" hypothesis is missing'
1173                 elif err.state == HYP_BAD_PARAMETER:
1174                     reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value'
1175                               % ( glob, dim, name ))
1176                 elif err.state == HYP_BAD_GEOMETRY:
1177                     reason = ('%s %sD algorithm "%s" is assigned to mismatching'
1178                               'geometry' % ( glob, dim, name ))
1179                 else:
1180                     reason = "For unknown reason."+\
1181                              " Revise Mesh.Compute() implementation in smeshDC.py!"
1182                     pass
1183                 if allReasons != "":
1184                     allReasons += "\n"
1185                     pass
1186                 allReasons += reason
1187                 pass
1188             if allReasons != "":
1189                 print '"' + GetName(self.mesh) + '"',"has not been computed:"
1190                 print allReasons
1191                 ok = False
1192             elif not ok:
1193                 print '"' + GetName(self.mesh) + '"',"has not been computed."
1194                 pass
1195             pass
1196         if salome.sg.hasDesktop():
1197             smeshgui = salome.ImportComponentGUI("SMESH")
1198             smeshgui.Init(self.mesh.GetStudyId())
1199             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) )
1200             salome.sg.updateObjBrowser(1)
1201             pass
1202         return ok
1203
1204     ## Return submesh objects list in meshing order
1205     #  @return list of list of submesh objects
1206     #  @ingroup l2_construct
1207     def GetMeshOrder(self):
1208         return self.mesh.GetMeshOrder()
1209
1210     ## Return submesh objects list in meshing order
1211     #  @return list of list of submesh objects
1212     #  @ingroup l2_construct
1213     def SetMeshOrder(self, submeshes):
1214         return self.mesh.SetMeshOrder(submeshes)
1215
1216     ## Removes all nodes and elements
1217     #  @ingroup l2_construct
1218     def Clear(self):
1219         self.mesh.Clear()
1220         if salome.sg.hasDesktop():
1221             smeshgui = salome.ImportComponentGUI("SMESH")
1222             smeshgui.Init(self.mesh.GetStudyId())
1223             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1224             salome.sg.updateObjBrowser(1)
1225
1226     ## Removes all nodes and elements of indicated shape
1227     #  @ingroup l2_construct
1228     def ClearSubMesh(self, geomId):
1229         self.mesh.ClearSubMesh(geomId)
1230         if salome.sg.hasDesktop():
1231             smeshgui = salome.ImportComponentGUI("SMESH")
1232             smeshgui.Init(self.mesh.GetStudyId())
1233             smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True )
1234             salome.sg.updateObjBrowser(1)
1235
1236     ## Computes a tetrahedral mesh using AutomaticLength + MEFISTO + NETGEN
1237     #  @param fineness [0,-1] defines mesh fineness
1238     #  @return True or False
1239     #  @ingroup l3_algos_basic
1240     def AutomaticTetrahedralization(self, fineness=0):
1241         dim = self.MeshDimension()
1242         # assign hypotheses
1243         self.RemoveGlobalHypotheses()
1244         self.Segment().AutomaticLength(fineness)
1245         if dim > 1 :
1246             self.Triangle().LengthFromEdges()
1247             pass
1248         if dim > 2 :
1249             self.Tetrahedron(NETGEN)
1250             pass
1251         return self.Compute()
1252
1253     ## Computes an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron
1254     #  @param fineness [0,-1] defines mesh fineness
1255     #  @return True or False
1256     #  @ingroup l3_algos_basic
1257     def AutomaticHexahedralization(self, fineness=0):
1258         dim = self.MeshDimension()
1259         # assign the hypotheses
1260         self.RemoveGlobalHypotheses()
1261         self.Segment().AutomaticLength(fineness)
1262         if dim > 1 :
1263             self.Quadrangle()
1264             pass
1265         if dim > 2 :
1266             self.Hexahedron()
1267             pass
1268         return self.Compute()
1269
1270     ## Assigns a hypothesis
1271     #  @param hyp a hypothesis to assign
1272     #  @param geom a subhape of mesh geometry
1273     #  @return SMESH.Hypothesis_Status
1274     #  @ingroup l2_hypotheses
1275     def AddHypothesis(self, hyp, geom=0):
1276         if isinstance( hyp, Mesh_Algorithm ):
1277             hyp = hyp.GetAlgorithm()
1278             pass
1279         if not geom:
1280             geom = self.geom
1281             if not geom:
1282                 geom = self.mesh.GetShapeToMesh()
1283             pass
1284         status = self.mesh.AddHypothesis(geom, hyp)
1285         isAlgo = hyp._narrow( SMESH_Algo )
1286         TreatHypoStatus( status, GetName( hyp ), GetName( geom ), isAlgo )
1287         return status
1288
1289     ## Unassigns a hypothesis
1290     #  @param hyp a hypothesis to unassign
1291     #  @param geom a subshape of mesh geometry
1292     #  @return SMESH.Hypothesis_Status
1293     #  @ingroup l2_hypotheses
1294     def RemoveHypothesis(self, hyp, geom=0):
1295         if isinstance( hyp, Mesh_Algorithm ):
1296             hyp = hyp.GetAlgorithm()
1297             pass
1298         if not geom:
1299             geom = self.geom
1300             pass
1301         status = self.mesh.RemoveHypothesis(geom, hyp)
1302         return status
1303
1304     ## Gets the list of hypotheses added on a geometry
1305     #  @param geom a subshape of mesh geometry
1306     #  @return the sequence of SMESH_Hypothesis
1307     #  @ingroup l2_hypotheses
1308     def GetHypothesisList(self, geom):
1309         return self.mesh.GetHypothesisList( geom )
1310
1311     ## Removes all global hypotheses
1312     #  @ingroup l2_hypotheses
1313     def RemoveGlobalHypotheses(self):
1314         current_hyps = self.mesh.GetHypothesisList( self.geom )
1315         for hyp in current_hyps:
1316             self.mesh.RemoveHypothesis( self.geom, hyp )
1317             pass
1318         pass
1319
1320     ## Creates a mesh group based on the geometric object \a grp
1321     #  and gives a \a name, \n if this parameter is not defined
1322     #  the name is the same as the geometric group name \n
1323     #  Note: Works like GroupOnGeom().
1324     #  @param grp  a geometric group, a vertex, an edge, a face or a solid
1325     #  @param name the name of the mesh group
1326     #  @return SMESH_GroupOnGeom
1327     #  @ingroup l2_grps_create
1328     def Group(self, grp, name=""):
1329         return self.GroupOnGeom(grp, name)
1330
1331     ## Deprecated, used only for compatibility! Please, use ExportMED() method instead.
1332     #  Exports the mesh in a file in MED format and chooses the \a version of MED format
1333     #  @param f the file name
1334     #  @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2
1335     #  @param opt boolean parameter for creating/not creating
1336     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ...
1337     #  @ingroup l2_impexp
1338     def ExportToMED(self, f, version, opt=0):
1339         self.mesh.ExportToMED(f, opt, version)
1340
1341     ## Exports the mesh in a file in MED format
1342     #  @param f is the file name
1343     #  @param auto_groups boolean parameter for creating/not creating
1344     #  the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
1345     #  the typical use is auto_groups=false.
1346     #  @param version MED format version(MED_V2_1 or MED_V2_2)
1347     #  @ingroup l2_impexp
1348     def ExportMED(self, f, auto_groups=0, version=MED_V2_2):
1349         self.mesh.ExportToMED(f, auto_groups, version)
1350
1351     ## Exports the mesh in a file in DAT format
1352     #  @param f the file name
1353     #  @ingroup l2_impexp
1354     def ExportDAT(self, f):
1355         self.mesh.ExportDAT(f)
1356
1357     ## Exports the mesh in a file in UNV format
1358     #  @param f the file name
1359     #  @ingroup l2_impexp
1360     def ExportUNV(self, f):
1361         self.mesh.ExportUNV(f)
1362
1363     ## Export the mesh in a file in STL format
1364     #  @param f the file name
1365     #  @param ascii defines the file encoding
1366     #  @ingroup l2_impexp
1367     def ExportSTL(self, f, ascii=1):
1368         self.mesh.ExportSTL(f, ascii)
1369
1370
1371     # Operations with groups:
1372     # ----------------------
1373
1374     ## Creates an empty mesh group
1375     #  @param elementType the type of elements in the group
1376     #  @param name the name of the mesh group
1377     #  @return SMESH_Group
1378     #  @ingroup l2_grps_create
1379     def CreateEmptyGroup(self, elementType, name):
1380         return self.mesh.CreateGroup(elementType, name)
1381
1382     ## Creates a mesh group based on the geometrical object \a grp
1383     #  and gives a \a name, \n if this parameter is not defined
1384     #  the name is the same as the geometrical group name
1385     #  @param grp  a geometrical group, a vertex, an edge, a face or a solid
1386     #  @param name the name of the mesh group
1387     #  @param typ  the type of elements in the group. If not set, it is
1388     #              automatically detected by the type of the geometry
1389     #  @return SMESH_GroupOnGeom
1390     #  @ingroup l2_grps_create
1391     def GroupOnGeom(self, grp, name="", typ=None):
1392         if name == "":
1393             name = grp.GetName()
1394
1395         if typ == None:
1396             tgeo = str(grp.GetShapeType())
1397             if tgeo == "VERTEX":
1398                 typ = NODE
1399             elif tgeo == "EDGE":
1400                 typ = EDGE
1401             elif tgeo == "FACE":
1402                 typ = FACE
1403             elif tgeo == "SOLID":
1404                 typ = VOLUME
1405             elif tgeo == "SHELL":
1406                 typ = VOLUME
1407             elif tgeo == "COMPOUND":
1408                 try: # it raises on a compound of compounds
1409                     if len( self.geompyD.GetObjectIDs( grp )) == 0:
1410                         print "Mesh.Group: empty geometric group", GetName( grp )
1411                         return 0
1412                     pass
1413                 except:
1414                     pass
1415                 if grp.GetType() == 37: # GEOMImpl_Types.hxx: #define GEOM_GROUP 37
1416                     # group
1417                     tgeo = self.geompyD.GetType(grp)
1418                     if tgeo == geompyDC.ShapeType["VERTEX"]:
1419                         typ = NODE
1420                     elif tgeo == geompyDC.ShapeType["EDGE"]:
1421                         typ = EDGE
1422                     elif tgeo == geompyDC.ShapeType["FACE"]:
1423                         typ = FACE
1424                     elif tgeo == geompyDC.ShapeType["SOLID"]:
1425                         typ = VOLUME
1426                         pass
1427                     pass
1428                 else:
1429                     # just a compound
1430                     for elemType, shapeType in [[VOLUME,"SOLID"],[FACE,"FACE"],
1431                                                 [EDGE,"EDGE"],[NODE,"VERTEX"]]:
1432                         if self.geompyD.SubShapeAll(grp,geompyDC.ShapeType[shapeType]):
1433                             typ = elemType
1434                             break
1435                         pass
1436                     pass
1437                 pass
1438             pass
1439         if typ == None:
1440             print "Mesh.Group: bad first argument: expected a group, a vertex, an edge, a face or a solid"
1441             return 0
1442         else:
1443             return self.mesh.CreateGroupFromGEOM(typ, name, grp)
1444
1445     ## Creates a mesh group by the given ids of elements
1446     #  @param groupName the name of the mesh group
1447     #  @param elementType the type of elements in the group
1448     #  @param elemIDs the list of ids
1449     #  @return SMESH_Group
1450     #  @ingroup l2_grps_create
1451     def MakeGroupByIds(self, groupName, elementType, elemIDs):
1452         group = self.mesh.CreateGroup(elementType, groupName)
1453         group.Add(elemIDs)
1454         return group
1455
1456     ## Creates a mesh group by the given conditions
1457     #  @param groupName the name of the mesh group
1458     #  @param elementType the type of elements in the group
1459     #  @param CritType the type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
1460     #  @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo}
1461     #  @param Treshold the threshold value (range of id ids as string, shape, numeric)
1462     #  @param UnaryOp FT_LogicalNOT or FT_Undefined
1463     #  @return SMESH_Group
1464     #  @ingroup l2_grps_create
1465     def MakeGroup(self,
1466                   groupName,
1467                   elementType,
1468                   CritType=FT_Undefined,
1469                   Compare=FT_EqualTo,
1470                   Treshold="",
1471                   UnaryOp=FT_Undefined):
1472         aCriterion = self.smeshpyD.GetCriterion(elementType, CritType, Compare, Treshold, UnaryOp, FT_Undefined)
1473         group = self.MakeGroupByCriterion(groupName, aCriterion)
1474         return group
1475
1476     ## Creates a mesh group by the given criterion
1477     #  @param groupName the name of the mesh group
1478     #  @param Criterion the instance of Criterion class
1479     #  @return SMESH_Group
1480     #  @ingroup l2_grps_create
1481     def MakeGroupByCriterion(self, groupName, Criterion):
1482         aFilterMgr = self.smeshpyD.CreateFilterManager()
1483         aFilter = aFilterMgr.CreateFilter()
1484         aCriteria = []
1485         aCriteria.append(Criterion)
1486         aFilter.SetCriteria(aCriteria)
1487         group = self.MakeGroupByFilter(groupName, aFilter)
1488         return group
1489
1490     ## Creates a mesh group by the given criteria (list of criteria)
1491     #  @param groupName the name of the mesh group
1492     #  @param theCriteria the list of criteria
1493     #  @return SMESH_Group
1494     #  @ingroup l2_grps_create
1495     def MakeGroupByCriteria(self, groupName, theCriteria):
1496         aFilterMgr = self.smeshpyD.CreateFilterManager()
1497         aFilter = aFilterMgr.CreateFilter()
1498         aFilter.SetCriteria(theCriteria)
1499         group = self.MakeGroupByFilter(groupName, aFilter)
1500         return group
1501
1502     ## Creates a mesh group by the given filter
1503     #  @param groupName the name of the mesh group
1504     #  @param theFilter the instance of Filter class
1505     #  @return SMESH_Group
1506     #  @ingroup l2_grps_create
1507     def MakeGroupByFilter(self, groupName, theFilter):
1508         anIds = theFilter.GetElementsId(self.mesh)
1509         anElemType = theFilter.GetElementType()
1510         group = self.MakeGroupByIds(groupName, anElemType, anIds)
1511         return group
1512
1513     ## Passes mesh elements through the given filter and return IDs of fitting elements
1514     #  @param theFilter SMESH_Filter
1515     #  @return a list of ids
1516     #  @ingroup l1_controls
1517     def GetIdsFromFilter(self, theFilter):
1518         return theFilter.GetElementsId(self.mesh)
1519
1520     ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n
1521     #  Returns a list of special structures (borders).
1522     #  @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes.
1523     #  @ingroup l1_controls
1524     def GetFreeBorders(self):
1525         aFilterMgr = self.smeshpyD.CreateFilterManager()
1526         aPredicate = aFilterMgr.CreateFreeEdges()
1527         aPredicate.SetMesh(self.mesh)
1528         aBorders = aPredicate.GetBorders()
1529         return aBorders
1530
1531     ## Removes a group
1532     #  @ingroup l2_grps_delete
1533     def RemoveGroup(self, group):
1534         self.mesh.RemoveGroup(group)
1535
1536     ## Removes a group with its contents
1537     #  @ingroup l2_grps_delete
1538     def RemoveGroupWithContents(self, group):
1539         self.mesh.RemoveGroupWithContents(group)
1540
1541     ## Gets the list of groups existing in the mesh
1542     #  @return a sequence of SMESH_GroupBase
1543     #  @ingroup l2_grps_create
1544     def GetGroups(self):
1545         return self.mesh.GetGroups()
1546
1547     ## Gets the number of groups existing in the mesh
1548     #  @return the quantity of groups as an integer value
1549     #  @ingroup l2_grps_create
1550     def NbGroups(self):
1551         return self.mesh.NbGroups()
1552
1553     ## Gets the list of names of groups existing in the mesh
1554     #  @return list of strings
1555     #  @ingroup l2_grps_create
1556     def GetGroupNames(self):
1557         groups = self.GetGroups()
1558         names = []
1559         for group in groups:
1560             names.append(group.GetName())
1561         return names
1562
1563     ## Produces a union of two groups
1564     #  A new group is created. All mesh elements that are
1565     #  present in the initial groups are added to the new one
1566     #  @return an instance of SMESH_Group
1567     #  @ingroup l2_grps_operon
1568     def UnionGroups(self, group1, group2, name):
1569         return self.mesh.UnionGroups(group1, group2, name)
1570         
1571     ## Produces a union list of groups
1572     #  New group is created. All mesh elements that are present in 
1573     #  initial groups are added to the new one
1574     #  @return an instance of SMESH_Group
1575     #  @ingroup l2_grps_operon
1576     def UnionListOfGroups(self, groups, name):
1577       return self.mesh.UnionListOfGroups(groups, name)
1578       
1579     ## Prodices an intersection of two groups
1580     #  A new group is created. All mesh elements that are common
1581     #  for the two initial groups are added to the new one.
1582     #  @return an instance of SMESH_Group
1583     #  @ingroup l2_grps_operon
1584     def IntersectGroups(self, group1, group2, name):
1585         return self.mesh.IntersectGroups(group1, group2, name)
1586         
1587     ## Produces an intersection of groups
1588     #  New group is created. All mesh elements that are present in all 
1589     #  initial groups simultaneously are added to the new one
1590     #  @return an instance of SMESH_Group
1591     #  @ingroup l2_grps_operon
1592     def IntersectListOfGroups(self, groups, name):
1593       return self.mesh.IntersectListOfGroups(groups, name)
1594
1595     ## Produces a cut of two groups
1596     #  A new group is created. All mesh elements that are present in
1597     #  the main group but are not present in the tool group are added to the new one
1598     #  @return an instance of SMESH_Group
1599     #  @ingroup l2_grps_operon
1600     def CutGroups(self, main_group, tool_group, name):
1601         return self.mesh.CutGroups(main_group, tool_group, name)
1602         
1603     ## Produces a cut of groups
1604     #  A new group is created. All mesh elements that are present in main groups 
1605     #  but do not present in tool groups are added to the new one
1606     #  @return an instance of SMESH_Group
1607     #  @ingroup l2_grps_operon
1608     def CutListOfGroups(self, main_groups, tool_groups, name):
1609       return self.mesh.CutListOfGroups(main_groups, tool_groups, name)
1610       
1611     ## Produces a group of elements with specified element type using list of existing groups
1612     #  A new group is created. System 
1613     #  1) extract all nodes on which groups elements are built
1614     #  2) combine all elements of specified dimension laying on these nodes
1615     #  @return an instance of SMESH_Group
1616     #  @ingroup l2_grps_operon
1617     def CreateDimGroup(self, groups, elem_type, name):
1618       return self.mesh.CreateDimGroup(groups, elem_type, name)
1619
1620
1621     ## Convert group on geom into standalone group
1622     #  @ingroup l2_grps_delete
1623     def ConvertToStandalone(self, group):
1624         return self.mesh.ConvertToStandalone(group)
1625
1626     # Get some info about mesh:
1627     # ------------------------
1628
1629     ## Returns the log of nodes and elements added or removed
1630     #  since the previous clear of the log.
1631     #  @param clearAfterGet log is emptied after Get (safe if concurrents access)
1632     #  @return list of log_block structures:
1633     #                                        commandType
1634     #                                        number
1635     #                                        coords
1636     #                                        indexes
1637     #  @ingroup l1_auxiliary
1638     def GetLog(self, clearAfterGet):
1639         return self.mesh.GetLog(clearAfterGet)
1640
1641     ## Clears the log of nodes and elements added or removed since the previous
1642     #  clear. Must be used immediately after GetLog if clearAfterGet is false.
1643     #  @ingroup l1_auxiliary
1644     def ClearLog(self):
1645         self.mesh.ClearLog()
1646
1647     ## Toggles auto color mode on the object.
1648     #  @param theAutoColor the flag which toggles auto color mode.
1649     #  @ingroup l1_auxiliary
1650     def SetAutoColor(self, theAutoColor):
1651         self.mesh.SetAutoColor(theAutoColor)
1652
1653     ## Gets flag of object auto color mode.
1654     #  @return True or False
1655     #  @ingroup l1_auxiliary
1656     def GetAutoColor(self):
1657         return self.mesh.GetAutoColor()
1658
1659     ## Gets the internal ID
1660     #  @return integer value, which is the internal Id of the mesh
1661     #  @ingroup l1_auxiliary
1662     def GetId(self):
1663         return self.mesh.GetId()
1664
1665     ## Get the study Id
1666     #  @return integer value, which is the study Id of the mesh
1667     #  @ingroup l1_auxiliary
1668     def GetStudyId(self):
1669         return self.mesh.GetStudyId()
1670
1671     ## Checks the group names for duplications.
1672     #  Consider the maximum group name length stored in MED file.
1673     #  @return True or False
1674     #  @ingroup l1_auxiliary
1675     def HasDuplicatedGroupNamesMED(self):
1676         return self.mesh.HasDuplicatedGroupNamesMED()
1677
1678     ## Obtains the mesh editor tool
1679     #  @return an instance of SMESH_MeshEditor
1680     #  @ingroup l1_modifying
1681     def GetMeshEditor(self):
1682         return self.mesh.GetMeshEditor()
1683
1684     ## Gets MED Mesh
1685     #  @return an instance of SALOME_MED::MESH
1686     #  @ingroup l1_auxiliary
1687     def GetMEDMesh(self):
1688         return self.mesh.GetMEDMesh()
1689
1690
1691     # Get informations about mesh contents:
1692     # ------------------------------------
1693
1694     ## Gets the mesh stattistic
1695     #  @return dictionary type element - count of elements
1696     #  @ingroup l1_meshinfo
1697     def GetMeshInfo(self, obj = None):
1698         if not obj: obj = self.mesh
1699         return self.smeshpyD.GetMeshInfo(obj)
1700
1701     ## Returns the number of nodes in the mesh
1702     #  @return an integer value
1703     #  @ingroup l1_meshinfo
1704     def NbNodes(self):
1705         return self.mesh.NbNodes()
1706
1707     ## Returns the number of elements in the mesh
1708     #  @return an integer value
1709     #  @ingroup l1_meshinfo
1710     def NbElements(self):
1711         return self.mesh.NbElements()
1712
1713     ## Returns the number of 0d elements in the mesh
1714     #  @return an integer value
1715     #  @ingroup l1_meshinfo
1716     def Nb0DElements(self):
1717         return self.mesh.Nb0DElements()
1718
1719     ## Returns the number of edges in the mesh
1720     #  @return an integer value
1721     #  @ingroup l1_meshinfo
1722     def NbEdges(self):
1723         return self.mesh.NbEdges()
1724
1725     ## Returns the number of edges with the given order in the mesh
1726     #  @param elementOrder the order of elements:
1727     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1728     #  @return an integer value
1729     #  @ingroup l1_meshinfo
1730     def NbEdgesOfOrder(self, elementOrder):
1731         return self.mesh.NbEdgesOfOrder(elementOrder)
1732
1733     ## Returns the number of faces in the mesh
1734     #  @return an integer value
1735     #  @ingroup l1_meshinfo
1736     def NbFaces(self):
1737         return self.mesh.NbFaces()
1738
1739     ## Returns the number of faces with the given order in the mesh
1740     #  @param elementOrder the order of elements:
1741     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1742     #  @return an integer value
1743     #  @ingroup l1_meshinfo
1744     def NbFacesOfOrder(self, elementOrder):
1745         return self.mesh.NbFacesOfOrder(elementOrder)
1746
1747     ## Returns the number of triangles in the mesh
1748     #  @return an integer value
1749     #  @ingroup l1_meshinfo
1750     def NbTriangles(self):
1751         return self.mesh.NbTriangles()
1752
1753     ## Returns the number of triangles with the given order in the mesh
1754     #  @param elementOrder is the order of elements:
1755     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1756     #  @return an integer value
1757     #  @ingroup l1_meshinfo
1758     def NbTrianglesOfOrder(self, elementOrder):
1759         return self.mesh.NbTrianglesOfOrder(elementOrder)
1760
1761     ## Returns the number of quadrangles in the mesh
1762     #  @return an integer value
1763     #  @ingroup l1_meshinfo
1764     def NbQuadrangles(self):
1765         return self.mesh.NbQuadrangles()
1766
1767     ## Returns the number of quadrangles with the given order in the mesh
1768     #  @param elementOrder the order of elements:
1769     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1770     #  @return an integer value
1771     #  @ingroup l1_meshinfo
1772     def NbQuadranglesOfOrder(self, elementOrder):
1773         return self.mesh.NbQuadranglesOfOrder(elementOrder)
1774
1775     ## Returns the number of polygons in the mesh
1776     #  @return an integer value
1777     #  @ingroup l1_meshinfo
1778     def NbPolygons(self):
1779         return self.mesh.NbPolygons()
1780
1781     ## Returns the number of volumes in the mesh
1782     #  @return an integer value
1783     #  @ingroup l1_meshinfo
1784     def NbVolumes(self):
1785         return self.mesh.NbVolumes()
1786
1787     ## Returns the number of volumes with the given order in the mesh
1788     #  @param elementOrder  the order of elements:
1789     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1790     #  @return an integer value
1791     #  @ingroup l1_meshinfo
1792     def NbVolumesOfOrder(self, elementOrder):
1793         return self.mesh.NbVolumesOfOrder(elementOrder)
1794
1795     ## Returns the number of tetrahedrons in the mesh
1796     #  @return an integer value
1797     #  @ingroup l1_meshinfo
1798     def NbTetras(self):
1799         return self.mesh.NbTetras()
1800
1801     ## Returns the number of tetrahedrons with the given order in the mesh
1802     #  @param elementOrder  the order of elements:
1803     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1804     #  @return an integer value
1805     #  @ingroup l1_meshinfo
1806     def NbTetrasOfOrder(self, elementOrder):
1807         return self.mesh.NbTetrasOfOrder(elementOrder)
1808
1809     ## Returns the number of hexahedrons in the mesh
1810     #  @return an integer value
1811     #  @ingroup l1_meshinfo
1812     def NbHexas(self):
1813         return self.mesh.NbHexas()
1814
1815     ## Returns the number of hexahedrons with the given order in the mesh
1816     #  @param elementOrder  the order of elements:
1817     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1818     #  @return an integer value
1819     #  @ingroup l1_meshinfo
1820     def NbHexasOfOrder(self, elementOrder):
1821         return self.mesh.NbHexasOfOrder(elementOrder)
1822
1823     ## Returns the number of pyramids in the mesh
1824     #  @return an integer value
1825     #  @ingroup l1_meshinfo
1826     def NbPyramids(self):
1827         return self.mesh.NbPyramids()
1828
1829     ## Returns the number of pyramids with the given order in the mesh
1830     #  @param elementOrder  the order of elements:
1831     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1832     #  @return an integer value
1833     #  @ingroup l1_meshinfo
1834     def NbPyramidsOfOrder(self, elementOrder):
1835         return self.mesh.NbPyramidsOfOrder(elementOrder)
1836
1837     ## Returns the number of prisms in the mesh
1838     #  @return an integer value
1839     #  @ingroup l1_meshinfo
1840     def NbPrisms(self):
1841         return self.mesh.NbPrisms()
1842
1843     ## Returns the number of prisms with the given order in the mesh
1844     #  @param elementOrder  the order of elements:
1845     #         ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC
1846     #  @return an integer value
1847     #  @ingroup l1_meshinfo
1848     def NbPrismsOfOrder(self, elementOrder):
1849         return self.mesh.NbPrismsOfOrder(elementOrder)
1850
1851     ## Returns the number of polyhedrons in the mesh
1852     #  @return an integer value
1853     #  @ingroup l1_meshinfo
1854     def NbPolyhedrons(self):
1855         return self.mesh.NbPolyhedrons()
1856
1857     ## Returns the number of submeshes in the mesh
1858     #  @return an integer value
1859     #  @ingroup l1_meshinfo
1860     def NbSubMesh(self):
1861         return self.mesh.NbSubMesh()
1862
1863     ## Returns the list of mesh elements IDs
1864     #  @return the list of integer values
1865     #  @ingroup l1_meshinfo
1866     def GetElementsId(self):
1867         return self.mesh.GetElementsId()
1868
1869     ## Returns the list of IDs of mesh elements with the given type
1870     #  @param elementType  the required type of elements
1871     #  @return list of integer values
1872     #  @ingroup l1_meshinfo
1873     def GetElementsByType(self, elementType):
1874         return self.mesh.GetElementsByType(elementType)
1875
1876     ## Returns the list of mesh nodes IDs
1877     #  @return the list of integer values
1878     #  @ingroup l1_meshinfo
1879     def GetNodesId(self):
1880         return self.mesh.GetNodesId()
1881
1882     # Get the information about mesh elements:
1883     # ------------------------------------
1884
1885     ## Returns the type of mesh element
1886     #  @return the value from SMESH::ElementType enumeration
1887     #  @ingroup l1_meshinfo
1888     def GetElementType(self, id, iselem):
1889         return self.mesh.GetElementType(id, iselem)
1890
1891     ## Returns the list of submesh elements IDs
1892     #  @param Shape a geom object(subshape) IOR
1893     #         Shape must be the subshape of a ShapeToMesh()
1894     #  @return the list of integer values
1895     #  @ingroup l1_meshinfo
1896     def GetSubMeshElementsId(self, Shape):
1897         if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)):
1898             ShapeID = Shape.GetSubShapeIndices()[0]
1899         else:
1900             ShapeID = Shape
1901         return self.mesh.GetSubMeshElementsId(ShapeID)
1902
1903     ## Returns the list of submesh nodes IDs
1904     #  @param Shape a geom object(subshape) IOR
1905     #         Shape must be the subshape of a ShapeToMesh()
1906     #  @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes
1907     #  @return the list of integer values
1908     #  @ingroup l1_meshinfo
1909     def GetSubMeshNodesId(self, Shape, all):
1910         if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)):
1911             ShapeID = Shape.GetSubShapeIndices()[0]
1912         else:
1913             ShapeID = Shape
1914         return self.mesh.GetSubMeshNodesId(ShapeID, all)
1915
1916     ## Returns type of elements on given shape
1917     #  @param Shape a geom object(subshape) IOR
1918     #         Shape must be a subshape of a ShapeToMesh()
1919     #  @return element type
1920     #  @ingroup l1_meshinfo
1921     def GetSubMeshElementType(self, Shape):
1922         if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)):
1923             ShapeID = Shape.GetSubShapeIndices()[0]
1924         else:
1925             ShapeID = Shape
1926         return self.mesh.GetSubMeshElementType(ShapeID)
1927
1928     ## Gets the mesh description
1929     #  @return string value
1930     #  @ingroup l1_meshinfo
1931     def Dump(self):
1932         return self.mesh.Dump()
1933
1934
1935     # Get the information about nodes and elements of a mesh by its IDs:
1936     # -----------------------------------------------------------
1937
1938     ## Gets XYZ coordinates of a node
1939     #  \n If there is no nodes for the given ID - returns an empty list
1940     #  @return a list of double precision values
1941     #  @ingroup l1_meshinfo
1942     def GetNodeXYZ(self, id):
1943         return self.mesh.GetNodeXYZ(id)
1944
1945     ## Returns list of IDs of inverse elements for the given node
1946     #  \n If there is no node for the given ID - returns an empty list
1947     #  @return a list of integer values
1948     #  @ingroup l1_meshinfo
1949     def GetNodeInverseElements(self, id):
1950         return self.mesh.GetNodeInverseElements(id)
1951
1952     ## @brief Returns the position of a node on the shape
1953     #  @return SMESH::NodePosition
1954     #  @ingroup l1_meshinfo
1955     def GetNodePosition(self,NodeID):
1956         return self.mesh.GetNodePosition(NodeID)
1957
1958     ## If the given element is a node, returns the ID of shape
1959     #  \n If there is no node for the given ID - returns -1
1960     #  @return an integer value
1961     #  @ingroup l1_meshinfo
1962     def GetShapeID(self, id):
1963         return self.mesh.GetShapeID(id)
1964
1965     ## Returns the ID of the result shape after
1966     #  FindShape() from SMESH_MeshEditor for the given element
1967     #  \n If there is no element for the given ID - returns -1
1968     #  @return an integer value
1969     #  @ingroup l1_meshinfo
1970     def GetShapeIDForElem(self,id):
1971         return self.mesh.GetShapeIDForElem(id)
1972
1973     ## Returns the number of nodes for the given element
1974     #  \n If there is no element for the given ID - returns -1
1975     #  @return an integer value
1976     #  @ingroup l1_meshinfo
1977     def GetElemNbNodes(self, id):
1978         return self.mesh.GetElemNbNodes(id)
1979
1980     ## Returns the node ID the given index for the given element
1981     #  \n If there is no element for the given ID - returns -1
1982     #  \n If there is no node for the given index - returns -2
1983     #  @return an integer value
1984     #  @ingroup l1_meshinfo
1985     def GetElemNode(self, id, index):
1986         return self.mesh.GetElemNode(id, index)
1987
1988     ## Returns the IDs of nodes of the given element
1989     #  @return a list of integer values
1990     #  @ingroup l1_meshinfo
1991     def GetElemNodes(self, id):
1992         return self.mesh.GetElemNodes(id)
1993
1994     ## Returns true if the given node is the medium node in the given quadratic element
1995     #  @ingroup l1_meshinfo
1996     def IsMediumNode(self, elementID, nodeID):
1997         return self.mesh.IsMediumNode(elementID, nodeID)
1998
1999     ## Returns true if the given node is the medium node in one of quadratic elements
2000     #  @ingroup l1_meshinfo
2001     def IsMediumNodeOfAnyElem(self, nodeID, elementType):
2002         return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType)
2003
2004     ## Returns the number of edges for the given element
2005     #  @ingroup l1_meshinfo
2006     def ElemNbEdges(self, id):
2007         return self.mesh.ElemNbEdges(id)
2008
2009     ## Returns the number of faces for the given element
2010     #  @ingroup l1_meshinfo
2011     def ElemNbFaces(self, id):
2012         return self.mesh.ElemNbFaces(id)
2013
2014     ## Returns true if the given element is a polygon
2015     #  @ingroup l1_meshinfo
2016     def IsPoly(self, id):
2017         return self.mesh.IsPoly(id)
2018
2019     ## Returns true if the given element is quadratic
2020     #  @ingroup l1_meshinfo
2021     def IsQuadratic(self, id):
2022         return self.mesh.IsQuadratic(id)
2023
2024     ## Returns XYZ coordinates of the barycenter of the given element
2025     #  \n If there is no element for the given ID - returns an empty list
2026     #  @return a list of three double values
2027     #  @ingroup l1_meshinfo
2028     def BaryCenter(self, id):
2029         return self.mesh.BaryCenter(id)
2030
2031
2032     # Mesh edition (SMESH_MeshEditor functionality):
2033     # ---------------------------------------------
2034
2035     ## Removes the elements from the mesh by ids
2036     #  @param IDsOfElements is a list of ids of elements to remove
2037     #  @return True or False
2038     #  @ingroup l2_modif_del
2039     def RemoveElements(self, IDsOfElements):
2040         return self.editor.RemoveElements(IDsOfElements)
2041
2042     ## Removes nodes from mesh by ids
2043     #  @param IDsOfNodes is a list of ids of nodes to remove
2044     #  @return True or False
2045     #  @ingroup l2_modif_del
2046     def RemoveNodes(self, IDsOfNodes):
2047         return self.editor.RemoveNodes(IDsOfNodes)
2048
2049     ## Add a node to the mesh by coordinates
2050     #  @return Id of the new node
2051     #  @ingroup l2_modif_add
2052     def AddNode(self, x, y, z):
2053         x,y,z,Parameters = geompyDC.ParseParameters(x,y,z)
2054         self.mesh.SetParameters(Parameters)
2055         return self.editor.AddNode( x, y, z)
2056
2057     ## Creates a 0D element on a node with given number.
2058     #  @param IDOfNode the ID of node for creation of the element.
2059     #  @return the Id of the new 0D element
2060     #  @ingroup l2_modif_add
2061     def Add0DElement(self, IDOfNode):
2062         return self.editor.Add0DElement(IDOfNode)
2063
2064     ## Creates a linear or quadratic edge (this is determined
2065     #  by the number of given nodes).
2066     #  @param IDsOfNodes the list of node IDs for creation of the element.
2067     #  The order of nodes in this list should correspond to the description
2068     #  of MED. \n This description is located by the following link:
2069     #  http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3.
2070     #  @return the Id of the new edge
2071     #  @ingroup l2_modif_add
2072     def AddEdge(self, IDsOfNodes):
2073         return self.editor.AddEdge(IDsOfNodes)
2074
2075     ## Creates a linear or quadratic face (this is determined
2076     #  by the number of given nodes).
2077     #  @param IDsOfNodes the list of node IDs for creation of the element.
2078     #  The order of nodes in this list should correspond to the description
2079     #  of MED. \n This description is located by the following link:
2080     #  http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3.
2081     #  @return the Id of the new face
2082     #  @ingroup l2_modif_add
2083     def AddFace(self, IDsOfNodes):
2084         return self.editor.AddFace(IDsOfNodes)
2085
2086     ## Adds a polygonal face to the mesh by the list of node IDs
2087     #  @param IdsOfNodes the list of node IDs for creation of the element.
2088     #  @return the Id of the new face
2089     #  @ingroup l2_modif_add
2090     def AddPolygonalFace(self, IdsOfNodes):
2091         return self.editor.AddPolygonalFace(IdsOfNodes)
2092
2093     ## Creates both simple and quadratic volume (this is determined
2094     #  by the number of given nodes).
2095     #  @param IDsOfNodes the list of node IDs for creation of the element.
2096     #  The order of nodes in this list should correspond to the description
2097     #  of MED. \n This description is located by the following link:
2098     #  http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3.
2099     #  @return the Id of the new volumic element
2100     #  @ingroup l2_modif_add
2101     def AddVolume(self, IDsOfNodes):
2102         return self.editor.AddVolume(IDsOfNodes)
2103
2104     ## Creates a volume of many faces, giving nodes for each face.
2105     #  @param IdsOfNodes the list of node IDs for volume creation face by face.
2106     #  @param Quantities the list of integer values, Quantities[i]
2107     #         gives the quantity of nodes in face number i.
2108     #  @return the Id of the new volumic element
2109     #  @ingroup l2_modif_add
2110     def AddPolyhedralVolume (self, IdsOfNodes, Quantities):
2111         return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities)
2112
2113     ## Creates a volume of many faces, giving the IDs of the existing faces.
2114     #  @param IdsOfFaces the list of face IDs for volume creation.
2115     #
2116     #  Note:  The created volume will refer only to the nodes
2117     #         of the given faces, not to the faces themselves.
2118     #  @return the Id of the new volumic element
2119     #  @ingroup l2_modif_add
2120     def AddPolyhedralVolumeByFaces (self, IdsOfFaces):
2121         return self.editor.AddPolyhedralVolumeByFaces(IdsOfFaces)
2122
2123
2124     ## @brief Binds a node to a vertex
2125     #  @param NodeID a node ID
2126     #  @param Vertex a vertex or vertex ID
2127     #  @return True if succeed else raises an exception
2128     #  @ingroup l2_modif_add
2129     def SetNodeOnVertex(self, NodeID, Vertex):
2130         if ( isinstance( Vertex, geompyDC.GEOM._objref_GEOM_Object)):
2131             VertexID = Vertex.GetSubShapeIndices()[0]
2132         else:
2133             VertexID = Vertex
2134         try:
2135             self.editor.SetNodeOnVertex(NodeID, VertexID)
2136         except SALOME.SALOME_Exception, inst:
2137             raise ValueError, inst.details.text
2138         return True
2139
2140
2141     ## @brief Stores the node position on an edge
2142     #  @param NodeID a node ID
2143     #  @param Edge an edge or edge ID
2144     #  @param paramOnEdge a parameter on the edge where the node is located
2145     #  @return True if succeed else raises an exception
2146     #  @ingroup l2_modif_add
2147     def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge):
2148         if ( isinstance( Edge, geompyDC.GEOM._objref_GEOM_Object)):
2149             EdgeID = Edge.GetSubShapeIndices()[0]
2150         else:
2151             EdgeID = Edge
2152         try:
2153             self.editor.SetNodeOnEdge(NodeID, EdgeID, paramOnEdge)
2154         except SALOME.SALOME_Exception, inst:
2155             raise ValueError, inst.details.text
2156         return True
2157
2158     ## @brief Stores node position on a face
2159     #  @param NodeID a node ID
2160     #  @param Face a face or face ID
2161     #  @param u U parameter on the face where the node is located
2162     #  @param v V parameter on the face where the node is located
2163     #  @return True if succeed else raises an exception
2164     #  @ingroup l2_modif_add
2165     def SetNodeOnFace(self, NodeID, Face, u, v):
2166         if ( isinstance( Face, geompyDC.GEOM._objref_GEOM_Object)):
2167             FaceID = Face.GetSubShapeIndices()[0]
2168         else:
2169             FaceID = Face
2170         try:
2171             self.editor.SetNodeOnFace(NodeID, FaceID, u, v)
2172         except SALOME.SALOME_Exception, inst:
2173             raise ValueError, inst.details.text
2174         return True
2175
2176     ## @brief Binds a node to a solid
2177     #  @param NodeID a node ID
2178     #  @param Solid  a solid or solid ID
2179     #  @return True if succeed else raises an exception
2180     #  @ingroup l2_modif_add
2181     def SetNodeInVolume(self, NodeID, Solid):
2182         if ( isinstance( Solid, geompyDC.GEOM._objref_GEOM_Object)):
2183             SolidID = Solid.GetSubShapeIndices()[0]
2184         else:
2185             SolidID = Solid
2186         try:
2187             self.editor.SetNodeInVolume(NodeID, SolidID)
2188         except SALOME.SALOME_Exception, inst:
2189             raise ValueError, inst.details.text
2190         return True
2191
2192     ## @brief Bind an element to a shape
2193     #  @param ElementID an element ID
2194     #  @param Shape a shape or shape ID
2195     #  @return True if succeed else raises an exception
2196     #  @ingroup l2_modif_add
2197     def SetMeshElementOnShape(self, ElementID, Shape):
2198         if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)):
2199             ShapeID = Shape.GetSubShapeIndices()[0]
2200         else:
2201             ShapeID = Shape
2202         try:
2203             self.editor.SetMeshElementOnShape(ElementID, ShapeID)
2204         except SALOME.SALOME_Exception, inst:
2205             raise ValueError, inst.details.text
2206         return True
2207
2208
2209     ## Moves the node with the given id
2210     #  @param NodeID the id of the node
2211     #  @param x  a new X coordinate
2212     #  @param y  a new Y coordinate
2213     #  @param z  a new Z coordinate
2214     #  @return True if succeed else False
2215     #  @ingroup l2_modif_movenode
2216     def MoveNode(self, NodeID, x, y, z):
2217         x,y,z,Parameters = geompyDC.ParseParameters(x,y,z)
2218         self.mesh.SetParameters(Parameters)
2219         return self.editor.MoveNode(NodeID, x, y, z)
2220
2221     ## Finds the node closest to a point and moves it to a point location
2222     #  @param x  the X coordinate of a point
2223     #  @param y  the Y coordinate of a point
2224     #  @param z  the Z coordinate of a point
2225     #  @param NodeID if specified (>0), the node with this ID is moved,
2226     #  otherwise, the node closest to point (@a x,@a y,@a z) is moved
2227     #  @return the ID of a node
2228     #  @ingroup l2_modif_throughp
2229     def MoveClosestNodeToPoint(self, x, y, z, NodeID):
2230         x,y,z,Parameters = geompyDC.ParseParameters(x,y,z)
2231         self.mesh.SetParameters(Parameters)
2232         return self.editor.MoveClosestNodeToPoint(x, y, z, NodeID)
2233
2234     ## Finds the node closest to a point
2235     #  @param x  the X coordinate of a point
2236     #  @param y  the Y coordinate of a point
2237     #  @param z  the Z coordinate of a point
2238     #  @return the ID of a node
2239     #  @ingroup l2_modif_throughp
2240     def FindNodeClosestTo(self, x, y, z):
2241         #preview = self.mesh.GetMeshEditPreviewer()
2242         #return preview.MoveClosestNodeToPoint(x, y, z, -1)
2243         return self.editor.FindNodeClosestTo(x, y, z)
2244
2245     ## Finds the elements where a point lays IN or ON
2246     #  @param x  the X coordinate of a point
2247     #  @param y  the Y coordinate of a point
2248     #  @param z  the Z coordinate of a point
2249     #  @param elementType type of elements to find (SMESH.ALL type
2250     #         means elements of any type excluding nodes and 0D elements)
2251     #  @return list of IDs of found elements
2252     #  @ingroup l2_modif_throughp
2253     def FindElementsByPoint(self, x, y, z, elementType = SMESH.ALL):
2254         return self.editor.FindElementsByPoint(x, y, z, elementType)
2255         
2256
2257     ## Finds the node closest to a point and moves it to a point location
2258     #  @param x  the X coordinate of a point
2259     #  @param y  the Y coordinate of a point
2260     #  @param z  the Z coordinate of a point
2261     #  @return the ID of a moved node
2262     #  @ingroup l2_modif_throughp
2263     def MeshToPassThroughAPoint(self, x, y, z):
2264         return self.editor.MoveClosestNodeToPoint(x, y, z, -1)
2265
2266     ## Replaces two neighbour triangles sharing Node1-Node2 link
2267     #  with the triangles built on the same 4 nodes but having other common link.
2268     #  @param NodeID1  the ID of the first node
2269     #  @param NodeID2  the ID of the second node
2270     #  @return false if proper faces were not found
2271     #  @ingroup l2_modif_invdiag
2272     def InverseDiag(self, NodeID1, NodeID2):
2273         return self.editor.InverseDiag(NodeID1, NodeID2)
2274
2275     ## Replaces two neighbour triangles sharing Node1-Node2 link
2276     #  with a quadrangle built on the same 4 nodes.
2277     #  @param NodeID1  the ID of the first node
2278     #  @param NodeID2  the ID of the second node
2279     #  @return false if proper faces were not found
2280     #  @ingroup l2_modif_unitetri
2281     def DeleteDiag(self, NodeID1, NodeID2):
2282         return self.editor.DeleteDiag(NodeID1, NodeID2)
2283
2284     ## Reorients elements by ids
2285     #  @param IDsOfElements if undefined reorients all mesh elements
2286     #  @return True if succeed else False
2287     #  @ingroup l2_modif_changori
2288     def Reorient(self, IDsOfElements=None):
2289         if IDsOfElements == None:
2290             IDsOfElements = self.GetElementsId()
2291         return self.editor.Reorient(IDsOfElements)
2292
2293     ## Reorients all elements of the object
2294     #  @param theObject mesh, submesh or group
2295     #  @return True if succeed else False
2296     #  @ingroup l2_modif_changori
2297     def ReorientObject(self, theObject):
2298         if ( isinstance( theObject, Mesh )):
2299             theObject = theObject.GetMesh()
2300         return self.editor.ReorientObject(theObject)
2301
2302     ## Fuses the neighbouring triangles into quadrangles.
2303     #  @param IDsOfElements The triangles to be fused,
2304     #  @param theCriterion  is FT_...; used to choose a neighbour to fuse with.
2305     #  @param MaxAngle      is the maximum angle between element normals at which the fusion
2306     #                       is still performed; theMaxAngle is mesured in radians.
2307     #                       Also it could be a name of variable which defines angle in degrees.
2308     #  @return TRUE in case of success, FALSE otherwise.
2309     #  @ingroup l2_modif_unitetri
2310     def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle):
2311         flag = False
2312         if isinstance(MaxAngle,str):
2313             flag = True
2314         MaxAngle,Parameters = geompyDC.ParseParameters(MaxAngle)
2315         if flag:
2316             MaxAngle = DegreesToRadians(MaxAngle)
2317         if IDsOfElements == []:
2318             IDsOfElements = self.GetElementsId()
2319         self.mesh.SetParameters(Parameters)
2320         Functor = 0
2321         if ( isinstance( theCriterion, SMESH._objref_NumericalFunctor ) ):
2322             Functor = theCriterion
2323         else:
2324             Functor = self.smeshpyD.GetFunctor(theCriterion)
2325         return self.editor.TriToQuad(IDsOfElements, Functor, MaxAngle)
2326
2327     ## Fuses the neighbouring triangles of the object into quadrangles
2328     #  @param theObject is mesh, submesh or group
2329     #  @param theCriterion is FT_...; used to choose a neighbour to fuse with.
2330     #  @param MaxAngle   a max angle between element normals at which the fusion
2331     #                   is still performed; theMaxAngle is mesured in radians.
2332     #  @return TRUE in case of success, FALSE otherwise.
2333     #  @ingroup l2_modif_unitetri
2334     def TriToQuadObject (self, theObject, theCriterion, MaxAngle):
2335         if ( isinstance( theObject, Mesh )):
2336             theObject = theObject.GetMesh()
2337         return self.editor.TriToQuadObject(theObject, self.smeshpyD.GetFunctor(theCriterion), MaxAngle)
2338
2339     ## Splits quadrangles into triangles.
2340     #  @param IDsOfElements the faces to be splitted.
2341     #  @param theCriterion   FT_...; used to choose a diagonal for splitting.
2342     #  @return TRUE in case of success, FALSE otherwise.
2343     #  @ingroup l2_modif_cutquadr
2344     def QuadToTri (self, IDsOfElements, theCriterion):
2345         if IDsOfElements == []:
2346             IDsOfElements = self.GetElementsId()
2347         return self.editor.QuadToTri(IDsOfElements, self.smeshpyD.GetFunctor(theCriterion))
2348
2349     ## Splits quadrangles into triangles.
2350     #  @param theObject  the object from which the list of elements is taken, this is mesh, submesh or group
2351     #  @param theCriterion   FT_...; used to choose a diagonal for splitting.
2352     #  @return TRUE in case of success, FALSE otherwise.
2353     #  @ingroup l2_modif_cutquadr
2354     def QuadToTriObject (self, theObject, theCriterion):
2355         if ( isinstance( theObject, Mesh )):
2356             theObject = theObject.GetMesh()
2357         return self.editor.QuadToTriObject(theObject, self.smeshpyD.GetFunctor(theCriterion))
2358
2359     ## Splits quadrangles into triangles.
2360     #  @param IDsOfElements the faces to be splitted
2361     #  @param Diag13        is used to choose a diagonal for splitting.
2362     #  @return TRUE in case of success, FALSE otherwise.
2363     #  @ingroup l2_modif_cutquadr
2364     def SplitQuad (self, IDsOfElements, Diag13):
2365         if IDsOfElements == []:
2366             IDsOfElements = self.GetElementsId()
2367         return self.editor.SplitQuad(IDsOfElements, Diag13)
2368
2369     ## Splits quadrangles into triangles.
2370     #  @param theObject the object from which the list of elements is taken, this is mesh, submesh or group
2371     #  @param Diag13    is used to choose a diagonal for splitting.
2372     #  @return TRUE in case of success, FALSE otherwise.
2373     #  @ingroup l2_modif_cutquadr
2374     def SplitQuadObject (self, theObject, Diag13):
2375         if ( isinstance( theObject, Mesh )):
2376             theObject = theObject.GetMesh()
2377         return self.editor.SplitQuadObject(theObject, Diag13)
2378
2379     ## Finds a better splitting of the given quadrangle.
2380     #  @param IDOfQuad   the ID of the quadrangle to be splitted.
2381     #  @param theCriterion  FT_...; a criterion to choose a diagonal for splitting.
2382     #  @return 1 if 1-3 diagonal is better, 2 if 2-4
2383     #          diagonal is better, 0 if error occurs.
2384     #  @ingroup l2_modif_cutquadr
2385     def BestSplit (self, IDOfQuad, theCriterion):
2386         return self.editor.BestSplit(IDOfQuad, self.smeshpyD.GetFunctor(theCriterion))
2387
2388     ## Splits quadrangle faces near triangular facets of volumes
2389     #
2390     #  @ingroup l1_auxiliary
2391     def SplitQuadsNearTriangularFacets(self):
2392         faces_array = self.GetElementsByType(SMESH.FACE)
2393         for face_id in faces_array:
2394             if self.GetElemNbNodes(face_id) == 4: # quadrangle
2395                 quad_nodes = self.mesh.GetElemNodes(face_id)
2396                 node1_elems = self.GetNodeInverseElements(quad_nodes[1 -1])
2397                 isVolumeFound = False
2398                 for node1_elem in node1_elems:
2399                     if not isVolumeFound:
2400                         if self.GetElementType(node1_elem, True) == SMESH.VOLUME:
2401                             nb_nodes = self.GetElemNbNodes(node1_elem)
2402                             if 3 < nb_nodes and nb_nodes < 7: # tetra or penta, or prism
2403                                 volume_elem = node1_elem
2404                                 volume_nodes = self.mesh.GetElemNodes(volume_elem)
2405                                 if volume_nodes.count(quad_nodes[2 -1]) > 0: # 1,2
2406                                     if volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,2,4
2407                                         isVolumeFound = True
2408                                         if volume_nodes.count(quad_nodes[3 -1]) == 0: # 1,2,4 & !3
2409                                             self.SplitQuad([face_id], False) # diagonal 2-4
2410                                     elif volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,2,3 & !4
2411                                         isVolumeFound = True
2412                                         self.SplitQuad([face_id], True) # diagonal 1-3
2413                                 elif volume_nodes.count(quad_nodes[4 -1]) > 0: # 1,4 & !2
2414                                     if volume_nodes.count(quad_nodes[3 -1]) > 0: # 1,4,3 & !2
2415                                         isVolumeFound = True
2416                                         self.SplitQuad([face_id], True) # diagonal 1-3
2417
2418     ## @brief Splits hexahedrons into tetrahedrons.
2419     #
2420     #  This operation uses pattern mapping functionality for splitting.
2421     #  @param theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group.
2422     #  @param theNode000,theNode001 within the range [0,7]; gives the orientation of the
2423     #         pattern relatively each hexahedron: the (0,0,0) key-point of the pattern
2424     #         will be mapped into <VAR>theNode000</VAR>-th node of each volume, the (0,0,1)
2425     #         key-point will be mapped into <VAR>theNode001</VAR>-th node of each volume.
2426     #         The (0,0,0) key-point of the used pattern corresponds to a non-split corner.
2427     #  @return TRUE in case of success, FALSE otherwise.
2428     #  @ingroup l1_auxiliary
2429     def SplitHexaToTetras (self, theObject, theNode000, theNode001):
2430         # Pattern:     5.---------.6
2431         #              /|#*      /|
2432         #             / | #*    / |
2433         #            /  |  # * /  |
2434         #           /   |   # /*  |
2435         # (0,0,1) 4.---------.7 * |
2436         #          |#*  |1   | # *|
2437         #          | # *.----|---#.2
2438         #          |  #/ *   |   /
2439         #          |  /#  *  |  /
2440         #          | /   # * | /
2441         #          |/      #*|/
2442         # (0,0,0) 0.---------.3
2443         pattern_tetra = "!!! Nb of points: \n 8 \n\
2444         !!! Points: \n\
2445         0 0 0  !- 0 \n\
2446         0 1 0  !- 1 \n\
2447         1 1 0  !- 2 \n\
2448         1 0 0  !- 3 \n\
2449         0 0 1  !- 4 \n\
2450         0 1 1  !- 5 \n\
2451         1 1 1  !- 6 \n\
2452         1 0 1  !- 7 \n\
2453         !!! Indices of points of 6 tetras: \n\
2454         0 3 4 1 \n\
2455         7 4 3 1 \n\
2456         4 7 5 1 \n\
2457         6 2 5 7 \n\
2458         1 5 2 7 \n\
2459         2 3 1 7 \n"
2460
2461         pattern = self.smeshpyD.GetPattern()
2462         isDone  = pattern.LoadFromFile(pattern_tetra)
2463         if not isDone:
2464             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
2465             return isDone
2466
2467         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
2468         isDone = pattern.MakeMesh(self.mesh, False, False)
2469         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
2470
2471         # split quafrangle faces near triangular facets of volumes
2472         self.SplitQuadsNearTriangularFacets()
2473
2474         return isDone
2475
2476     ## @brief Split hexahedrons into prisms.
2477     #
2478     #  Uses the pattern mapping functionality for splitting.
2479     #  @param theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken;
2480     #  @param theNode000,theNode001 (within the range [0,7]) gives the orientation of the
2481     #         pattern relatively each hexahedron: keypoint (0,0,0) of the pattern
2482     #         will be mapped into the <VAR>theNode000</VAR>-th node of each volume, keypoint (0,0,1)
2483     #         will be mapped into the <VAR>theNode001</VAR>-th node of each volume.
2484     #         Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners.
2485     #  @return TRUE in case of success, FALSE otherwise.
2486     #  @ingroup l1_auxiliary
2487     def SplitHexaToPrisms (self, theObject, theNode000, theNode001):
2488         # Pattern:     5.---------.6
2489         #              /|#       /|
2490         #             / | #     / |
2491         #            /  |  #   /  |
2492         #           /   |   # /   |
2493         # (0,0,1) 4.---------.7   |
2494         #          |    |    |    |
2495         #          |   1.----|----.2
2496         #          |   / *   |   /
2497         #          |  /   *  |  /
2498         #          | /     * | /
2499         #          |/       *|/
2500         # (0,0,0) 0.---------.3
2501         pattern_prism = "!!! Nb of points: \n 8 \n\
2502         !!! Points: \n\
2503         0 0 0  !- 0 \n\
2504         0 1 0  !- 1 \n\
2505         1 1 0  !- 2 \n\
2506         1 0 0  !- 3 \n\
2507         0 0 1  !- 4 \n\
2508         0 1 1  !- 5 \n\
2509         1 1 1  !- 6 \n\
2510         1 0 1  !- 7 \n\
2511         !!! Indices of points of 2 prisms: \n\
2512         0 1 3 4 5 7 \n\
2513         2 3 1 6 7 5 \n"
2514
2515         pattern = self.smeshpyD.GetPattern()
2516         isDone  = pattern.LoadFromFile(pattern_prism)
2517         if not isDone:
2518             print 'Pattern.LoadFromFile :', pattern.GetErrorCode()
2519             return isDone
2520
2521         pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001)
2522         isDone = pattern.MakeMesh(self.mesh, False, False)
2523         if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode()
2524
2525         # Splits quafrangle faces near triangular facets of volumes
2526         self.SplitQuadsNearTriangularFacets()
2527
2528         return isDone
2529
2530     ## Smoothes elements
2531     #  @param IDsOfElements the list if ids of elements to smooth
2532     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
2533     #  Note that nodes built on edges and boundary nodes are always fixed.
2534     #  @param MaxNbOfIterations the maximum number of iterations
2535     #  @param MaxAspectRatio varies in range [1.0, inf]
2536     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
2537     #  @return TRUE in case of success, FALSE otherwise.
2538     #  @ingroup l2_modif_smooth
2539     def Smooth(self, IDsOfElements, IDsOfFixedNodes,
2540                MaxNbOfIterations, MaxAspectRatio, Method):
2541         if IDsOfElements == []:
2542             IDsOfElements = self.GetElementsId()
2543         MaxNbOfIterations,MaxAspectRatio,Parameters = geompyDC.ParseParameters(MaxNbOfIterations,MaxAspectRatio)
2544         self.mesh.SetParameters(Parameters)
2545         return self.editor.Smooth(IDsOfElements, IDsOfFixedNodes,
2546                                   MaxNbOfIterations, MaxAspectRatio, Method)
2547
2548     ## Smoothes elements which belong to the given object
2549     #  @param theObject the object to smooth
2550     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
2551     #  Note that nodes built on edges and boundary nodes are always fixed.
2552     #  @param MaxNbOfIterations the maximum number of iterations
2553     #  @param MaxAspectRatio varies in range [1.0, inf]
2554     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
2555     #  @return TRUE in case of success, FALSE otherwise.
2556     #  @ingroup l2_modif_smooth
2557     def SmoothObject(self, theObject, IDsOfFixedNodes,
2558                      MaxNbOfIterations, MaxAspectRatio, Method):
2559         if ( isinstance( theObject, Mesh )):
2560             theObject = theObject.GetMesh()
2561         return self.editor.SmoothObject(theObject, IDsOfFixedNodes,
2562                                         MaxNbOfIterations, MaxAspectRatio, Method)
2563
2564     ## Parametrically smoothes the given elements
2565     #  @param IDsOfElements the list if ids of elements to smooth
2566     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
2567     #  Note that nodes built on edges and boundary nodes are always fixed.
2568     #  @param MaxNbOfIterations the maximum number of iterations
2569     #  @param MaxAspectRatio varies in range [1.0, inf]
2570     #  @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
2571     #  @return TRUE in case of success, FALSE otherwise.
2572     #  @ingroup l2_modif_smooth
2573     def SmoothParametric(self, IDsOfElements, IDsOfFixedNodes,
2574                          MaxNbOfIterations, MaxAspectRatio, Method):
2575         if IDsOfElements == []:
2576             IDsOfElements = self.GetElementsId()
2577         MaxNbOfIterations,MaxAspectRatio,Parameters = geompyDC.ParseParameters(MaxNbOfIterations,MaxAspectRatio)
2578         self.mesh.SetParameters(Parameters)
2579         return self.editor.SmoothParametric(IDsOfElements, IDsOfFixedNodes,
2580                                             MaxNbOfIterations, MaxAspectRatio, Method)
2581
2582     ## Parametrically smoothes the elements which belong to the given object
2583     #  @param theObject the object to smooth
2584     #  @param IDsOfFixedNodes the list of ids of fixed nodes.
2585     #  Note that nodes built on edges and boundary nodes are always fixed.
2586     #  @param MaxNbOfIterations the maximum number of iterations
2587     #  @param MaxAspectRatio varies in range [1.0, inf]
2588     #  @param Method Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH)
2589     #  @return TRUE in case of success, FALSE otherwise.
2590     #  @ingroup l2_modif_smooth
2591     def SmoothParametricObject(self, theObject, IDsOfFixedNodes,
2592                                MaxNbOfIterations, MaxAspectRatio, Method):
2593         if ( isinstance( theObject, Mesh )):
2594             theObject = theObject.GetMesh()
2595         return self.editor.SmoothParametricObject(theObject, IDsOfFixedNodes,
2596                                                   MaxNbOfIterations, MaxAspectRatio, Method)
2597
2598     ## Converts the mesh to quadratic, deletes old elements, replacing
2599     #  them with quadratic with the same id.
2600     #  @ingroup l2_modif_tofromqu
2601     def ConvertToQuadratic(self, theForce3d):
2602         self.editor.ConvertToQuadratic(theForce3d)
2603
2604     ## Converts the mesh from quadratic to ordinary,
2605     #  deletes old quadratic elements, \n replacing
2606     #  them with ordinary mesh elements with the same id.
2607     #  @return TRUE in case of success, FALSE otherwise.
2608     #  @ingroup l2_modif_tofromqu
2609     def ConvertFromQuadratic(self):
2610         return self.editor.ConvertFromQuadratic()
2611
2612     ## Creates 2D mesh as skin on boundary faces of a 3D mesh
2613     #  @return TRUE if operation has been completed successfully, FALSE otherwise
2614     #  @ingroup l2_modif_edit
2615     def  Make2DMeshFrom3D(self):
2616         return self.editor. Make2DMeshFrom3D()
2617         
2618     ## Renumber mesh nodes
2619     #  @ingroup l2_modif_renumber
2620     def RenumberNodes(self):
2621         self.editor.RenumberNodes()
2622
2623     ## Renumber mesh elements
2624     #  @ingroup l2_modif_renumber
2625     def RenumberElements(self):
2626         self.editor.RenumberElements()
2627
2628     ## Generates new elements by rotation of the elements around the axis
2629     #  @param IDsOfElements the list of ids of elements to sweep
2630     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
2631     #  @param AngleInRadians the angle of Rotation (in radians) or a name of variable which defines angle in degrees
2632     #  @param NbOfSteps the number of steps
2633     #  @param Tolerance tolerance
2634     #  @param MakeGroups forces the generation of new groups from existing ones
2635     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
2636     #                    of all steps, else - size of each step
2637     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2638     #  @ingroup l2_modif_extrurev
2639     def RotationSweep(self, IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance,
2640                       MakeGroups=False, TotalAngle=False):
2641         flag = False
2642         if isinstance(AngleInRadians,str):
2643             flag = True
2644         AngleInRadians,AngleParameters = geompyDC.ParseParameters(AngleInRadians)
2645         if flag:
2646             AngleInRadians = DegreesToRadians(AngleInRadians)
2647         if IDsOfElements == []:
2648             IDsOfElements = self.GetElementsId()
2649         if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)):
2650             Axis = self.smeshpyD.GetAxisStruct(Axis)
2651         Axis,AxisParameters = ParseAxisStruct(Axis)
2652         if TotalAngle and NbOfSteps:
2653             AngleInRadians /= NbOfSteps
2654         NbOfSteps,Tolerance,Parameters = geompyDC.ParseParameters(NbOfSteps,Tolerance)
2655         Parameters = AxisParameters + var_separator + AngleParameters + var_separator + Parameters
2656         self.mesh.SetParameters(Parameters)
2657         if MakeGroups:
2658             return self.editor.RotationSweepMakeGroups(IDsOfElements, Axis,
2659                                                        AngleInRadians, NbOfSteps, Tolerance)
2660         self.editor.RotationSweep(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance)
2661         return []
2662
2663     ## Generates new elements by rotation of the elements of object around the axis
2664     #  @param theObject object which elements should be sweeped
2665     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
2666     #  @param AngleInRadians the angle of Rotation
2667     #  @param NbOfSteps number of steps
2668     #  @param Tolerance tolerance
2669     #  @param MakeGroups forces the generation of new groups from existing ones
2670     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
2671     #                    of all steps, else - size of each step
2672     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2673     #  @ingroup l2_modif_extrurev
2674     def RotationSweepObject(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
2675                             MakeGroups=False, TotalAngle=False):
2676         flag = False
2677         if isinstance(AngleInRadians,str):
2678             flag = True
2679         AngleInRadians,AngleParameters = geompyDC.ParseParameters(AngleInRadians)
2680         if flag:
2681             AngleInRadians = DegreesToRadians(AngleInRadians)
2682         if ( isinstance( theObject, Mesh )):
2683             theObject = theObject.GetMesh()
2684         if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)):
2685             Axis = self.smeshpyD.GetAxisStruct(Axis)
2686         Axis,AxisParameters = ParseAxisStruct(Axis)
2687         if TotalAngle and NbOfSteps:
2688             AngleInRadians /= NbOfSteps
2689         NbOfSteps,Tolerance,Parameters = geompyDC.ParseParameters(NbOfSteps,Tolerance)
2690         Parameters = AxisParameters + var_separator + AngleParameters + var_separator + Parameters
2691         self.mesh.SetParameters(Parameters)
2692         if MakeGroups:
2693             return self.editor.RotationSweepObjectMakeGroups(theObject, Axis, AngleInRadians,
2694                                                              NbOfSteps, Tolerance)
2695         self.editor.RotationSweepObject(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
2696         return []
2697
2698     ## Generates new elements by rotation of the elements of object around the axis
2699     #  @param theObject object which elements should be sweeped
2700     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
2701     #  @param AngleInRadians the angle of Rotation
2702     #  @param NbOfSteps number of steps
2703     #  @param Tolerance tolerance
2704     #  @param MakeGroups forces the generation of new groups from existing ones
2705     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
2706     #                    of all steps, else - size of each step
2707     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2708     #  @ingroup l2_modif_extrurev
2709     def RotationSweepObject1D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
2710                               MakeGroups=False, TotalAngle=False):
2711         flag = False
2712         if isinstance(AngleInRadians,str):
2713             flag = True
2714         AngleInRadians,AngleParameters = geompyDC.ParseParameters(AngleInRadians)
2715         if flag:
2716             AngleInRadians = DegreesToRadians(AngleInRadians)
2717         if ( isinstance( theObject, Mesh )):
2718             theObject = theObject.GetMesh()
2719         if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)):
2720             Axis = self.smeshpyD.GetAxisStruct(Axis)
2721         Axis,AxisParameters = ParseAxisStruct(Axis)
2722         if TotalAngle and NbOfSteps:
2723             AngleInRadians /= NbOfSteps
2724         NbOfSteps,Tolerance,Parameters = geompyDC.ParseParameters(NbOfSteps,Tolerance)
2725         Parameters = AxisParameters + var_separator + AngleParameters + var_separator + Parameters
2726         self.mesh.SetParameters(Parameters)
2727         if MakeGroups:
2728             return self.editor.RotationSweepObject1DMakeGroups(theObject, Axis, AngleInRadians,
2729                                                                NbOfSteps, Tolerance)
2730         self.editor.RotationSweepObject1D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
2731         return []
2732
2733     ## Generates new elements by rotation of the elements of object around the axis
2734     #  @param theObject object which elements should be sweeped
2735     #  @param Axis the axis of rotation, AxisStruct or line(geom object)
2736     #  @param AngleInRadians the angle of Rotation
2737     #  @param NbOfSteps number of steps
2738     #  @param Tolerance tolerance
2739     #  @param MakeGroups forces the generation of new groups from existing ones
2740     #  @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size
2741     #                    of all steps, else - size of each step
2742     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2743     #  @ingroup l2_modif_extrurev
2744     def RotationSweepObject2D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance,
2745                               MakeGroups=False, TotalAngle=False):
2746         flag = False
2747         if isinstance(AngleInRadians,str):
2748             flag = True
2749         AngleInRadians,AngleParameters = geompyDC.ParseParameters(AngleInRadians)
2750         if flag:
2751             AngleInRadians = DegreesToRadians(AngleInRadians)
2752         if ( isinstance( theObject, Mesh )):
2753             theObject = theObject.GetMesh()
2754         if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)):
2755             Axis = self.smeshpyD.GetAxisStruct(Axis)
2756         Axis,AxisParameters = ParseAxisStruct(Axis)
2757         if TotalAngle and NbOfSteps:
2758             AngleInRadians /= NbOfSteps
2759         NbOfSteps,Tolerance,Parameters = geompyDC.ParseParameters(NbOfSteps,Tolerance)
2760         Parameters = AxisParameters + var_separator + AngleParameters + var_separator + Parameters
2761         self.mesh.SetParameters(Parameters)
2762         if MakeGroups:
2763             return self.editor.RotationSweepObject2DMakeGroups(theObject, Axis, AngleInRadians,
2764                                                              NbOfSteps, Tolerance)
2765         self.editor.RotationSweepObject2D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance)
2766         return []
2767
2768     ## Generates new elements by extrusion of the elements with given ids
2769     #  @param IDsOfElements the list of elements ids for extrusion
2770     #  @param StepVector vector, defining the direction and value of extrusion
2771     #  @param NbOfSteps the number of steps
2772     #  @param MakeGroups forces the generation of new groups from existing ones
2773     #  @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2774     #  @ingroup l2_modif_extrurev
2775     def ExtrusionSweep(self, IDsOfElements, StepVector, NbOfSteps, MakeGroups=False):
2776         if IDsOfElements == []:
2777             IDsOfElements = self.GetElementsId()
2778         if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)):
2779             StepVector = self.smeshpyD.GetDirStruct(StepVector)
2780         StepVector,StepVectorParameters = ParseDirStruct(StepVector)
2781         NbOfSteps,Parameters = geompyDC.ParseParameters(NbOfSteps)
2782         Parameters = StepVectorParameters + var_separator + Parameters
2783         self.mesh.SetParameters(Parameters)
2784         if MakeGroups:
2785             return self.editor.ExtrusionSweepMakeGroups(IDsOfElements, StepVector, NbOfSteps)
2786         self.editor.ExtrusionSweep(IDsOfElements, StepVector, NbOfSteps)
2787         return []
2788
2789     ## Generates new elements by extrusion of the elements with given ids
2790     #  @param IDsOfElements is ids of elements
2791     #  @param StepVector vector, defining the direction and value of extrusion
2792     #  @param NbOfSteps the number of steps
2793     #  @param ExtrFlags sets flags for extrusion
2794     #  @param SewTolerance uses for comparing locations of nodes if flag
2795     #         EXTRUSION_FLAG_SEW is set
2796     #  @param MakeGroups forces the generation of new groups from existing ones
2797     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2798     #  @ingroup l2_modif_extrurev
2799     def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps,
2800                           ExtrFlags, SewTolerance, MakeGroups=False):
2801         if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)):
2802             StepVector = self.smeshpyD.GetDirStruct(StepVector)
2803         if MakeGroups:
2804             return self.editor.AdvancedExtrusionMakeGroups(IDsOfElements, StepVector, NbOfSteps,
2805                                                            ExtrFlags, SewTolerance)
2806         self.editor.AdvancedExtrusion(IDsOfElements, StepVector, NbOfSteps,
2807                                       ExtrFlags, SewTolerance)
2808         return []
2809
2810     ## Generates new elements by extrusion of the elements which belong to the object
2811     #  @param theObject the object which elements should be processed
2812     #  @param StepVector vector, defining the direction and value of extrusion
2813     #  @param NbOfSteps the number of steps
2814     #  @param MakeGroups forces the generation of new groups from existing ones
2815     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2816     #  @ingroup l2_modif_extrurev
2817     def ExtrusionSweepObject(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
2818         if ( isinstance( theObject, Mesh )):
2819             theObject = theObject.GetMesh()
2820         if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)):
2821             StepVector = self.smeshpyD.GetDirStruct(StepVector)
2822         StepVector,StepVectorParameters = ParseDirStruct(StepVector)
2823         NbOfSteps,Parameters = geompyDC.ParseParameters(NbOfSteps)
2824         Parameters = StepVectorParameters + var_separator + Parameters
2825         self.mesh.SetParameters(Parameters)
2826         if MakeGroups:
2827             return self.editor.ExtrusionSweepObjectMakeGroups(theObject, StepVector, NbOfSteps)
2828         self.editor.ExtrusionSweepObject(theObject, StepVector, NbOfSteps)
2829         return []
2830
2831     ## Generates new elements by extrusion of the elements which belong to the object
2832     #  @param theObject object which elements should be processed
2833     #  @param StepVector vector, defining the direction and value of extrusion
2834     #  @param NbOfSteps the number of steps
2835     #  @param MakeGroups to generate new groups from existing ones
2836     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2837     #  @ingroup l2_modif_extrurev
2838     def ExtrusionSweepObject1D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
2839         if ( isinstance( theObject, Mesh )):
2840             theObject = theObject.GetMesh()
2841         if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)):
2842             StepVector = self.smeshpyD.GetDirStruct(StepVector)
2843         StepVector,StepVectorParameters = ParseDirStruct(StepVector)
2844         NbOfSteps,Parameters = geompyDC.ParseParameters(NbOfSteps)
2845         Parameters = StepVectorParameters + var_separator + Parameters
2846         self.mesh.SetParameters(Parameters)
2847         if MakeGroups:
2848             return self.editor.ExtrusionSweepObject1DMakeGroups(theObject, StepVector, NbOfSteps)
2849         self.editor.ExtrusionSweepObject1D(theObject, StepVector, NbOfSteps)
2850         return []
2851
2852     ## Generates new elements by extrusion of the elements which belong to the object
2853     #  @param theObject object which elements should be processed
2854     #  @param StepVector vector, defining the direction and value of extrusion
2855     #  @param NbOfSteps the number of steps
2856     #  @param MakeGroups forces the generation of new groups from existing ones
2857     #  @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise
2858     #  @ingroup l2_modif_extrurev
2859     def ExtrusionSweepObject2D(self, theObject, StepVector, NbOfSteps, MakeGroups=False):
2860         if ( isinstance( theObject, Mesh )):
2861             theObject = theObject.GetMesh()
2862         if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)):
2863             StepVector = self.smeshpyD.GetDirStruct(StepVector)
2864         StepVector,StepVectorParameters = ParseDirStruct(StepVector)
2865         NbOfSteps,Parameters = geompyDC.ParseParameters(NbOfSteps)
2866         Parameters = StepVectorParameters + var_separator + Parameters
2867         self.mesh.SetParameters(Parameters)
2868         if MakeGroups:
2869             return self.editor.ExtrusionSweepObject2DMakeGroups(theObject, StepVector, NbOfSteps)
2870         self.editor.ExtrusionSweepObject2D(theObject, StepVector, NbOfSteps)
2871         return []
2872
2873
2874
2875     ## Generates new elements by extrusion of the given elements
2876     #  The path of extrusion must be a meshed edge.
2877     #  @param Base mesh or list of ids of elements for extrusion
2878     #  @param Path - 1D mesh or 1D sub-mesh, along which proceeds the extrusion
2879     #  @param NodeStart the start node from Path. Defines the direction of extrusion
2880     #  @param HasAngles allows the shape to be rotated around the path
2881     #                   to get the resulting mesh in a helical fashion
2882     #  @param Angles list of angles in radians
2883     #  @param LinearVariation forces the computation of rotation angles as linear
2884     #                         variation of the given Angles along path steps
2885     #  @param HasRefPoint allows using the reference point
2886     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
2887     #         The User can specify any point as the Reference Point.
2888     #  @param MakeGroups forces the generation of new groups from existing ones
2889     #  @param ElemType type of elements for extrusion (if param Base is a mesh)
2890     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
2891     #          only SMESH::Extrusion_Error otherwise
2892     #  @ingroup l2_modif_extrurev
2893     def ExtrusionAlongPathX(self, Base, Path, NodeStart,
2894                             HasAngles, Angles, LinearVariation,
2895                             HasRefPoint, RefPoint, MakeGroups, ElemType):
2896         Angles,AnglesParameters = ParseAngles(Angles)
2897         RefPoint,RefPointParameters = ParsePointStruct(RefPoint)
2898         if ( isinstance( RefPoint, geompyDC.GEOM._objref_GEOM_Object)):
2899             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
2900             pass
2901         Parameters = AnglesParameters + var_separator + RefPointParameters
2902         self.mesh.SetParameters(Parameters)
2903
2904         if isinstance(Base,list):
2905             IDsOfElements = []
2906             if Base == []: IDsOfElements = self.GetElementsId()
2907             else: IDsOfElements = Base
2908             return self.editor.ExtrusionAlongPathX(IDsOfElements, Path, NodeStart,
2909                                                    HasAngles, Angles, LinearVariation,
2910                                                    HasRefPoint, RefPoint, MakeGroups, ElemType)
2911         else:
2912             if isinstance(Base,Mesh):
2913                 return self.editor.ExtrusionAlongPathObjX(Base, Path, NodeStart,
2914                                                           HasAngles, Angles, LinearVariation,
2915                                                           HasRefPoint, RefPoint, MakeGroups, ElemType)
2916             else:
2917                 raise RuntimeError, "Invalid Base for ExtrusionAlongPathX"
2918
2919
2920     ## Generates new elements by extrusion of the given elements
2921     #  The path of extrusion must be a meshed edge.
2922     #  @param IDsOfElements ids of elements
2923     #  @param PathMesh mesh containing a 1D sub-mesh on the edge, along which proceeds the extrusion
2924     #  @param PathShape shape(edge) defines the sub-mesh for the path
2925     #  @param NodeStart the first or the last node on the edge. Defines the direction of extrusion
2926     #  @param HasAngles allows the shape to be rotated around the path
2927     #                   to get the resulting mesh in a helical fashion
2928     #  @param Angles list of angles in radians
2929     #  @param HasRefPoint allows using the reference point
2930     #  @param RefPoint the point around which the shape is rotated (the mass center of the shape by default).
2931     #         The User can specify any point as the Reference Point.
2932     #  @param MakeGroups forces the generation of new groups from existing ones
2933     #  @param LinearVariation forces the computation of rotation angles as linear
2934     #                         variation of the given Angles along path steps
2935     #  @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True,
2936     #          only SMESH::Extrusion_Error otherwise
2937     #  @ingroup l2_modif_extrurev
2938     def ExtrusionAlongPath(self, IDsOfElements, PathMesh, PathShape, NodeStart,
2939                            HasAngles, Angles, HasRefPoint, RefPoint,
2940                            MakeGroups=False, LinearVariation=False):
2941         Angles,AnglesParameters = ParseAngles(Angles)
2942         RefPoint,RefPointParameters = ParsePointStruct(RefPoint)
2943         if IDsOfElements == []:
2944             IDsOfElements = self.GetElementsId()
2945         if ( isinstance( RefPoint, geompyDC.GEOM._objref_GEOM_Object)):
2946             RefPoint = self.smeshpyD.GetPointStruct(RefPoint)
2947             pass
2948         if ( isinstance( PathMesh, Mesh )):
2949             PathMesh = PathMesh.GetMesh()
2950         if HasAngles and Angles and LinearVariation:
2951             Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles )
2952             pass
2953         Parameters = AnglesParameters + var_separator + RefPointParameters
2954         self.mesh.SetParameters(Parameters)
2955         if MakeGroups:
2956             return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh,
2957                                                             PathShape, NodeStart, HasAngles,
2958                                                             Angles, HasRefPoint, RefPoint)
2959         return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh, PathShape,
2960                                               NodeStart, HasAngles, Angles, HasRefPoint, RefPoint)
2961
2962     ## Generates new elements by extrusion of the elements which belong to the object
2963     #  The path of extrusion must be a meshed edge.
2964     #  @param theObject the object which elements should be processed