Salome HOME
Join modifications from BR_Dev_For_4_0 tag V4_1_1.
[modules/visu.git] / doc / salome / gui / VISU / input / stream_lines.doc
diff --git a/doc/salome/gui/VISU/input/stream_lines.doc b/doc/salome/gui/VISU/input/stream_lines.doc
new file mode 100644 (file)
index 0000000..4b7bf14
--- /dev/null
@@ -0,0 +1,83 @@
+/*!
+
+\page stream_lines_page Stream Lines presentation
+
+\n <b>Stream Lines</b> is a type of presentation transforming the
+cells with vectors having most similar direction into lines . A
+streamline can be thought of as the path that a massless particle
+takes in a vector field. Streamlines are used to convey the structure
+of a vector field. Usually streamlines are created to explore the most
+interesting features in the field.
+\n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creating
+streamlines requires specifying multiple parameters including
+<b>starting points</b> of streamlines, \b direction and other
+parameters to control the \b propagation of the streamlines.
+\n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In \b Post-Pro
+there is an option allowing to specify <b>one particular area</b> of
+the field on which the <b>Stream Lines</b> presentation will be
+created. This option has been created for optimization purposes:
+sometimes generation of a Stream Lines presentation based on all
+points of a very complicated field is very time-consuming and requires
+a lot of hardware resources.
+\n &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To bound the area
+on which the Stream Lines presentation will be created. you can use
+another field presentation. The points of the field located on this
+source presentation will serve as starting points for generated
+streamlines.
+
+<em>To create a Stream Lines presentation:</em>
+\par
+&ndash; Right-click on one of the time stamps of the field in the
+Object browser and from the pop-up menu choose <b>Stream Lines</b>, or
+\n &ndash; Click on one of the time stamps of the field in the Object
+browser and select from the main menu <b>Visualization > Stream
+Lines</b>, or click <em>"Stream Lines"</em> icon in the
+<b>Visualization Toolbar</b>.
+
+\image html streamlinesicon.jpg
+<center><em>"Stream Lines" icon</em></center>
+
+\image html streamlines.png
+
+\par
+<b>Stream Lines</b> tab allows you to set additional parameters of
+your Stream Lines presentation:
+<ul>
+<li>\b Source: This set of fields allows to define a source
+presentation on the basis of which your <b>Stream Lines</b>
+presentation will be generated. If in the <b>Source type</b> choose
+box you have chosen \b None, your Stream Lines presentation will be
+generated on all points of the field. You can also choose \b Entity,
+\b Family, \b Group or \b Presentation. You can also specify the
+source presentation (from the list of already created field
+presentations). The points of the field located on this source
+presentation will serve as starting points for generated
+streamlines.</li>
+<li>In the <b>Used points</b> field you can set the number of these
+starting points (from 0 to 100%).</li>
+<li><b>Step Length:</b> this parameter defines the size of the output
+line segments that make up the streamline (which is represented as a
+polyline).</li>
+<li><b>Integration Step</b> field: parameter of smoothness of the
+stream lines. This parameter defines the accuracy of construction of
+the streamlines. A smaller value of this parameter allows to construct
+smoother streamlines (at the cost of more computation time).</li>
+<li><b>Propagation Time</b> field: this parameter controls the maximum
+length of the stream line (measured in units of time).</li>
+<li>\b Direction choose box: this option allows to select direction of
+the stream lines (Forward, Backward or Both).</li>
+<li><b>Magnitude coloring</b> check box: this option allows to color
+your presentation according the vector values applied to the cells of
+the mesh or to display it using only one color (this color can be
+selected if you click <b>Use Color</b> button).</li>
+</ul>
+<b>Scalar Bar tab</b> allows to define the parameters of the scalar bar
+displayed with this presentation (\ref scalar_map_page "see also").
+
+After you have finished with setting these parameters, click \b
+OK. Your presentation with scalar bar will be immediately displayed in
+the viewer:
+
+\image html streamlinesprsnt.png
+
+*/
\ No newline at end of file