Salome HOME
0021308: EDF 1923 SMESH: Remove hard-coded dependency of the external mesh plugins...
[modules/smesh.git] / doc / salome / gui / SMESH / input / constructing_meshes.doc
index efbd97403cd83793192ee8192d1a698a785bba35..cefbd8ac7e4b9e40366b8eca6261e2ad805431a7 100644 (file)
@@ -25,7 +25,8 @@ The following dialog box will appear:
 <li>For example, you need to mesh a 3d object.
 \n First, type the name for your mesh in the "Name" box, by default,
 it is "Mesh_1". Then select the object you wish to mesh in the Object
-Browser and click the "Add" button.
+Browser and click the "Add" button (if name of the object not yet
+appeared in \b Geometry field).
 
 \image html image120.png
 <center><em>"Add" button</em></center>
@@ -33,7 +34,8 @@ Browser and click the "Add" button.
 Now you can define 1d Algorithm and 1d Hypotheses, which will be
 applied to the edges of your object. (Note that any object has edges,
 even if their existence is not apparent, for example, a sphere has 4
-edges). Click the <em>"Add Hypothesis"</em>  button to add a hypothesis.
+edges). Click the <em>"Add Hypothesis"</em>  button to add a
+hypothesis.
 
 \image html image121.png
 <center><em>"Add Hypothesis" button</em></center>
@@ -49,8 +51,10 @@ The use of additional hypotheses is optional (i.e. you may leave
 
 Proceed in the same way with 2d and 3d Algorithms and Hypotheses, note
 that the choice of hypotheses depends on the algorithm. There must be
-one Algorithm and one or several Hypotheses for each dimension of your
-object, otherwise you will not get any mesh at all. Of course, if you
+one Algorithm and zero or several Hypotheses for each dimension of your
+object (most standard 2D and 3D algorithms can work without
+hypotheses using some default parameters), 
+otherwise you will not get any mesh at all. Of course, if you
 wish to mesh a face, which is a 2d object, you don't need to define 3d
 Algorithm and Hypotheses.
 \n In the <b>Object Browser</b> the structure of the new mesh will be
@@ -66,13 +70,22 @@ hypotheses applied to the construction of the mesh;</li>
 <li><b>Applied algorithms</b> folder containing the references to the
 algorithms applied to the construction of the mesh.</li>
 </ul>
-
+<br>
 There is an alternative way to create a mesh on an object simply by
-clicking <b>Assign a set of hypotheses</b> button and selecting between
-Automatic Tetrahedralization or Hexahedralization.  The program will
-automatically generate a 3D mesh with the most appropriate
-settings. In the same way you can apply this functionality for meshing
-2D objects, in which case 3D algorithms are not applied.</li>
+clicking <b>Assign a set of hypotheses</b> button and selecting among
+pre-defined sets of hypotheses. In addition to the standard
+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).
+\image html hypo_sets.png
+<center>List of sets of hypotheses: <em>[custom]</em> is automatically added to the sets defined
+by the user</center>
+</li>
+
+\anchor preview_mesh_anchor
 
 <li> After the mesh object is created and all hypotheses are assigned and
 before the mesh computation, it is possible to see the mesh preview.
@@ -119,19 +132,19 @@ failure is provided.
 
 \image html meshcomputationfail.png
 
-After you select the error, <b>Show Subshape</b> button allows
+After you select the error, <b>Show Sub-shape</b> button allows
 visualizing the geometrical entity that causes it.
 
 \image html failed_computation.png "Example of the invalid input mesh"
 
-\Note Mesh Computation Information box does not appear if you set
+\note Mesh Computation Information box does not appear if you set
 "Mesh computation/Show a computation result notification" preference 
 to the "Never" value. This option gives the possibility to control mesh
 computation reporting. There are the following possibilities: always
 show information box, only if an error occurs or never. 
 By default, the information box is always shown after mesh computation operation.
 
-<b>Publish Subshape</b> button publishes the subshape, whose meshing
+<b>Publish Sub-shape</b> button publishes the sub-shape, whose meshing
 failed, in GEOM component as a child of the mesh geometry, which
 allows analyzing the problem geometry and creating a submesh on it in
 order to locally tune hypotheses.
@@ -143,9 +156,97 @@ existing faces</b>. They are not entirely usable from the GUI, so a
 mesh created using these algorithms should be exported into a python
 script, edited and then imported into the GUi. 
 
-Consider trying a sample script for construction of a mesh from our 
-\ref tui_creating_meshes_page "TUI Scripts" section.
+<li>It is possible to calculate the eventual mesh size 
+before \b Compute operation. For this, select the mesh in the <b>Object
+Browser</b> and from the \b Mesh menu select \b Evaluate. The result of
+evaluation will be displayed in the following information box:
+
+\image html mesh_evaluation_succeed.png
+
+</li>
+
+
+\anchor mesh_order_anchor
+
+<li>
+If the mesh contains concurrent submeshes, it is possible to change
+the priority of their computation, i.e. to change the priority of
+applying algorithms to the shared sub-shapes of the Mesh shape.</li>
+
+<em>To change submesh priority:</em>
+
+<li>Choose "Change submesh priority" from the Mesh menu or a popup menu. The opened dialogue
+shows a list of submeshes in the order of their priority. 
+
+There is an example of submesh order modifications of the Mesh created on a Box
+shape. The main Mesh object:
+<ul>
+<li><i>1D</i> <b>Wire discretisation</b> with <b>Number of Segments</b>=20</li>
+<li><i>2D</i> <b>Triangle (Mefisto)</b> with Hypothesis<b>Max Element Area</b>
 </li>
+</ul>
+The first submesh object <b>Submesh_1</b> created on <b>Face_1</b>
+is:
+<ul>
+<li><i>1D</i> <b>Wire discretisation</b> with <b>Number of Segments</b>=4</li>
+<li><i>2D</i> <b>Triangle (Mefisto)</b> with Hypothesis<b>MaxElementArea</b>=1200</li>
+</ul>
+The second submesh object <b>Submesh_2</b> created on <b>Face_2</b>
+is:
+<ul>
+<li><i>1D</i> <b>Wire discretisation</b> with <b>Number of Segments</b>=8</li>
+<li><i>2D</i> <b>Triangle (Mefisto)</b> with Hypothesis<b>MaxElementArea</b>=1200</li>
+</ul>
+
+And the last submesh object <b>Submesh_3</b> created on <b>Face_3</b>
+is:
+<ul>
+<li><i>1D</i> <b>Wire discretisation</b> with <b>Number of Segments</b>=12</li>
+<li><i>2D</i> <b>Triangle (Mefisto)</b> with Hypothesis<b>MaxElementArea</b>=1200</li>
+</ul>
+
+The submeshes become concurrent if they share sub-shapes that can be meshed 
+with different algorithms (or different hypothesises).
+In the example, we have three submeshes with concurrent algorithms,
+because they have different hypotheses. 
+
+The first mesh computation is made with:
+\image html mesh_order_123.png
+<center><em>"Mesh order SubMesh_1, SubMesh_2, SubMesh_3"</em></center>
+\image html mesh_order_123_res.png
+<center><em>"Result mesh with order SubMesh_1, SubMesh_2, SubMesh_3 "</em></center>
+
+The next mesh computation is made with:
+\image html mesh_order_213.png
+<center><em>"Mesh order SubMesh_2, SubMesh_1, SubMesh_3"</em></center>
+\image html mesh_order_213_res.png
+<center><em>"Result mesh with order SubMesh_2, SubMesh_1, SubMesh_3 "</em></center>
+
+And the last mesh computation is made with:
+\image html mesh_order_321.png
+<center><em>"Mesh order SubMesh_3, SubMesh_2, SubMesh_1"</em></center>
+\image html mesh_order_321_res.png
+<center><em>"Result mesh with order SubMesh_3, SubMesh_2, SubMesh_1 "</em></center>
+
+As we can see, each mesh computation has a different number of result
+elements and a different mesh discretisation on the shared edges (the edges 
+that are shared between <b>Face_1</b>, <b>Face_2</b> and <b>Face_3</b>)
+
+Additionally, submesh priority (the order of applied algorithms) can
+be modified not only in a separate dialog box, but also in the
+<b>Preview</b>. This helps to preview different mesh results,
+modifying the order of submeshes.
+\image html mesh_order_preview.png
+<center><em>"Preview with submesh priority list box"</em></center>
+
+If there are no concurrent submeshes under the Mesh object, the user will see the
+following information.
+\image html mesh_order_no_concurrent.png
+<center><em>"No concurrent submeshes detected"</em></center>
+
 </ol>
 
-*/
\ No newline at end of file
+Consider trying a sample script for construction of a mesh from our 
+\ref tui_creating_meshes_page "TUI Scripts" section.
+
+*/