doc/salome/tutorial/english/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 SALOME HYDRO Tutorial
  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 is an open integration platform devoted to hydraulic studies with the TELEMAC and MASCARET
  35 codes in the field of free surface flows. The platform is based on the SALOME generic modules
  36 (geometry and mesh creation, monitoring and automated management of computations, post-processing, etc.)
  37 to which two specific task modules have been added:
  38
  39   * HYDRO |Hydro_module_button|: acquisition of field data (contours, bathymetry, etc.),
  40     construction of the geometry for the calculation case, identification of the boundary condition regions, etc
  41
  42   * HYDROSOLVER |hydrosolver_module_button|: definition of the physical model and numerical parameters of the
  43     simulation (calculation case) parameters, computational steering.
  44
  45 The tutorial provides a step-by-step guide to a carrying out a case study on river flood inundation.
  46 The practical exercise is drawn from a real example for which plenty of data is available.
  47
  48 .. _ref_installationLancementSalome:
  49
  50 ###################################
  51 Introduction to SALOME
  52 ###################################
  53
  54 This section briefly recalls the procedure for installing and running SALOME.
  55
  56 .. toctree::
  57    :numbered:
  58    :maxdepth: 3
  59
  60    english_installationLancementSalome.rst
  61
  62 .. _ref_notionsPrealables:
  63
  64 ###################################
  65 A few preliminary concepts
  66 ###################################
  67
  68 The different steps involved in a SALOME-HYDRO study are described herein and the necessary concepts introduced.
  69 This section also contains a series of recommendations and pitfalls to be avoided.
  70
  71 This is followed by a simple exercise enabling to discover these concepts through practical experience.
  72
  73 .. toctree::
  74    :numbered:
  75    :maxdepth: 3
  76
  77    english_preliminaires.rst
  78    english_piegesAEviter.rst
  79    english_donneesPrealables.rst
  80
  81 .. _ref_exempleInondation:
  82
  83 ###################################
  84 A simple example of flooding
  85 ###################################
  86
  87 This exercise covers the full procedure for conducting a flood study on a simple problem.
  88
  89 .. toctree::
  90    :numbered:
  91    :maxdepth: 3
  92
  93    english_import.rst
  94    english_importBathy.rst
  95    english_polylignes.rst
  96    english_objetsNaturels.rst
  97    english_casCalcul.rst
  98    english_geometrie.rst
  99    english_maillage.rst
 100    english_interpolationZ.rst
 101    english_miseEnDonneesTelemac.rst
 102    english_lancementCalcul.rst
 103    english_depouillementCalcul.rst
 104
 105 .. _ref_casParticuliers:
 106
 107 ###################################
 108 Some specific cases
 109 ###################################
 110
 111 This chapter introduces a few concepts that were not addressed in the previous simple example.
 112
 113 .. toctree::
 114    :numbered:
 115    :maxdepth: 3
 116
 117    english_streams.rst
 118    english_objetsArtificiels.rst
 119    english_manipsPolys.rst
 120    english_landCoverMap.rst
 121
 122 .. _ref_formatsSpecs:
 123
 124 ###################################
 125 Formats and specifications
 126 ###################################
 127
 128 A few import-export formats are introduced herein.
 129 The SinusX format documentation in French corresponds to the original use of the format and can be transposed to SALOME use.
 130 **The SinusX format documentation in English provides the precise specification for the SinusX format in SALOME HYDRO. The latter documentation constitutes the reference for SALOME HYDRO.**
 131
 132
 133 .. toctree::
 134    :numbered:
 135    :maxdepth: 3
 136
 137    english_format_sinusx.rst
 138    english_sinusX_Format.rst
 139