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
  13 load an 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
  19 \anchor filtering_elements
  20
  21 When we use filters during a group creation or another operation (by
  22 clicking <b>Set Filter</b> button in the corresponding dialog), the
  23 menu for setting filters looks as shown below.
  24
  25 The \b Add button creates a new criterion at the end of the list of
  26 criteria. The \b Insert button creates a new criterion before the
  27 selected criterion. The \b Remove button deletes the selected
  28 criterion. The \b Clear button deletes all criteria.
  29 \n Each <b>Entity type</b> has its specific list of criteria, however all
  30 filters have common syntax. For each criterion you should specify the
  31 <b>Threshold Value</b> and for numerical criteria whether we search
  32 for the elements that should be \b More, \b Less or \b Equal to this
  33 \b Value. You can also reverse the sense of a criterion using \b Unary
  34 operator \a Not and you should specify logical relations between
  35 criteria using \b Binary operators \a Or and \a And.
  36 \n Some criteria have the additional parameter of \b Tolerance.<br>
  37 Switching on <b>Insert filter in viewer</b> checkbox limits
  38 selection of elements in the Viewer to the current filter.
  39 <br>
  40 In the \b Source field you choose if the filter will be applied to
  41 the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current
  42 Dialog</b>. If \b Mesh is chosen, the elements satisfying the filter
  43 will be selected in the 3D Viewer. If <b> Initial Selection</b> is
  44 chosen, the filter will be applied to the selected elements and the
  45 elements rejected by the filter will be deselected. If <b>Current
  46 Dialog</b> is chosen, the filter will be applied to the list of
  47 elements in the current dialog and the elements rejected
  48 by the filter will be removed from the list.
  49 <br>
  50 <b>Copy from...</b> button gives you a possibility to load an
  51 existing filter from <b>Selection filter library</b> and <b>Add
  52 to...</b> button gives you a possibility to save your current filter
  53 in the Library.
  54 <br>
  55 <b>Note:</b> If the button <b>Apply and Close</b> is disabled, there
  56 is no selected mesh in the Object Browser and the filter can not be
  57 created. You have to select the mesh and the button will be enabled.
  58
  59 \image html a-filteronfaces.png
  60
  61 Some criteria are applicable to all <b>Entity types</b>:
  62 <ul><li>
  63 <b>Belong to Geom</b> selects entities whose all nodes lie on the
  64 shape defined by <b>Threshold Value</b>. If the threshold shape is a
  65 sub-shape of the main shape of the mesh the algorithm works faster, if
  66 this is any other shape the algorithm works slower.
  67 </li><li>
  68 <b>Lying on Geom</b> selects entities whose at least one node
  69 lies on the shape defined by the <b>Threshold Value</b>.
  70 If the threshold shape is a sub-shape of the main shape of the mesh the
  71 algorithm works faster, if this is any other
  72 shape, the algorithm works slower.
  73 </li><li>
  74 <b>Belong to Mesh Group</b> selects entities included into the mesh group
  75 defined by <b>Threshold Value</b>.
  76 </li><li>
  77 <b>Range of IDs</b> allows selection of entities with the specified
  78 IDs.
  79 <b>Threshold Value</b> can be, for example: "1,2,3,50-60,63,67,70-78"
  80 </li><li>
  81 <b>Color of Group</b> allows selection of entities belonging to the Group with
  82 the color defined by the <b>Threshold Value</b>.
  83 </li><li>
  84 <b>Elements of a domain</b> allows selection of entities belonging to
  85 one domain of a mesh. The domain is mesh part not connected to
  86 other parts. <b>Threshold Value</b> locating any element of the domain can be either
  87 - node ID (that you can pick in the Viewer) or
  88 - geometrical vertex (that you can pick either in the Viewer or in the
  89   Object Browser) or
  90 - 3 coordinates of a point (that you can enter in TUI mode only).
  91
  92 </li>
  93 </ul>
  94
  95 Some criteria are applicable to all <b>Entity types</b> of dimension
  96 more than zero, i.e. to \b Edges, \b Faces and \b Volumes:
  97 <ul><li>
  98 <b>Linear</b> allows selection of Linear or Quadratic elements (if Unary is set to "Not")
  99 </li><li>
 100 <b>Geometry type</b> allows selection of elements by their geometric type
 101 defined by the <b>Threshold Value</b>. The list of available geometric
 102 types depends on the current entity type.
 103 </li><li>
 104 <b>Entity type</b> allows selection of elements by their type defined
 105 as combination of geometry type + number of nodes.
 106 </li>
 107 </ul>
 108
 109 The following criteria are applicable to all <b>Entity types</b>
 110 except for <b>Volumes</b>:
 111 <ul><li>
 112 <b>Belong to Plane</b> selects entities whose all nodes belong to a
 113 specified plane within a given <b>Tolerance</b>.
 114 </li><li>
 115 <b>Belong to Cylinder</b> selects entities whose all nodes belong to a
 116 specified cylinder within a given <b>Tolerance</b>.
 117 </li><li>
 118 <b>Belong to Surface</b> selects entities whose all nodes belong to a
 119 specified arbitrary surface within a given <b>Tolerance</b>.
 120 </li>
 121 </ul>
 122
 123 The following criteria allow selecting mesh <b>Nodes</b>:
 124 <ul><li>
 125 <b>Free nodes</b> selects nodes not belonging to any mesh element.
 126 </li><li>
 127 <b>Double nodes</b> selects a node coincident with other nodes
 128 (within a given <b>Tolerance</b>).
 129 See also \ref tui_double_nodes_control "Double Nodes quality control".
 130 </li>
 131 </ul>
 132
 133 The following criteria allow selecting mesh <b>Edges</b>:
 134 <ul><li>
 135 <b>Free Borders</b> selects free 1D mesh elements, i.e. edges belonging to
 136 one face only. See also a
 137 \ref free_borders_page "Free Borders quality control".
 138 </li><li>
 139 <b>Double edges</b> selects 1D mesh elements basing on the same set of nodes.
 140 See also \ref filter_double_elements "Double Elements quality control".
 141 </li><li>
 142 <b>Borders at Multi-Connections</b> selects edges belonging to several faces.
 143 The number of faces should be more, less or equal (within a given <b>Tolerance</b>)
 144 to the predefined <b>Threshold Value</b>. See also a
 145 \ref borders_at_multi_connection_page "Borders at Multi-Connection quality control".
 146 </li><li>
 147 <b>Length</b> selects edges with a value of length, which is more, less or equal
 148 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 149 See also a
 150 \ref length_page "Length quality control".
 151 </li>
 152 </ul>
 153
 154 The following criteria allow selecting mesh <b>Faces</b>:
 155 <ul><li>
 156 <b>Aspect ratio</b> selects 2D mesh elements with an aspect ratio (see also an
 157 \ref aspect_ratio_page "Aspect Ratio quality control"), which is more, less or equal
 158 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 159 </li><li>
 160 <b>Warping</b> selects quadrangles with warping angle (see also a
 161 \ref warping_page "Warping quality control"), which is more, less or equal
 162 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 163 </li><li>
 164 <b>Minimum angle</b> selects triangles and quadrangles with minimum angle (see also a
 165 \ref minimum_angle_page "Minimum angle 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>Taper</b> selects quadrangles cells with taper value (see also a
 169 \ref taper_page "Taper 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>Skew</b> selects triangles and quadrangles with skew value (see also a
 173 \ref skew_page "Skew quality control"), which is more, less or equal (within a given
 174 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 175 </li><li>
 176 <b>Area</b> selects triangles and quadrangles with a value of area (see also an
 177 \ref area_page "Area quality control"), which is more, less or equal (within a given
 178 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 179 </li><li>
 180 <b>Free edges</b> selects 2D mesh elements consisting of edges belonging to
 181 one element of mesh only. See also a
 182 \ref free_edges_page "Free Edges quality control".
 183 </li><li>
 184 <b>Free faces</b> selects 2D mesh elements, which belong to less than two volumes.
 185 </li><li>
 186 <b>Double faces</b> selects 2D mesh elements basing on the same set of nodes.
 187 See also \ref filter_double_elements "Double Elements quality control".
 188 </li><li>
 189 <b>Faces with bare border</b> selects 2D mesh elements having a free border without an edge on it.
 190 See also \ref bare_border_faces_page "Bare border faces quality control".
 191 </li><li>
 192 <b>Over-constrained faces</b> selects 2D mesh elements having only one border shared
 193 with other 2D elements.
 194 See also \ref over_constrained_faces_page "Over-constrained faces quality control".
 195 </li><li>
 196 <b>Borders at Multi-Connections 2D</b> selects cells consisting of edges belonging to
 197 several elements of mesh. The number of mesh elements should be more, less or equal
 198 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 199 See also a
 200 \ref borders_at_multi_connection_2d_page "Borders at Multi-Connection 2D quality control".
 201 </li><li>
 202 <b>Length 2D</b> selects triangles and quadrangles combining of the edges with a value of
 203 length, which is more, less or equal (within a given <b>Tolerance</b>) to the predefined
 204 <b>Threshold Value</b>. See also a
 205 \ref length_2d_page "Length 2D quality control".
 206 </li><li>
 207 <b>Coplanar faces</b> selects mesh faces neighboring the one selected
 208 by ID in <b>Threshold Value</b> field, if the angle between the
 209 normal to the neighboring face and the normal to the selected face is less then the
 210 angular tolerance (defined in degrees). Selection continues among all neighbor faces of already
 211 selected ones.<br>
 212 </li><li>
 213 <b>Element Diameter 2D</b> selects triangles and quadrangles composed of the edges and
 214 diagonals with a value of length, which is more, less or equal
 215 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>. See also a
 216 \ref max_element_length_2d_page "Element Diameter 2D quality control".
 217 </li>
 218 </ul>
 219
 220 The following criteria allow selecting  mesh <b>Volumes</b>:
 221 <ul><li>
 222 <b>Aspect ratio 3D</b> selects 3D mesh elements with an aspect ratio (see also an
 223 \ref aspect_ratio_3d_page "Aspect Ratio 3D quality control"), which is more, less or equal
 224 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 225 </li><li>
 226 <b>Volume</b> selects 3D mesh elements with a value of volume (see also a
 227 \ref volume_page "Volume quality control"), which is more, less or equal (within a given
 228 <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
 229 </li><li>
 230 <b>Element Diameter 3D</b> selects 3D mesh elements composed of the edges and
 231 diagonals with a value of length, which is more, less or equal
 232 (within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>. See also a
 233 \ref max_element_length_3d_page "Element Diameter 3D quality control".
 234 </li><li>
 235 <b>Double volumes</b> selects 3D mesh elements basing on the same set of nodes.
 236 See also \ref filter_double_elements "Double Elements quality control".
 237 </li><li>
 238 <b>Bad oriented volume</b> selects mesh volumes, which are incorrectly oriented from
 239 the point of view of MED convention.
 240 </li><li>
 241 <b>Over-constrained volumes</b> selects mesh volumes having only one facet shared
 242 with other volumes.
 243 See also \ref over_constrained_volumes_page "Over-constrained volumes quality control".
 244 </li><li>
 245 <b>Volumes with bare border</b> selects 3D mesh elements having a free border without a face on it.
 246 See also \ref bare_border_volumes_page "Bare border volumes quality control".
 247 </li>
 248 </ul>
 249
 250
 251 */