Salome HOME
Redesign SALOME documentation
[modules/smesh.git] / doc / salome / gui / SMESH / input / measurements.rst
1 .. _measurements_page:
2
3 ************
4 Measurements
5 ************
6
7 Mesh module provides the possibility to perform different measurements of the selected mesh data.
8
9 All measurement operations are available via **Measurements** top-level menu. Access to the measurements operations is implemented via a single dialog box, where each operation is represented as a separate tab page.
10
11 .. _min_distance_anchor:
12
13 Minimum Distance
14 ################
15
16 This operation allows measuring the distance between two objects. Currently only node-to-node and node-to-origin operations are available, but this operation will be extended in the future to support other mesh objects - elements, meshes, sub-meshes and groups.
17
18 To start **Minimum Distance** operation, select **Minimum Distance** tab in **Measurements** dialog.
19
20 .. image:: ../images/min_distance.png
21         :align: center
22
23 Choose the first and the second target by switching the corresponding radio buttons, then select the objects the distance between which is to be calculated (or input their IDs directly in case of nodes/elements) and press **Compute** button.
24
25 The following targets are supported:
26
27 * **Node:** single mesh node;
28 * **Element:** single mesh element (not available in this version);
29 * **Object:** mesh, sub-mesh or group object (not available in this version);
30 * **Origin:** origin of the global co-ordinate system.
31
32 The result will be shown in the bottom area of the dialog. In addition, a simple preview will be shown in the 3D viewer.
33
34 .. image:: ../images/min_distance_preview.png
35         :align: center
36
37 .. _bounding_box_anchor:
38
39 Bounding Box
40 ############
41
42 This operation allows calculating the bounding box of the selected object(s).
43
44 To start **Bounding Box** operation, select **Bounding Box** tab in **Measurements** dialog.
45
46 .. image:: ../images/bnd_box.png
47         :align: center
48
49 Choose the required type of the object by switching the corresponding radio button, select the object(s) and press *Compute* button.
50
51 The following types of input are available:
52
53 * **Objects:** one or several mesh, sub-mesh or group objects;
54 * **Nodes:** a set of mesh nodes;
55 * **Elements:** a set of mesh elements.
56
57 The result of calculation will be shown in the bottom area of the dialog. In addition, a simple preview will be shown in the 3D viewer.
58
59 .. image:: ../images/bnd_box_preview.png
60         :align: center
61
62 .. _basic_properties_anchor:
63
64 Basic Properties
65 ################
66
67 This operation provides calculation of length, area or volume for the the selected object:
68
69 * **Length** is calculated as a sum of lengths of all 1D elements;
70 * **Area** is a sum of areas of all 2D elements
71 * **Volume** is a sum of volumes of all 3D elements. 
72
73 To start a **Basic Properties** calculation, select **Length**, **Area** or **Volume** item.
74
75 .. image:: ../images/basic_props.png
76         :align: center
77
78 In the dialog box select the required type of calculation (length, area or volume) and the object (mesh, sub-mesh or group) and press **Compute** button.
79
80 The result of calculation will be shown in the bottom area of the dialog.
81
82 .. note::
83         * If the mesh consists of 3D elements only, its "length" and "area" will be 0.
84         * As calculation result is a sum of lengths, areas and volumes of all mesh elements, the duplication is not taken into account; i.e. all duplicated elements (elements built on the same set of nodes) will be included into the result.
85         * Similarly, intersection of elements is not taken into account.
86
87 **See Also** a sample TUI Script of :ref:`tui_measurements_page`.
88
89