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