doc/salome/gui/SMESH/input/about_filters.doc

   1 /*!
   2
   3 \page filters_page About filters
   4
   5 \b Filters allow picking only the mesh elements satisfying to a
   6 specific condition or a set of conditions. Filters can be used to create
   7 or edit mesh groups, remove elements from the mesh, control
   8 mesh quality by different parameters, etc.
   9
  10 Several \ref filtering_criteria "filtering criteria" can be combined
  11 together by using logical operators \a AND and \a OR. In addition, a
  12 filter criterion can be reverted using logical operator \a NOT.
  13
  14 Some filtering criteria use the functionality of \ref quality_page
  15 "mesh quality controls" to filter mesh nodes / elements by specific
  16 characteristic (Area, Length, etc).
  17
  18 The functinality of mesh filters is available in both GUI and TUI
  19 modes:
  20
  21 - In GUI, filters are available in some dialog boxes via "Set Filters"
  22 button, clicking on which opens the \ref filtering_elements "dialog box"
  23 allowing to specify the list of filter criteria to be applied to the
  24 current selection. See \subpage selection_filter_library_page page to
  25 learn more about selection filters and their usage in GUI.
  26
  27 - In Python scripts, filters can be used to choose only some mesh
  28   entities (nodes or elements) for the operations, which require the
  29   list of entities as input parameter (create/modify group, remove
  30   nodes/elements, etc) and for the operations, which accept objects
  31   (groups, sub-meshes) as input parameter. The page \ref
  32   tui_filters_page provides examples of the filters usage in Python
  33   scripts.
  34
  35 */