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