doc/salome/gui/SMESH/input/selection_filter_library.doc

   1 /*!
   2
   3 \page selection_filter_library_page Selection filter library
   4
   5 \n Selection filter library is a powerful tool enabling to create
   6 filters to be used on meshes. You can access to it from the Main Menu
   7 via <b>Tools / Selection filter library</b>.
   8
   9 \image html selectionfilterlibrary.png
  10
  11 <b>Library file name</b> shows the path and the file name where your
  12 filters will be stored. By clicking the <em>Browse</em> button you can load an
  13 existing filter library.
  14 \n <b>Names of filters</b> lists the filters created or uploaded for
  15 the current study. You can \b Add or \b Delete filters.
  16 \n In <b>Filter name</b> box you can specify the name for your
  17 filter. By default it is prefixed with the corresponding entity type.
  18 \n Each filter can be applicable to \b Nodes, \b Edges, \b Faces or \b
  19 Volumes. You can combine many criteria in one filter, but they all
  20 must be of the same <b>Entity type</b>.
  21 \n The \b Add button creates a new criterion at the end of the list of
  22 criteria. The \b Insert button creates a new criterion before the
  23 selected criterion. The \b Remove button deletes the selected
  24 criterion. The \b Clear button deletes all criteria.
  25 \n Each <b>Entity type</b> has its specific list of criteria, however all
  26 filters have common syntax. For each criterion you should specify the
  27 <b>Threshold Value</b> and whether we search for the elements that should be
  28 \b More, \b Less or \b Equal to this \b Value. You can also reverse the
  29 sense of a criterion using \b Unary operator Not and you should
  30 specify logical relations between criteria using \b Binary operators
  31 Or and And.
  32 \n Some criteria should have the additional parameter of \b Tolerance.
  33
  34 When we create a <b>Standalone Group</b> using filters (for this click
  35 <b>Set Filters</b> button in the <b>Create Group</b> menu), the menu
  36 for setting filters looks a bit differently. Toggling <b>Insert filter
  37 in viewer</b> checkbox enables to preview the group selected with your
  38 current filter in the viewer.
  39 \n In the \b Source field you choose if the filter will be applied to
  40 the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current Group</b>.
  41 \n <b>Copy from...</b> button gives you a possibility to load an
  42 existing filter from <b>Selection filter library</b> and <b>Add
  43 to...</b> button gives you a possibility to save your current filter
  44 in the Library.
  45 \n <b>Note:</b> If the button <b>Apply and Close</b> is disabled, there
  46 is no selected mesh in the Object Browser and the filter can not be
  47 created. You have to select the mesh and the button will be enabled.
  48
  49 \image html a-filteronfaces.png
  50
  51 Some criteria are applicable to all <b>Entity types</b>:
  52 <ul><li>
  53 <b>Belong to Geom</b> selects entities whose all nodes
  54 lie on the shape defined by <b>Threshold Value</b>.
  55 If the threshold shape is a sub-shape of the main shape of the mesh
  56 the algorithm works faster, if this is any other
  57 shape the algorithm works slower.
  58 </li><li>
  59 <b>Lying on Geom</b> selects entities whose at least one node
  60 lies on the shape defined by the <b>Threshold Value</b>.
  61 If the hreshold shape is a sub-shape of the main shape of the mesh the
  62 algorithm works faster, if this is any other
  63 shape, the algorithm works slower.
  64 </li><li>
  65 <b>Range of IDs</b> allows selection of entities with the specified
  66 IDs.
  67 <b>Threshold Value</b> can be, for example: "1,2,3,50-60,63,67,70-78"
  68 </li><li>
  69 <b>Color of Group</b> allows selection of entities belonging to the Group with
  70 the color defined by the <b>Threshold Value</b>.
  71 </li>
  72 </ul>
  73
  74 Some criteria are applicable to all <b>Entity types</b>, except for
  75 <b>Nodes</b>
  76 <ul><li>
  77 <b>Linear</b> allows selection of Linear or Quadratic elements (if Unary is set to "Not")
  78 </li><li>
  79 <b>Geometry type</b> allows selection of elements by their geometric type
  80 defined by the <b>Threshold Value</b>. The list of available geometric
  81 types depends on the element entity type defined by the <b>Threshold Value</b>.
  82 </li>
  83 </ul>
  84
  85 The following criteria are applicable to all <b>Entity types</b>
  86 except for <b>Volumes</b>:
  87 <ul><li>
  88 <b>Belong to Plane</b> selects entities whose all nodes belong to a
  89 specified plane within a given <b>Tolerance</b>.
  90 </li><li>
  91 <b>Belong to Cylinder</b> selects entities whose all nodes belong to a
  92 specified cylinder within a given <b>Tolerance</b>.
  93 </li><li>
  94 <b>Belong to Surface</b> selects entities whose all nodes belong to a
  95 specified arbitrary surface within a given <b>Tolerance</b>.
  96 </li>
  97 </ul>
  98
  99 Additional criteria to select mesh <b>Edges</b> are the following:
 100 <ul><li>
 101 <b>Free Borders</b> selects free 1D mesh elements, i.e. edges belonging to
 102 one face only. See also a
 103 \ref free_borders_page "Free Borders quality control".
 104 </li><li>
 105 <b>Borders at Multi-Connections</b> selects edges belonging to several faces.
 106 The number of faces should be more, less or equal (within a given <b>Tolerance</b>)
 107 to the predefined <b>Threshold Value</b>. See also a
 108 \ref borders_at_multi_connection_page "Borders at Multi-Connection quality control".
 109 </li><li>
 110 <b>Length</b> selects edges with a value of length, which is more, less or equal
 111 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 112 See also a
 113 \ref length_page "Length quality control".
 114 </li>
 115 </ul>
 116
 117 Additional criteria to select mesh <b>Faces</b> are the following:
 118 <ul><li>
 119 <b>Aspect ratio</b> selects 2D mesh elements with an aspect ratio (see also an
 120 \ref aspect_ratio_page "Aspect Ratio quality control"), which is more, less or equal
 121 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 122 </li><li>
 123 <b>Warping</b> selects quadrangles with warping angle (see also a
 124 \ref warping_page "Warping quality control"), which is more, less or equal
 125 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 126 </li><li>
 127 <b>Minimum angle</b> selects triangles and quadrangles with minimum angle (see also a
 128 \ref minimum_angle_page "Minimum angle quality control"), which is more, less or equal
 129 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 130 </li><li>
 131 <b>Taper</b> selects quadrangles cells with taper value (see also a
 132 \ref taper_page "Taper quality control"), which is more, less or equal (within a given
 133 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 134 </li><li>
 135 <b>Skew</b> selects triangles and quadrangles with skew value (see also a
 136 \ref skew_page "Skew quality control"), which is more, less or equal (within a given
 137 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 138 </li><li>
 139 <b>Area</b> selects triangles and quadrangles with a value of area (see also an
 140 \ref area_page "Area quality control"), which is more, less or equal (within a given
 141 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 142 </li><li>
 143 <b>Free edges</b> selects 2D mesh elements consisting of edges belonging to
 144 one element of mesh only. See also a
 145 \ref free_edges_page "Free Edges quality control".
 146 </li><li>
 147 <b>Free faces</b> selects 3D mesh elements wich belong to less than two volumes.
 148 </li><li>
 149 <b>Borders at Multi-Connections 2D</b> selects cells consisting of edges belonging to
 150 several elements of mesh. The number of mesh elements should be more, less or equal
 151 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 152 See also a
 153 \ref borders_at_multi_connection_2d_page "Borders at Multi-Connection 2D quality control".
 154 </li><li>
 155 <b>Length 2D</b> selects triangles and quadrangles combining of the edges with a value of
 156 length, which is more, less or equal (within a given <b>Tolerance</b>) to the predefined
 157 <b>Threshold Value</b>. See also a
 158 \ref length_2d_page "Length 2D quality control".
 159 </li>
 160 </ul>
 161
 162 Additional criteria to select mesh <b>Volumes</b> are the following:
 163 <ul><li>
 164 <b>Aspect ratio 3D</b> selects 3D mesh elements with an aspect ratio (see also an
 165 \ref aspect_ratio_3d_page "Aspect Ratio 3D quality control"), which is more, less or equal
 166 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 167 </li><li>
 168 <b>Volume</b> selects 3D mesh elements with a value of volume (see also a
 169 \ref volume_page "Volume quality control"), which is more, less or equal (within a given
 170 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 171 </li><li>
 172 <b>Bad oriented volume</b> selects mesh volumes, which are incorrectly oriented from
 173 the point of view of MED convention.
 174 </li>
 175 </ul>
 176
 177
 178 */