X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fselection_filter_library.doc;h=c06fb6ec5d09a7cf07581b11849f231231b93820;hb=d9b70538644d78d4defa84cb64d7b28aa526e000;hp=613febb9cc16fd27932985540756f76c4262a2ba;hpb=79b1ac2b6df9117f16f11d444b1f165d477a1813;p=modules%2Fsmesh.git
diff --git a/doc/salome/gui/SMESH/input/selection_filter_library.doc b/doc/salome/gui/SMESH/input/selection_filter_library.doc
index 613febb9c..c06fb6ec5 100644
--- a/doc/salome/gui/SMESH/input/selection_filter_library.doc
+++ b/doc/salome/gui/SMESH/input/selection_filter_library.doc
@@ -9,13 +9,20 @@ via Tools / Selection filter library.
\image html selectionfilterlibrary.png
Library file name shows the path and the file name where your
-filters will be stored. By clicking the Browse button you can load an
-existing filter library.
+filters will be stored. By clicking the Browse button you can
+load an existing filter library.
\n Names of filters lists the filters created or uploaded for
the current study. You can \b Add or \b Delete filters.
\n In Filter name 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
+
+\anchor filtering_elements
+
+When we use filters during a group creation or another operation (by
+clicking Set Filters button in the corresponding dialog), the
+menu for setting filters looks a bit differently (see the image below).
+
+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 Entity type.
\n The \b Add button creates a new criterion at the end of the list of
@@ -25,22 +32,219 @@ criterion. The \b Clear button deletes all criteria.
\n Each Entity type has its specific list of criteria, however all
filters have common syntax. For each criterion you should specify the
Threshold Value 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.
+\b More, \b Less or \b Equal to this \b Value. You can also reverse the
+sense of a criterion using \b Unary operator Not and you should
+specify logical relations between criteria using \b Binary operators
+Or and And.
\n Some criteria should have the additional parameter of \b Tolerance.
-
-When we create a Standalone Group using filters (for this click
-Set Filters button in the Create Group menu), the menu
-for setting filters looks a bit differently. Toggling Insert filter
-in viewer 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 Initial Selection or the Current Group.
-\n Copy from... button gives you a possibility to load an
+
+Switching on Insert filter in viewer checkbox limits
+selection of elements in the Viewer to the current filter.
+
+In the \b Source field you choose if the filter will be applied to
+the whole \b Mesh, the Initial Selection or the Current
+Group. If \b Mesh is chosen, the elements satisfying the filter
+will be selected in the 3D Viewer. If Initial Selection is
+chosen, the filter will be applied to the selected elements and the
+elements rejected by the filter will be deselected. If Current
+Group 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.
+
+Copy from... button gives you a possibility to load an
existing filter from Selection filter library and Add
to... button gives you a possibility to save your current filter
in the Library.
+
+Note: If the button Apply and Close 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.
+
+\image html a-filteronfaces.png
+
+Some criteria are applicable to all Entity types:
+
-
+Belong to Geom selects entities whose all nodes
+lie on the shape defined by Threshold Value.
+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.
+
-
+Lying on Geom selects entities whose at least one node
+lies on the shape defined by the Threshold Value.
+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.
+
-
+Range of IDs allows selection of entities with the specified
+IDs.
+Threshold Value can be, for example: "1,2,3,50-60,63,67,70-78"
+
-
+Color of Group allows selection of entities belonging to the Group with
+the color defined by the Threshold Value.
+
-
+Elements of a domain allows selection of entities belonging to
+one domain of a mesh. The domain is mesh part not connected to
+other parts. Threshold Value 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).
+
+
+
+
+Some criteria are applicable to all Entity types, except for
+Nodes
+-
+Linear allows selection of Linear or Quadratic elements (if Unary is set to "Not")
+
-
+Geometry type allows selection of elements by their geometric type
+defined by the Threshold Value. The list of available geometric
+types depends on the element entity type defined by the Threshold Value.
+
+
+
+The following criteria are applicable to all Entity types
+except for Volumes:
+-
+Belong to Plane selects entities whose all nodes belong to a
+specified plane within a given Tolerance.
+
-
+Belong to Cylinder selects entities whose all nodes belong to a
+specified cylinder within a given Tolerance.
+
-
+Belong to Surface selects entities whose all nodes belong to a
+specified arbitrary surface within a given Tolerance.
+
+
+
+The following criteria allow selecting mesh Nodes:
+-
+Free nodes selects nodes not belonging to any mesh element.
+
-
+Double nodes selects a node coincident with other nodes
+(within a given Tolerance).
+See also \ref tui_double_nodes_control "Double Nodes quality control".
+
+
+
+The following criteria allow selecting mesh Edges:
+-
+Free Borders selects free 1D mesh elements, i.e. edges belonging to
+one face only. See also a
+\ref free_borders_page "Free Borders quality control".
+
-
+Double edges selects 1D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+
-
+Borders at Multi-Connections selects edges belonging to several faces.
+The number of faces should be more, less or equal (within a given Tolerance)
+to the predefined Threshold Value. See also a
+\ref borders_at_multi_connection_page "Borders at Multi-Connection quality control".
+
-
+Length selects edges with a value of length, which is more, less or equal
+(within a given Tolerance) to the predefined Threshold Value.
+See also a
+\ref length_page "Length quality control".
+
+
+
+The following criteria allow selecting mesh Faces:
+-
+Aspect ratio 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 Tolerance) to the predefined Threshold Value.
+
-
+Warping selects quadrangles with warping angle (see also a
+\ref warping_page "Warping quality control"), which is more, less or equal
+(within a given Tolerance) to the predefined Threshold Value.
+
-
+Minimum angle 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 Tolerance) to the predefined Threshold Value.
+
-
+Taper selects quadrangles cells with taper value (see also a
+\ref taper_page "Taper quality control"), which is more, less or equal (within a given
+Tolerance) to the predefined Threshold Value.
+
-
+Skew 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
+Tolerance) to the predefined Threshold Value.
+
-
+Area 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
+Tolerance) to the predefined Threshold Value.
+
-
+Free edges selects 2D mesh elements consisting of edges belonging to
+one element of mesh only. See also a
+\ref free_edges_page "Free Edges quality control".
+
-
+Free faces selects 2D mesh elements, which belong to less than two volumes.
+
-
+Double faces selects 2D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+
-
+Faces with bare border 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".
+
-
+Over-constrained faces 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".
+
-
+Borders at Multi-Connections 2D 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 Tolerance) to the predefined Threshold Value.
+See also a
+\ref borders_at_multi_connection_2d_page "Borders at Multi-Connection 2D quality control".
+
-
+Length 2D selects triangles and quadrangles combining of the edges with a value of
+length, which is more, less or equal (within a given Tolerance) to the predefined
+Threshold Value. See also a
+\ref length_2d_page "Length 2D quality control".
+
-
+Coplanar faces selects mesh faces neighboring the one selected
+by ID in Threshold Value 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.
+ -
+Element Diameter 2D selects triangles and quadrangles composed of the edges and
+diagonals with a value of length, which is more, less or equal
+(within a given Tolerance) to the predefined Threshold Value. See also a
+\ref max_element_length_2d_page "Element Diameter 2D quality control".
+
+
+
+The following criteria allow selecting mesh Volumes:
+-
+Aspect ratio 3D 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 Tolerance) to the predefined Threshold Value.
+
-
+Volume 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
+Tolerance) to the predefined Threshold Value.
+
-
+Element Diameter 3D selects 3D mesh elements composed of the edges and
+diagonals with a value of length, which is more, less or equal
+(within a given Tolerance) to the predefined Threshold Value. See also a
+\ref max_element_length_3d_page "Element Diameter 3D quality control".
+
-
+Double volumes selects 3D mesh elements basing on the same set of nodes.
+See also \ref filter_double_elements "Double Elements quality control".
+
-
+Bad oriented volume selects mesh volumes, which are incorrectly oriented from
+the point of view of MED convention.
+
-
+Over-constrained volumes selects mesh volumes having only one border shared
+with other volumes.
+See also \ref over_constrained_volumes_page "Over-constrained volumes quality control".
+
-
+Volumes with bare border 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".
+
+
-\image html a-filteronedges.png
-*/
\ No newline at end of file
+*/