Salome HOME
Merge from V6_main 13/12/2012
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_divideddisk.doc
1 /*!
2
3 \page create_divideddisk_page DividedDisk
4
5 The <b>Divided disk</b> object is a disk divided into \b blocks for easy hexahedral meshing. Two division patterns are available :
6
7 <ul>
8 <li> A square pattern, which is frequently used; </li>
9 <li> A hexagonal pattern, which ensures a better mesh quality and especially less acute or obtuse angles. </li>
10 </ul>
11
12
13 \n Moreover, this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path" operation in order to obtain any <b>tube shape</b> prepared for hexahedral meshing 
14 (see example below). (Another alternative is to create a 2D mesh on the divided disk and create a 3D mesh by extrusion in the SMESH module.)
15
16
17 Example:
18
19 \image html divided_disk.png
20
21 To create a <b> Divided Disk </b> in the <b>Main Menu</b> select <b>New Entity - >
22 Advanced - > DividedDisk </b>
23
24 \n There are 2 ways to create a <b> Divided Disk</b> in 3D space. 
25 \n For both operations : 
26 Specify the parameters of the DividedDisk object creation in the opened dialog
27 box and press "Apply" or "Apply & Close" button.
28 The result of each operation will be a GEOM_Object.
29
30 \n At first it is possible to define a disk by its radius and orientation (plane "OXY", "OYZ" or "OZX"). The resulting disk is located at the origin of coordinates
31
32 <b>TUI Command:</b> <em>geompy.MakeDividedDisk(Radius, Orientation, Pattern)</em>
33
34 <b>Arguments:</b>
35 - \b Radius - Radius of the disk
36 - \b Orientation - Plane on wich the disk will be built
37 - \b Pattern - Division pattern
38
39 \image html divided_disk_dlg.png
40
41 \n At second the disk can be defined by its center, normal and radius.
42
43 <b>TUI Command:</b> <em>geompy.MakeDividedDiskPntVecR(Center, Vector,
44 Radius, Pattern)</em>
45
46 <b>Arguments:</b>
47 - \b Center - Center of the disk
48 - \b Vector - Normal to the plane of the disk
49 - \b Radius - Radius of the disk
50 - \b Pattern - Division pattern
51
52 \image html divided_disk_PntVecR_dlg.png
53
54 Our <b>TUI Scripts</b> provide you with useful examples of creation of
55 \ref tui_creation_divideddisk "Advanced objects".
56
57 */