53103: Mesh visualization performance problem

[modules/smesh.git] / doc / salome / gui / SMESH / input / mesh_infos.doc

diff --git a/doc/salome/gui/SMESH/input/mesh_infos.doc b/doc/salome/gui/SMESH/input/mesh_infos.doc
index 06a02d2cc1d90d5d356fe5badf49f6016df7b5a7..929deb8f3f34e98d1b8eb885ba7c8235fefecfb8 100644 (file)
--- a/doc/salome/gui/SMESH/input/mesh_infos.doc
+++ b/doc/salome/gui/SMESH/input/mesh_infos.doc
@@ -10,16 +10,20 @@ group in the <b>Object Browser</b> and invoke <b>Mesh Information</b>
 item from the \b Mesh menu or click <em>"Mesh Information"</em> button
 in the toolbar. 
 
 item from the \b Mesh menu or click <em>"Mesh Information"</em> button
 in the toolbar. 
 

-\image html image49.png
-<center><em>"Mesh Information" button</em></center>
+<center>\image html image49.png
+<em>"Mesh Information" button</em></center>

 
 The <b>Mesh Information</b> dialog box provides three tab pages:
 
 The <b>Mesh Information</b> dialog box provides three tab pages:

-- <b>\ref advanced_mesh_infos_anchor "Base Info"</b> - to show base
-information about the selected mesh object
+- <b>\ref advanced_mesh_infos_anchor "Base Info"</b> - to show
+  base and quantitative information about the selected mesh object.

 - <b>\ref mesh_element_info_anchor "Element Info"</b> - to show
 - <b>\ref mesh_element_info_anchor "Element Info"</b> - to show

-detailed information about the selected mesh node or element.
-- <b>\ref mesh_addition_info_anchor "Additional Info"</b> - to show additional information available
-for the selected mesh, sub-mesh or group object.
+  detailed information about the selected mesh nodes or elements.
+- <b>\ref mesh_addition_info_anchor "Additional Info"</b> - to show
+  additional information available for the selected mesh, sub-mesh or
+  group object. 
+- <b>\ref mesh_quality_info_anchor "Quality Info"</b> - to show
+  overall quality information about the selected mesh, sub-mesh or group
+  object. 

 
 \anchor advanced_mesh_infos_anchor
 <h2>Base Information</h2>
 
 \anchor advanced_mesh_infos_anchor
 <h2>Base Information</h2>


@@ -27,28 +31,52 @@ for the selected mesh, sub-mesh or group object.
 The <b>Base Info</b> tab page of the dialog box provides general
 information on the selected object - mesh, sub-mesh or mesh group:
 name, type, total number of nodes and elements separately for each
 The <b>Base Info</b> tab page of the dialog box provides general
 information on the selected object - mesh, sub-mesh or mesh group:
 name, type, total number of nodes and elements separately for each

-type: 0D elements, edges, faces and volumes.
+type: 0D elements, edges, faces, volumes, balls.

 
 

-\image html advanced_mesh_infos.png
-<center><em>"Base Info" page</em></center>
+<center>\image html advanced_mesh_infos.png
+<em>"Base Info" page</em></center>

 
 \anchor mesh_element_info_anchor
 <h2>Mesh Element Information</h2> 
 
 
 \anchor mesh_element_info_anchor
 <h2>Mesh Element Information</h2> 
 

-The <b>Element Info</b> tab page of the dialog box gives basic
-information about the type, coordinates and connectivity of the
-selected mesh node or element.
+The <b>Element Info</b> tab page of the dialog box gives detailed
+information about the selected mesh node(s) or element(s), namely:

 
 

-\image html eleminfo1.png
-<center><em>"Element Info" page, node information</em></center>
+- For a node:
+  - Node ID;
+  - Coordinates (X, Y, Z);
+  - Connectivity information (connected elements); double click in
+    this line reveals information about these elements;
+  - Position on a shape (for meshes built on a geometry);
+  - Groups information (names of groups the node belongs to).
+
+<center>\image html eleminfo1.png
+<em>"Element Info" page, node information</em></center>

 <br>
 <br>

-\image html eleminfo2.png 
-<center><em>"Element Info" page, element information</em></center>

 
 

-The use can either input the ID of a node or element he wants to
-analyze directly in the dialog box or select the node or element in
+- For an element:
+  - Element ID;
+  - Type (triangle, quadrangle, etc.);
+  - Gravity center (X, Y, Z coordinates);
+  - Connectivity information (connected nodes); double click in
+    a line of a node reveals the information about this node;
+  - Quality controls (area, aspect ration, volume, etc.);
+  - Position on a shape (for meshes built on a geometry);
+  - Groups information (names of groups the element belongs to).
+
+<center>\image html eleminfo2.png 
+<em>"Element Info" page, element information</em></center>
+
+The user can either input the ID of a node or element he wants to
+analyze directly in the dialog box or select the node(s) or element(s) in

 the 3D viewer.
 
 the 3D viewer.
 

+\note The information about the groups, to which the node or element belongs,
+ can be shown in a short or in a detailed form. By default, for performance
+reasons, this information is shown in a short form (group names
+only). The detailed information on groups can be switched on via the user
+preferences, see \ref mesh_preferences_page.
+

 \anchor mesh_addition_info_anchor
 <h2>Additional Information</h2> 
 
 \anchor mesh_addition_info_anchor
 <h2>Additional Information</h2> 
 


@@ -64,8 +92,8 @@ For a mesh object, the following information is shown:
 - Groups
 - Sub-meshes
 
 - Groups
 - Sub-meshes
 

-\image html addinfo_mesh.png
-<center><em>"Additional Info" page, mesh information</em></center>
+<center>\image html addinfo_mesh.png
+<em>"Additional Info" page, mesh information</em></center>

 <br>
 
 For a sub-mesh object, the following information is shown:
 <br>
 
 For a sub-mesh object, the following information is shown:


@@ -73,8 +101,8 @@ For a sub-mesh object, the following information is shown:
 - Parent mesh
 - Shape
 
 - Parent mesh
 - Shape
 

-\image html addinfo_submesh.png
-<center><em>"Additional Info" page, sub-mesh information</em></center>
+<center>\image html addinfo_submesh.png
+<em>"Additional Info" page, sub-mesh information</em></center>

 <br>
 
 For a group object, the following information is shown:
 <br>
 
 For a group object, the following information is shown:


@@ -86,8 +114,8 @@ For a group object, the following information is shown:
 - Color
 - Number of underlying nodes (for non-nodal groups)
 
 - Color
 - Number of underlying nodes (for non-nodal groups)
 

-\image html addinfo_group.png
-<center><em>"Additional Info" page, group information</em></center>
+<center>\image html addinfo_group.png
+<em>"Additional Info" page, group information</em></center>

 <br>
 
 \note For the performance reasons, the number of underlying nodes is
 <br>
 
 \note For the performance reasons, the number of underlying nodes is


@@ -97,9 +125,46 @@ automatically calculated if the size of the group does not exceed
 the "Automatic nodes compute limit" set via the  "Mesh information"
 preferences (zero value means no limit).
 
 the "Automatic nodes compute limit" set via the  "Mesh information"
 preferences (zero value means no limit).
 

+\anchor mesh_quality_info_anchor
+<h2>Quality Information</h2>
+
+The <b>Quality Info</b> tab provides overall information about mesh quality controls  on the selected object - mesh, sub-mesh or mesh group:
+- Name;
+- Nodes information:
+  - Number of free nodes;
+  - Number of double nodes;
+- Edges information:
+  - Number of double edges;
+- Faces information:
+  - Number of double faces;
+  - Number of over-constrained faces;
+  - Aspect Ratio histogram;
+- Volume information:
+  - Number of double volumes;
+  - Number of over-constrained volumes;
+  - Aspect Ratio 3D histogram.
+
+<center>\image html ctrlinfo.png
+<em>"Quality Info" page</em></center>
+
+\note It is possible to set "Double nodes tolerance" in the dialog for a local change 
+      or via the "Quality controls" in Mesh preferences.
+
+\note For performance reasons, all quality control values for big meshes are
+computed only by demand. For this, press the "compute"
+button. Also, values are automatically computed if the number of 
+nodes / elements does not exceed the "Automatic controls compute limit" set 
+via the "Mesh information" preferences (zero value means that there is no limit).
+
+\note The plot functionality is available only if the GUI module is built with Plot 2D Viewer (option SALOME_USE_PLOT2DVIEWER is ON when building GUI module).
+
+The button \b "Dump" allows printing the information displayed in the
+dialog box to a .txt file.
+

 In case you get <b>Mesh Information</b> via a TUI script, the information is
 displayed in the Python Console. 
 In case you get <b>Mesh Information</b> via a TUI script, the information is
 displayed in the Python Console. 

-<b>See the</b> \ref tui_viewing_mesh_infos "TUI Example".
+
+See the \ref tui_viewing_mesh_infos "TUI Example".

 
 */
        
 
 */