Salome HOME
Merge remote branch 'origin/V8_5_asterstudy'
[modules/smesh.git] / doc / salome / gui / SMESH / input / tui_defining_hypotheses.rst
1 .. _tui_defining_hypotheses_page:
2
3 **********************************
4 Defining Hypotheses and Algorithms
5 **********************************
6
7 This page provides example codes of :ref:`defining algorithms <tui_defining_meshing_algos>`
8 and hypotheses.
9
10 * Wire discretisation 1D algorithm
11   
12     * :ref:`tui_1d_adaptive` hypothesis
13     * :ref:`Arithmetic Progression <tui_1d_arithmetic>` hypothesis
14     * :ref:`Geometric Progression <tui_1d_arithmetic>` hypothesis
15     * :ref:`Deflection and Number of Segments <tui_deflection_1d>` hypotheses
16     * :ref:`Start and End Length <tui_start_and_end_length>` hypothesis
17     * :ref:`tui_average_length` hypothesis
18     * :ref:`tui_propagation` additional hypotheses 
19     * :ref:`Fixed Points 1D <tui_fixed_points>` hypothesis
20   
21
22 * Triangle: Mefisto 2D algorithm
23   
24     * :ref:`tui_max_element_area` hypothesis 
25     * :ref:`tui_length_from_edges` hypothesis 
26   
27 * Quadrangle: Mapping 2D algorithm
28   
29     * :ref:`Quadrangle Parameters <tui_quadrangle_parameters>` hypothesis 
30
31 * :ref:`Radial Quadrangle 1D-2D <tui_radial_quadrangle>` algorithm
32 * NETGEN 3D algorithm
33   
34     *  :ref:`tui_max_element_volume` hypothesis 
35     *  :ref:`Viscous layers <tui_viscous_layers>` hypotheses
36
37 * :ref:`tui_projection`
38 * :ref:`Extrusion 3D <tui_prism_3d_algo>` algorithm
39 * :ref:`Radial Prism <tui_radial_prism>` algorithm
40 * :ref:`Body Fitting <tui_cartesian_algo>` algorithm
41 * :ref:`Import 1D-2D Elements from Another Mesh <tui_import>` algorithm
42 * :ref:`Use Faces to be Created Manually <tui_use_existing_faces>` algorithm
43 * :ref:`Segments around Vertex <tui_segments_around_vertex>` algorithm
44
45
46
47 Defining 1D Hypotheses
48 ######################
49
50 .. _tui_1d_arithmetic:
51
52 Arithmetic Progression and Geometric Progression
53 ================================================
54
55 .. literalinclude:: ../../../examples/defining_hypotheses_ex01.py
56     :linenos:
57     :language: python
58
59 :download:`Download this script <../../../examples/defining_hypotheses_ex01.py>`
60
61 .. _tui_1d_adaptive:
62
63 Adaptive
64 ========
65
66 .. literalinclude:: ../../../examples/defining_hypotheses_adaptive1d.py
67     :linenos:
68     :language: python
69
70 :download:`Download this script <../../../examples/defining_hypotheses_adaptive1d.py>`
71
72
73 .. _tui_deflection_1d:
74
75 Deflection and Number of Segments
76 =================================
77
78 .. literalinclude:: ../../../examples/defining_hypotheses_ex02.py
79     :linenos:
80     :language: python
81
82 :download:`Download this script <../../../examples/defining_hypotheses_ex02.py>`
83
84
85 .. _tui_start_and_end_length:
86
87 Start and End Length
88 ====================
89
90 .. literalinclude:: ../../../examples/defining_hypotheses_ex03.py
91     :linenos:
92     :language: python
93
94 :download:`Download this script <../../../examples/defining_hypotheses_ex03.py>`
95
96
97 .. _tui_average_length:
98
99 Local Length
100 ============
101
102 .. literalinclude:: ../../../examples/defining_hypotheses_ex04.py
103     :linenos:
104     :language: python
105
106 :download:`Download this script <../../../examples/defining_hypotheses_ex04.py>`
107
108 Defining 2D and 3D hypotheses
109 #############################
110
111
112 .. _tui_max_element_area:
113
114 Maximum Element Area
115 ====================
116
117 .. literalinclude:: ../../../examples/defining_hypotheses_ex05.py
118     :linenos:
119     :language: python
120
121 :download:`Download this script <../../../examples/defining_hypotheses_ex05.py>`
122
123
124 .. _tui_max_element_volume:
125
126 Maximum Element Volume
127 ======================
128
129 .. literalinclude:: ../../../examples/defining_hypotheses_ex06.py
130     :linenos:
131     :language: python
132
133 :download:`Download this script <../../../examples/defining_hypotheses_ex06.py>`
134
135
136 .. _tui_length_from_edges:
137
138 Length from Edges
139 =================
140
141 .. literalinclude:: ../../../examples/defining_hypotheses_ex07.py
142     :linenos:
143     :language: python
144
145 :download:`Download this script <../../../examples/defining_hypotheses_ex07.py>`
146
147 Defining Additional Hypotheses
148 ##############################
149
150 .. _tui_propagation:
151
152 Propagation
153 ===========
154
155 .. literalinclude:: ../../../examples/defining_hypotheses_ex08.py
156     :linenos:
157     :language: python
158
159 :download:`Download this script <../../../examples/defining_hypotheses_ex08.py>`
160
161
162 .. _tui_defining_meshing_algos:
163
164 Defining Meshing Algorithms
165 ###########################
166
167 .. literalinclude:: ../../../examples/defining_hypotheses_ex09.py
168     :linenos:
169     :language: python
170
171 :download:`Download this script <../../../examples/defining_hypotheses_ex09.py>`
172
173
174 .. _tui_projection:
175
176 Projection Algorithms
177 =====================
178
179 .. literalinclude:: ../../../examples/defining_hypotheses_ex10.py
180     :linenos:
181     :language: python
182
183 :download:`Download this script <../../../examples/defining_hypotheses_ex10.py>`
184
185 Projection 1D2D
186 ===============
187
188 .. literalinclude:: ../../../examples/defining_hypotheses_ex11.py
189     :linenos:
190     :language: python
191
192 :download:`Download this script <../../../examples/defining_hypotheses_ex11.py>`
193
194 .. _tui_fixed_points:
195
196 1D Mesh with Fixed Points example
197 #################################
198
199 .. literalinclude:: ../../../examples/defining_hypotheses_ex12.py
200     :linenos:
201     :language: python
202
203 :download:`Download this script <../../../examples/defining_hypotheses_ex12.py>`
204
205 .. _tui_radial_quadrangle:
206
207 Radial Quadrangle 1D-2D example
208 ###############################
209
210 .. literalinclude:: ../../../examples/defining_hypotheses_ex13.py
211     :linenos:
212     :language: python
213
214 :download:`Download this script <../../../examples/defining_hypotheses_ex13.py>`
215
216 .. _tui_quadrangle_parameters:
217
218 Quadrangle Parameters example 1 (meshing a face with 3 edges)
219 ##############################################################
220
221 .. literalinclude:: ../../../examples/defining_hypotheses_ex14.py
222     :linenos:
223     :language: python
224
225 :download:`Download this script <../../../examples/defining_hypotheses_ex14.py>`
226
227 Quadrangle Parameters example 2 (using different types)
228 #######################################################
229
230 .. literalinclude:: ../../../examples/defining_hypotheses_ex15.py
231     :linenos:
232     :language: python
233
234 :download:`Download this script <../../../examples/defining_hypotheses_ex15.py>`
235
236 .. _tui_import:
237
238 "Import 1D-2D Elements from Another Mesh" example
239 #################################################
240
241 .. literalinclude:: ../../../examples/defining_hypotheses_ex16.py
242     :linenos:
243     :language: python
244
245 :download:`Download this script <../../../examples/defining_hypotheses_ex16.py>`
246
247 .. _tui_viscous_layers:
248
249 Viscous layers construction
250 ###########################
251
252 .. literalinclude:: ../../../examples/defining_hypotheses_ex17.py
253     :linenos:
254     :language: python
255
256 :download:`Download this script <../../../examples/defining_hypotheses_ex17.py>`
257
258 .. _tui_radial_prism:
259
260 Radial Prism example
261 ####################
262
263 .. literalinclude:: ../../../examples/radial_prism_3d_algo.py
264     :linenos:
265     :language: python
266
267 :download:`Download this script <../../../examples/radial_prism_3d_algo.py>`
268
269 .. _tui_cartesian_algo:
270
271 Usage of Body Fitting algorithm
272 ###############################
273
274 .. literalinclude:: ../../../examples/cartesian_algo.py
275     :linenos:
276     :language: python
277
278 :download:`Download this script <../../../examples/cartesian_algo.py>`
279
280 .. _tui_use_existing_faces: 
281
282 Usage of "Use Faces to be Created Manually" algorithm
283 #####################################################
284
285 This sample demonstrates how to use **Use Faces to be Created Manually** algorithm,
286 which is actually just a stub allowing to use your own 2D algorithm
287 implemented in Python.
288
289 .. literalinclude:: ../../../examples/use_existing_faces.py
290     :linenos:
291     :language: python
292
293 :download:`Download this script <../../../examples/use_existing_faces.py>`
294
295 Resulting mesh:
296
297 .. image:: ../images/use_existing_face_sample_mesh.png
298         :align: center
299
300
301 .. _tui_prism_3d_algo:
302
303 Usage of Extrusion 3D meshing algorithm
304 ########################################
305
306 .. literalinclude:: ../../../examples/prism_3d_algo.py
307     :linenos:
308     :language: python
309
310 :download:`Download this script <../../../examples/prism_3d_algo.py>`
311
312 The result geometry and mesh is shown below
313
314 .. image:: ../images/prism_tui_sample.png
315         :align: center
316
317
318 .. _tui_quad_ma_proj_algo:
319
320 Usage of Medial Axis Projection algorithm
321 #########################################
322
323 .. literalinclude:: ../../../examples/quad_medial_axis_algo.py
324     :linenos:
325     :language: python
326
327 :download:`Download this script <../../../examples/quad_medial_axis_algo.py>`
328
329
330 .. _tui_segments_around_vertex:
331
332 Usage of Segments around Vertex algorithm
333 #########################################
334
335 .. literalinclude:: ../../../examples/defining_hypotheses_len_near_vertex.py
336     :linenos:
337     :language: python
338
339 :download:`Download this script <../../../examples/defining_hypotheses_len_near_vertex.py>`
340