]> SALOME platform Git repositories - modules/hydro.git/blob - doc/salome/gui/HYDRO/immersible_zone.h
Salome HOME
788e9ea8db66ed954a9c976ff4e88a850a08ca79
[modules/hydro.git] / doc / salome / gui / HYDRO / immersible_zone.h
1
2 /**
3   @file
4   \brief Help for the immersible zone
5 */
6
7 /**
8   \page imzone Immersible zone
9
10   The <b>immersible zone</b> is a natural object.
11   In the HYDROGUI module it is the face limited by one polyline.
12   It simulates the zone under the water.
13
14   The immersible zone can be created via the main menu HYDRO => Create immersible zone.
15
16   In the dialog box: 
17
18   \image html immersible_zone_dlg.png "Immersible zone dialog box"
19
20   the user should select the polyline limited the immersible zone and the bathymetry object associated with the immersible zone.
21
22   The immersible zone can be defined on the polyline with one contour, in this case it will be a simple face limited by the contour:
23
24   \image html simple_immersible_zone.png "A simple immersible zone"
25
26   Also the immersible zone can be defined on the polyline with two contours (one inside another),
27   in this case it will be a face limited by external contour with the hole limited by the internal contour.
28
29   \image html immersible_zone_with_hole.png "An immersible zone with a hole"
30 */