Salome HOME
0787b7c2083c929fb158ac1dade11715f7f3fcf5
[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 item from \b Measurements menu.
22
23 \image html min_distance.png
24
25 In the dialog box choose the first target and the second target mode 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 \em Compute button.
29
30 The following types of targets are supported:
31 - \em Node: single mesh node;
32 - \em Element: single mesh element (not available in this version);
33 - \em Object: mesh, sub-mesh or group object (not available in this
34 version);
35 - \em Origin: origin of the global co-ordinate system.
36
37 The result will
38 be shown in the bottom area of the dialog box. In addition, a simple
39 preview will be shown in the 3D viewer.
40
41 \image html min_distance_preview.png
42
43 \section bounding_box_anchor Bounding Box
44
45 This operation allows to calculate the bounding box of the selected
46 object(s).
47
48 To start <b>Bounding Box</b> operation, select <b>Bounding Box</b>
49 item from \b Measurements menu.
50
51 \image html bnd_box.png
52
53 In the dialog box choose the required type of the object by switching the
54 corresponding radio button, select the object(s) and press \em Compute button.
55
56 The following types of input are available:
57 - \em Objects: select one or several mesh, sub-mesh or group objects;
58 - \em Nodes: select a set of mesh nodes;
59 - \em Elements: select a set of mesh elements.
60
61 The result of calculation will be shown in the bottom area of the
62 dialog box. In addition, a simple preview will be shown in the 3D
63 viewer.
64
65 \image html bnd_box_preview.png
66
67 \section basic_properties_anchor Basic Properties
68
69 This operation allows calculation of length, area or volume for the the selected
70 object:
71 - Length is calculated as a sum of length of all 1D elements;
72 - Area id a sum of area of all 2D elements
73 - Volume is a sum of volume of all 3D elements. 
74
75 To start one of <b>Basic Properties</b> calculations, select <b>Length</b>, <b>Area</b> 
76 or <b>Volume</b> item from <b>Measurements - Basic Properties</b> menu.
77
78 \image html basic_props.png
79
80 In the dialog box select the required type of calculation (length, area or volume), select
81 the the object (mesh, sub-mesh or group) and press \em Compute button.
82
83 The result of calculation will be shown in the bottom area of the
84 dialog box.
85
86 \note
87 - If mesh consists of 3D elements only, its "length" and "area" will be 0.
88 - As calculation result is a sum of length, area and volume of all mesh elements,
89   duplications are not taken into account; i.e. all duplicated elements
90   (elements built on the same set of nodes) will be included into the result.
91 - Similarly, intersection of elements is not taken into account.
92
93 <b>See Also</b> a sample TUI Script of a 
94 \ref tui_measurements_page "Measurement operations".
95
96 */