2 Copyright (C) 2015-2016 EDF
4 This file is part of SALOME HYDRO module.
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.
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.
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/>.
19 #########################################
20 Mise en données TELEMAC
21 #########################################
23 .. |HYDROSolver| image:: /_static/HYDROSolver.png
28 .. |eficas_04| image:: /_static/eficas_04.png
33 .. |genereCondlim| image:: /_static/genereCondlim.png
36 .. |eficas_01| image:: /_static/eficas_01.png
39 .. |eficas_02| image:: /_static/eficas_02.png
42 .. |eficas_03| image:: /_static/eficas_03.png
45 .. |eficas_20| image:: /_static/eficas_20.png
48 .. |eficas_21| image:: /_static/eficas_21.png
51 .. |eficas_22| image:: /_static/eficas_22.png
54 .. |eficas_23| image:: /_static/eficas_23.png
57 .. |salomeShell| image:: /_static/salomeShell.png
60 .. |initialisationHauteurEau| image:: /_static/initialisationHauteurEau.png
63 .. |choixCodeEficas| image:: /_static/choixCodeEficas.png
66 .. |rechercheEficas| image:: /_static/rechercheEficas.png
69 Une fois le maillage généré avec l'altimétrie, il reste à définir la nature des zones de conditions limites,
70 les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps, et l'ensemble des
71 paramètres physiques et numériques du calcul.
72 Il faut se reporter au manuel de Telemac pour la définition de ces différents paramètres.
74 Ces informations sont regroupées dans plusieurs fichiers de texte (ASCII) à générer ou éditer manuellement.
76 **Ces différents fichiers seront rangés dans le même répertoire que le maillage.**
78 Il faut activer le module HYDROSOLVER, via la liste défilante des modules, ou son icône dans le bandeau : |HYDROSolver|.
79 Le module HYDROSOLVER prend en charge la mise en donnée physico-numérique et les calculs pour les codes
80 Telemac et Mascaret ainsi que leur couplages.
82 Caractérisation des zones de conditions limites
83 ===============================================
85 Les zones de conditions limites ont été définies dans les étapes précédentes,
86 et sont concrétisées par des groupes nommés d'éléments dans le maillage.
88 Le fichier *condlim.bcd* associe à chaque groupe ses caractéristiques :
89 entrée, sortie, paroi... Quatre valeurs entières définissent un type de condition limite.
91 La première ligne indique le nombre de conditions limites définies, il y a ensuite une ligne par condition limite.
92 Chaque ligne comprend 4 entiers (le type) et le nom du groupe.
94 Nous pouvons générer le fichier à partir de la commande *Edit boundary conditions file* du module *HYDROSOLVER*.
96 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.
97 L'entrée *Boundary condition file* ne sert que pour lire un fichier existant.
99 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.
103 Le fichier résultat ressemble à ceci :
105 .. literalinclude:: condlim.bcd
108 * **Remarque** : Il n'est plus nécessaire de créer le fichier *.cli* prévu dans le manuel de Telemac,
109 qui liste l'ensemble des noeuds de conditions limites avec les types associés. Ce fichier est généré
112 Valeurs des conditions limites de débit et hauteur d'eau
113 ========================================================
115 Le fichier *init.lqd* donne les valeurs des conditions limites de débit et de hauteur d'eau au cours du temps.
116 Il faut se reporter au manuel de Telemac pour sa définition précise.
118 .. literalinclude:: init.lqd
121 Ajout d'un champ initial dans le fichier MED
122 ============================================
124 Afin d'initialiser le calcul, on peut utiliser le script suivant pour imposer une hauteur
125 d'eau initiale ou une cote initiale dans les groupes de faces qui nous intéressent,
126 en l'occurence, ici, dans le lit mineur.
128 .. literalinclude:: add_field_h_on_group.py
131 Il suffit de remplir :
133 * le nom du fichier MED,
134 * le nom du maillage (dans le module SMESH) à partir duquel il a été construit,
135 * les groupes de faces auxquels on souhaite ajouter une cote ou une hauteur d'eau initiale,
136 * le nom du champ ajouté (*WATER_DEPTH* ou *WATER ELEVATION*).
138 Pour lancer le script :
140 * ouvrir un SALOME shell.
144 * se placer dans le répertoire où l'on a rangé le script *add_field_h_on_group.py*,
146 * exécuter le script : *python add_field_h_on_group.py*.
148 Le champ *hauteur d'eau* est ajouté au fichier MED. Penser à enregistrer le fichier précédent
149 (comprenant Z et Ks) sous un autre nom pour le conserver pour réutilisation en cas de besoin.
151 |initialisationHauteurEau|
153 Paramètres physiques et numériques du calcul
154 ============================================
156 Le fichier *CasGaronne.cas* liste les autres fichiers, qui doivent être dans le même répertoire.
157 Il donne ensuite les différents paramètres physico-numériques nécessaires au calcul.
158 De même que précédemment, il faut se reporter au manuel de Telemac pour la définition de ces paramètres.
160 Voici la version générée avec EFICAS (voir ci-dessous l'utilisation d'EFICAS)
162 .. literalinclude:: CasGaronne.cas
165 Et la version plus légère, ou seuls figurent les mots clefs différents de leur valeur par défaut.
167 .. literalinclude:: CasGaronne.Lcas
170 Edition du fichier cas avec EFICAS
171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173 Il existe 2 méthodes pour réaliser cette action, avec le module *HYDROSOLVER* :
175 * **avec les menus :** dans le menu HYDRO, cliquer sur *Edit cas file*
179 * **avec les icônes :** quand on active le module Hydrosolver, de nouveaux boutons apparaissent dans la barre d'outils.
180 Cliquer à droite sur Edit cas file
184 Cliquer sur New pour créer un fichier cas.
186 Sélectionner le code souhaité : dans notre cas, *telemac2d*.
192 Renseigner ce qui est rouge. Quand une sous-rubrique ou rubrique est complète elle passe au vert.
193 Ce qui est en vert est rempli par défaut mais l'utilisateur a la main dessus.
194 Penser à enregistrer régulièrement le cas créé. Pour cela, aller dans *File / Save* ou *Save as*,
195 ou cliquer sur l'icône |eficas_04| le fichier sera enregistré en *.comm* ou *.jdc*.
197 Les puces vertes sont de deux couleurs :
199 * Quand la valeur renseignée est la valeur par défaut, la puce est vert foncé.
200 * Quand la valeur renseignée est différente de la valeur par défaut, la puce est vert clair.
202 Comment fonctionne EFICAS ?
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
205 **remarque** : Pour chercher où est rangé un mot clé, aller dans le menu *Edit / Find Keyword*.
207 La fenêtre suivante donne l'emplacement du mot clé ainsi que la documentation associée.
211 Quand on se place dans l'interface centrale, au niveau de la rubrique, dans la partie de droite intitulée Settings *NOM DE RUBRIQUE*,
212 apparaissent des mots clés facultatifs que l'on peut rajouter dans la sous-rubrique correspondante,
213 en double cliquant sur le carré devant le mot clé.
215 **Exemple :** je souhaite rajouter le mot clé *Control_section* dans *Output_Files*. Je double-clique dessus à droite :
219 Il apparaît alors dans la sous-rubrique *Output_Files*. Si je me place dessus dans l'écran central,
220 j'ai d'autres mots clés qui se présentent à moi dans la partie de droite sous le titre
221 *Control_Section* que je peux rajouter de la même manière.
225 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 :
229 Si on clique sur le mot clé avec la souris l'aide apparaît en bas à gauche :
233 **Rangement des paramètres par rubriques et sous-rubriques**
235 Dans *Computation_Environment*, on retrouve par défaut :
237 * *Initialization* : concerne les fichiers de données d'entrée comme le fichier de géométrie et le fichier des conditions limites.
238 Pour prendre en compte le titre, taper le nom souhaité et faites entrer.
240 * *Restart* : pour repartir d'un calcul précédent
242 * *Output_files* : concerne les fichiers résultats, le listing et leurs caractéristiques.
244 Dans *Hydro*, on retrouve par défaut :
246 * *Boundary_Conditions* : concerne les fichiers de condition limites
247 (fichier des frontières liquides, fichier des courbes de tarage, cote ou débit imposé...)
249 * *Physical_Parameters_Hydro* : concerne le frottement. L'utilisateur peut rajouter ce qui concerne les vagues,
250 la météorologie, les sources, la qualité d'eau...
252 * *Numerical_Parameters_Hydro* : concerne les équations utilisées, le traitement du système linéaire.
254 Dans General_Parameters, on retrouve par défaut :
256 * *Debugger* : en mode debugger ou non
258 * *Time* : concerne le pas de temps, durée de la simulation...
260 * *Location* : concerne l'origine des coordonnées...
262 Dans Numerical_Parameters, on retrouve par défaut :
264 * *Solver_Info* : concerne le solveur
266 * *Discretizations_Implicitation* : concerne l'implicitation de la hauteur, de la vitesse, la discrétisation en espace...
270 * *Advection_Info* : concerne le mass lumping, la compatibilité du gradient de surface libre...
272 * *Diffusion* : concerne la diffusion des vitesses, l'option pour la diffusion des vitesses...
274 * *Automatic_Differentiation*
276 * *Advanced* : concerne le stockage de matrice, le produit vecteur-matrice...
278 **Développement à venir**
280 A terme, l'utilisateur pourra choisir parmi des "fichiers cas modèles" pré-remplis. On trouvera parmi ceux-ci :
282 * un fichier cas modèle inondation,
284 * un fichier cas modèle maritime,
286 * un fichier cas modèle thermique.
290 :ref:`ref_exempleInondation`