doc/salome/tutorial/english/english_streams.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 Streams
  21 #########################################
  22
  23 .. |exemple_profil| image:: /../_static/exemple_profil.png
  24    :align: middle
  25
  26 .. |profilsEtLignedo| image:: /../_static/profilsEtLignedo.png
  27    :align: middle
  28
  29 .. |iconeImportSinusX| image:: /../_static/iconeImportSinusX.png
  30    :align: middle
  31
  32 .. |menuImportSinusX| image:: /../_static/menuImportSinusX.png
  33    :align: middle
  34
  35 .. |georeferencementProfiles| image:: /../_static/georeferencementProfiles.png
  36    :align: middle
  37
  38 .. |profilsIgnores| image:: /../_static/profilsIgnores.png
  39    :align: middle
  40
  41 .. |createStream| image:: /../_static/createStream.png
  42    :align: middle
  43
  44 .. |objetStream| image:: /../_static/objetStream.png
  45    :align: middle
  46
  47 Stream object allow to define a river with a list of profiles (cross sections).
  48 These cross sections are vertical sections done at regular intervals along the river.
  49
  50   |exemple_profil|
  51
  52 To rebuild the river, we need a list of georeferenced profiles, and a line defining the river axis.
  53 This line is only used to reorder the profiles.
  54
  55   |profilsEtLignedo|
  56
  57 Let's import a list of georeferenced profiles, and a XY polyline defining the river axis, in SinusX format (or xyz).
  58 The polyline must not be precise, but must cut all the profiles.
  59
  60 SinusX import is done with *HYDRO* menu, *Import from SinusX* command, or corresponding button in the module toolbar.
  61
  62   |iconeImportSinusX|
  63
  64   |menuImportSinusX|
  65
  66 Let's import *lignedo.sx* and *garonne_profiles.sx* files, in the SALOME_HYDRO install folder ::
  67
  68   <appli_xxx>/bin/salome/test/HYDRO
  69
  70 Th axis is stored in *POLYLINES* folder in the study tree, and the profiles are the *PROFILES* folder.
  71
  72 Each profile receive a name, and is editable.
  73
  74   |georeferencementProfiles|
  75
  76 To build the Stream object, use the *Create stream* command of the context menu on study folder *NATURAL OBJECTS*.
  77
  78 Let's name the stream *garonne_stream*, select the polyline *lignedo* and the list of profiles previously imported
  79 (They must be selected in the study tree. Use the *Add* button in the *create stream* dialog).
  80
  81 The polyligne does not cut all the profiles. Some profiles upstream and downstream will be ignored.
  82
  83   |profilsIgnores|
  84
  85 To allow the bathymetry calculation, a 3D point cloud is generated by interpolation between profiles: a list of
  86 intermediate profiles defined by points is built.
  87
  88 The *Stream spatial step* parameter gives the distance between intermediate profiles.
  89
  90 The *Stream ddz* parameter gives the vertical step used to discretize the profiles.
  91
  92   |createStream|
  93
  94 Use *Apply and Close* to validate. The Stream object is shown on the 3D view and in the *NATURAL OBJECTS* folder,
  95 under the name previouly given, *garonne_stream*.
  96
  97   |objetStream|
  98
  99 The corresponding point cloud appears in *BATHYMETRIES* folder under the name *garonne_stream_Altitude_1*.
 100
 101 .. only:: html
 102
 103    :ref:`ref_casParticuliers`
 104