Salome HOME
Fix make distcheck error (merge from V6_4_BR branch)
[modules/smesh.git] / doc / salome / gui / SMESH / input / creating_groups.doc
1 /*!
2
3 \page creating_groups_page Creating groups
4
5 \n In MESH you can create groups of elements of a certain type whose
6 contents is defined in different ways. To create a group, in the \b
7 Mesh menu select <b>Create Group</b> item (also available in the
8 contextual menu of the mesh).<br> 
9 To create a group of any type you should define the following: 
10 <ul>
11 <li><b>Mesh</b> - the mesh whose elements will form your
12 group. You can select your mesh in the Objet Browser or in the 3D
13 viewer.</li>
14 <li><b>Elements Type</b> - set of radio buttons allows to select the type of
15 elements which will form your group:</li>
16 <ul>
17 <li><b>Nodes</b></li>
18 <li><b>Edges</b></li>
19 <li><b>Faces</b></li>
20 <li><b>Volumes</b></li>
21 </ul>
22 <li><b>Name</b> field allows to enter the name of your new group.</li>
23 <li><b>Color</b> - allows to assign to the group a certain color, for
24 example, defining boundary conditions. The chosen color is used to
25 display the elements of the group. The color attribute of the group is
26 not persistent, it is lost if you save and then load the study from
27 the file.</li>
28 </ul>
29 SALOME Platform distinguishes between the three Group types:
30 <b>Standalone Group</b>, <b>Group on Geometry</b> and <b>Group on Filter</b>.
31
32 \anchor standalone_group <br><h2>"Standalone Group"</h2>
33
34 <b>Standalone Group</b> contains a list of mesh elements, which you can define in
35 the following ways:
36 <ul>
37 <li>By adding all entities of the chosen type existing in the
38   mesh. For this, turn on the <b>Select All</b> check box. In this mode
39   all controls, which allow selecting the entities in other ways are
40   disabled.</li>
41 <li>By applying the Filter. The <b>Set filter</b> button allows to
42   define the filter for selection of the elements for your group. See more
43   about filters on the 
44   \ref selection_filter_library_page "Selection filter library" page.<br>
45   If the <b>Enable manual edition</b> check box is turned off, the defined
46   filter defines contents of the group. In this mode, the filter is
47   applied to all elements of the mesh. If none entity satisfies the
48   filter, the \b Apply button is disabled.<br>
49   If the <b>Enable manual edition</b> check box is turned on, the defined
50   filter can be used to for selection of entities composing the group.</li>
51 <li>By choosing entities manually with the mouse in the 3D Viewer. For
52   this, turn on the <b>Enable manual edition</b> check box. You can
53   click on an element in the 3D viewer and it will be highlighted. After
54   that click the \b Add button and the ID of this element will be
55   added to the list.</li>
56 <li>By adding entities from either a submesh or an existing
57   group.  For this, turn on the <b>Enable manual edition</b> check
58   box. <b>Select from</b> set of fields allows to select a submesh or
59   a group of an appropriate type.</li>
60 </ul>
61 In the <b>manual edition</b> mode you can
62 <ul>
63 <li>click the \b Remove button to remove selected elements from the list</li>
64 <li>click the <b>Sort List</b> button to sort the list of IDs of 
65 mesh elements.</li>
66 </ul>
67
68 \image html creategroup.png
69
70
71 For example, to create a new group containing all faces of an
72 existing group and some other faces selected in the viewer:
73 <ul>
74 <li> Select the \b Face type of entities and input the name of the new group.</li>
75 <li> Check the \b Group checkbox in <b>Select From</b> group.</li>
76 <li> Select the existing group of faces in the object browser or in the viewer</li>
77 <li> Click \b Add in \b Content group. <b>Id Elements</b> list will be filled
78 with IDs of faces belonging to the exising group.</li>
79 <li> Select other faces in the viewer.</li>
80 <li> Click \b Add in \b Content group.</li>
81 <li> Click \b Apply button to create the new group.</li>
82 </ul>
83
84 Please note that the new group does not have references to the source
85 group. It contains only the list of face IDs. So if the source group
86 is changed, the new one is not updated accordingly.
87
88
89 \image html image130.gif
90 <center>In this picture the brown cells belong to a group defined
91   manually.</center> 
92
93 \image html image131.gif
94 <center>In this picture the brown cells belong to the group defined by
95   the criterion <b>Taper > 0</b>.</center>
96
97 <b>See Also</b> a sample TUI Script of a 
98 \ref tui_create_standalone_group "Create a Standalone Group"
99 operation.  
100
101
102 \anchor group_on_geom <br><h2>"Group on Geometry"</h2>
103
104 To create a group on geometry check <b>Group on geometry</b> in the \b
105 Group \b type field. The group on geometry contains the elements
106 of a certain type generated on the selected geometrical object. Group
107 contents is dynamically updated if the mesh is modified.<br>
108 To define a group, select in the Objet Browser or in the 3D viewer a
109 geometrical object from which the elements will be taken. After
110 confirmation of the operation a new group of mesh elements will be
111 created.
112
113 \image html a-creategroup.png
114
115 \image html image132.gif
116 <center>In this picture the cells which belong to a certain
117   geometrical face are selected in green.</center>
118
119 <b>See Also</b> a sample TUI Script of a 
120 \ref tui_create_group_on_geometry "Create a Group on Geometry"
121 operation.
122
123
124
125 \anchor group_on_filter <br><h2>"Group on Filter"</h2>
126
127 To create a group on filter check <b>Group on filter</b> in the <b>
128 Group type</b> field. The group on filter contains the elements
129 of a certain type satisfying the defined filter. Group contents is
130 dynamically updated if the mesh is modified.<br> To define a group,
131 click the <b>Set filter</b> button and define criteria of the
132 filter in the opened dialog. After confirmation of the operation a
133 new group of mesh elements will be created. See more about filters on
134 the \ref selection_filter_library_page "Selection filter library" page.
135
136 \image html creategroup_on_filter.png
137
138 <b>See Also</b> a sample TUI Script of a 
139 \ref tui_create_group_on_filter "Create a Group on Filter" operation.
140
141 */