smesh/doc/salome/gui/SMESH/input/mesh_infos.doc

/*!

\page mesh_infos_page Mesh Information

The user can obtain information about the selected mesh object
(mesh, sub-mesh or group) using <b>Mesh Information</b> dialog box.

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. 

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

The <b>Mesh Information</b> dialog box provides three tab pages:
- <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
  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>

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.

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

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

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 a node:
  - Node ID;
  - Coordinates (X, Y, Z);
  - Connectivity information (connected elements); double click in
    this line makes the dialog show information of 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>

- 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 makes the dialog show information of 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.

\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>

For a sub-mesh object, the following information is shown:
- Name
- Parent mesh
- Shape

<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:
- 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>

\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 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 GUI module is builded with Plot 2D Viewer (set option SALOME_USE_PLOT2DVIEWER to 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. 

See the \ref tui_viewing_mesh_infos "TUI Example".

*/