doc/salome/gui/VISU/input/stream_lines.doc

   1 /*!
   2
   3 \page stream_lines_page Stream Lines presentation
   4
   5 \n <b>Stream Lines</b> is a type of presentation transforming the
   6 cells with vectors having most similar direction into lines . A
   7 streamline can be thought of as the path that a massless particle
   8 takes in a vector field. Streamlines are used to convey the structure
   9 of a vector field. Usually streamlines are created to explore the most
  10 interesting features in the field.
  11 \n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creating
  12 streamlines requires specifying multiple parameters including
  13 <b>starting points</b> of streamlines, \b direction and other
  14 parameters to control the \b propagation of the streamlines.
  15 \n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In \b Post-Pro
  16 there is an option allowing to specify <b>one particular area</b> of
  17 the field on which the <b>Stream Lines</b> presentation will be
  18 created. This option has been created for optimization purposes:
  19 sometimes generation of a Stream Lines presentation based on all
  20 points of a very complicated field is very time-consuming and requires
  21 a lot of hardware resources.
  22 \n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To bound the area
  23 on which the Stream Lines presentation will be created. you can use
  24 another field presentation. The points of the field located on this
  25 source presentation will serve as starting points for generated
  26 streamlines.
  27
  28 <em>To create a Stream Lines presentation:</em>
  29 \par
  30 &ndash; Right-click on one of the time stamps of the field in the
  31 Object browser and from the pop-up menu choose <b>Stream Lines</b>, or
  32 \n &ndash; Click on one of the time stamps of the field in the Object
  33 browser and select from the main menu <b>Visualization > Stream
  34 Lines</b>, or click <em>"Stream Lines"</em> icon in the
  35 <b>Visualization Toolbar</b>.
  36
  37 \image html streamlinesicon.jpg
  38 <center><em>"Stream Lines" icon</em></center>
  39
  40 \image html streamlines.png
  41
  42 \par
  43 <b>Stream Lines</b> tab allows you to set additional parameters of
  44 your Stream Lines presentation:
  45 <ul>
  46 <li>\b Source: This set of fields allows to define a source
  47 presentation on the basis of which your <b>Stream Lines</b>
  48 presentation will be generated. If in the <b>Source type</b> choose
  49 box you have chosen \b None, your Stream Lines presentation will be
  50 generated on all points of the field. You can also choose \b Entity,
  51 \b Family, \b Group or \b Presentation. You can also specify the
  52 source presentation (from the list of already created field
  53 presentations). The points of the field located on this source
  54 presentation will serve as starting points for generated
  55 streamlines.</li>
  56 <li>In the <b>Used points</b> field you can set the number of these
  57 starting points (from 0 to 100%).</li>
  58 <li><b>Step Length:</b> this parameter defines the size of the output
  59 line segments that make up the streamline (which is represented as a
  60 polyline).</li>
  61 <li><b>Integration Step</b> field: parameter of smoothness of the
  62 stream lines. This parameter defines the accuracy of construction of
  63 the streamlines. A smaller value of this parameter allows to construct
  64 smoother streamlines (at the cost of more computation time).</li>
  65 <li><b>Propagation Time</b> field: this parameter controls the maximum
  66 length of the stream line (measured in units of time).</li>
  67 <li>\b Direction choose box: this option allows to select direction of
  68 the stream lines (Forward, Backward or Both).</li>
  69 <li><b>Magnitude coloring</b> check box: this option allows to color
  70 your presentation according the vector values applied to the cells of
  71 the mesh or to display it using only one color (this color can be
  72 selected if you click <b>Use Color</b> button).</li>
  73 </ul>
  74 <b>Scalar Bar tab</b> allows to define the parameters of the scalar bar
  75 displayed with this presentation (\ref scalar_map_page "see also").
  76
  77 After you have finished with setting these parameters, click \b
  78 OK. Your presentation with scalar bar will be immediately displayed in
  79 the viewer:
  80
  81 \image html streamlinesprsnt.png
  82
  83 */