Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/smesh.git] / doc / salome / gui / SMESH / input / constructing_meshes.doc
1 /*!
2
3 \page constructing_meshes_page Constructing meshes
4
5 \n Construction of a mesh consists of:
6 <ul>
7 <li>Selecting a geometrical object for meshing</li>
8 <li>Applying \subpage basic_meshing_algos_page "meshing algorithms" and
9 \subpage about_hypo_page "hypotheses" which will be used at computation of
10 this mesh.</li>
11 </ul>
12
13 <em>To construct a mesh:</em>
14 <ol>
15 <li>In the \b Mesh menu select <b>Create Mesh</b> or click <em>"Create
16 Mesh"</em> button in the toolbar. 
17
18 \image html image32.png
19 <center><em>"Create Mesh" button</em></center>
20
21 The following dialog box will appear: 
22
23 \image html createmesh-inv.png
24 </li>
25 <li>For example, you need to mesh a 3d object.
26 \n First, type the name for your mesh in the "Name" box, by default,
27 it is "Mesh_1". Then select the object you wish to mesh in the Object
28 Browser and click the "Add" button.
29
30 \image html image120.png
31 <center><em>"Add" button</em></center>
32
33 Now you can define 1d Algorithm and 1d Hypotheses, which will be
34 applied to the edges of your object. (Note that any object has edges,
35 even if their existence is not apparent, for example, a sphere has 4
36 edges). Click the <em>"Add Hypothesis"</em>  button to add a hypothesis.
37
38 \image html image121.png
39 <center><em>"Add Hypothesis" button</em></center>
40
41 Click the <em>"Edit Hypothesis"</em> button to define values for the
42 current hypothesis.
43
44 \image html image122.png
45 <center><em>"Edit Hypothesis" button</em></center>
46
47 The use of additional hypotheses is optional (i.e. you may leave
48 "None" in this box).
49
50 Proceed in the same way with 2d and 3d Algorithms and Hypotheses, note
51 that the choice of hypotheses depends on the algorithm. There must be
52 one Algorithm and one or several Hypotheses for each dimension of your
53 object, otherwise you will not get any mesh at all. Of course, if you
54 wish to mesh a face, which is a 2d object, you don't need to define 3d
55 Algorithm and Hypotheses.
56 \n In the <b>Object Browser</b> the structure of the new mesh will be
57 displayed as follows:
58
59 \image html image88.jpg
60
61 It contains:
62 <ul>
63 <li>a reference to the geometrical object on the basis of which the mesh has been constructed;</li>
64 <li><b>Applied hypotheses</b> folder containing the references to the
65 hypotheses applied to the construction of the mesh;</li>
66 <li><b>Applied algorithms</b> folder containing the references to the
67 algorithms applied to the construction of the mesh.</li>
68 </ul>
69
70 There is an alternative way to create a mesh on an object simply by
71 clicking <b>Assign a set of hypotheses</b> button and selecting between
72 Automatic Tetrahedralization or Hexahedralization.  The program will
73 automatically generate a 3D mesh with the most appropriate
74 settings. In the same way you can apply this functionality for meshing
75 2D objects, in which case 3D algorithms are not applied.</li>
76 <li>Now, when everything is ready, select your mesh in the <b>Object
77 Browser</b>. From the \b Mesh menu select \b Compute or click "Compute" button of the
78 toolbar. 
79
80 \image html image28.png
81 <center><em>"Compute" button</em></center>
82
83 The Mesh Computation information box appears.
84
85 \image html meshcomputationsucceed.png
86
87 If the mesh computation failed, the information about the cause of the
88 failure is provided.
89
90 \image html meshcomputationfail.png
91
92 After you select the error, <b>Show Subshape</b> button allows
93 visualizing the geometrical entity that causes it.
94
95 \image html failed_computation.png "Example of the invalid input mesh"
96
97 \Note Mesh Computation Information box does not appear if you set
98 "Mesh computation/Show a computation result notification" preference 
99 to the "Never" value. This option gives the possibility to control mesh
100 computation reporting. There are the following possibilities: always
101 show information box, only if an error occurs or never. 
102 By default, the information box is always shown after mesh computation operation.
103
104 <b>Publish Subshape</b> button publishes the subshape, whose meshing
105 failed, in GEOM component as a child of the mesh geometry, which
106 allows analyzing the problem geometry and creating a submesh on it in
107 order to locally tune hypotheses.
108
109 <b>NOTE</b> It is possible to define a 1D or a 2D mesh in a
110 python script and then use such submeshes in the construction of a 3D
111 mesh. For this, there exist two algorithms: <b>Use existing edges</b> and <b>Use
112 existing faces</b>. They are not entirely usable from the GUI, so a
113 mesh created using these algorithms should be exported into a python
114 script, edited and then imported into the GUi. 
115
116 Consider trying a sample script for construction of a mesh from our 
117 \ref tui_creating_meshes_page "TUI Scripts" section.
118 </li>
119 </ol>
120
121 */