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