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