doc/salome/gui/HYDRO/input/stream.doc

   1
   2 /**
   3   @file
   4   \brief Help for the stream
   5 */
   6
   7 /**
   8   \page stream Stream
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   <b>Stream</b> is a natural object simulating the river bed.
  13
  14   <b>Create stream</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Stream => Create stream</b>;
  16   <li> Context menu of <b>NATURAL OBJECTS</b> in Object browser => <b>Create stream</b>;
  17   <li> <b>Create steam</b> toolar button.\image html create_stream_toolbar_button.png "Create stream toolbar button"
  18   </ol>
  19
  20   Arguments of the input panel:
  21
  22   \image html create_stream_input_panel.png "Create stream input panel"
  23
  24 <b>Name</b> - field to define the stream name;<br>
  25 <b>Polyline</b> - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.<br>
  26 <b>Hydraulic axis</b> - combo - box to select the polyline, which is hydraulic axis of the river. Rules are following:<ul>
  27 <li>Polyline should be open;</li>
  28 <li>Polyline should consist from one section only;</li>
  29 <li>Polyline cannot be self-intersected or contain sharp angles, which can lead to self-intersections in resulting shell.</li>
  30 </ul>
  31 <b>Apply</b> - button to generate stream;<br>
  32 <b>Apply and Close</b> - button to generate stream and close input panel;<br>
  33 <b>Close</b> - button to close input panel.<br>
  34
  35 Also it's necessary to add profiles into the list. For this select one/several profiles objects in the object browser and click the button <b>Add</b>. The rules are following:<ol>
  36 <li>Invalid (not positioned) profiles can not be added; they are simply ignored;</li>
  37 <li>Profile can not be added several times to the list; such profiles are simply ignored;</li>
  38 <li>Each added profile should intersect with the selected hydraulic axis; if for certain profile does not intersect, it is ignored.</li>
  39 </ol>
  40 It's possible to remove added profiles from the list. For this select profile(s) in the list and click <b>Remove</b> button.<br>
  41
  42 Generated stream object contains 3D object, simulating the river bed, and its projection on XY plane, which is used for calculation.<br>
  43
  44 Following operations are available with stream:
  45         - \ref findbottom "Find bottom"
  46         - \ref profilesinterpolation "Profiles interpolation"
  47
  48 <b>Examples</b>:<br>
  49
  50 \image html stream_3d_example.png "Stream 3D example"
  51 \image html stream_2d_example.png "Stream 2D example"
  52
  53 <a href="index.html"><b>Back to Main page.</b></a>
  54 */