Salome HOME
Update of CheckDone
[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 * Hexahedron (i,j,k) 3D algorithm
38
39    *   :ref:`tui_block_renumber`
40
41 * :ref:`tui_projection`
42 * :ref:`Extrusion 3D <tui_prism_3d_algo>` algorithm
43 * :ref:`Radial Prism <tui_radial_prism>` algorithm
44 * :ref:`Body Fitting <tui_cartesian_algo>` algorithm
45 * :ref:`Import 1D-2D Elements from Another Mesh <tui_import>` algorithm
46 * :ref:`Use Faces to be Created Manually <tui_use_existing_faces>` algorithm
47 * :ref:`Segments around Vertex <tui_segments_around_vertex>` algorithm
48
49
50
51 Defining 1D Hypotheses
52 ######################
53
54 .. _tui_1d_arithmetic:
55
56 Arithmetic Progression and Geometric Progression
57 ================================================
58
59 .. literalinclude:: ../../../examples/defining_hypotheses_ex01.py
60     :language: python
61
62 :download:`Download this script <../../../examples/defining_hypotheses_ex01.py>`
63
64 .. _tui_1d_adaptive:
65
66 Adaptive
67 ========
68
69 .. literalinclude:: ../../../examples/defining_hypotheses_adaptive1d.py
70     :language: python
71
72 :download:`Download this script <../../../examples/defining_hypotheses_adaptive1d.py>`
73
74
75 .. _tui_deflection_1d:
76
77 Deflection and Number of Segments
78 =================================
79
80 .. literalinclude:: ../../../examples/defining_hypotheses_ex02.py
81     :language: python
82
83 :download:`Download this script <../../../examples/defining_hypotheses_ex02.py>`
84
85
86 .. _tui_start_and_end_length:
87
88 Start and End Length
89 ====================
90
91 .. literalinclude:: ../../../examples/defining_hypotheses_ex03.py
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     :language: python
104
105 :download:`Download this script <../../../examples/defining_hypotheses_ex04.py>`
106
107 Defining 2D and 3D hypotheses
108 #############################
109
110
111 .. _tui_max_element_area:
112
113 Maximum Element Area
114 ====================
115
116 .. literalinclude:: ../../../examples/defining_hypotheses_ex05.py
117     :language: python
118
119 :download:`Download this script <../../../examples/defining_hypotheses_ex05.py>`
120
121
122 .. _tui_max_element_volume:
123
124 Maximum Element Volume
125 ======================
126
127 .. literalinclude:: ../../../examples/defining_hypotheses_ex06.py
128     :language: python
129
130 :download:`Download this script <../../../examples/defining_hypotheses_ex06.py>`
131
132
133 .. _tui_length_from_edges:
134
135 Length from Edges
136 =================
137
138 .. literalinclude:: ../../../examples/defining_hypotheses_ex07.py
139     :language: python
140
141 :download:`Download this script <../../../examples/defining_hypotheses_ex07.py>`
142
143 .. _tui_block_renumber:
144
145 Renumber 3D hypothesis
146 ======================
147
148 .. literalinclude:: ../../../examples/filters_ex39.py
149     :language: python
150
151 :download:`Download this script <../../../examples/filters_ex39.py>`
152
153 Defining Additional Hypotheses
154 ##############################
155
156 .. _tui_propagation:
157
158 Propagation
159 ===========
160
161 .. literalinclude:: ../../../examples/defining_hypotheses_ex08.py
162     :language: python
163
164 :download:`Download this script <../../../examples/defining_hypotheses_ex08.py>`
165
166
167 .. _tui_defining_meshing_algos:
168
169 Defining Meshing Algorithms
170 ###########################
171
172 .. literalinclude:: ../../../examples/defining_hypotheses_ex09.py
173     :language: python
174
175 :download:`Download this script <../../../examples/defining_hypotheses_ex09.py>`
176
177
178 .. _tui_projection:
179
180 Projection Algorithms
181 =====================
182
183 .. literalinclude:: ../../../examples/defining_hypotheses_ex10.py
184     :language: python
185
186 :download:`Download this script <../../../examples/defining_hypotheses_ex10.py>`
187
188 Projection 1D2D
189 ===============
190
191 .. literalinclude:: ../../../examples/defining_hypotheses_ex11.py
192     :language: python
193
194 :download:`Download this script <../../../examples/defining_hypotheses_ex11.py>`
195
196 .. _tui_fixed_points:
197
198 1D Mesh with Fixed Points example
199 #################################
200
201 .. literalinclude:: ../../../examples/defining_hypotheses_ex12.py
202     :language: python
203
204 :download:`Download this script <../../../examples/defining_hypotheses_ex12.py>`
205
206 .. _tui_radial_quadrangle:
207
208 Radial Quadrangle 1D-2D example
209 ###############################
210
211 .. literalinclude:: ../../../examples/defining_hypotheses_ex13.py
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     :language: python
223
224 :download:`Download this script <../../../examples/defining_hypotheses_ex14.py>`
225
226 Quadrangle Parameters example 2 (using different types)
227 #######################################################
228
229 .. literalinclude:: ../../../examples/defining_hypotheses_ex15.py
230     :language: python
231
232 :download:`Download this script <../../../examples/defining_hypotheses_ex15.py>`
233
234 .. _tui_import:
235
236 "Import 1D-2D Elements from Another Mesh" example
237 #################################################
238
239 .. literalinclude:: ../../../examples/defining_hypotheses_ex16.py
240     :language: python
241
242 :download:`Download this script <../../../examples/defining_hypotheses_ex16.py>`
243
244 .. _tui_viscous_layers:
245
246 Viscous layers construction
247 ###########################
248
249 .. literalinclude:: ../../../examples/defining_hypotheses_ex17.py
250     :language: python
251
252 :download:`Download this script <../../../examples/defining_hypotheses_ex17.py>`
253
254 .. _tui_radial_prism:
255
256 Radial Prism example
257 ####################
258
259 .. literalinclude:: ../../../examples/radial_prism_3d_algo.py
260     :language: python
261
262 :download:`Download this script <../../../examples/radial_prism_3d_algo.py>`
263
264 .. _tui_cartesian_algo:
265
266 Usage of Body Fitting algorithm
267 ###############################
268
269 .. literalinclude:: ../../../examples/cartesian_algo.py
270     :language: python
271
272 :download:`Download this script <../../../examples/cartesian_algo.py>`
273
274 .. _tui_use_existing_faces: 
275
276 Usage of "Use Faces to be Created Manually" algorithm
277 #####################################################
278
279 This sample demonstrates how to use **Use Faces to be Created Manually** algorithm,
280 which is actually just a stub allowing to use your own 2D algorithm
281 implemented in Python.
282
283 .. literalinclude:: ../../../examples/use_existing_faces.py
284     :language: python
285
286 :download:`Download this script <../../../examples/use_existing_faces.py>`
287
288 Resulting mesh:
289
290 .. image:: ../images/use_existing_face_sample_mesh.png
291         :align: center
292
293
294 .. _tui_prism_3d_algo:
295
296 Usage of Extrusion 3D meshing algorithm
297 ########################################
298
299 .. literalinclude:: ../../../examples/prism_3d_algo.py
300     :language: python
301
302 :download:`Download this script <../../../examples/prism_3d_algo.py>`
303
304 The result geometry and mesh is shown below
305
306 .. image:: ../images/prism_tui_sample.png
307         :align: center
308
309
310 .. _tui_quad_ma_proj_algo:
311
312 Usage of Medial Axis Projection algorithm
313 #########################################
314
315 .. literalinclude:: ../../../examples/quad_medial_axis_algo.py
316     :language: python
317
318 :download:`Download this script <../../../examples/quad_medial_axis_algo.py>`
319
320
321 .. _tui_segments_around_vertex:
322
323 Usage of Segments around Vertex algorithm
324 #########################################
325
326 .. literalinclude:: ../../../examples/defining_hypotheses_len_near_vertex.py
327     :language: python
328
329 :download:`Download this script <../../../examples/defining_hypotheses_len_near_vertex.py>`
330