Salome HOME
99190b003d0465d978d9821289e37d6117f92a67
[modules/hydro.git] / doc / salome / tutorial / english / english_casCalcul.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 Calculation case set-up
21 #########################################
22
23 .. |createCalculationCase1| image:: /../_static/createCalculationCase1.png
24    :align: middle
25
26 .. |createCalculationCase2| image:: /../_static/createCalculationCase2.png
27    :align: middle
28
29 .. |createCalculationCase3| image:: /../_static/createCalculationCase3.png
30    :align: middle
31
32 .. |createCalculationCase4| image:: /../_static/createCalculationCase4.png
33    :align: middle
34
35 .. |createCalculationCase5| image:: /../_static/createCalculationCase5.png
36    :align: middle
37
38 .. |createCalculationCase6| image:: /../_static/createCalculationCase6.png
39    :align: middle
40
41 .. |createCalculationCase7| image:: /../_static/createCalculationCase7.png
42    :align: middle
43
44 .. |createCalculationCase8| image:: /../_static/createCalculationCase8.png
45    :align: middle
46
47 .. |createCalculationCase9| image:: /../_static/createCalculationCase9.png
48    :align: middle
49
50 .. |createCalculationCase10| image:: /../_static/createCalculationCase10.png
51    :align: middle
52
53 Case creation
54 =============
55
56 This step consists in creating a *calculation case*, i.e. the configuration of objects that will be retained 
57 in the example study. 
58
59 Three objects have been created: the minor bed, the major bed and the study domain. 
60
61 To create a *calculation case*, open the context menu of the *CALCULATION CASE* folder 
62 and name the case garonne_1 in the dialog box. 
63
64   |createCalculationCase1|
65
66 **Select the domain as the limit**, then click on **manual mode** 
67 (this mode will be explained below) and select the three objects present and include them in the case. 
68
69 This step must be confirmed by pressing the *next* button. 
70
71   |createCalculationCase2|
72
73 The dialog proposes to select the groups to be preserved: these are the contours of the different objects 
74 taken into account in the case. These groups may prove useful later to define the boundary conditions 
75 or to control the mesh. By keeping them, they can be found under their names in subsequent steps of the calculation.
76
77 Select the three available groups and include them in the case. 
78
79 The *next* button should then be clicked to confirm this step. 
80
81   |createCalculationCase3|
82
83 The dialog box below enables the assignment of friction coefficients to the different domain zones, 
84 using a Strickler coefficients table and a *land cover map* partitioning the study area into zones, 
85 both of which need to have been previously imported and/or edited. 
86 This step is omitted in the context of the present simple study; it will, however, be expanded upon later. 
87
88 The instructions must be confirmed by pressing the *next* button. 
89
90   |createCalculationCase4|
91
92 Choice of Bathymetry calculation for the overlapping zones
93 ==========================================================
94
95 The following step shows the result of the *partition* of the different zones retained in the calculation case. 
96 The original surfaces were cut along the overlapping lines. 
97
98 The panel on the right shows as many cut *regions* as cut faces: each region contains one a cut face or *zone*.
99
100 Certain zones are coloured red: these zones are the overlap zones of the original faces. 
101 The list of initial objects appears in the second column. 
102
103 Several bathymetry definitions are possible for these zones, as listed in the third column. 
104 Until a rule has been defined to calculate the zone bathymetry, this zone is declared to be *in conflict*.
105
106   |createCalculationCase5|
107
108 Each conflict zone must be selected, one after the other, to choose the bathymetry mode for the zone. 
109 The selection is made from the drop-down menu associated with the zone. 
110
111 The following options can be selected: 
112
113  * A bathymetry among those listed 
114
115  * The local minimum of all listed bathymetries 
116
117  * The local maximum of all listed bathymetries 
118
119   |createCalculationCase6|
120
121 There should be no red zones remaining once the conflicts have been resolved. 
122
123 The zone colours can be regenerated (*regenerate colors* button), if necessary. 
124
125   |createCalculationCase7|
126
127 Grouping zones into regions
128 ===========================
129
130 The next step is to group several zones into separate regions. 
131
132 What purpose does this serve? A zone corresponds to a computational mode for the bathymetry.
133 The contour of this zone is not necessarily of interest as a *mesh constraint line*. 
134 When several adjacent zones are grouped together into one region, only the contour of the region 
135 will be kept as a *mesh constraint line*. 
136
137 Hence, group the two left bank zones together and do likewise with the two zones on the Right bank, 
138 so as to obtain three regions. 
139
140 To move a zone, drag and drop the zone name from one region to another (in the right panel).
141
142   |createCalculationCase8|
143
144 This last step must be confirmed by clicking on the *Finish* button.
145
146 The case now appears in the study tree. Select each region and give it a meaningful name (context menu).
147  
148 It can be helpful, when renaming a region, to look at the zones it contains, which are displayed in the graphic view.
149 By expanding the study tree for each region, the zones can be selected and then highlighted. 
150
151 As a rule, there is no need to rename the zones themselves, just the regions. 
152 This is because the regions, identified by name, will subsequently be used. 
153 A real case study could contain several dozens of regions. 
154
155   |createCalculationCase10|
156
157 .. only:: html
158
159   :ref:`ref_exempleInondation`
160