doc/salome/tutorial/index.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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  21 Tutoriel SALOME HYDRO
  22 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  23
  24 .. |Hydro_module_button| image:: /_static/HYDRO.png
  25    :align: middle
  26    :width: 16pt
  27    :height: 16pt
  28
  29 .. |hydrosolver_module_button| image:: /_static/HYDROSolver.png
  30    :align: middle
  31    :width: 16pt
  32    :height: 16pt
  33
  34 SALOME HYDRO est une plateforme métier dédiée aux études d'hydraulique à surface
  35 libre, avec les codes TELEMAC et MASCARET. La plateforme s'appuie sur les modules
  36 génériques de SALOME (géométrie, maillage, supervision de calculs, post traitement...)
  37 auxquels ont été ajoutés deux modules spécifiques du métier :
  38
  39   * HYDRO |Hydro_module_button| : acquisition des données de terrain (contours, bathymétrie...),
  40     construction de la géométrie du cas de calcul, identification des zones de
  41     condition limite...
  42
  43   * HYDROSolver |hydrosolver_module_button| : définition des paramètres physiques et
  44     numériques du cas de calcul, pilotage du calcul
  45
  46 Le tutoriel traite l'ensemble des étapes d'une étude d'inondation liée à une crue
  47 de fleuve. L'exemple est tiré d'un cas réel pour lequel beaucoup de données sont disponibles.
  48
  49 .. _ref_installationLancementSalome:
  50
  51 ###################################
  52 Introduction à SALOME
  53 ###################################
  54
  55 Dans cette partie, on rappelle comment installer et exécuter SALOME.
  56
  57 .. toctree::
  58    :numbered:
  59    :maxdepth: 3
  60
  61    installationLancementSalome.rst
  62
  63 .. _ref_notionsPrealables:
  64
  65 ###################################
  66 Quelques notions préalables
  67 ###################################
  68
  69 On décrit ici les différentes étapes d'une étude SALOME-HYDRO, en introduisant les concepts nécessaires.
  70 Cette partie contient également une série de recommandations et de pièges à éviter.
  71
  72 .. toctree::
  73    :numbered:
  74    :maxdepth: 3
  75
  76    preliminaires.rst
  77    piegesAEviter.rst
  78    donneesPrealables.rst
  79
  80 .. _ref_exempleInondation:
  81
  82 ###################################
  83 Un exemple simple d'inondation
  84 ###################################
  85
  86 Cet exercice couvre complètement une étude d'inondation sur un problème simple.
  87
  88 .. toctree::
  89    :numbered:
  90    :maxdepth: 3
  91
  92    import.rst
  93    importBathy.rst
  94    polylignes.rst
  95    objetsNaturels.rst
  96    casCalcul.rst
  97    geometrie.rst
  98    maillage.rst
  99    interpolationZ.rst
 100    miseEnDonneesTelemac.rst
 101    lancementCalcul.rst
 102    depouillementCalcul.rst
 103
 104 .. _ref_casParticuliers:
 105
 106 ###################################
 107 Des cas particuliers
 108 ###################################
 109
 110 On introduit ici quelques concepts non abordés dans l'exemple simple précédent.
 111
 112 .. toctree::
 113    :numbered:
 114    :maxdepth: 3
 115
 116    streams.rst
 117    objetsArtificiels.rst
 118    landCoverMap.rst
 119