Salome HOME
Updated copyright comment
[modules/homard.git] / doc / en / gui_create_boundary.rst
1 .. _gui_create_boundary:
2
3 The boundary
4 ############
5 .. index:: single: boundary
6 .. index:: single: frontière
7 .. index:: single: CAO
8
9 The object boundary contains all the geometrical definitions allowing to describe a curved boundary to be followed.
10
11 There are two modes of description of a boundary:
12
13   - CAO: the boundary comes from the geometry of the domain
14   - Non CAO: if the CAO is not available, the boundary can be approxaimted by its descriptions:
15
16     * Discrete: to describe the set of 1D curves that defines the boundary
17     * Analytics: to describe every surface that defines the boundary
18
19 This choice is:
20
21 .. image:: images/create_boundary_1.png
22    :align: center
23
24 CAO boundary
25 ************
26
27 The follow-up of a CAO boundary will be made by selecting a boundary chosen in the list of the existing CAO boundaries.
28
29 In the starting up, the list is empty. It is necessary to create a first CAO boundary by activation of the button "*New*":
30
31 .. image:: images/create_boundary_cao_1.png
32    :align: center
33
34 The window invites in the choice of a file that contains the CAO with XAO format. This CAO is the one that is the basis for the initial mesh. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
35
36 .. image:: images/create_boundary_cao_2.png
37    :align: center
38
39 .. note::
40   The coherence between this CAO and the initial mesh is not checked.
41
42 Discrete boundary
43 *****************
44
45 The follow-up of a discrete boundary will be made by selecting a boundary chosen in the list of the existing discrete boundaries.
46
47 In the starting up, the list is empty. It is necessary to create a first discrete boundary by activation of the button "*New*":
48
49 .. image:: images/create_boundary_di_1.png
50    :align: center
51
52 The window invites in the choice of a file of mesh. This mesh is the one of all the lines constituting the boundary. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
53
54 .. image:: images/create_boundary_di_2.png
55    :align: center
56
57 .. note::
58   The file has to contain only a single mesh.
59
60 If discrete boundaries were already defined for another case, we can select one of them. We can also create a new discrete boundary by activation of the button "*New*", as explained previously.
61
62 .. image:: images/create_boundary_di_3.png
63    :align: center
64
65
66
67 Analytical boundary
68 *******************
69 In the starting up, SALOME shows a table with one only one column. This column contains the list of all the groups of the initial mesh defining the case.
70
71 .. image:: images/create_boundary_an_1.png
72    :align: center
73
74 It is necessary to create a first analytical boundary by activation of the button "*New*". We shall have the choice between cylinder, sphere, cone or torus. When the boundary will be validated, its name will appear in header of the second column.
75
76 .. image:: images/create_boundary_an_2.png
77    :align: center
78
79 It is now necessary to establish the link enter the mesh defining the case and this boundary described analytically. It is made by checking the groups of the faces which have to be on the boundary.
80
81 .. image:: images/create_boundary_an_3.png
82    :align: center
83
84 This operation is repeated as often as we wish to place faces of meshs on a curved surface:
85
86 .. image:: images/create_boundary_an_4.png
87    :align: center
88
89 .. note::
90
91   A group can be checked very well never: it means that the elements which it defines belong to none of the described boundaries.
92
93   A group can be checked only once. Indeed, surface elements cannot belong to more than one surface.
94
95   Several groups can be checked for the same boundary. It occurs if the initial mesh of the zone was subdivided into several groups: all the surface elements belong to this surface but were distributed in several groups.
96
97   Conversely, a boundary can be very well retained by no group. It occurs if it was defined for a previous case and if it is groundless for the case in the course of definition.
98
99
100 There are four types of analytical boundary:
101
102   - Cylindre
103   - Sphere
104   - Cone, described by an axis and an angle or by two radius
105   - Torus
106
107 .. note::
108   The numerical values proposed by default take into account the geometry of the mesh.
109
110
111 Cylindre
112 ========
113 .. index:: single: cylindre
114
115 The cylinder is defined by a point of the axis, its axis and its radius. The axis is defined by a vector. The standard of this vector is not inevitably equal to 1; also, its orientation has no importance. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
116
117 .. image:: images/create_boundary_an_cy.png
118    :align: center
119
120 Sphere
121 ======
122 .. index:: single: sphere
123
124 The sphere is defined by its center and its radius. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
125
126 .. image:: images/create_boundary_an_sp.png
127    :align: center
128
129 Cone
130 ====
131 .. index:: single: cone
132
133 A cone is defined by two different manners: the center, the axis and the angle of opening in degree or by two points centered on the axis and the associated radius. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
134
135 Creation by an origin, an axis and an angle of opening:
136
137 .. image:: images/create_boundary_an_co_1.png
138    :align: center
139
140 Creation by two points centered on the axis and the associated radius:
141
142 .. image:: images/create_boundary_an_co_2.png
143    :align: center
144
145 .. index:: single: object browser
146
147 Torus
148 =====
149 .. index:: single: torus
150
151 The torus is defined by its centre, its axis, the revolution radius and the primary radius. The axis is defined by a vector. The standard of this vector is not inevitably equal to 1; also, its orientation has no importance. A name of boundary is automatically proposed: Boun_1, Boun_2, etc. This name can be modified. It must not already have been used for another boundary, whatever its type.
152
153 .. image:: images/create_boundary_an_to.png
154    :align: center
155
156 Object browser
157 **************
158 At the end of this creation of boundaries, the object browser was enriched. We find all the boundaries created, identified there by their name, with the possibility of editing them.
159
160 .. image:: images/create_boundary.png
161    :align: center
162
163 Corresponding python functions
164 ******************************
165 Look :doc:`tui_create_boundary`
166
167
168