Salome HOME
23189: EDF 11603 - Dyssymetry in meshing
[modules/smesh.git] / doc / salome / gui / SMESH / input / selection_filter_library.doc
index 613febb9cc16fd27932985540756f76c4262a2ba..c73c1e42e67995a5f856fe3d7b6aa508de2b1e28 100644 (file)
 
 \page selection_filter_library_page Selection filter library
 
-\n Selection filter library is a powerful tool enabling to create
-filters to be used on meshes. You can access to it from the Main Menu
-via <b>Tools / Selection filter library</b>.
+\n Selection filter library allows creating and storing in files
+filters that can be later loaded and used for operations on meshes. You can
+access to it from the Main Menu via <b>Tools / Selection filter library</b>.
+It is also possible to save any filter by invoking the filter library
+from \a Filter dialog launched from any mesh operation.
 
 \image html selectionfilterlibrary.png
 
 <b>Library file name</b> shows the path and the file name where your
-filters will be stored. By clicking the <em>Browse</em> button you can load an
-existing filter library.
+filters will be stored. By clicking the <em>Browse</em> button you can
+load an existing filter library.
 \n <b>Names of filters</b> lists the filters created or uploaded for
 the current study. You can \b Add or \b Delete filters.
 \n In <b>Filter name</b> box you can specify the name for your
 filter. By default it is prefixed with the corresponding entity type.
-\n Each filter can be applicable to \b Nodes, \b Edges, \b Faces or \b
-Volumes. You can combine many criteria in one filter, but they all
-must be of the same <b>Entity type</b>.
-\n The \b Add button creates a new criterion at the end of the list of
+
+\anchor filtering_elements
+
+When we use filters during group creation or another operation (by 
+clicking <b>Set Filter</b> button in the corresponding dialog), the
+dialog for setting filters looks as shown below.
+
+\image html a-filteronfaces.png
+
+The \b Add button creates a new criterion at the end of the list of
 criteria. The \b Insert button creates a new criterion before the
 selected criterion. The \b Remove button deletes the selected
-criterion. The \b Clear button deletes all criteria.
+criterion. The \b Clear button deletes all criteria.\n
+If there is a choice of <b>Entity type</b> in the dialog, only
+criteria of currently selected type are used to create or change a
+filter, and criteria of hidden types (if were specified) are ignored.
 \n Each <b>Entity type</b> has its specific list of criteria, however all
-filters have common syntax. For each criterion you should specify the
-<b>Threshold Value</b> and whether we search for the elements that should be
-\b More, \b Less or \b Equal to this \b Value. You should also specify if the
-criterion is \b Unary or \b Binary.   
-\n Some criteria should have the additional parameter of \b Tolerance.
-
-When we create a <b>Standalone Group</b> using filters (for this click
-<b>Set Filters</b> button in the <b>Create Group</b> menu), the menu
-for setting filters looks a bit differently. Toggling <b>Insert filter
-in viewer</b> checkbox enables to preview the group selected with your
-current filter in the viewer.
-\n In the \b Source field you choose if the filter will be applied to
-the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current Group</b>. 
-\n <b>Copy from...</b> button gives you a possibility to load an
+filters have common syntax. The <b>Threshold Value</b> should be specified 
+for most criteria. For numerical criteria it is necessary to indicate if 
+the found elements should be \b More, \b Less or \b Equal to this
+\b Value. You can also reverse the sense of a criterion using \b Unary
+operator \a Not and you should specify logical relations between
+criteria using \b Binary operators \a Or and \a And.
+\n Some criteria have the additional parameter of \b Tolerance.<br> 
+Switching on <b>Insert filter in viewer</b> check-box limits
+selection of elements in the Viewer to the current filter.
+<br>
+In the \b Source field you choose if the filter will be applied to
+the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current
+Dialog</b>. If \b Mesh is chosen, the elements satisfying the filter
+will be selected in the 3D Viewer. If <b> Initial Selection</b> is
+chosen, the filter will be applied to the selected elements and the
+elements rejected by the filter will be deselected. If <b>Current
+Dialog</b> is chosen, the filter will be applied to the list of
+elements in the current dialog and the elements rejected
+by the filter will be removed from the list.
+<br>
+<b>Copy from...</b> button gives you a possibility to load an
 existing filter from <b>Selection filter library</b> and <b>Add
 to...</b> button gives you a possibility to save your current filter
 in the Library.
+<br>
+<b>Note:</b> If the button <b>Apply and Close</b> is disabled, there
+is no selected mesh in the Object Browser and the filter can not be
+created. You have to select the mesh and the button will be enabled.
+
+Some criteria are applicable to all <b>Entity types</b>:
+<ul><li>
+<b>Belong to Geom</b> selects entities whose all nodes lie on the
+shape defined by <b>Threshold Value</b>. If the threshold shape is a
+sub-shape of the main shape of the mesh the algorithm works faster, if
+this is any other shape the algorithm works slower.
+</li><li>
+<b>Lying on Geom</b> selects entities whose at least one node
+lies on the shape defined by the <b>Threshold Value</b>.
+If the threshold shape is a sub-shape of the main shape of the mesh the
+algorithm works faster, if this is any other
+shape, the algorithm works slower.
+</li><li>
+<b>Belong to Mesh Group</b> selects entities included into the mesh group
+defined by the <b>Threshold Value</b>.
+</li><li>
+<b>Range of IDs</b> allows selection of entities with the specified
+IDs. 
+<b>Threshold Value</b> can be, for example: "1,2,3,50-60,63,67,70-78"
+</li><li>
+<b>Color of Group</b> allows selection of entities belonging to the Group with
+the color defined by the <b>Threshold Value</b>.
+</li><li>
+<b>Elements of a domain</b> allows selection of entities belonging to
+one domain of a mesh. The domain is mesh part not connected to
+other parts. <b>Threshold Value</b> locating any element of the domain can be either
+- node ID (that you can pick in the Viewer) or
+- geometrical vertex (that you can pick either in the Viewer or in the
+  Object Browser) or
+- 3 coordinates of a point (that you can enter in TUI mode only).
+
+</li>
+</ul>
+
+Some criteria are applicable to all <b>Entity types</b> of dimension
+more than zero, i.e. to \b Edges, \b Faces and \b Volumes:
+<ul><li>
+<b>Linear</b> allows selection of Linear or Quadratic elements (if Unary is set to "Not")
+</li><li>
+<b>Geometry type</b> allows selection of elements by their geometric type
+defined by the <b>Threshold Value</b>. The list of available geometric
+types depends on the current entity type.
+</li><li>
+<b>Entity type</b> allows selection of elements by their type defined
+as a combination of geometry type and the number of nodes.
+</li>
+</ul>
+
+The following criteria are applicable to all <b>Entity types</b>
+except for <b>Volumes</b>:
+<ul><li>
+<b>Belong to Plane</b> selects entities whose all nodes belong to a
+specified plane within a given <b>Tolerance</b>.
+</li><li>
+<b>Belong to Cylinder</b> selects entities whose all nodes belong to a
+specified cylinder within a given <b>Tolerance</b>.
+</li><li>
+<b>Belong to Surface</b> selects entities whose all nodes belong to a
+specified arbitrary surface within a given <b>Tolerance</b>.
+</li>
+</ul>
+
+The following criteria allow selecting mesh <b>Nodes</b>:
+<ul><li>
+<b>Free nodes</b> selects nodes not belonging to any mesh element.
+</li><li>
+<b>Double nodes</b> selects a node coincident with other nodes 
+(within a given <b>Tolerance</b>). 
+See also \ref tui_double_nodes_control "Double Nodes quality control".
+</li>
+</ul>
+
+The following criteria allow selecting mesh <b>Edges</b>:
+<ul><li>
+<b>Free Borders</b> selects free 1D mesh elements, i.e. edges belonging to 
+one element (face or volume) only. See also a
+\ref free_borders_page "Free Borders quality control".
+</li><li>
+<b>Double edges</b> selects 1D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+</li><li>
+<b>Borders at Multi-Connections</b> selects edges belonging to several faces.
+The number of faces should be more, less or equal (within a given <b>Tolerance</b>)
+to the predefined <b>Threshold Value</b>. See also a
+\ref borders_at_multi_connection_page "Borders at Multi-Connection quality control".
+</li><li>
+<b>Length</b> selects edges with a value of length, which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+See also a
+\ref length_page "Length quality control".
+</li>
+</ul>
+
+The following criteria allow selecting mesh <b>Faces</b>:
+<ul><li>
+<b>Aspect ratio</b> selects 2D mesh elements with an aspect ratio (see also an
+\ref aspect_ratio_page "Aspect Ratio quality control"), which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Warping</b> selects quadrangles with warping angle (see also a
+\ref warping_page "Warping quality control"), which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Minimum angle</b> selects triangles and quadrangles with minimum angle (see also a
+\ref minimum_angle_page "Minimum angle quality control"), which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Taper</b> selects quadrangles cells with taper value (see also a
+\ref taper_page "Taper quality control"), which is more, less or equal (within a given
+<b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Skew</b> selects triangles and quadrangles with skew value (see also a
+\ref skew_page "Skew quality control"), which is more, less or equal (within a given
+<b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Area</b> selects triangles and quadrangles with a value of area (see also an
+\ref area_page "Area quality control"), which is more, less or equal (within a given
+<b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Free edges</b> selects 2D mesh elements having at least one of its
+edges not shared with other faces. See also a
+\ref free_edges_page "Free Edges quality control".
+</li><li>
+<b>Free faces</b> selects 2D mesh elements, which belong to less than two volumes.
+</li><li>
+<b>Double faces</b> selects 2D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+</li><li>
+<b>Faces with bare border</b> selects 2D mesh elements having a free border without an edge on it.
+See also \ref bare_border_faces_page "Bare border faces quality control".
+</li><li>
+<b>Over-constrained faces</b> selects 2D mesh elements having only one border shared 
+with other 2D elements.
+See also \ref over_constrained_faces_page "Over-constrained faces quality control".
+</li><li>
+<b>Borders at Multi-Connections 2D</b> selects cells consisting of edges belonging to
+several elements of mesh. The number of mesh elements should be more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+See also a
+\ref borders_at_multi_connection_2d_page "Borders at Multi-Connection 2D quality control".
+</li><li>
+<b>Length 2D</b> selects triangles and quadrangles combining of the edges with a value of
+length, which is more, less or equal (within a given <b>Tolerance</b>) to the predefined
+<b>Threshold Value</b>. See also a
+\ref length_2d_page "Length 2D quality control".
+</li><li>
+<b>Coplanar faces</b> selects mesh faces neighboring the one selected
+by ID in <b>Threshold Value</b> field, if the angle between the
+normal to the neighboring face and the normal to the selected face is less then the
+angular tolerance (defined in degrees). Selection continues among all neighbor faces of already 
+selected ones.<br>
+</li><li>
+<b>Element Diameter 2D</b> selects triangles and quadrangles composed of the edges and
+diagonals with a value of length, which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>. See also a
+\ref max_element_length_2d_page "Element Diameter 2D quality control".
+</li>
+</ul>
+
+The following criteria allow selecting  mesh <b>Volumes</b>:
+<ul><li>
+<b>Aspect ratio 3D</b> selects 3D mesh elements with an aspect ratio (see also an
+\ref aspect_ratio_3d_page "Aspect Ratio 3D quality control"), which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Volume</b> selects 3D mesh elements with a value of volume (see also a
+\ref volume_page "Volume quality control"), which is more, less or equal (within a given
+<b>Tolerance</b>) to the predefined <b>Threshold Value</b>.
+</li><li>
+<b>Element Diameter 3D</b> selects 3D mesh elements composed of the edges and
+diagonals with a value of length, which is more, less or equal
+(within a given <b>Tolerance</b>) to the predefined <b>Threshold Value</b>. See also a
+\ref max_element_length_3d_page "Element Diameter 3D quality control".
+</li><li>
+<b>Double volumes</b> selects 3D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+</li><li>
+<b>Bad oriented volume</b> selects mesh volumes, which are incorrectly oriented from
+the point of view of MED convention.
+</li><li>
+<b>Over-constrained volumes</b> selects mesh volumes having only one facet shared 
+with other volumes.
+See also \ref over_constrained_volumes_page "Over-constrained volumes quality control".
+</li><li>
+<b>Volumes with bare border</b> selects 3D mesh elements having a free border without a face on it.
+See also \ref bare_border_volumes_page "Bare border volumes quality control".
+</li>
+</ul>
 
-\image html a-filteronedges.png
 
-*/
\ No newline at end of file
+*/