Salome HOME
Update documentation
[modules/smesh.git] / doc / salome / gui / SMESH / input / extrusion_along_path.doc
1 /*!
2
3 \page extrusion_along_path_page Extrusion along Path
4
5 \n In principle, <b>Extrusion along Path</b> works in the same way
6 as \b Extrusion, the main difference is that we define not a vector,
7 but a path of extrusion which must be a 1D mesh or 1D sub-mesh. 
8 To get an idea of how this algorithm works, examine several examples,
9 starting from the most simple case of extrusion along a straight edge.
10 In the examples the sample mesh will be extruded along different
11 paths and with different parameters.
12 This 2D mesh has two quadrangle faces and seven edges. Look
13 at the picture, where white digits are the node numbers and green
14 are the element numbers:
15
16 \image html mesh_for_extr_along_path.png
17
18 <br><center><h2>Extrusion along a straight edge</h2>(not using base point
19 or angles)</center>
20
21 \image html straight_before.png
22 <center>The image shows a 1D path mesh, built on a linear edge, and the initial 2D mesh.</center>
23
24 \image html straight_after.png
25 <center> The image shows the result of extrusion of two edges
26 (#1 and #2) of the initial mesh along the path. \n Node #1 of path mesh
27 has been selected as Start node.</center>
28
29 <br><center><h2>Extrusion along a curvilinear edge</h2>(with and
30 without angles)</center>
31
32 \image html curvi_simple_before.png
33 <center>The image shows a 1D path mesh, built on curvilinear edge, and
34 the initial  2D mesh.</center>
35
36 \image html curvi_simple_after.png
37 <center>The central image shows the result of extrusion of one edge
38 (#2) of the initial mesh along the path. \n Node #1 of path mesh has
39 been selected as <b>Start node</b>.</center>
40
41 \image html curvi_angles_after.png
42 <center>The same, but using angles {45, 45, 45, 0, -45, -45, -45}</center>
43
44 <br><center><h2>Extrusion of a 2D face along a mesh built on a wire</h2></center>
45
46 In this example the path mesh has been built on a wire containing 3
47 edges. Node 1 is a start node. Linear angle variation by 180 degrees
48 has also been applied.
49
50 \image html extr_along_wire_before.png
51 <center><em>Meshed wire</em></center>
52
53 \image html extr_along_wire_after.png
54 <center><em>The resulting extrusion</em></center>
55
56 <br><center><h2>Extrusion of 2d elements along a closed path</h2></center>
57
58 \image html circle_simple_before.png
59 <center>The image shows a path mesh built on a closed edge
60 (circle).</center>
61
62 \image html circle_simple_after.png
63 <center>The central image shows the result of extrusion of both faces
64 of the initial mesh. \n Note, that no sewing has been done, so, there are
65 six coincident nodes and two coincident faces in the resulting
66 mesh.</center>
67
68 \image html circle_angles_after.png
69 <center>The same, but using angles {45, -45, 45, -45, 45, -45, 45,
70 -45}</center>
71
72 <br><em>To use Extrusion along Path:</em>
73 <ol>
74 <li>From the \b Modification menu choose the <b>Extrusion along a
75 path</b> item or click <em>"Extrusion along a path"</em> button in the toolbar.
76
77 \image html image101.png
78 <center><em>"Extrusion along a path" button</em></center>
79
80 The following dialog common for line and planar elements will appear:
81
82 \image html extrusion_along_path_dlg.png
83 </li>
84
85 <li>In this dialog:
86 <ul>
87 <li>select the type of elements which will be extruded (1D or 2D),</li>
88 <li>specify the <b>IDs of the elements</b> which will be extruded
89
90 <ul>
91 <li><b>Select the whole mesh, sub-mesh or group</b> activating the corresponding check-box; or</li>
92 <li>Choose mesh elements with the mouse in the 3D Viewer. It is
93 possible to select a whole area with a mouse frame; or</li> 
94 <li>Input the element IDs directly in <b>ID Elements</b> field. The selected elements will be highlighted in the
95 viewer; or</li>
96 <li>apply Filters. <b>Set filter</b> button allows to apply a filter to the selection of elements. See more
97 about filters in the \ref selection_filter_library_page "Selection filter library" page.</li>
98 </ul>
99
100 </li>
101 <li>Define the \b Path along which the elements will be extruded.<br>
102   Path definition consists of several elements:
103   <ul>
104     <li><b>Mesh or submesh</b> - 1D mesh or sub-mesh, along which proceeds the extrusion</li>
105     <li><b>Start node</b> - the start node. It is used to define the direction of extrusion </li>
106   </ul>
107 </li>
108 <li>Activate <b>Generate Groups</b> check-box if it is necessary to  copy the groups of
109   elements of the source mesh to the newly created one. </li>
110 </ul>
111 </li>
112
113 <li>There are two optional parameters, which can be very useful:
114 <ul>
115 <li>If the path of extrusion is curvilinear, at each iteration the
116 extruded elements are rotated to keep its initial angularity to the
117 curve. By default, the <b>Base Point</b> around which the elements are rotated is
118 the mass center of the elements, however, you can specify any point as
119 the <b>Base Point</b> and the elements will be rotated with respect to this
120 point.<br>
121   Note that only the displacement of the <b>Base Point</b> exactly equals to the 
122   path, and all other extruded elements simply keep their position relatively to the <b>Base Point</b> at each iteration.
123 </li>
124 <li>The elements can also be rotated around the path to get the resulting
125 mesh in a helical fashion. You can set the values of angles at the
126 right, add them to the list of angles at the left by pressing the <em>"Add"</em>
127 button and remove them from the list by pressing the <em>"Remove"</em> button. 
128
129 \image html add.png
130 <center><em>"Add" button</em></center>
131
132 \image html remove.png
133 <center><em>"Remove" button</em></center>
134
135 <b>Linear variation of the angles</b> option allows defining the angle of gradual rotation for the whole path. 
136 At each step the elements will be rotated by <code>angle / nb. of steps</code>. 
137
138 </li>
139 </ul>
140 </li>
141
142
143 <li>Click \b Apply or <b> Apply and Close</b>  button to confirm the operation.
144 Mesh edges will be extruded into
145 faces, faces into volumes. The external surface of the resulting 3d
146 mesh (if faces have been extruded) is covered with faces, and corners
147 with edges. If the path is closed, the resulting mesh can contain
148 duplicated nodes and faces, because no sewing is done.
149 </li>
150 </ol>
151
152 <br><b>See Also</b> a sample TUI Script of an 
153 \ref tui_extrusion_along_path "Extrusion along a Path" operation.  
154
155 */