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 .. |edit_initial_field_file| image:: /_static/edit_initial_field_file.png
  34    :align: middle
  35    :width: 16pt
  36    :height: 16pt
  37
  38 .. |genereCondlim| image:: /_static/genereCondlim.png
  39    :align: middle
  40
  41 .. |eficas_01| image:: /_static/eficas_01.png
  42    :align: middle
  43
  44 .. |eficas_02| image:: /_static/eficas_02.png
  45    :align: middle
  46
  47 .. |eficas_03| image:: /_static/eficas_03.png
  48    :align: middle
  49
  50 .. |eficas_20| image:: /_static/eficas_20.png
  51    :align: middle
  52
  53 .. |eficas_21| image:: /_static/eficas_21.png
  54    :align: middle
  55
  56 .. |eficas_22| image:: /_static/eficas_22.png
  57    :align: middle
  58
  59 .. |eficas_23| image:: /_static/eficas_23.png
  60    :align: middle
  61
  62 .. |salomeShell| image:: /_static/salomeShell.png
  63    :align: middle
  64
  65 .. |initialisationHauteurEau| image:: /_static/initialisationHauteurEau.png
  66    :align: middle
  67
  68 .. |choixCodeEficas| image:: /_static/choixCodeEficas.png
  69    :align: middle
  70
  71 .. |rechercheEficas| image:: /_static/rechercheEficas.png
  72    :align: middle
  73
  74 .. |initialFieldDialog| image:: /_static/initialFieldDialog.png
  75    :align: middle
  76
  77 .. |CheckBoundaryConditions| image:: /_static/CheckBoundaryConditions.png
  78    :align: middle
  79
  80 .. |CheckBoundaryConditions1| image:: /_static/CheckBoundaryConditions1.png
  81    :align: middle
  82
  83 .. |CheckBoundaryConditions2| image:: /_static/CheckBoundaryConditions2.png
  84    :align: middle
  85
  86 .. |CheckBoundaryConditions3| image:: /_static/CheckBoundaryConditions3.png
  87    :align: middle
  88
  89 Une fois le maillage généré avec l'altimétrie, il reste à définir la nature des zones de conditions limites,
  90 les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps, et l'ensemble des
  91 paramètres physiques et numériques du calcul.
  92 Il faut se reporter au manuel de Telemac pour la définition de ces différents paramètres.
  93
  94 Ces informations sont regroupées dans plusieurs fichiers de texte (ASCII) à générer ou éditer manuellement.
  95
  96 **Ces différents fichiers seront rangés dans le même répertoire que le maillage.**
  97
  98 Il faut activer le module HYDROSOLVER, via la liste défilante des modules, ou son icône dans le bandeau : |HYDROSolver|.
  99 Le module HYDROSOLVER prend en charge la mise en donnée physico-numérique et les calculs pour les codes
 100 Telemac et Mascaret ainsi que leur couplages.
 101
 102 Caractérisation des zones de conditions limites
 103 ===============================================
 104
 105 Les zones de conditions limites ont été définies dans les étapes précédentes,
 106 et sont concrétisées par des groupes nommés d'éléments dans le maillage.
 107
 108 Le fichier *condlim.bcd* associe à chaque groupe ses caractéristiques :
 109 entrée, sortie, paroi... Quatre valeurs entières définissent un type de condition limite.
 110
 111 La première ligne indique le nombre de conditions limites définies, il y a ensuite une ligne par condition limite.
 112 Chaque ligne comprend 4 entiers (le type) et le nom du groupe.
 113
 114 Nous pouvons générer le fichier à partir de la commande *Edit boundary conditions file* du module *HYDROSOLVER*.
 115
 116 Il faut définir en entrée le chemin du fichier MED utilisé, et en sortie, le chemin du fichier des zones de conditions limites.
 117 L'entrée *Boundary condition file* ne sert que pour lire un fichier existant.
 118
 119 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.
 120
 121   |genereCondlim|
 122
 123 Le fichier résultat ressemble à ceci :
 124
 125 .. literalinclude:: condlim.bcd
 126     :lines: 1-
 127
 128 * **Remarque** : Il n'est plus nécessaire de créer le fichier *.cli* prévu dans le manuel de Telemac,
 129   qui liste l'ensemble des noeuds de conditions limites avec les types associés. Ce fichier est généré
 130   automatiquement.
 131
 132 Vérification que le contour est bien fermé et affichage des conditions limites
 133 ------------------------------------------------------------------------------
 134
 135 Il est possible de vérifier que le contour du modèle est bien fermé.
 136
 137 Dans *HYDROSOLVER / Hydro*, cliquer sur *Check boundary conditions*.
 138
 139   |CheckBoundaryConditions|
 140
 141   |CheckBoundaryConditions1|
 142
 143 Il faut désigner le fichier de maillage MED et le fichier des conditions limites.
 144
 145 Puis on a la possibilité d’afficher les frontières solides et liquides du modèle :
 146
 147   |CheckBoundaryConditions2|
 148
 149 Ou alors d’afficher les frontières de type Télémac (débit imposé, cote imposée…) :
 150
 151   |CheckBoundaryConditions3|
 152
 153 Valeurs des conditions limites de débit et hauteur d'eau
 154 ========================================================
 155
 156 Le fichier *init.lqd* donne les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps.
 157 Il faut se reporter au manuel de Telemac pour sa définition précise.
 158
 159 .. literalinclude:: init.lqd
 160     :lines: 1-
 161
 162 Ajout d'un champ initial dans le fichier MED
 163 ============================================
 164
 165 Afin d'initialiser le calcul, on peut imposer une hauteur
 166 d'eau initiale ou une cote initiale dans les groupes de faces qui nous intéressent,
 167 en l'occurence, ici, dans le lit mineur.
 168
 169 Avec une interface de saisie
 170 ----------------------------
 171
 172 Pour cela, on utilise le dialogue *Initial Field* du module *HYDROSOLVER*
 173 (icone |edit_initial_field_file| ou menu *hydro / edit initial field*).
 174
 175   |initialFieldDialog|
 176
 177 Après avoir sélectionné le fichier MED issu des étapes précédentes, le dialogue propose un nom de fichier MED en sortie,
 178 placé par défaut dans le même répertoire que le fichier d'origine, et avec un suffixe *_ic*. Ce nom est éditable.
 179
 180 Le nom du champ à compléter est éditable, il est mis par défaut à *WATER_DEPTH*, on peut aussi utiliser *WATER ELEVATION* pour saisir une cote.
 181
 182 Le dialogue affiche la liste des groupes de faces trouvés, et leur affecte une valeur de champ par défaut, modifiable.
 183 On peut changer spécifiquement la valeur d'un ou plusieurs groupes de faces.
 184 Ici, par exemple, on a changé la hauteur d'eau initiale dans le lit mineur à 10m.
 185
 186 Ou par script
 187 -------------
 188
 189 Pour information, on peut faire la même initialisation à l'aide d'un script Python :
 190
 191 .. literalinclude:: add_field_h_on_group.py
 192     :lines: 1-
 193
 194 Il suffit de remplir :
 195
 196  * le nom du fichier MED,
 197  * le nom du maillage (dans le module SMESH) à partir duquel il a été construit,
 198  * les groupes de faces auxquels on souhaite ajouter une cote ou une hauteur d'eau initiale,
 199  * le nom du champ ajouté (*WATER_DEPTH* ou *WATER ELEVATION*).
 200
 201 Pour lancer le script :
 202
 203  * ouvrir un SALOME shell.
 204
 205   |salomeShell|
 206
 207  * se placer dans le répertoire où l'on a rangé le script *add_field_h_on_group.py*,
 208
 209  * exécuter le script : *python add_field_h_on_group.py*.
 210
 211 Le résultat
 212 -----------
 213
 214 Le champ *hauteur d'eau* est ajouté au fichier MED. Si on a utilisé le script, il faut penser à enregistrer le fichier précédent
 215 (comprenant Z et Ks) sous un autre nom pour le conserver pour réutilisation en cas de besoin.
 216
 217   |initialisationHauteurEau|
 218
 219 Paramètres physiques et numériques du calcul
 220 ============================================
 221
 222 Le fichier *CasGaronne.cas* liste les autres fichiers, qui doivent être dans le même répertoire.
 223 Il donne ensuite les différents paramètres physico-numériques nécessaires au calcul.
 224 De même que précédemment, il faut se reporter au manuel de Telemac pour la définition de ces paramètres.
 225
 226 Voici la version générée avec EFICAS (voir ci-dessous l'utilisation d'EFICAS)
 227
 228 .. literalinclude:: CasGaronne.cas
 229     :lines: 1-
 230
 231 Et la version plus légère, ou seuls figurent les mots clefs différents de leur valeur par défaut.
 232
 233 .. literalinclude:: CasGaronne.Lcas
 234     :lines: 1-
 235
 236 Edition du fichier cas avec EFICAS
 237 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 238
 239 Il existe 2 méthodes pour réaliser cette action, avec le module *HYDROSOLVER* :
 240
 241 * **avec les menus :** dans le menu HYDRO, cliquer sur *Edit cas file*
 242
 243   |eficas_01|
 244
 245 * **avec les icônes :** quand on active le module Hydrosolver, de nouveaux boutons apparaissent dans la barre d'outils.
 246   Cliquer à droite sur Edit cas file
 247
 248   |eficas_02|
 249
 250 Cliquer sur New pour créer un fichier cas.
 251
 252 Sélectionner le code souhaité : dans notre cas, *telemac2d*.
 253
 254   |choixCodeEficas|
 255
 256   |eficas_03|
 257
 258 Renseigner ce qui est rouge. Quand une sous-rubrique ou rubrique est complète elle passe au vert.
 259 Ce qui est en vert est rempli par défaut mais l'utilisateur a la main dessus.
 260 Penser à enregistrer régulièrement le cas créé. Pour cela, aller dans *File / Save* ou *Save as*,
 261 ou cliquer sur l'icône |eficas_04| le fichier sera enregistré en *.comm* ou *.jdc*.
 262
 263 Les puces vertes sont de deux couleurs :
 264
 265  * Quand la valeur renseignée est la valeur par défaut, la puce est vert foncé.
 266  * Quand la valeur renseignée est différente de la valeur par défaut, la puce est vert clair.
 267
 268 Comment fonctionne EFICAS ?
 269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 270
 271 **remarque** : Pour chercher où est rangé un mot clé, aller dans le menu *Edit / Find Keyword*.
 272
 273 La fenêtre suivante donne l'emplacement du mot clé ainsi que la documentation associée.
 274
 275   |rechercheEficas|
 276
 277 Quand on se place dans l'interface centrale, au niveau de la rubrique, dans la partie de droite intitulée Settings *NOM DE RUBRIQUE*,
 278 apparaissent des mots clés facultatifs que l'on peut rajouter dans la sous-rubrique correspondante,
 279 en double cliquant sur le carré devant le mot clé.
 280
 281 **Exemple :** je souhaite rajouter le mot clé *Control_section* dans *Output_Files*. Je double-clique dessus à droite :
 282
 283   |eficas_20|
 284
 285 Il apparaît alors dans la sous-rubrique *Output_Files*. Si je me place dessus dans l'écran central,
 286 j'ai d'autres mots clés qui se présentent à moi dans la partie de droite sous le titre
 287 *Control_Section* que je peux rajouter de la même manière.
 288
 289   |eficas_21|
 290
 291 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 :
 292
 293   |eficas_22|
 294
 295 Si on clique sur le mot clé avec la souris l'aide apparaît en bas à gauche :
 296
 297   |eficas_23|
 298
 299 **Rangement des paramètres par rubriques et sous-rubriques**
 300
 301 Dans *Computation_Environment*, on retrouve par défaut :
 302
 303  * *Initialization* : concerne les fichiers de données d'entrée comme le fichier de géométrie et le fichier des conditions limites.
 304    Pour prendre en compte le titre, taper le nom souhaité et faites entrer.
 305
 306  * *Restart* : pour repartir d'un calcul précédent
 307
 308  * *Output_files* : concerne les fichiers résultats, le listing et leurs caractéristiques.
 309
 310 Dans *Hydro*, on retrouve par défaut :
 311
 312  * *Boundary_Conditions* : concerne les fichiers de condition limites
 313    (fichier des frontières liquides, fichier des courbes de tarage, cote ou débit imposé...)
 314
 315  * *Physical_Parameters_Hydro* : concerne le frottement. L'utilisateur peut rajouter ce qui concerne les vagues,
 316    la météorologie, les sources, la qualité d'eau...
 317
 318  * *Numerical_Parameters_Hydro* : concerne les équations utilisées, le traitement du système linéaire.
 319
 320 Dans General_Parameters, on retrouve par défaut :
 321
 322  * *Debugger* : en mode debugger ou non
 323
 324  * *Time* : concerne le pas de temps, durée de la simulation...
 325
 326  * *Location* : concerne l'origine des coordonnées...
 327
 328 Dans Numerical_Parameters, on retrouve par défaut :
 329
 330  * *Solver_Info* : concerne le solveur
 331
 332  * *Discretizations_Implicitation* : concerne l'implicitation de la hauteur, de la vitesse, la discrétisation en espace...
 333
 334  * *Propagation_Info*
 335
 336  * *Advection_Info* : concerne le mass lumping, la compatibilité du gradient de surface libre...
 337
 338  * *Diffusion* : concerne la diffusion des vitesses, l'option pour la diffusion des vitesses...
 339
 340  * *Automatic_Differentiation*
 341
 342  * *Advanced* : concerne le stockage de matrice, le produit vecteur-matrice...
 343
 344 **Développement à venir**
 345
 346 A terme, l'utilisateur pourra choisir parmi des "fichiers cas modèles" pré-remplis. On trouvera parmi ceux-ci :
 347
 348  * un fichier cas modèle inondation,
 349
 350  * un fichier cas modèle maritime,
 351
 352  * un fichier cas modèle thermique.
 353
 354 .. only:: html
 355
 356    :ref:`ref_exempleInondation`