Salome HOME
0020976: EDF 1471 SMESH: New ergonomy to display quality controls
[modules/smesh.git] / doc / salome / gui / SMESH / input / mesh_infos.doc
index 5c526af674870b08de16873ed71f0021c68af351..5be0d58c6fd6f383c43ba0a47ea1643dfb94c6c2 100644 (file)
@@ -15,11 +15,13 @@ in the toolbar.
 
 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
+information about the selected mesh object.
 - <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.
+- <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>
@@ -35,28 +37,28 @@ type: 0D elements, edges, faces, volumes, balls.
 \anchor mesh_element_info_anchor
 <h2>Mesh Element Information</h2> 
 
-The <b>Element Info</b> tab page of the dialog box gives detail
-information about selected mesh node(s) or element(s), namely:
+The <b>Element Info</b> tab page of the dialog box gives detailed
+information about the selected mesh node(s) or element(s), namely:
 
-- For node:
-  - Node ID
-  - Coordinates (X, Y, Z)
-  - Connectivity information (connected elements)
-  - Position on a shape (for meshes built on geometry)
-  - Groups information (names of groups the node belongs to)
+- For node:
+  - Node ID;
+  - Coordinates (X, Y, Z);
+  - Connectivity information (connected 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>
 
-- For element:
-  - Element ID
-  - Type (triangle, quadrangle, etc...)
-  - Gravity center (X, Y, Z coordinates)
-  - Connectivity information (connected nodes)
-  - Quality controls (area, aspect ration, volume, etc)
-  - Position on a shape (for meshes built on geometry)
-  - Groups information (names of groups the element belongs to)
+- For an element:
+  - Element ID;
+  - Type (triangle, quadrangle, etc.);
+  - Gravity center (X, Y, Z coordinates);
+  - Connectivity information (connected nodes);
+  - 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>
@@ -65,10 +67,10 @@ 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(s) or element(s) in
 the 3D viewer.
 
-\note The information about the groups, the node or element belongs
-to, can be shown in short or detail form. By default, for performance
-reasons, this information is show in short form (group names
-only). Detail information on groups can be switched on via the user
+\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
@@ -119,8 +121,38 @@ 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).
 
+\anchor mesh_quality_info_anchor
+<h2>Quality Information</h2>
+
+The <b>Quality Info</b> tab page of the dialog box provides overal
+mesh quality controls information on the selected object - mesh, 
+sub-mesh or mesh group:
+- Name;
+- Nodes information:
+  - Number of the 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 For the perfomance reason, the Aspect Ratio histogram for the big meshes is
+computed only by demand. For this, the user should press the "Compute"
+button (see picture). Also, histogram is automatically computed if the size of the 
+elements does not exceed the "Automatic controls compute limit" set 
+via the "Mesh information" preferences (zero value means no limit).
+
 The button \b "Dump" allows printing the information displayed in the
-dialog box to the txt file.
+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.