3 \page tui_filters_page Filters usage
5 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 object, control
8 mesh quality by different parameters, etc.
10 Several filters can be combined together by using logical operators \a
11 AND and \a OR. In addition, applied filter criterion can be reverted
12 using logical operator \a NOT.
14 Mesh filters use the functionality of mesh quality controls to filter
15 mesh nodes / elements by a specific characteristic (Area, Length, etc).
17 This page provides a short description of the existing mesh filters,
18 describes required parameters and gives simple examples of usage in
21 \sa \ref tui_quality_controls_page
23 \section filter_aspect_ratio Aspect ratio
25 Filter 2D mesh elements (faces) according to the aspect ratio value:
26 - element type should be \a SMESH.FACE
27 - functor type should be \a SMESH.FT_AspectRatio
28 - threshold is floating point value (aspect ratio)
30 \tui_script{filters_ex01.py}
32 \sa \ref tui_aspect_ratio
34 \section filter_aspect_ratio_3d Aspect ratio 3D
36 Filter 3D mesh elements (volumes) according to the aspect ratio value:
37 - element type is \a SMESH.VOLUME
38 - functor type is \a SMESH.FT_AspectRatio3D
39 - threshold is floating point value (aspect ratio)
41 \tui_script{filters_ex02.py}
43 \sa \ref tui_aspect_ratio_3d
45 \section filter_warping_angle Warping angle
47 Filter 2D mesh elements (faces) according to the warping angle value:
48 - element type is \a SMESH.FACE
49 - functor type is \a SMESH.FT_Warping
50 - threshold is floating point value (warping angle)
52 \tui_script{filters_ex03.py}
56 \section filter_minimum_angle Minimum angle
58 Filter 2D mesh elements (faces) according to the minimum angle value:
59 - element type is \a SMESH.FACE
60 - functor type is \a SMESH.FT_MinimumAngle
61 - threshold is floating point value (minimum angle)
63 \tui_script{filters_ex04.py}
65 \sa \ref tui_minimum_angle
67 \section filter_taper Taper
69 Filter 2D mesh elements (faces) according to the taper value:
70 - element type is \a SMESH.FACE
71 - functor type is \a SMESH.FT_Taper
72 - threshold is floating point value (taper)
74 \tui_script{filters_ex05.py}
78 \section filter_skew Skew
80 Filter 2D mesh elements (faces) according to the skew value:
81 - element type is \a SMESH.FACE
82 - functor type is \a SMESH.FT_Skew
83 - threshold is floating point value (skew)
85 \tui_script{filters_ex06.py}
89 \section filter_area Area
91 Filter 2D mesh elements (faces) according to the area value:
92 - element type is \a SMESH.FACE
93 - functor type is \a SMESH.FT_Area
94 - threshold is floating point value (area)
96 \tui_script{filters_ex07.py}
100 \section filter_volume Volume
102 Filter 3D mesh elements (volumes) according to the volume value:
103 - element type is \a SMESH.VOLUME
104 - functor type is \a SMESH.FT_Volume3D
105 - threshold is floating point value (volume)
107 \tui_script{filters_ex08.py}
111 \section filter_free_borders Free borders
113 Filter 1D mesh elements (edges) which represent free borders of a mesh:
114 - element type is \a SMESH.EDGE
115 - functor type is \a SMESH.FT_FreeBorders
116 - threshold value is not required
118 \tui_script{filters_ex09.py}
120 \sa \ref tui_free_borders
122 \section filter_free_edges Free edges
124 Filter 2D mesh elements (faces) consisting of edges belonging to one
125 element of mesh only:
126 - element type is \a SMESH.FACE
127 - functor type is \a SMESH.FT_FreeEdges
128 - threshold value is not required
130 \tui_script{filters_ex10.py}
132 \sa \ref tui_free_edges
134 \section filter_free_nodes Free nodes
137 - element type is \a SMESH.NODE
138 - functor type is \a SMESH.FT_FreeNodes
139 - threshold value is not required
141 \tui_script{filters_ex11.py}
143 \sa \ref tui_free_nodes
145 \section filter_free_faces Free faces
148 - element type is \a SMESH.FACE
149 - functor type is \a SMESH.FT_FreeFaces
150 - threshold value is not required
152 \tui_script{filters_ex12.py}
154 \sa \ref tui_free_faces
156 \section filter_bare_border_faces Bare border faces
158 Filter faces with bare borders:
159 - element type is \a SMESH.FACE
160 - functor type is \a SMESH.FT_BareBorderFace
161 - threshold value is not required
163 \tui_script{filters_ex13.py}
165 \sa \ref tui_bare_border_faces
167 \section filter_coplanar_faces Coplanar faces
169 Filter faces with bare borders:
170 - element type is \a SMESH.FACE
171 - functor type is \a SMESH.FT_CoplanarFaces
172 - threshold value is the face ID
173 - tolerance is in degrees
175 \tui_script{filters_ex14.py}
177 \section filter_over_constrained_faces Over-constrained faces
179 Filter over-constrained faces:
180 - element type is \a SMESH.FACE
181 - functor type is \a SMESH.FT_OverConstrainedFace
182 - threshold value is not required
184 \tui_script{filters_ex15.py}
186 \sa \ref tui_over_constrained_faces
188 \section filter_double_elements Double edges, Double faces, Double volumes
190 filter mesh elements basing on the same set of nodes:
191 - element type is either \a smesh.EGDE, \a SMESH.FACE or \a SMESH.VOLUME
192 - functor type is either \a SMESH.FT_EqualEdges, \a
193 SMESH.FT_EqualFaces or \a SMESH.FT_EqualVolumes,
194 - threshold value is not required
196 \tui_script{filters_ex16.py}
199 \section tui_double_nodes_control Double nodes
201 filters mesh nodes which are coincident with other nodes (within a given tolerance):
202 - element type is \a SMESH.NODE
203 - functor type is \a SMESH.FT_EqualNodes
204 - threshold value is not required
205 - default tolerance is 1.0e-7
207 \tui_script{filters_ex17.py}
210 \section filter_borders_multiconnection Borders at multi-connection
212 Filter border 1D mesh elements (edges) according to the specified number of
213 connections (faces belonging the border edges)
214 - element type is \a SMESH.EDGE
215 - functor type is \a SMESH.FT_MultiConnection
216 - threshold is integer value (number of connections)
218 \tui_script{filters_ex18.py}
220 \sa \ref tui_borders_at_multiconnection
222 \section filter_borders_multiconnection_2d Borders at multi-connection 2D
224 Filter 2D mesh elements (faces) which consist of edges belonging
225 to the specified number of mesh elements
226 - element type is \a SMESH.FACE
227 - functor type is \a SMESH.FT_MultiConnection2D
228 - threshold is integer value (number of connections)
230 \tui_script{filters_ex19.py}
232 \sa \ref tui_borders_at_multiconnection_2d
234 \section filter_length Length
236 Filter 1D mesh elements (edges) according to the edge length value:
237 - element type should be \a SMESH.EDGE
238 - functor type should be \a SMESH.FT_Length
239 - threshold is floating point value (length)
241 \tui_script{filters_ex20.py}
243 \sa \ref tui_length_1d
245 \section filter_length_2d Length 2D
247 Filter 2D mesh elements (faces) corresponding to the maximum length.
249 - element type should be \a SMESH.FACE
250 - functor type should be \a SMESH.FT_Length2D
251 - threshold is floating point value (edge length)
253 \tui_script{filters_ex21.py}
255 \sa \ref tui_length_2d
257 \section filter_max_element_length_2d Element Diameter 2D
259 Filter 2D mesh elements (faces) corresponding to the maximum length
260 value of its edges and diagonals:
261 - element type should be \a SMESH.FACE
262 - functor type should be \a SMESH.FT_MaxElementLength2D
263 - threshold is floating point value (edge/diagonal length)
265 \tui_script{filters_ex22.py}
267 \sa \ref tui_max_element_length_2d
269 \section filter_max_element_length_3d Element Diameter 3D
271 Filter 3D mesh elements (volumes) corresponding to the maximum length
272 value of its edges and diagonals:
273 - element type should be \a SMESH.VOLUME
274 - functor type should be \a SMESH.FT_MaxElementLength3D
275 - threshold is floating point value (edge/diagonal length)
277 \tui_script{filters_ex23.py}
279 \sa \ref tui_max_element_length_3d
281 \section filter_bare_border_volumes Bare border volumes
283 Filter 3D mesh elements with bare borders:
284 - element type is \a SMESH.VOLUME
285 - functor type is \a SMESH.FT_BareBorderVolume
286 - threshold value is not required
288 \tui_script{filters_ex24.py}
290 \sa \ref tui_bare_border_volumes
292 \section filter_over_constrained_volumes Over-constrained volumes
294 Filter over-constrained volumes:
295 - element type is \a SMESH.VOLUME
296 - functor type is \a SMESH.FT_OverConstrainedVolume
297 - threshold value is not required
299 \tui_script{filters_ex25.py}
301 \sa \ref tui_over_constrained_faces
303 \section filter_belong_to_geom Belong to Geom
305 Filter mesh entities (nodes or elements) which all nodes lie on the
306 shape defined by threshold value:
307 - element type can be any entity type, from \a SMESH.NODE to \a SMESH.VOLUME
308 - functor type should be \a SMESH.FT_BelongToGeom
309 - threshold is geometrical object
311 \tui_script{filters_ex26.py}
313 \section filter_lying_on_geom Lying on Geom
315 Filter mesh entities (nodes or elements) at least one node of which lies on the
316 shape defined by threshold value:
317 - element type can be any entity type, from \a SMESH.NODE to \a SMESH.VOLUME
318 - functor type should be \a SMESH.FT_LyingOnGeom
319 - threshold is geometrical object
321 \tui_script{filters_ex27.py}
323 \section filter_belong_to_plane Belong to Plane
325 Filter mesh entities (nodes or elements) which all nodes belong to the
326 plane defined by threshold value with the given tolerance:
327 - element type can be: \a SMESH.NODE, \a SMESH.EDGE, \a SMESH.FACE
328 - functor type should be \a SMESH.FT_BelongToPlane
329 - threshold is geometrical object (plane)
330 - default tolerance is 1.0e-7
332 \tui_script{filters_ex28.py}
334 \section filter_belong_to_cylinder Belong to Cylinder
336 Filter mesh entities (nodes or elements) which all nodes belong to the
337 cylindrical face defined by threshold value with the given tolerance:
338 - element type can be: \a , \a SMESH.EDGE, \a SMESH.FACE
339 - functor type should be \a SMESH.FT_BelongToCylinder
340 - threshold is geometrical object (cylindrical face)
341 - default tolerance is 1.0e-7
343 \tui_script{filters_ex29.py}
345 \section filter_belong_to_surface Belong to Surface
347 Filter mesh entities (nodes or elements) which all nodes belong to the
348 arbitrary surface defined by threshold value with the given tolerance:
349 - element type can be: \a SMESH.NODE, \a SMESH.EDGE, \a SMESH.FACE
350 - functor type should be \a SMESH.FT_BelongToGenSurface
351 - threshold is geometrical object (arbitrary surface)
352 - default tolerance is 1.0e-7
354 \tui_script{filters_ex30.py}
356 \section filter_range_of_ids Range of IDs
358 Filter mesh entities elements (nodes or elements) according to the
359 specified identifiers range:
360 - element type can be any entity type, from \a SMESH.NODE to \a SMESH.VOLUME
361 - functor type is \a SMESH.FT_RangeOfIds
362 - threshold is string listing required IDs and/or ranges of IDs, e.g."1,2,3,50-60,63,67,70-78"
364 \tui_script{filters_ex31.py}
366 \section filter_bad_oriented_volume Badly oriented volume
368 Filter 3D mesh elements (volumes), which are incorrectly oriented from
369 the point of view of MED convention.
370 - element type should be \a SMESH.VOLUME
371 - functor type is \a SMESH.FT_BadOrientedVolume
372 - threshold is not required
374 \tui_script{filters_ex32.py}
376 \section filter_linear_or_quadratic Linear / quadratic
378 Filter linear / quadratic mesh elements:
379 - element type should be any element type, e.g.: \a SMESH.EDGE, \a SMESH.FACE, \a SMESH.VOLUME
380 - functor type is \a SMESH.FT_LinearOrQuadratic
381 - threshold is not required
382 - if unary operator is set to SMESH.FT_LogicalNOT, the quadratic
383 elements are selected, otherwise (by default) linear elements are selected
385 \tui_script{filters_ex33.py}
387 \section filter_group_color Group color
389 Filter mesh entities, belonging to the group with the color defined by the threshold value.
390 - element type can be any entity type, from \a SMESH.NODE to \a SMESH.VOLUME
391 - functor type is \a SMESH.FT_GroupColor
392 - threshold should be of SALOMEDS.Color type
394 \tui_script{filters_ex34.py}
396 \section filter_geom_type Geometry type
398 Filter mesh elements by the geometric type defined with the threshold
399 value. The list of available geometric types depends on the element
401 - element type should be any element type, e.g.: \a SMESH.EDGE, \a SMESH.FACE, \a SMESH.VOLUME
402 - functor type should be \a SMESH.FT_ElemGeomType
403 - threshold is of smesh.GeometryType value
405 \tui_script{filters_ex35.py}
407 \section combining_filters How to combine filters with Criterion structures?
409 Filters can be combined by making use of "criteria".
413 \tui_script{filters_ex36.py}