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

   1 /*!
   2
   3 \page mesh_infos_page Mesh Information
   4
   5 The user can obtain information about the selected mesh object
   6 (mesh, sub-mesh or group) using <b>Mesh Information</b> dialog box.
   7
   8 To view the <b>Mesh Information</b>, select your mesh, sub-mesh or
   9 group in the <b>Object Browser</b> and invoke <b>Mesh Information</b>
  10 item from the \b Mesh menu or from the context menu, or click <em>"Mesh Information"</em> button
  11 in the toolbar.
  12
  13 <center>\image html image49.png
  14 <em>"Mesh Information" button</em></center>
  15
  16 The <b>Mesh Information</b> dialog box provides three tab pages:
  17 - <b>\ref advanced_mesh_infos_anchor "Base Info"</b> - to show
  18   base and quantitative information about the selected mesh object.
  19 - <b>\ref mesh_element_info_anchor "Element Info"</b> - to show
  20   detailed information about the selected mesh nodes or elements.
  21 - <b>\ref mesh_addition_info_anchor "Additional Info"</b> - to show
  22   additional information available for the selected mesh, sub-mesh or
  23   group object.
  24 - <b>\ref mesh_quality_info_anchor "Quality Info"</b> - to show
  25   overall quality information about the selected mesh, sub-mesh or group
  26   object.
  27
  28 \anchor advanced_mesh_infos_anchor
  29 <h2>Base Information</h2>
  30
  31 The <b>Base Info</b> tab page of the dialog box provides general
  32 information on the selected object - mesh, sub-mesh or mesh group:
  33 name, type, total number of nodes and elements separately for each
  34 type: 0D elements, edges, faces, volumes, balls.
  35
  36 <center>\image html advanced_mesh_infos.png
  37 <em>"Base Info" page</em></center>
  38
  39 \anchor mesh_element_info_anchor
  40 <h2>Mesh Element Information</h2>
  41
  42 The <b>Element Info</b> tab page of the dialog box gives detailed
  43 information about the selected mesh node(s) or element(s), namely:
  44
  45 - For a node:
  46   - Node ID;
  47   - Coordinates (X, Y, Z);
  48   - Connectivity information (connected elements); double click in
  49     this line reveals information about these elements;
  50   - Position on a shape (for meshes built on a geometry);
  51   - Groups information (names of groups the node belongs to).
  52
  53 <center>\image html eleminfo1.png
  54 <em>"Element Info" page, node information</em></center>
  55 <br>
  56
  57 - For an element:
  58   - Element ID;
  59   - Type (triangle, quadrangle, etc.);
  60   - Gravity center (X, Y, Z coordinates);
  61   - Connectivity information (connected nodes); double click in
  62     a line of a node reveals the information about this node;
  63   - Quality controls (area, aspect ratio, volume, etc.);
  64   - Position on a shape (for meshes built on a geometry);
  65   - Groups information (names of groups the element belongs to).
  66
  67 <center>\image html eleminfo2.png
  68 <em>"Element Info" page, element information</em></center>
  69
  70 The user can either input the ID of a node or element he wants to
  71 analyze directly in the dialog box or select the node(s) or element(s) in
  72 the 3D viewer.
  73
  74 \note The information about the groups, to which the node or element belongs,
  75  can be shown in a short or in a detailed form. By default, for performance
  76 reasons, this information is shown in a short form (group names
  77 only). The detailed information on groups can be switched on via the user
  78 preferences, see \ref mesh_preferences_page.
  79
  80 \anchor mesh_addition_info_anchor
  81 <h2>Additional Information</h2>
  82
  83 The <b>Additional Info</b> tab page of the dialog box provides an
  84 additional information on the selected object: mesh, sub-mesh or
  85 group.
  86
  87 For a mesh object, the following information is shown:
  88 - Name
  89 - Type: based on geomerty, imported, standalone
  90 - Shape (if mesh is based on geometry)
  91 - File (if mesh is imported from the file)
  92 - Groups
  93 - Sub-meshes
  94
  95 <center>\image html addinfo_mesh.png
  96 <em>"Additional Info" page, mesh information</em></center>
  97 <br>
  98
  99 For a sub-mesh object, the following information is shown:
 100 - Name
 101 - Parent mesh
 102 - Shape
 103
 104 <center>\image html addinfo_submesh.png
 105 <em>"Additional Info" page, sub-mesh information</em></center>
 106 <br>
 107
 108 For a group object, the following information is shown:
 109 - Name
 110 - Parent mesh
 111 - Type: standalone, group on geometry, group on filter
 112 - Entity type: node, edge, face, volume
 113 - Size
 114 - Color
 115 - Number of underlying nodes (for non-nodal groups)
 116
 117 <center>\image html addinfo_group.png
 118 <em>"Additional Info" page, group information</em></center>
 119 <br>
 120
 121 \note For the performance reasons, the number of underlying nodes is
 122 computed only by demand. For this, the user should press the "Compute"
 123 button (see picture). Also, the number of underlying nodes is
 124 automatically calculated if the size of the group does not exceed
 125 the "Automatic nodes compute limit" set via the  "Mesh information"
 126 preferences (zero value means no limit).
 127
 128 \anchor mesh_quality_info_anchor
 129 <h2>Quality Information</h2>
 130
 131 The <b>Quality Info</b> tab provides overall information about mesh quality controls  on the selected object - mesh, sub-mesh or mesh group:
 132 - Name;
 133 - Nodes information:
 134   - Number of free nodes;
 135   - Maximal number of elements connected to a node;
 136   - Number of double nodes;
 137 - Edges information:
 138   - Number of double edges;
 139 - Faces information:
 140   - Number of double faces;
 141   - Number of over-constrained faces;
 142   - Aspect Ratio histogram;
 143 - Volume information:
 144   - Number of double volumes;
 145   - Number of over-constrained volumes;
 146   - Aspect Ratio 3D histogram.
 147
 148 <center>\image html ctrlinfo.png
 149 <em>"Quality Info" page</em></center>
 150
 151 \note It is possible to set "Double nodes tolerance" in the dialog for a local change
 152       or via the "Quality controls" in Mesh preferences.
 153
 154 \note For performance reasons, all quality control values for big meshes are
 155 computed only by demand. For this, press the "compute"
 156 button. Also, values are automatically computed if the number of
 157 nodes / elements does not exceed the "Automatic controls compute limit" set
 158 via the "Mesh information" preferences (zero value means that there is no limit).
 159
 160 \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).
 161
 162 The button \b "Dump" allows printing the information displayed in the
 163 dialog box to a .txt file.
 164
 165 See the \ref tui_viewing_mesh_infos "TUI Example".
 166
 167 */
 168