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