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