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/>.
20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
22 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
24 .. |Hydro_module_button| image:: /../_static/HYDRO.png
29 .. |hydrosolver_module_button| image:: /../_static/HYDROSolver.png
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:
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
42 * HYDROSOLVER |hydrosolver_module_button|: definition of the physical model and numerical parameters of the
43 simulation (calculation case) parameters, computational steering.
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.
48 .. _ref_installationLancementSalome:
50 ###################################
51 Introduction to SALOME
52 ###################################
54 This section briefly recalls the procedure for installing and running SALOME.
60 english_installationLancementSalome.rst
62 .. _ref_notionsPrealables:
64 ###################################
65 A few preliminary concepts
66 ###################################
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.
71 This is followed by a simple exercise enabling to discover these concepts through practical experience.
77 english_preliminaires.rst
78 english_piegesAEviter.rst
79 english_donneesPrealables.rst
81 .. _ref_exempleInondation:
83 ###################################
84 A simple example of flooding
85 ###################################
87 This exercise covers the full procedure for conducting a flood study on a simple problem.
94 english_importBathy.rst
95 english_polylignes.rst
96 english_objetsNaturels.rst
100 english_interpolationZ.rst
101 english_miseEnDonneesTelemac.rst
102 english_lancementCalcul.rst
103 english_depouillementCalcul.rst
105 .. _ref_casParticuliers:
107 ###################################
109 ###################################
111 This chapter introduces a few concepts that were not addressed in the previous simple example.
118 english_objetsArtificiels.rst
119 english_manipsPolys.rst
120 english_landCoverMap.rst
122 .. _ref_formatsSpecs:
124 ###################################
125 Formats and specifications
126 ###################################
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.**
137 english_format_sinusx.rst
138 english_sinusX_Format.rst