Salome HOME
Merge branch 'occ/shaper2smesh'
[modules/smesh.git] / doc / salome / gui / SMESH / input / constructing_meshes.rst
1 .. _constructing_meshes_page:
2
3 *******************
4 Constructing meshes
5 *******************
6
7 To create a mesh on geometry, it is necessary to create a mesh object by choosing
8
9 * a geometrical shape produced in the Geometry module (*main shape*);
10 * *meshing parameters*, including 
11
12   * :ref:`meshing algorithms <basic_meshing_algos_page>` and
13   * :ref:`hypotheses <about_hypo_page>` specifying constraints to be taken into account by the chosen meshing algorithms.
14
15 Then you can launch mesh generation by invoking :ref:`Compute <compute_anchor>` command.
16 The generated mesh will be automatically shown in the Viewer. You can
17 switch off automatic visualization or limit mesh size until which it is
18 automatically shown in :ref:`mesh_preferences_page` (*Automatic update* entry).
19
20 Read more about meshing parameters:
21
22 .. toctree::
23         :maxdepth: 1
24
25         basic_meshing_algos.rst
26         about_hypo.rst
27
28 Mesh generation on the geometry is performed in the bottom-up
29 flow: nodes on vertices are created first, then edges are divided into
30 segments using nodes on vertices; the nodes of segments are then
31 used to mesh faces; then the nodes of faces are used to mesh
32 solids. This automatically assures the conformity of the mesh.
33
34 It is required to choose a meshing algorithm for every dimension of
35 sub-shapes up to the highest dimension to be generated. Note
36 that some algorithms generate elements of several dimensions, and
37 others of only one. It is not necessary to define meshing
38 parameters for all dimensions at once; you can start from 1D
39 meshing parameters only, compute the 1D mesh, then define 2D meshing
40 parameters and compute the 2D mesh (note that 1D mesh will not be
41 re-computed).
42
43 An algorithm of a certain dimension chosen at mesh creation is applied
44 to discretize every sub-shape of this dimension. It is possible to
45 specify a different algorithm or hypothesis to be applied to one or
46 a group of sub-shapes by creating a :ref:`sub-mesh <constructing_submeshes_page>`.
47 You can specify no algorithms at all at mesh object
48 creation and specify the meshing parameters on sub-meshes only; then
49 only the sub-shapes, for which an algorithm and a hypothesis (if any)
50 have been defined will be discretized.
51
52 Construction of a mesh on a geometry includes at least two (:ref:`mesh creation <create_mesh_anchor>` and :ref:`computing <compute_anchor>`) of the following steps:
53
54 * :ref:`create_mesh_anchor`, where you can specify meshing parameters to apply to all sub-shapes of the main shape.
55 * :ref:`Creation of sub-meshes <constructing_submeshes_page>`, (optional) where you can specify meshing parameters to apply to the selected sub-shapes.
56 * :ref:`evaluate_anchor` (optional) can be used to know an approximate number of elements before their actual generation.
57 * :ref:`preview_anchor` (optional) can be used to generate mesh of only lower dimension(s) in order to visually estimate it before full mesh generation, which can be much longer.
58 * :ref:`submesh_order_anchor` (optional) can be useful if there are concurrent sub-meshes defined.
59 * :ref:`compute_anchor` uses defined meshing parameters to generate mesh elements.
60 * :ref:`edit_anchor` (optional) can be used to :ref:`modify <modifying_meshes_page>` the mesh of a lower dimension before :ref:`computing <compute_anchor>` elements of an upper dimension.
61
62
63 .. _create_mesh_anchor:
64
65 Creation of a mesh object
66 #########################
67
68 To construct a mesh:
69
70 .. |img| image:: ../images/image32.png
71 .. |sel| image:: ../images/image120.png
72 .. |add| image:: ../images/image121.png
73 .. |edt| image:: ../images/image122.png
74 .. |cmp| image:: ../images/image28.png
75 .. |prv| image:: ../images/mesh_precompute.png
76
77 #. Select a geometrical object for meshing.
78 #. In the **Mesh** menu select **Create Mesh** or click *"Create Mesh"* button |img| in the toolbar.
79
80    The following dialog box will appear: 
81
82         .. image:: ../images/createmesh-inv.png
83                 :align: center
84   
85 #. To filter off irrelevant meshing algorithms, you can select **Mesh Type** in the corresponding list from **Any, Hexahedral, Tetrahedral, Triangular** and **Quadrilateral** (there can be less items for the geometry of lower dimensions). Selection of a mesh type hides all meshing algorithms that cannot generate elements of this type.
86
87 #. Apply :ref:`meshing algorithms <basic_meshing_algos_page>` and :ref:`hypotheses <about_hypo_page>` which will be used to compute this mesh.
88
89    "Create mesh" dialog box contains several tab pages titled **3D**, **2D**, **1D** and **0D**. The title of each page reflects the dimension of the sub-shapes the algorithms listed on this page affect and the maximal dimension of elements the algorithms generate. For example, **3D** page lists the algorithms that affect 3D sub-shapes (solids) and generate 3D mesh elements (tetrahedra, hexahedra etc.)
90
91    As soon as you have selected an algorithm, you can create a hypothesis (or select an already created one). A set of accessible hypotheses includes only the hypotheses that can be used by the selected algorithm.
92
93    .. note::
94       * Some page(s) can be disabled if the geometrical object does not include shapes (sub-shapes) of the corresponding dimension(s). For example, if the input object is a geometrical face, **3D** page is disabled.
95       * Some algorithms affect the geometry of several dimensions, i.e. 1D+2D or 1D+2D+3D. If such an algorithm is selected, the dialog pages related to the corresponding lower dimensions are disabled.
96       * **0D** page refers to 0D geometry (vertices) rather than to 0D elements. Mesh module does not provide algorithms that produce 0D elements. Currently **0D** page provides only one algorithm "Segments around vertex" that allows specifying the required size of mesh edges about the selected vertex (or vertices).
97
98    For example, you need to mesh a 3D object.
99
100    First, you can change a default name of your mesh in the **Name** box. Then check that the selected geometrical object indicated in **Geometry** field, is what you wish to mesh; if not, select the correct object in the Object Browser. Click "Select" button |sel| near **Geometry** field if the name of the object has not yet appeared in **Geometry** field.
101
102    Now you can define 3D Algorithm and 3D Hypotheses, which will be applied to discretize the solids of your geometrical object using 3D elements. Click the *"Add Hypothesis"* button |add| to create  and add a hypothesis.
103
104    Click the *"Plus"* button to enable adding more additional hypotheses.
105
106    Click the *"Edit Hypothesis"* button |edt| to change the values for the current hypothesis.
107
108    Most 2D and 3D algorithms can work without hypotheses using default meshing parameters. Some algorithms do not require any hypotheses. After selection of an algorithm "Hypothesis" field of the dialog can contain:
109     
110    * *\<Default\>* if the algorithm can work using default parameters.
111    * *\<None\>* if the algorithm requires a hypothesis defining its parameters.
112    * If the algorithm does not use hypotheses, this field is grayed.
113     
114    After selection of an algorithm **Add. Hypothesis** field can contain:
115     
116    * *\<None\>* if the algorithm can be tuned using an additional hypothesis.
117    * If the algorithm does not use additional hypotheses, this field is grayed.
118     
119
120    Proceed in the same way with 2D and 1D Algorithms and Hypotheses that will be used to mesh faces and edges of your geometry. (Note that any object has edges, even if their existence is not apparent, for example, a sphere has 4 edges). Note that the choice of hypotheses and lower dimension algorithms depends on the higher dimension algorithm.
121
122    If you wish you can select other algorithms and/or hypotheses for meshing some sub-shapes of your CAD model by :ref:`constructing_submeshes_page`.
123
124    Some algorithms generate mesh of several dimensions, while others produce mesh of only one dimension. In the latter case there must be one Algorithm and zero or several Hypotheses for each dimension of your object, otherwise you will not get any mesh at all. Of course, if you wish to mesh a face, which is a 2D object, you do not need to define a 3D Algorithm and Hypotheses.
125
126    In the **Object Browser** the structure of the new mesh is displayed as follows:
127
128         .. image:: ../images/image88.jpg
129                 :align: center
130
131    It contains: 
132     
133    * a mesh name (*Mesh_mechanic*);
134    * a reference to the geometrical object on the basis of which the mesh has been constructed (*mechanic*); 
135    * **Applied hypotheses** folder containing the references to the hypotheses chosen at the construction of the mesh;
136    * **Applied algorithms** folder containing the references to the algorithms chosen at the construction of the mesh. 
137    * **SubMeshes on Face** folder containing the sub-meshes defined on geometrical faces. There also can be folders for sub-meshes on vertices, edges, wires, shells, solids and compounds.
138    * **Groups of Faces** folder containing the groups of mesh faces. There also can be folders for groups of nodes, edges, volumes 0D elements and balls.
139
140
141    There is an alternative way to assign Algorithms and Hypotheses by clicking **Assign a set of hypotheses** button and selecting among pre-defined sets of algorithms and hypotheses. In addition to the built-in sets of hypotheses, it is possible to create custom sets by editing CustomMeshers.xml file located in the home directory. CustomMeshers.xml file must describe sets of hypotheses in the same way as ${SMESH_ROOT_DIR}/share/salome/resources/smesh/StdMeshers.xml file does (sets of hypotheses are enclosed between \<hypotheses-set-group\> tags). For example:
142         ::
143
144                 <?xml version='1.0' encoding='us-ascii'?>
145                 <!DOCTYPE meshers PUBLIC "" "desktop.dtd">
146                 <meshers>
147                 <hypotheses-set-group>
148                         <hypotheses-set name="My favorite hypotheses"
149                                 hypos="AutomaticLength"
150                                 algos="CompositeSegment_1D, Quadrangle_2D, GHS3D_3D"/>
151                 </hypotheses-set-group>
152                 </meshers>
153
154    If the file contents are incorrect, there can be an error at activation of Mesh module: *"fatal parsing error: error triggered by consumer in line ..."*
155
156         .. image:: ../images/hypo_sets.png
157                 :align: center
158
159    .. centered::
160       List of sets of hypotheses. Tag *[custom]* is automatically added to the sets defined by the user.
161
162    .. note::
163       * The list of sets of hypotheses can be shorter than in the above image depending on the geometry dimension.
164   
165
166 Consider trying a sample script for construction of a mesh from our :ref:`TUI Scripts <tui_creating_meshes_page>` section.
167
168 .. _evaluate_anchor:
169
170 Evaluating mesh size
171 ####################
172
173 After the mesh object is created and all hypotheses are assigned and before :ref:`Compute <compute_anchor>` operation, it is possible to calculate the eventual mesh size. For this, select the mesh in the **Object Browser** and from the **Mesh** menu select **Evaluate**.
174 The result of evaluation will be displayed in the following information box: 
175
176         .. image:: ../images/mesh_evaluation_succeed.png
177                 :align: center
178
179 .. _preview_anchor:
180
181 Previewing the mesh
182 ###################
183
184 Before :ref:`the mesh computation <compute_anchor>`, it is also possible to see the mesh preview. This operation allows to incrementally compute the mesh, dimension by dimension, and to discard an unsatisfactory mesh.
185
186 For this, select the mesh in the Object Browser. From the **Mesh** menu select **Preview** or click "Preview" button |prv| in the toolbar or activate "Preview" item from the pop-up menu.
187
188 Select **1D mesh** or **2D mesh** preview mode in the Preview dialog. 
189
190 .. image:: ../images/preview_mesh_1D.png 
191         :align: center
192
193 .. centered::
194         1D mesh preview shows nodes computed on geometry edges
195
196
197 .. image:: ../images/preview_mesh_2D.png 
198         :align: center
199
200 .. centered::
201         2D mesh preview shows edge mesh elements, computed on geometry faces
202
203
204 **Compute** button computes the whole mesh.
205
206 When the Preview dialog is closed, the question about the storage of temporarily created mesh elements appears:
207
208 .. image:: ../images/preview_tmp_data.png
209         :align: center
210
211 These elements can be kept in the mesh.
212
213
214 .. _submesh_order_anchor:
215
216 Changing sub-mesh priority
217 ##########################
218
219 If the mesh contains concurrent :ref:`sub-meshes <constructing_submeshes_page>`, it is possible to change their :ref:`default priority <submesh_priority>`. Changing priority works in two ways:
220
221 * For sub-meshes with assigned algorithms of same dimension generating mesh of *several dimensions*, it sets the order in which the sub-meshes are computed.
222 * For the rest sub-meshes, it sets the order in which the sub-meshes are checked when looking for  meshing parameters to apply to a sub-shape. Examples below present this way. To impose the order in which sub-meshes with uni-dimensional algorithms are computed, invoke **Compute Sub-mesh** command on sub-meshes in a desired order.
223
224
225 *To change sub-mesh priority:*
226
227 Choose **Change sub-mesh priority** from the **Mesh** menu or a pop-up menu. The opened dialog shows a list of sub-meshes in the order of their priority. 
228
229 There is an example of sub-mesh order modifications taking a Mesh created on a Box shape. The main Mesh object:
230
231 * *1D* **Wire discretisation** with **Number of Segments** = 20
232 * *2D* **Triangle: Mefisto** with Hypothesis **Max Element Area**
233   
234
235 The first sub-mesh **Submesh_1** created on **Face_1** is:
236
237 * *1D* **Wire discretisation** with **Number of Segments** = 4
238 * *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
239
240 The second sub-mesh **Submesh_2** created on **Face_2** is:
241
242 * *1D* **Wire discretisation** with **Number of Segments** = 8
243 * *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
244
245
246 And the last sub-mesh **Submesh_3** created on **Face_3** is:
247
248 * *1D* **Wire discretisation** with **Number of Segments** = 12
249 * *2D* **Triangle: Mefisto** with Hypothesis **MaxElementArea** = 1200
250
251
252 The sub-meshes become concurrent if they share sub-shapes that can be meshed with different algorithms (or different hypotheses). In the example, we have three sub-meshes with concurrent algorithms, because they have different hypotheses.
253
254 The first mesh computation is made with:
255
256 .. image:: ../images/mesh_order_123.png
257         :align: center
258
259 .. centered::
260         Mesh order SubMesh_1, SubMesh_2, SubMesh_3
261
262
263 .. image:: ../images/mesh_order_123_res.png
264         :align: center
265
266 .. centered::
267         Result mesh with order SubMesh_1, SubMesh_2, SubMesh_3
268
269 The next mesh computation is made with:
270
271 .. image:: ../images/mesh_order_213.png
272         :align: center
273
274 .. centered::
275         Mesh order SubMesh_2, SubMesh_1, SubMesh_3
276
277 .. image:: ../images/mesh_order_213_res.png
278         :align: center
279
280 .. centered::
281         Result mesh with order SubMesh_2, SubMesh_1, SubMesh_3
282
283 And the last mesh computation is made with:
284
285 .. image:: ../images/mesh_order_321.png
286         :align: center
287
288 .. centered::
289         Mesh order SubMesh_3, SubMesh_2, SubMesh_1
290         
291
292 .. image:: ../images/mesh_order_321_res.png
293         :align: center
294
295 .. centered::
296         Result mesh with order SubMesh_3, SubMesh_2, SubMesh_1
297
298 As we can see, each mesh computation has a different number of result
299 elements and a different mesh discretization on the shared edges (the edges 
300 that are shared between **Face_1**, **Face_2** and **Face_3**)
301
302 Additionally, sub-mesh priority (the order of applied algorithms) can
303 be modified not only in a separate dialog box, but also in
304 the **Preview**. This helps to preview different mesh results,
305 modifying the order of sub-meshes. 
306
307 .. image:: ../images/mesh_order_preview.png
308         :align: center
309
310 .. centered::
311         Preview with sub-mesh priority list box
312
313 If there are no concurrent sub-meshes under the Mesh object, the user
314 will see the following information.
315
316 .. image:: ../images/mesh_order_no_concurrent.png
317         :align: center
318
319 .. centered::
320         No concurrent submeshes detected
321
322
323 .. _compute_anchor:
324
325 Computing the mesh
326 ##################
327
328 It is equally possible to skip  :ref:`Evaluation <evaluate_anchor>`
329 and :ref:`Preview <preview_anchor>` and to **Compute** the mesh after
330 the hypotheses are assigned. For this, select your mesh in
331 the Object Browser. From the **Mesh** menu or the context menu
332 select **Compute** or click *"Compute"* button |cmp| of the toolbar.
333
334 After the mesh computation finishes, the Mesh Computation information
335 box appears. If you close this box and click "Compute" button again,
336 without previously changing meshing parameters, the mesh will NOT be
337 re-computed and the Mesh Computation information box will be shown
338 with the same contents. (To fully re-compute the mesh, invoke 
339 :ref:`clear_mesh_anchor` command before). 
340
341 .. _meshing_result_anchor:
342
343 If the mesh computation has been a success, the box shows information on the number of entities of different types in the mesh.
344
345 .. image:: ../images/meshcomputationsucceed.png
346         :align: center
347
348 .. _meshing_failed_anchor:
349
350 If the mesh computation has failed, the information about the cause of the failure is provided in **Errors** table.
351
352 .. image:: ../images/meshcomputationfail.png
353         :align: center
354
355 After you select an error in **Errors** table, **Show Sub-shape** button allows
356 visualizing in magenta the geometrical entity meshing of which failed
357 (Name of this entity or its ID and type is shown in *Sub-shape* column).
358
359 .. image:: ../images/failed_computation.png 
360         :align: center
361
362 .. centered::
363         3D algorithm failed to compute mesh on a box shown using **Show Sub-shape** button
364
365 **Publish Sub-shape** button publishes the sub-shape, whose meshing
366 has failed, in the Geometry component as a child of the main shape, which
367 allows analyzing the problematic geometry and creating a sub-mesh on it in
368 order to locally tune the hypotheses.
369
370 If the failure is caused by an invalid input mesh and the algorithm has
371 found which mesh entities are bad, **Show bad Mesh** 
372 button appears in the dialog. Clicked, it shows the bad mesh entities in
373 the Viewer in magenta. Sometimes the shown mesh entities are too small
374 or/and hidden by other mesh elements. They can be seen after
375 switching the mesh to Wireframe visualization mode or switching off
376 the visualization of faces and volumes (if any).
377
378 **Bad Mesh to Group** button creates groups of bad mesh entities to facilitate their analysis.
379
380 .. image:: ../images/show_bad_mesh.png
381         :align: center
382
383 Edges bounding a hole in the surface are shown in magenta using **Show bad Mesh** button
384
385 .. note::
386         Mesh Computation Information box does not appear if you set :ref:`Mesh computation/Show a computation result notification <show_comp_result_pref>` preference to the "Never" value. This option gives the possibility to control mesh computation reporting. There are the following possibilities: always show the information box, show only if an error occurs or never. By default, the information box is always shown after mesh computation operation.
387
388 .. _edit_anchor:
389
390 Editing the mesh
391 ################
392
393 It is possible to :ref:`edit the mesh <modifying_meshes_page>` of a 
394 lower dimension before generation of the mesh of a higher dimension.
395
396 For example you can generate a 2D mesh, modify it using e.g. :ref:`Pattern mapping <pattern_mapping_page>`, and then generate a 3D mesh basing on the modified 2D mesh. The workflow is as follows:
397
398 * Define 1D and 2D meshing algorithms.
399 * Compute the mesh. 2D mesh is generated.
400 * Apply :ref:`Pattern mapping <pattern_mapping_page>`.
401 * Define 3D meshing algorithms without modifying 1D and 2D algorithms and hypotheses.
402 * Compute the mesh. 3D mesh is generated basing on a modified 2D mesh.
403
404 .. note::
405    Nodes and elements added :ref:`manually <adding_nodes_and_elements_page>` cannot be used in this workflow because the manually created entities are not attached to any geometry and thus (usually) cannot be found by the mesher paving a geometry.
406
407 **See Also** a sample TUI Script demonstrates the possibility of :ref:`tui_editing_while_meshing`.
408