Salome HOME
Merge branch 'BR_2018_V8_5' into BR_PY3
[modules/hydro.git] / doc / salome / tutorial / english / english_objetsNaturels.rst
1 ..
2    Copyright (C) 2015-2016 EDF
3
4    This file is part of SALOME HYDRO module.
5
6    SALOME HYDRO module is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation, either version 3 of the License, or
9    (at your option) any later version.
10
11    SALOME HYDRO module is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
18
19 #########################################
20 "Natural" objects – immersible zones
21 #########################################
22
23 .. |createImmersibleZone| image:: /../_static/createImmersibleZone.png
24    :align: middle
25
26 .. |selectColor| image:: /../_static/selectColor.png
27    :align: middle
28
29 .. |zonesImmersibles| image:: /../_static/zonesImmersibles.png
30    :align: middle
31
32 .. |changeLayerOrder| image:: /../_static/changeLayerOrder.png
33    :align: middle
34
35 .. |zoneSubmersible| image:: /../_static/zoneSubmersible.png
36    :align: middle
37
38 The contours created thus far are for "natural" objects, as against "artificial" objects. 
39 The latter classification corresponds to the use of altitude mode for computing the Z-elevation 
40 at all points on their surfaces. 
41
42 Natural objects correspond to surfaces whose Z-dimension is determined by a bathymetry/altitude field.
43
44 Examples of artificial objects are embankments, canals or channels, which will be represented by a constant 
45 cross-section, extruded along a line whose altitude could potentially vary.
46  
47 There are two sub-categories of natural objects: "immersible" zones associated to a point cloud of the 
48 bathymetry field /altitude type (.xyz or .asc) and "stream" zones which correspond to rivers described 
49 by a series of cross profiles. These profiles constitute a bathymetry field on which a specific interpolation 
50 method will be applied to calculate the Z-dimension. 
51
52 In this exercise, three immersible zones will be created, defined by a contour and a bathymetry/altitude field: 
53
54  * The minor bed, defined by the *garonne* contour and the bathymetry field *garonne_point_L93*, 
55
56  * The major bed, defined by the contour of the *garonne_point_L93* field and the field itself, 
57
58  * The study domain, defined by its contour, and the *cloud_02* field. 
59
60 The context menu of the *NATURAL OBJECTS* folder is used to create an immersible zone. 
61
62   |createImmersibleZone|
63
64 The dialog box proposes defining the zone name and selecting the contour and the bathymetry from the drop-down 
65 lists of existing objects. The choices must be confirmed with *apply and close* to create the zone.
66  
67 Once created, the colour of the zone can changed using the context menu associated to the object name. 
68
69   |selectColor|
70
71 Displaying all three zones should provide a view resembling the one below:
72
73   |zonesImmersibles|
74
75 It may be necessary to re-order the display layers: the *Change Layer* Order option in the context menu 
76 of the graphic view permits to set the object order. This setting will be remembered when the study is saved:
77
78   |changeLayerOrder|
79
80 The context menu associated with each immersible zone contains a *Submersible* parameter that is checked by default 
81 (icon pushed in). If the user wants to create an island in the TELEMAC sense, i.e. a non-floodable zone, 
82 which will create a hole in the mesh, this parameter has to be unchecked.
83  
84   |zoneSubmersible|
85
86 .. only:: html
87
88    :ref:`ref_exempleInondation`