Creating a spiral drilling stabilizer with Salomé - Python Script

As I promised, we are going to take a look at the Python script generated by the dump file from the generated stabilizer. But ... to make things clear ... I'm not an expert on Python but I try to make things to be reusable as much as possible. My coding can be very ugly, but I understand them on the first sight.

I would suggest you to visit the following links regarding Salomé's script:

• http://docs.salome-platform.org/salome_6_6_0/gui/GEOM/geompy_page.html
• http://www.salome-platform.org/user-section/salome-tutorials/edf-exercise-10

I know this can be boring but that is why I strongly suggest you to have a problem to be solved, a driver ... something to give you a purpose, and if do so learn something from the script, it can save you lots and lots of time.

Time to go.

1. Open Salomé and load the hdf file you had created. 
2. Press "Ctrl" + "D" or go to "File >> Dump Study". 
3. Name your python file the way you would like.
4. Save it.

The generated file:

1. # -*- coding: iso-8859-1 -*-
2. 
   
3. ###
4. ### This file is generated automatically by SALOME v6.6.0 with dump python functionality
5. ###
6. 
   
7. import sys
8. import salome
9. 
   
10. salome.salome_init()
11. theStudy = salome.myStudy
12. 
    
13. import salome_notebook
14. notebook = salome_notebook.notebook
15. sys.path.insert( 0, r'/media/rafael/5e8dda66-24fd-42c8-b0d6-ece1a49fa89d/Projects/CFD/Salome')
16. 
    
17. ###
18. ### GEOM component
19. ###
20. 
    
21. import GEOM
22. import geompy
23. import math
24. import SALOMEDS
25. 
    
26. 
    
27. geompy.init_geom(theStudy)
28. 
    
29. O = geompy.MakeVertex(0, 0, 0)
30. OX = geompy.MakeVectorDXDYDZ(1, 0, 0)
31. OY = geompy.MakeVectorDXDYDZ(0, 1, 0)
32. OZ = geompy.MakeVectorDXDYDZ(0, 0, 1)
33. OD_max_point = geompy.MakeVertexWithRef(O, 0.10795, 0, 0)
34. Vertex_1 = geompy.MakeVertexWithRef(OD_max_point, 0, 0.3, 0)
35. OD_min_point = geompy.MakeVertexWithRef(Vertex_1, -0.0254, 0.043994, 0)
36. Vertex_2 = geompy.MakeVertexWithRef(OD_min_point, 0, 0.6, 0)
37. Vertex_3 = geompy.MakeVertex(0, 0.943994, 0)
38. Line_1 = geompy.MakeLineTwoPnt(Vertex_3, O)
39. Line_2 = geompy.MakeLineTwoPnt(O, OD_max_point)
40. Line_3 = geompy.MakeLineTwoPnt(OD_max_point, Vertex_1)
41. Line_4 = geompy.MakeLineTwoPnt(Vertex_1, OD_min_point)
42. Line_5 = geompy.MakeLineTwoPnt(OD_min_point, Vertex_2)
43. Line_1_vertex_2 = geompy.GetSubShape(Line_1, [2])
44. Line_6 = geompy.MakeLineTwoPnt(Vertex_2, Line_1_vertex_2)
45. Wire_1 = geompy.MakeWire([Line_1, Line_2, Line_3, Line_4, Line_5, Line_6], 1e-07)
46. Face_1 = geompy.MakeFaceWires([Wire_1], 1)
47. Revolution_1 = geompy.MakeRevolution(Face_1, OY, 360*math.pi/180.0)
48. geomObj_1 = geompy.MakeCurveParametric("0.5*0.2159*cos(t+pi/2)", "t*1.2/pi", "0.5*0.2159*sin(t+pi/2)", 0, 1, 999, geompy.GEOM.Interpolation, True)
49. [geomObj_2,geomObj_3] = geompy.ExtractShapes(geomObj_1, geompy.ShapeType["VERTEX"], True)
50. geomObj_4 = geompy.MakeCurveParametric("0.5*0.1651*cos(t+pi/2)", "t*1.2/pi", "0.5*0.1651*sin(t+pi/2)", 0, 1, 999, geompy.GEOM.Interpolation, True)
51. [geomObj_5,geomObj_6] = geompy.ExtractShapes(geomObj_4, geompy.ShapeType["VERTEX"], True)
52. geomObj_7 = geompy.MakeEdge(geomObj_2, geomObj_5)
53. geomObj_8 = geompy.MakeEdge(geomObj_6, geomObj_3)
54. geomObj_9 = geompy.MakeWire([geomObj_1, geomObj_4, geomObj_7, geomObj_8], 1e-07)
55. geomObj_10 = geompy.MakeFaceWires([geomObj_9], 0)
56. geomObj_11 = geompy.MakeRevolution(geomObj_10, OY, 40*math.pi/180.0)
57. Curve_1 = geompy.MakeCurveParametric("0.6*0.2159*cos(t+pi/2)", "t*1.2/pi", "0.6*0.2159*sin(t+pi/2)", 0, 0.9, 999, geompy.GEOM.Interpolation, True)
58. [Vertex_4,Vertex_5] = geompy.ExtractShapes(Curve_1, geompy.ShapeType["VERTEX"], True)
59. Curve_2 = geompy.MakeCurveParametric("0.5*0.1651*cos(t+pi/2)", "t*1.2/pi", "0.5*0.1651*sin(t+pi/2)", 0, 0.9, 999, geompy.GEOM.Interpolation, True)
60. [Vertex_6,Vertex_7] = geompy.ExtractShapes(Curve_2, geompy.ShapeType["VERTEX"], True)
61. Edge_1 = geompy.MakeEdge(Vertex_4, Vertex_6)
62. Edge_2 = geompy.MakeEdge(Vertex_7, Vertex_5)
63. Wire_2 = geompy.MakeWire([Curve_1, Curve_2, Edge_1, Edge_2], 1e-07)
64. Face_2 = geompy.MakeFaceWires([Wire_2], 0)
65. Revolution_2 = geompy.MakeRevolution(Face_2, OY, 80*math.pi/180.0)
66. Cut_1 = geompy.MakeCut(Revolution_1, Revolution_2)
67. geompy.Rotate(Cut_1, OY, 120*math.pi/180.0)
68. Cut_2 = geompy.MakeCut(Cut_1, Revolution_2)
69. geompy.Rotate(Cut_2, OY, 120*math.pi/180.0)
70. Cut_3 = geompy.MakeCut(Cut_2, Revolution_2)
71. Mirror_1 = geompy.MakeMirrorByAxis(Cut_3, OX)
72. geompy.Rotate(Mirror_1, OY, 20*math.pi/180.0)
73. Fuse_1 = geompy.MakeFuse(Cut_3, Mirror_1)
74. geompy.addToStudy( O, 'O' )
75. geompy.addToStudy( OX, 'OX' )
76. geompy.addToStudy( OY, 'OY' )
77. geompy.addToStudy( OZ, 'OZ' )
78. geompy.addToStudy( OD_max_point, 'OD_max_point' )
79. geompy.addToStudy( Vertex_1, 'Vertex_1' )
80. geompy.addToStudy( OD_min_point, 'OD_min_point' )
81. geompy.addToStudy( Vertex_2, 'Vertex_2' )
82. geompy.addToStudy( Vertex_3, 'Vertex_3' )
83. geompy.addToStudy( Line_1, 'Line_1' )
84. geompy.addToStudy( Line_2, 'Line_2' )
85. geompy.addToStudy( Line_3, 'Line_3' )
86. geompy.addToStudy( Line_4, 'Line_4' )
87. geompy.addToStudy( Line_5, 'Line_5' )
88. geompy.addToStudyInFather( Line_1, Line_1_vertex_2, 'Line_1:vertex_2' )
89. geompy.addToStudy( Line_6, 'Line_6' )
90. geompy.addToStudy( Wire_1, 'Wire_1' )
91. geompy.addToStudy( Face_1, 'Face_1' )
92. geompy.addToStudy( Revolution_1, 'Revolution_1' )
93. geompy.addToStudy( Curve_1, 'Curve_1' )
94. geompy.addToStudy( Curve_2, 'Curve_2' )
95. geompy.addToStudyInFather( Curve_1, Vertex_4, 'Vertex_4' )
96. geompy.addToStudyInFather( Curve_1, Vertex_5, 'Vertex_5' )
97. geompy.addToStudyInFather( Curve_2, Vertex_6, 'Vertex_6' )
98. geompy.addToStudyInFather( Curve_2, Vertex_7, 'Vertex_7' )
99. geompy.addToStudy( Edge_1, 'Edge_1' )
100. geompy.addToStudy( Edge_2, 'Edge_2' )
101. geompy.addToStudy( Wire_2, 'Wire_2' )
102. geompy.addToStudy( Face_2, 'Face_2' )
103. geompy.addToStudy( Revolution_2, 'Revolution_2' )
104. geompy.addToStudy( Cut_1, 'Cut_1' )
105. geompy.addToStudy( Cut_2, 'Cut_2' )
106. geompy.addToStudy( Mirror_1, 'Mirror_1' )
107. geompy.addToStudy( Cut_3, 'Cut_3' )
108. geompy.addToStudy( Fuse_1, 'Fuse_1' )

Just ugly ... I used to get terrified by coding but, as I mentioned ... you'll save time. You can take this time and enjoy in a nerdish way by improving the code, or the tool, I don't know ... just choose something. 

I would like to explain from the line 1 to 28, but I'm here to be practical so, don't touch them. 

Why do we need to take a look on this? Well, mainly because I would like to understand what is happening and also, because, we can draw any type of stabilizer. But, as heads up, If you want to create any sort of STB you probably are going to debug the code or create more code. Why? A Spiral STB is a tortuous tool and it depends on the precision ... sometimes the cutting action over the virgin tool, won't work, that is when you need to debug the code/design.

From now on I'll try to comment the coding.

29 - From the previous Salomé, I believe, we had to create the origin point. Salomé 6.6 takes care of this by creating the O vertex at (0,0,0). That is what this line of code does, calls the geompy package and asks for MakeVertex function.

30-32 - From these lines is possible to observe that it was created the unit vectors by calling the MakeVector function. Again, this a good thing and shouldn't be touched.

33-36 - As we did with the first steps with stabilizer creation. We used a reference to create our vertexes . The MakeVertexWithRef function asks for the Reference point, "x" axis walk, "y" walk and "z" axis walk all related to a reference point. Pay attention on the values we are inputting. Do they mean anything to you?

38-44 - After point creation, what we did? We had created lines to connect all the points. That is what is happening in here. Pay attention on line 43. We can see two inputs: Line_1 and [2]. The function geompy.GetSubShape(Line_1, [2]) takes Line_1 as the source of the SubShapes (it can be a vertex, edge, line, face, etc ...) and wants the "[2]", for this case, [2], is the first variable when you created the Line_1, so, it would be Vertex_3. If you put [3] it is going to return the second variable, O, and [1] would be the line itself.

Uhhhmmm ... I believe I'm made my point here. I don't want to be boring and you can see the rest of the code is pretty much self explanatory.

So ... What do we want? We want to have this code to be reusable and with those numbers ... just can't. Your brain can decode easily names, not numbers. We must put everything on a easy way. This is my code and for sure can be improved.

Cheers!!!

1. import GEOM
2. import geompy
3. import math
4. import SALOMEDS
5. 
   
6. OD_max = 8.5 # in
7. OD_min = 6.5 # in
8. a = 20 # deg
9. WaC = 0.6 # m - Wall Contact
10. SmSpa = (0.5*(OD_max-OD_min)*0.0254)/math.tan(a*math.pi/180) # m 
11. FN = 0.6 # m - Tem que ser igual ao Body Neck BN
12. BN = 0.6 # m
13. Total_Length = WaC + 2*SmSpa + FN + BN
14. geompy.init_geom(theStudy)
15. 
    
16. O = geompy.MakeVertex(0, 0, 0)
17. OX = geompy.MakeVectorDXDYDZ(1, 0, 0)
18. OY = geompy.MakeVectorDXDYDZ(0, 1, 0)
19. OZ = geompy.MakeVectorDXDYDZ(0, 0, 1)
20. Flow = geompy.MakeVectorDXDYDZ(0, 0, 1)
21. 
    
22. #Creating the points before making the lines and closing the wire
23. OD_max_point = geompy.MakeVertexWithRef(O, 0, 0.5*OD_max*0.0254, 0)
24. Half_WaC = geompy.MakeVertexWithRef(OD_max_point, 0,  0 , WaC/2)
25. OD_min_point = geompy.MakeVertexWithRef(Half_WaC,0, -0.5*(OD_max-OD_min)*0.0254, SmSpa)
26. FN_point = geompy.MakeVertexWithRef(OD_min_point, 0, 0 , FN)
27. FN_point_2 = geompy.MakeVertexWithRef(FN_point, 0, -0.5*OD_min*0.0254, 0)
28. #
29. 
    
30. #Connecting the points
31. Line_1 = geompy.MakeLineTwoPnt(O, OD_max_point)
32. Line_2 = geompy.MakeLineTwoPnt(OD_max_point, Half_WaC)
33. Line_3 = geompy.MakeLineTwoPnt(Half_WaC, OD_min_point)
34. Line_4 = geompy.MakeLineTwoPnt(OD_min_point, FN_point)
35. Line_5 = geompy.MakeLineTwoPnt(FN_point, FN_point_2)
36. Line_6 = geompy.MakeLineTwoPnt(FN_point_2, O)
37. #
38. 
    
39. #Creating the wireframe and the face
40. Wire_1 = geompy.MakeWire([Line_1, Line_2, Line_3, Line_4, Line_5, Line_6], 1e-07)
41. Face_1 = geompy.MakeFaceWires([Wire_1], 1)
42. #
43. 
    
44. #Creating the solid. The stabilizer basis
45. Revolution_1 = geompy.MakeRevolution(Face_1, OZ, 360*math.pi/180.0)
46. #
47. 
    
48. #Creating the cutting tool
49. Curve_1 = geompy.MakeCurveParametric("0.55*OD_max*0.0254*cos(t+pi/2)", "0.55*OD_max*0.0254*sin(t+pi/2)", "t*1.2/pi", 0, (0.5*WaC + SmSpa)*math.pi/1.2, 999, geompy.GEOM.Interpolation, True)
50. [Vertex_1,Vertex_2] = geompy.ExtractShapes(Curve_1, geompy.ShapeType["VERTEX"], True)
51. 
    
52. Curve_2 = geompy.MakeCurveParametric("0.5*OD_min*0.0254*cos(t+pi/2)", "0.5*OD_min*0.0254*sin(t+pi/2)", "t*1.2/pi", 0, (0.5*WaC + SmSpa)*math.pi/1.2, 999, geompy.GEOM.Interpolation, True)
53. [Vertex_3,Vertex_4] = geompy.ExtractShapes(Curve_2, geompy.ShapeType["VERTEX"], True)
54. 
    
55. Edge_1 = geompy.MakeEdge(Vertex_1, Vertex_3)
56. Edge_2 = geompy.MakeEdge(Vertex_2, Vertex_4)
57. Wire_2 = geompy.MakeWire([Curve_1, Curve_2, Edge_1, Edge_2], 1e-07)
58. Face_2 = geompy.MakeFaceWires([Wire_2], 0)
59. Revolution_2 = geompy.MakeRevolution(Face_2, OZ, 20*math.pi/180.0)
60. #
61. 
    
62. #Cutting, Rotating, Mirroring
63. Cut_1 = geompy.MakeCut(Revolution_1, Revolution_2)
64. geompy.Rotate(Cut_1, OZ, 120*math.pi/180.0)
65. Cut_2 = geompy.MakeCut(Cut_1, Revolution_2)
66. geompy.Rotate(Cut_2, OZ, 120*math.pi/180.0)
67. Cut_3 = geompy.MakeCut(Cut_2, Revolution_2)
68. Mirror_1 = geompy.MakeMirrorByAxis(Cut_3, OY)
69. geompy.Rotate(Mirror_1, OZ, -40*math.pi/180.0)
70. Stabilizer = geompy.MakeFuse(Cut_3, Mirror_1)
71. 
    
72. geompy.addToStudy( Stabilizer, 'Stabilizer' )
73. 
    
74. geompy.addToStudy( Revolution_1, 'Revolution_1' )
75. geompy.addToStudy( Revolution_2, 'Revolution_2' )
76. 
    
77. if salome.sg.hasDesktop():
78.   salome.sg.updateObjBrowser(1)