Salome HOME
ajustement doc tutoriel
[modules/hydro.git] / doc / salome / tutorial / miseEnDonneesTelemac.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 Mise en données TELEMAC
21 #########################################
22
23 .. |HYDROSolver| image:: /_static/HYDROSolver.png
24    :align: middle
25    :width: 16pt
26    :height: 16pt
27
28 .. |eficas_04| image:: /_static/eficas_04.png
29    :align: middle
30    :width: 16pt
31    :height: 16pt
32
33 .. |genereCondlim| image:: /_static/genereCondlim.png
34    :align: middle
35    
36 .. |eficas_01| image:: /_static/eficas_01.png
37    :align: middle
38    
39 .. |eficas_02| image:: /_static/eficas_02.png
40    :align: middle
41    
42 .. |eficas_03| image:: /_static/eficas_03.png
43    :align: middle
44    
45 .. |eficas_20| image:: /_static/eficas_20.png
46    :align: middle
47    
48 .. |eficas_21| image:: /_static/eficas_21.png
49    :align: middle
50    
51 .. |eficas_22| image:: /_static/eficas_22.png
52    :align: middle
53    
54 .. |eficas_23| image:: /_static/eficas_23.png
55    :align: middle
56
57 Une fois le maillage généré avec l'altimétrie, il reste à définir la nature des zones de conditions limites,
58 les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps, et l'ensemble des
59 paramètres physiques et numériques du calcul.
60 Il faut se reporter au manuel de Telemac pour la définition de ces différents paramètres.
61
62 Ces informations sont regroupées dans plusieurs fichiers de texte (ASCII) à générer ou éditer manuellement.
63
64 **Ces différents fichiers seront rangés dans le même répertoire que le maillage.**
65
66 Il faut activer le module HYDROSOLVER, via la liste défilante des modules, ou son icône dans le bandeau : |HYDROSolver|.
67 Le module HYDROSOLVER prend en charge la mise en donnée physico-numérique et les calculs pour les codes
68 Telemac et Mascaret ainsi que leur couplages.
69
70 Caractérisation des zones de conditions limites
71 ===============================================
72
73 Les zones de conditions limites ont été définies dans les étapes précédentes,
74 et sont concrétisées par des groupes nommés d'éléments dans le maillage.
75
76 Le fichier *condlim.bcd* associe à chaque groupe ses caractéristiques :
77 entrée, sortie, paroi... Quatre valeurs entières définissent un type de condition limite.
78
79 La première ligne indique le nombre de conditions limites définies, il y a ensuite une ligne par condition limite.
80 Chaque ligne comprend 4 entiers (le type) et le nom du groupe.
81
82 Nous pouvons générer le fichier à partir de la commande *Edit boundary conditions file* du module *HYDROSOLVER*.
83
84 Il faut définir en entrée le chemin du fichier MED utilisé, et en sortie, le chemind du fichier des zones de conditions limites.
85 L'entree *Boundary condition file* ne sert que pour lire un fichier existant.
86
87 Il faut sélectionner le type de condition limite sur les zones amont, aval, bord gauche et droit, et ne rien mettre sur les autres groupes.
88
89   |genereCondlim|
90   
91 Le fichier résultat ressemble à ceci :
92
93 .. literalinclude:: condlim.bcd
94     :lines: 1-
95
96 * **Remarque** : Il n'est plus nécessaire de créer le fichier *.cli* prévu dans le manuel de Telemac, 
97   qui liste l'ensemble des noeuds de conditions limites avec les types associés. Ce fichier est généré
98   automatiquement.
99
100 Valeurs des conditions limites de débit et hauteur d'eau
101 ========================================================
102
103 Le fichier *init.lqd* donne les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps.
104 Il faut se reporter au manuel de Telemac pour sa définition précise.
105
106 .. literalinclude:: init.lqd
107     :lines: 1-
108
109 Paramètres physiques et numériques du calcul
110 ============================================
111
112 Le fichier *init.cas* liste les autres fichiers, qui doivent être dans le même répertoire.
113 Il donne ensuite les différents paramètres physico-numériques nécessaires au calcul.
114 De même que précédemment, il faut se reporter au manuel de Telemac pour la définition de ces paramètres.
115
116 * **Remarque importante** : pour la version 1.0 de mars 2016, la présence d'un fichier Fortran est obligatoire,
117   même si celui-ci ne comprend qu'une ligne de commentaire (il faut forcer la recompilation de l'éxécutable TELEMAC).
118   Dans le fichier *init.cas*, Il faut enlever le commentaire devant le mot clé *FICHIER FORTRAN* et créer le fichier correspondant.
119
120 .. literalinclude:: init.cas
121     :lines: 1-
122
123 Edition du fichier cas avec EFICAS
124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
126 Il existe 2 méthodes pour réaliser cette action, avec le module *HYDROSOLVER* : 
127
128 * **avec les menus :** dans le menu HYDRO, cliquer sur *Edit cas file*
129
130   |eficas_01|
131
132 * **avec les icônes :** quand on active le module Hydrosolver, de nouveaux boutons apparaissent dans la barre d’outils.
133   Cliquer à droite sur Edit cas file
134   
135   |eficas_02|
136   
137 Cliquer sur New pour créer un fichier cas. 
138   
139   |eficas_03|
140   
141 Renseigner ce qui est rouge. Quand une sous-rubrique ou rubrique est complète elle passe au vert.
142 Ce qui est en vert est rempli par défaut mais l’utilisateur a la main dessus.
143 Penser à enregistrer régulièrement le cas créé. Pour cela, aller dans *File / Save* ou *Save as*, 
144 ou cliquer sur l’icône |eficas_04| le fichier sera enregistré en *.comm* ou *.jdc*.
145
146 Comment fonctionne EFICAS ?
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
148
149 Quand on se place dans l’interface centrale, au niveau de la rubrique, dans la partie de droite intitulée Settings *NOM DE RUBRIQUE*,
150 apparaissent des mots clés facultatifs que l’on peut rajouter dans la sous-rubrique correspondante,
151 en double cliquant sur le carré devant le mot clé.
152
153 **Exemple :** je souhaite rajouter le mot clé *Control_section* dans *Output_Files*. Je double-clique dessus à droite :
154   
155   |eficas_20|
156
157 Il apparaît alors dans la sous-rubrique *Output_Files*. Si je me place dessus dans l’écran central, 
158 j’ai d’autres mots clés qui se présentent à moi dans la partie de droite sous le titre 
159 *Control_Section* que je peux rajouter de la même manière.
160
161   |eficas_21|
162   
163 Il est également possible d’avoir l’aide du mot clé en direct. Pour cela, il suffit de se placer sur le mot clé et l’aide apparaît :  
164
165   |eficas_22|
166
167 Si on clique sur le mot clé avec la souris l’aide apparaît en bas à gauche :
168
169   |eficas_23|
170
171 **Rangement des paramètres par rubriques et sous-rubriques**
172
173 Dans *Computation_Environment*, on retrouve par défaut :
174
175  * *Initialization* : concerne les fichiers de données d’entrée comme le fichier de géométrie et le fichier des conditions limites.
176    Pour prendre en compte le titre, taper le nom souhaité et faites entrer.
177    
178  * *Restart* : pour repartir d’un calcul précédent
179  
180  * *Output_files* : concerne les fichiers résultats, le listing et leurs caractéristiques.
181
182 Dans *Hydro*, on retrouve par défaut :
183
184  * *Boundary_Conditions* : concerne les fichiers de condition limites
185    (fichier des frontières liquides, fichier des courbes de tarage, cote ou débit imposé…)
186    
187  * *Physical_Parameters_Hydro* : concerne le frottement. L’utilisateur peut rajouter ce qui concerne les vagues,
188    la météorologie, les sources, la qualité d’eau…
189    
190  * *Numerical_Parameters_Hydro* : concerne les équations utilisées, le traitement du système linéaire.
191
192 Dans General_Parameters, on retrouve par défaut :
193
194  * *Debugger* : en mode debugger ou non
195
196  * *Time* : concerne le pas de temps, durée de la simulation….
197  
198  * *Location* : concerne l’origine des coordonnées…
199
200 Dans Numerical_Parameters, on retrouve par défaut :
201
202  * *Solver_Info* : concerne le solveur
203
204  * *Discretizations_Implicitation* : concerne l’implicitation de la hauteur, de la vitesse, la discrétisation en espace…
205
206  * *Propagation_Info*
207
208  * *Advection_Info* : concerne le mass lumping, la compatibilité du gradient de surface libre…
209
210  * *Diffusion* : concerne la diffusion des vitesses, l’option pour la diffusion des vitesses…
211
212  * *Automatic_Differentiation*
213
214  * *Advanced* : concerne le stockage de matrice, le produit vecteur-matrice…
215
216 **Développement à venir**
217
218 A terme, l’utilisateur pourra choisir parmi des « fichiers cas modèles » pré-remplis. On trouvera parmi ceux-ci : 
219
220  * un fichier cas modèle inondation,
221
222  * un fichier cas modèle maritime,
223
224  * un fichier cas modèle thermique.
225
226 .. only:: html
227
228    :ref:`ref_exempleInondation`