Salome HOME
0020976: EDF 1471 SMESH: New ergonomy to display quality controls
[modules/smesh.git] / doc / salome / gui / SMESH / input / mesh_infos.doc
index 25982899502906cfecce822f2a70c9dccd99e83b..5be0d58c6fd6f383c43ba0a47ea1643dfb94c6c2 100644 (file)
 /*!
 
-\page mesh_infos_page Mesh infos
+\page mesh_infos_page Mesh Information
 
-\n There are three information boxes: <b>Standard Mesh
-Infos</b>, <b>Advanced Mesh Infos</b> and <b> Mesh Element Info</b>.
+The user can obtain information about the selected mesh object
+(mesh, sub-mesh or group) using <b>Mesh Information</b> dialog box.
 
-<br>
-\anchor standard_mesh_infos_anchor
-<h2>Standard Mesh Infos</h2>
-
-The <b>Standard Mesh Infos</b> box gives only the information on the
-number of elements of maximum dimension and the number of nodes in the
-mesh. However, from this Info you can learn about groups selected on
-this mesh.
-\n To view the <b>Standard Mesh Infos</b>, select your mesh or submesh
-in the <b>Object Browser</b> and select <b>Standard Mesh Infos</b>
-from the \b Mesh menu or click <em>"Standard Mesh Infos"</em> button
+To view the <b>Mesh Information</b>, select your mesh, sub-mesh or
+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. 
 
-\image html image49.gif
-<center><em>"Standard Mesh Infos" button</em></center>
-
-The following information will be displayed:
+<center>\image html image49.png
+<em>"Mesh Information" button</em></center>
 
-\image html a-standmeshinfo.png
+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 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.
 
-<br>
 \anchor advanced_mesh_infos_anchor
-<h2>Advanced Mesh Infos</h2>
+<h2>Base Information</h2>
 
-The <b>Advanced Mesh Infos</b> box gives more information about the mesh,
-including the total number of faces and volumes and their geometrical
-types.
-\n To view the <b>Advanced Mesh Infos</b>, select your mesh or submesh
-in the <b>Object Browser</b> and select <b>Advanced Mesh Infos</b>
-from the \b Mesh menu or click <em>"Advanced Mesh Infos"</em> button
-in the toolbar.
+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, volumes, balls.
 
-\image html image50.gif
-<center><em>"Advanced Mesh Infos" button</em></center>
+<center>\image html advanced_mesh_infos.png
+<em>"Base Info" page</em></center>
 
-The following information will be displayed:
+\anchor mesh_element_info_anchor
+<h2>Mesh Element Information</h2> 
 
-\image html advanced_mesh_infos.png
+The <b>Element Info</b> tab page of the dialog box gives detailed
+information about the selected mesh node(s) or element(s), namely:
 
-In case you get Mesh Infos via a \ref tui_viewing_mesh_infos "TUI script", 
-the information is displayed in Python Console.
+- For a 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).
 
-\image html b-mesh_infos.png
+<center>\image html eleminfo1.png
+<em>"Element Info" page, node information</em></center>
+<br>
 
+- 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>
+
+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, 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> 
+
+The <b>Additional Info</b> tab page of the dialog box provides an
+additional information on the selected object: mesh, sub-mesh or
+group.
+
+For a mesh object, the following information is shown:
+- Name
+- Type: based on geomerty, imported, standalone
+- Shape (if mesh is based on geometry)
+- File (if mesh is imported from the file)
+- Groups
+- Sub-meshes
+
+<center>\image html addinfo_mesh.png
+<em>"Additional Info" page, mesh information</em></center>
 <br>
-\anchor mesh_element_info_anchor
-<h2>Mesh Element Info</h2> 
 
-The <b>Mesh Element Info</b> box gives basic information about the
-type and the coordinates of the selected mesh element. 
+For a sub-mesh object, the following information is shown:
+- Name
+- Parent mesh
+- Shape
 
-\image html eleminfo1.png
+<center>\image html addinfo_submesh.png
+<em>"Additional Info" page, sub-mesh information</em></center>
+<br>
 
-\image html eleminfo2.png 
+For a group object, the following information is shown:
+- Name
+- Parent mesh
+- Type: standalone, group on geometry, group on filter
+- Entity type: node, edge, face, volume
+- Size
+- Color
+- Number of underlying nodes (for non-nodal groups)
+
+<center>\image html addinfo_group.png
+<em>"Additional Info" page, group information</em></center>
+<br>
 
-*/
\ No newline at end of file
+\note For the performance reasons, the number of underlying nodes is
+computed only by demand. For this, the user should press the "Compute"
+button (see picture). Also, the number of underlying nodes is
+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 a .txt file.
+
+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".
+
+*/
+