Salome HOME
bos #20430 Move fields documentation to the common doc folder
[modules/med.git] / doc / dev / sphinx / fields_vector_field_presentation.rst
diff --git a/doc/dev/sphinx/fields_vector_field_presentation.rst b/doc/dev/sphinx/fields_vector_field_presentation.rst
new file mode 100644 (file)
index 0000000..62caee7
--- /dev/null
@@ -0,0 +1,25 @@
+.. _fields_vector_field_presentation_page:
+
+*************************
+Vector field presentation
+*************************
+
+.. image:: images/image_vector_field_prs.png
+   :align: center
+
+**Vector field** presentation visualizes vectors of the corresponding mesh cells in graphical mode.
+
+.. |img_vct| image:: images/image_vector.png
+
+To create a **Vector field** presentation,
+
+* Select a field item in the **Object Browser**, and
+* Choose **Presentations > Vector field** menu or click |img_vct| button in the *Presentations* toolbar.
+
+As a result, **Vector field** presentation is published in the **Object Browser** under selected field and displayed
+in the 3D Viewer.
+
+**Vector field** presentation has the same base parameters as :ref:`fields_scalar_map_presentation_page`, plus
+the following own ones:
+
+* **Scale Factor**: specifies the constant multiplier to apply - it is used to scale vectors.